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

interface XToolbarController

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 pop-up 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 usually 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 pop-up 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