LibreOffice Module ucbhelper (master)  1
Public Member Functions | List of all members
ucbhelper::SimpleInteractionRequest Class Referencefinal

This class implements a simple interaction request. More...

#include <simpleinteractionrequest.hxx>

Inheritance diagram for ucbhelper::SimpleInteractionRequest:
[legend]
Collaboration diagram for ucbhelper::SimpleInteractionRequest:
[legend]

Public Member Functions

 SimpleInteractionRequest (const css::uno::Any &rRequest, const ContinuationFlags nContinuations)
 Constructor. More...
 
ContinuationFlags getResponse () const
 After passing this request to XInteractionHandler::handle, this method returns the continuation that was chosen by the interaction handler. More...
 
- Public Member Functions inherited from ucbhelper::InteractionRequest
 InteractionRequest (const css::uno::Any &rRequest)
 Constructor. More...
 
void setContinuations (const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > &rContinuations)
 This method sets the continuations for the request. More...
 
virtual css::uno::Any SAL_CALL getRequest () override
 
virtual css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > SAL_CALL getContinuations () override
 
rtl::Reference< InteractionContinuation > const & getSelection () const
 After passing this request to XInteractionHandler::handle, this method returns the continuation that was chosen by the interaction handler. More...
 
void setSelection (const rtl::Reference< InteractionContinuation > &rxSelection)
 This method sets a continuation for the request. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ucbhelper::InteractionRequest
void setRequest (const css::uno::Any &rRequest)
 
 InteractionRequest ()
 
virtual ~InteractionRequest () override
 

Detailed Description

This class implements a simple interaction request.

The user must not deal with XInteractionContinuations directly, but can use constants that are mapped internally to the according objects. This class encapsulates the standard Interaction Continuations "Abort", "Retry", "Approve" and "Disapprove". Instances can be passed directly to XInteractionHandler::handle(...).

See also
InteractionRequest
InteractionAbort
InteractionRetry
InteractionApprove
InteractionDisapprove

Definition at line 65 of file simpleinteractionrequest.hxx.

Constructor & Destructor Documentation

SimpleInteractionRequest::SimpleInteractionRequest ( const css::uno::Any &  rRequest,
const ContinuationFlags  nContinuations 
)

Constructor.

Parameters
rRequestis the exception describing the error.
nContinuationscontains the possible "answers" for the request. This can be any of the CONTINUATION_* constants combinations listed above.

Definition at line 30 of file simpleinteractionrequest.cxx.

References Abort, Approve, comphelper::containerToSequence(), Disapprove, NONE, Retry, and ucbhelper::InteractionRequest::setContinuations().

Member Function Documentation

ContinuationFlags SimpleInteractionRequest::getResponse ( ) const

After passing this request to XInteractionHandler::handle, this method returns the continuation that was chosen by the interaction handler.

Returns
the continuation chosen by an interaction handler or ContinuationFlags::NONE, if the request was not (yet) handled.

Definition at line 60 of file simpleinteractionrequest.cxx.

References Abort, Approve, Disapprove, ucbhelper::InteractionRequest::getSelection(), NONE, and Retry.


The documentation for this class was generated from the following files: