Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.11

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

unpublished interface XToolbarController
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 with a more sophisticated user interface.
A typical example for toolbar controller is a font chooser on a toolbar. It provides all available fonts in a dropdown box and shows the current chosen font.

Since
OOo 2.0
See also
XDispatchProvider

Methods' Summary
execute provides a function to execute the command which is bound to the toolbar controller.  
click notifies a component that a single click has been made on the toolbar item.  
doubleClick notifies a component that a double click has been made on the toolbar item.  
createPopupWindow requests to create a popup window for additional functions.  
createItemWindow requests to create an item window which can be added to the toolbar.  
Methods' Details
execute
void
execute( [in] short  KeyModifier );

Description
provides a function to execute the command which is bound to the toolbar controller.
Parameter a
combination of ::com::sun::star::awt::KeyModifier value that represent the current state of the modifier keys.

This function is usally called by a toolbar implementation when a user clicked on a toolbar button or pressed enter on the keyboard when the item has the input focus.

click
void
click();

Description
notifies a component that a single click has been made on the toolbar item.
doubleClick
void
doubleClick();

Description
notifies a component that a double click has been made on the toolbar item.
createPopupWindow
::com::sun::star::awt::XWindow
createPopupWindow();

Description
requests to create a popup window for additional functions.
Returns
a ::com::sun::star::awt::XWindow which provides additional functions to the user. The reference must be empty if component does not want to provide a separate window.
createItemWindow
::com::sun::star::awt::XWindow
createItemWindow( [in] ::com::sun::star::awt::XWindow  Parent );

Description
requests to create an item window which can be added to the toolbar.
Parameter Parent
a ::com::sun::star::awt::XWindow which must be used as a parent for the requested item window.
Returns
a ::com::sun::star::awt::XWindow which can be added to a toolbar. The reference must be empty if a component does not want to provide an item window.
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.