Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: configuration :: backend ::

service InteractionHandler
Description
An interaction request handler that lets the user handle a number of well known requests via GUI dialogs.

The well known requests handled by this service include

The requests marked with an asterisk are only handled if (a) their continuations match certain restrictions (see below), and (b) the necessary resource strings are available (this can be exploited by applications that carry only a subset of all resource files with them).

The continuation restrictions are as follows: Let C be the subset of the provided continuations that are of type ::com::sun::star::task::XInteractionApprove, ::com::sun::star::task::XInteractionDisapprove, ::com::sun::star::task::XInteractionRetry, or ::com::sun::star::task::XInteractionAbort (or of a derived type). All other continuations are ignored for these requests. The request is only handled if the set C is any of the following:

  • Abort
  • Retry, Abort
  • Approve
  • Approve, Abort
  • Approve, Disapprove
  • Approve, Disapprove, Abort

Since
OOo 2.0
See also
::com::sun::star::task::InteractionHandler

Exported Interfaces - Summary
::com::sun::star::task::XInteractionHandler

Handle an interaction request.

::com::sun::star::lang::XInitialization

Initialize the interaction handler. (details)

Exported Interfaces - Details
::com::sun::star::task::XInteractionHandler
Description
Handle an interaction request.
::com::sun::star::lang::XInitialization
Description
Initialize the interaction handler.

The arguments must be a sequence of ::com::sun::star::beans::PropertyValues. The currently supported properties are:

  • "Parent" of type ::com::sun::star::awt::XWindow denotes the parent window for any GUI dialogs the interaction handler pops up; it is strongly recommended that this property is supplied;
  • "Context" of type string is a textual description of the current context (used, e.g., as a first line of text in error boxes); this property is optional.


 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.