Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished service ToolbarController
Usage Restrictions
not published
Description
is an abstract service for a component which offers a more complex user interface to users within a toolbar.

A generic toolbar function is represented as a button which has a state (enabled,disabled and selected, not selected). A toolbar controller can be added to a toolbar and provide information or functions within a more sophisticated user interface.
A typical example for toolbar controller is the font chooser within the toolbar. It provides all available fonts in a dropdown box and shows the current chosen font.

Since
OOo 2.0
See also
XDispatchProvider

Exported Interfaces - Summary
XStatusListener

with this interface a component can receive events if a feature has changed. (details)

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

used to initialize a component with required arguments. A toolbar controller needs at least three additional arguments provided as ::com::sun::star::beans::PropertyValue: (details)

::com::sun::star::util::XUpdatable

used to notify an implementation that it needs to add its listener or remove and add them again. (details)

XToolbarController

used to notify changed features and requests for additional user interface items. (details)

XSubToolbarController

used to notify and retrieve information that are specific for sub-toolbar controllers. (details)

Exported Interfaces - Details
XStatusListener
Description
with this interface a component can receive events if a feature has changed.

The toolbar controller implementation should register itself as a listener when its XUpdatable interface has been called.

::com::sun::star::lang::XInitialization
Description
used to initialize a component with required arguments. A toolbar controller needs at least three additional arguments provided as ::com::sun::star::beans::PropertyValue:
  • Frame
    a XFrame instance to which the toolbar controller belongs.
  • CommandURL
    a string which specifies the command a toolbar controller is bound.
  • ServiceManager
    a ::com::sun::star::lang::XMultiServiceFactory instance which can be used to create additional UNO services.
::com::sun::star::util::XUpdatable
Description
used to notify an implementation that it needs to add its listener or remove and add them again.

A toolbar controller instance is ready for use after this call has been made the first time. The toolbar implementation guarentees that the controller's item window has been added to the toolbar and its reference is held by it.

XToolbarController
Description
used to notify changed features and requests for additional user interface items.

Mostly used by a toolbar implementation to forward information to and request services from a toolbar controller component. This interface must be useable after com::sun::star::lang::XInitialitation::initialize has been called. The behavior of the interface is undefined if the controller component hasn't been initialized.

XSubToolbarController
Usage Restrictions
optional
Description
used to notify and retrieve information that are specific for sub-toolbar controllers.

Used by implementations that want to provide the toolbar button/sub- toolbar function feature. A controller supporting this interface exchanges the function of its own toolbar button, that opened the sub-toolbar, with the one that has been selected on the sub-toolbar.


 
Top of Page

Apache Software Foundation

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

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