Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: frame ::

interface XDispatch

Base Interface
com::sun::star::uno::XInterface

Description
serves state information of objects which can be connected to controllers (e.g., toolbox controllers).

Each state change is to be broadcast to all registered status listeners. The first notification should be performed synchronously from XDispatch::addStatusListener ; if not, controllers may flicker. State listener must be aware of this synchronous notification.

The state consists of enabled/disabled and a short descriptive text of the function (e.g., "undo insert character"). It is to be broadcast whenever this state changes or the controller should re-get the value for the URL to which it is connected. Additionally, a context-switch-event is to be broadcast whenever the object may be out of scope, to force the state listener to requery the XDispatch .

See also
StatusEvent
See also
Frame
See also
View


Known Services which Export this Interface

com::sun::star::form::control::InteractionGridControl is an extended grid control, which allows the user to customize some of it's user interface's aspects.

Methods' Summary

dispatch dispatches (executes) an URL asynchronously.
addStatusListener registers a listener of a controller for a specific URL to this object to receive status events.
removeStatusListener unregisters a listener of a controller.

Methods' Details

dispatch
 
[ oneway ] void
dispatch(
[ in ] com::sun::star::util::URL aURL,
[ in ] sequence< com::sun::star::beans::PropertyValue > aArgs );

Description
dispatches (executes) an URL asynchronously.

It is only allowed to dispatch URLs for which this XDispatch was explicitely queried. Additional arguments "'#..." or "?...") are allowed.

Example
 // some code for a click-handler of a hyperlink in a view
 XFrame xTargetFrame = m_xFrame-&amp;gt;findFrame(
 m_aHyperlink-&amp;gt;getTargetFrameName(), FRAME_SEARCH_STANDARD );
 URL aURL;
 aURL.Original = m_aHyperlink-&amp;gt;getURL();
 XDispatch m_xFrame-&amp;gt;queryDispatch( aURL, sequence&amp;lt;PropertyValue&amp;gt;() );
 xDispatch-&amp;gt;dispatch( aURL );
addStatusListener
 
[ oneway ] void
addStatusListener(
[ in ] com::sun::star::frame::XStatusListener xControl,
[ in ] com::sun::star::util::URL aURL );

Description
registers a listener of a controller for a specific URL to this object to receive status events.

It is only allowed to register for URLs for which this XDispatch was explicitely queried. Additional arguments ("#..." or "?...") will be ignored.

See also
XDispatch::removeStatusListener
removeStatusListener
 
[ oneway ] void
removeStatusListener(
[ in ] com::sun::star::frame::XStatusListener xControl,
[ in ] com::sun::star::util::URL aURL );

Description
unregisters a listener of a controller.
See also
Dispatch::addStatusListener

Top of Page