The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15



Tips ‘n’ Tricks


:: com :: sun :: star :: task ::

service InteractionHandler
An interaction request handler that lets the user handle requests via GUI dialogs.

The interaction handler service has a numerof of built-in handlers, responsible for a lot of well known interactions. Additionally, there's a configuration module which allows to configure additional handlers, responsible for arbitrary requests.

Built-in Handlers

The following well-known requests can be dealt with by the built-in handlers: 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 XInteractionApprove, XInteractionDisapprove, XInteractionRetry, or 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

An ::com::sun::star::ucb::InteractiveAugmentedIOException carries with it a sequence of arguments, which should be ::com::sun::star::beans::PropertyValues. The following details which properties are interpreted by the interaction handler, depending on the request's ::com::sun::star::ucb::IOErrorCode:

All error codes except IOErrorCode::DIFFERENT_DEVICES. The URI of the involved resource (a string).
All error codes except IOErrorCode::DIFFERENT_DEVICES. A name for the involved resource (a string) that might be more meaningful to the user than the URI. For example, a (platform-dependent) path notation for file system resources.
IOErrorCode::DEVICE_NOT_READY and IOErrorCode::NOT_EXISTING only. An identifier for the type of resource involved (a string). Currently understood values are "volume" (e.g., a file system volume) and "folder" (i.e., a resource that contains other resources).
IOErrorCode::NOT_EXISTING only. A flag indicating whether the resource resides on a storage medium that can be removed by the user (a boolean).
IOErrorCode::CANT_CREATE only. The name of the foler in which a resource cannot be created (a string).
"Volume" and "OtherVolume"
IOErrorCode::DIFFERENT_DEVICES only. The names of the two volumes involved (two strings).

Configurating additional Handlers

It is possible to configure additional interaction handlers, to which certain requests can be delegated. The configuration node /org.openoffice.Interaction/InteractionHandlers is evaluated and respected by the InteractionHandler implementation.

A custom interaction handler can declare itself responsible for an arbitrary number of UNO types, specified by full-qualified type name. Also, for each type, it can specify whether it is responsible for only this particular type, or all possibly existent derived types.

Whenever the InteractionHandler encounteres a request it cannot fulfill itself, it will examine the configuration, to find a handler implementation for the request, and delegate it to the first matching handler.

If multiple custom interaction handlers declare themself responsible for the same request type, it is not defined which handler will actully be invoked. Thus, when deploying a custom interaction handler, ensure that the types you specify are general enough to cover all requests you want to handle, but also specific enough to not cover requests which other handlers might be interested in.

Exported Interfaces - Summary

Handle an interaction request.


Initialize the interaction handler. (details)

Exported Interfaces - Details
Handle an interaction request.
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, 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.