Difference between revisions of "Framework/Tutorial/Popup Menu Controller"
(Added architecture picture and table of popup menu controllers) |
|||
| Line 13: | Line 13: | ||
= Popup menu controller = | = Popup menu controller = | ||
| − | Popup menu controllers are used in OpenOffice.org when the content of | + | Popup menu controllers are used in OpenOffice.org when the content of a popup menu is dynamic (e.g. changes at runtime). Technically OpenOffice.org uses the following architecture to integrate popup menu controllers. |
| + | |||
| + | [[image:Menu-Popupmenu-controller-architecture.png]] | ||
| + | |||
| + | The menubar controls all menu items. At activation time the menubar implementation checks once for all menu items if a popup menu controller has been registered for a command. The menubar uses the CommandURL property and queries the PopupMenuControllerFactory service for an associated popup menu controller. On success the PopupMenuControllerFactory is asked to create an instance of the popup menu controller and provides it information about it context (e.g. a reference to its popup menu, the associated frame). | ||
| + | |||
| + | OpenOffice.org 2.0.4 uses the following popup menu controllers. | ||
{| width="100%" border="1" cellpadding="4" | {| width="100%" border="1" cellpadding="4" | ||
Revision as of 12:12, 24 November 2006
This tutorial will give you a detailed step-by-step insight into a very flexible way to add dynamic popup menus into the OpenOffice.org menu bar. Dynamic popup menus are implemented via UNO using the popup menu controller service. This tutorial will be split into small chapters which describe different aspects of popup menu controllers. The prerequisites
The outcome of this tutorial will be an add-on which exchanges the default recent file list with an enhanced version. Hopefully some people will find it useful and may be encourage other developers to extend it.
Popup menu controllers are used in OpenOffice.org when the content of a popup menu is dynamic (e.g. changes at runtime). Technically OpenOffice.org uses the following architecture to integrate popup menu controllers.
The menubar controls all menu items. At activation time the menubar implementation checks once for all menu items if a popup menu controller has been registered for a command. The menubar uses the CommandURL property and queries the PopupMenuControllerFactory service for an associated popup menu controller. On success the PopupMenuControllerFactory is asked to create an instance of the popup menu controller and provides it information about it context (e.g. a reference to its popup menu, the associated frame).
OpenOffice.org 2.0.4 uses the following popup menu controllers.
|
Command |
Modules |
Service |
Purpose |
|---|---|---|---|
|
.uno:CharFontName |
all |
com.sun.star.comp.framework.FontMenuController |
Provides a popup menu with all supported fonts. |
|
.uno:FontHeight |
all |
com.sun.star.comp.framework.FontSizeMenuController |
Provides a popup menu with all supported font sizes. |
|
.uno:ObjectMenue |
all |
com.sun.star.comp.framework.ObjectMenuController |
Provides a popup menu with all supported commands of an embedded object. |
|
.uno:InsertPageHeader |
all |
com.sun.star.comp.framework.HeaderMenuController |
Provides a popup menu to insert pages headers. |
|
.uno:InsertPageFooter |
all |
com.sun.star.comp.framework.FooterMenuController |
Provides a popup menu to insert page footers. |
|
.uno:ChangeControlType |
all |
com.sun.star.comp.framework.ControlMenuController |
Provides a popup menu to change the control type of a selected form control. |
|
.uno:AvailableToolbars |
all |
com.sun.star.comp.framework.ToolBarsMenuController |
Provides a popup menu to show/hide toolbars. |
|
.uno:ScriptOrganizer |
all |
com.sun.star.comp.framework.MacrosMenuController |
Provides a popup menu with all available scripting languages. |
|
.uno:RecentFileList |
all |
com.sun.star.comp.framework.RecentFilesMenuController |
Provides a popup menu with recently opened files. |
|
.uno:AddDirect |
all |
com.sun.star.comp.framework.NewMenuController |
Provides a popup menu to create document for all available application modules. |
|
.uno:AutoPilotMenu |
all |
com.sun.star.comp.framework.NewMenuController |
Provides a popup menu with all available wizards. |
A popup menu controller is a UNO based implementation which supports the service com.sun.star.frame.PopupMenuController. Popup menu controllers are supported since OpenOffice.org 2.0 and
[cpp]
module com { module sun { module star { module frame {
//=============================================================================
/** provides access to a popup menu controller.
A popup menu controller is used to make special functions available to users, which depend on runtime or context specific conditions.
A typical example for a popup menu controller can be a recent file list implementation which provides a list of latest files that a user has worked on. This list gets changes consistently during a work session.
@since OOo 2.0.0
- /
service PopupMenuController {
//-------------------------------------------------------------------------
/** supports functions to initialize and update a popup menu controller
implementation.
A popup menu controller implementation gets initialized with a
com::sun::star::awt::XPopupMenu object. This assures that a
popup menu controller can be implemented with any UNO based
language.
*/
interface com::sun::star::frame::XPopupMenuController;
//-------------------------------------------------------------------------
/** provides functions to initialize a popup menu controller with
specific data which are needed.
This interface should not directly used. A factory service is responsible to
initialize every controller correctly.
A popup menu controller needs at least two additional arguments
provided as com::sun::star::beans::PropertyValue:
Frame
specifies the com::sun::star::frame::XFrame instance to which the
popup menu controller belongs to.
CommandURL
specifies which popup menu controller should be created.
@see PopupMenuControllerFactory */ interface com::sun::star::lang::XInitialization;
//------------------------------------------------------------------------- /** used to brief the popup menu controller with new status information.
A popup menu controller makes special functions available to users which normally
depend on the state of other data. This interface is used to send this data
to a controller implementation.
*/
interface com::sun::star::frame::XStatusListener;
};
}; }; }; };
//=============================================================================
