LibreOffice Module ucbhelper (master) 1
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ucbhelper::InterceptedInteraction::InterceptedRequest Struct Reference

#include <interceptedinteraction.hxx>

Public Member Functions

 InterceptedRequest ()
 default ctor. More...
 
 InterceptedRequest (css::uno::Any Request_, css::uno::Type Continuation_, sal_Int32 Handle_)
 

Public Attributes

css::uno::Any Request
 contains the interaction request, which should be intercepted. More...
 
css::uno::Type Continuation
 specify the fix continuation, which must be selected, if the interaction could be intercepted successfully. More...
 
sal_Int32 Handle
 it's a unique identifier, which must be managed by the outside code. More...
 

Static Public Attributes

static const sal_Int32 INVALID_HANDLE = -1
 marks an Handle as invalid. More...
 

Detailed Description

Definition at line 53 of file interceptedinteraction.hxx.

Constructor & Destructor Documentation

◆ InterceptedRequest() [1/2]

ucbhelper::InterceptedInteraction::InterceptedRequest::InterceptedRequest ( )
inline

default ctor.

@descr Such constructed object can't be used really. Might it will crash if it's used! Don't forget to initialize all(!) members...

Definition at line 86 of file interceptedinteraction.hxx.

References Handle.

◆ InterceptedRequest() [2/2]

ucbhelper::InterceptedInteraction::InterceptedRequest::InterceptedRequest ( css::uno::Any  Request_,
css::uno::Type  Continuation_,
sal_Int32  Handle_ 
)
inline

Definition at line 90 of file interceptedinteraction.hxx.

References Handle.

Member Data Documentation

◆ Continuation

css::uno::Type ucbhelper::InterceptedInteraction::InterceptedRequest::Continuation

specify the fix continuation, which must be selected, if the interaction could be intercepted successfully.

Definition at line 68 of file interceptedinteraction.hxx.

Referenced by ucbhelper::InterceptedInteraction::impl_interceptRequest().

◆ Handle

sal_Int32 ucbhelper::InterceptedInteraction::InterceptedRequest::Handle

it's a unique identifier, which must be managed by the outside code.

@descr If there is a derived class, which overwrites the InterceptedInteraction::intercepted() method, it will be called with a reference to an InterceptedRequest struct. Then it can use the handle to react without checking the request type again.

Definition at line 77 of file interceptedinteraction.hxx.

◆ INVALID_HANDLE

const sal_Int32 ucbhelper::InterceptedInteraction::InterceptedRequest::INVALID_HANDLE = -1
static

marks an Handle as invalid.

Definition at line 58 of file interceptedinteraction.hxx.

◆ Request

css::uno::Any ucbhelper::InterceptedInteraction::InterceptedRequest::Request

contains the interaction request, which should be intercepted.

Definition at line 62 of file interceptedinteraction.hxx.


The documentation for this struct was generated from the following file: