:: com :: sun :: star :: drawing :: framework ::

unpublished interface XToolBarFactory
Description
Factory and possibly cache for creating and releasing tool bars.

A tool bar factory is registered at and used by an XToolBarController object.

A factory may want to implement a cache to reuse previously released tool bars.

See also
XToolBarController, XToolBar

Methods' Summary
createToolBar Create a tool bar for the given URL. When the tool bar is not used anymore then call releaseToolBar() .  
releaseToolBar Call this method to tell a factory that the given toll bar is no longer in use in any configuration. The factory can decide whether to release its reference (and thus destroy the tool bar) or to keep it in a cache in order to reuse it later.  
Methods' Details
createToolBar
XToolBar
createToolBar( [in] XResourceId  xToolBarId,
[in] ::com::sun::star::frame::XController  xController );

Description
Create a tool bar for the given URL. When the tool bar is not used anymore then call releaseToolBar() .
Parameter xToolBarId
This XResourceId object specifies both the type of the tool bar to create as well as to which anchor to link it. Valid values for the resource URL are those for which the factory has been registered at the XToolBarController .
Parameter xController
The controller to which the new tool bar will be connected.
Returns
Returns a tool bar object that has been just created or was taken from a cache.
Throws
InvalidArgumentException when the ResourceURL field of the aToolBarId is not supported by the factory.
releaseToolBar
void
releaseToolBar( [in] XToolBar  xToolBar );

Description
Call this method to tell a factory that the given toll bar is no longer in use in any configuration. The factory can decide whether to release its reference (and thus destroy the tool bar) or to keep it in a cache in order to reuse it later.
Parameter xToolBar
The given pane has to be one created by the same factory.
Throws
InvalidArgumentException when the given pane was not created by the same factory.
Top of Page