:: com :: sun :: star :: frame ::
|
unpublished |
interface XSubToolbarController |
|
|
|
- Usage Restrictions
- not published
- Description
- special interface to support sub-toolbars in a controller implementation.
This interface is normally used to implement the toolbar button/sub-
toolbar function feature. It exchanges the function of the toolbar
button, that opened the sub-toolbar, with the one that has been selected
on the sub-toolbar.
- Since
- OOo 2.0
- See also
- ToolbarController
|
Methods' Summary |
opensSubToolbar |
if the controller features a sub-toolbar.
|
getSubToolbarName |
provides the resource URL of the sub-toolbar this controller opens.
|
functionSelected |
gets called to notify a controller that a sub-toolbar function has been
selected.
|
updateImage |
gets called to notify a controller that it should set an image which
represents the current selected function.
|
Methods' Details |
opensSubToolbar
boolean |
opensSubToolbar(); |
- Description
- if the controller features a sub-toolbar.
- Returns
- true if the controller offers a sub toolbar, otherwise false.
Enables implementations to dynamically decide to support sub-toolbars
or not.
|
|
getSubToolbarName
string |
getSubToolbarName(); |
- Description
- provides the resource URL of the sub-toolbar this controller opens.
- Returns
- name of the sub-toolbar this controller offers. A empty string
will be interpreted as if this controller offers no sub-toolbar.
|
|
functionSelected
void |
functionSelected( |
[in] string |
aCommand ); |
- Description
- gets called to notify a controller that a sub-toolbar function has been
selected.
- Parameter aCommand
- a string which identifies the function that has been selected by
a user.
|
|
updateImage
- Description
- gets called to notify a controller that it should set an image which
represents the current selected function.
Only the controller instance is able to set the correct image for the
current function. A toolbar implementation will ask sub-toolbar
controllers to update their image whenever it has to update the images
of all its buttons.
|
|
Top of Page
Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.