Difference between revisions of "Framework/Tutorial/Popup Menu Controller"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Popup menu controller work)
Line 12: Line 12:
  
 
= Popup menu controller =
 
= Popup menu controller =
 +
 +
Popup menu controllers are used in OpenOffice.org when the content of the popup menu is dynamic (e.g. changes at runtime). OpenOffice.org 2.0.4 uses the following popup menu controllers.
 +
 +
{| width="100%" border="1" cellpadding="4"
 +
|- valign="TOP"
 +
! width="24%" |
 +
Command
 +
! width="12%" |
 +
Modules
 +
! width="31%" |
 +
Service
 +
! width="34%" |
 +
Purpose
 +
|- valign="TOP"
 +
| width="24%" |
 +
<font size="2">.uno:CharFontName</font>
 +
| width="12%" |
 +
<font size="2">all</font>
 +
| width="31%" |
 +
<font size="2">com.sun.star.comp.framework.FontMenuController</font>
 +
| width="34%" |
 +
<font size="2">Provides a popup menu with all supported fonts.</font>
 +
|- valign="TOP"
 +
| width="24%" |
 +
<font size="2">.uno:FontHeight</font>
 +
| width="12%" |
 +
<font size="2">all</font>
 +
| width="31%" |
 +
<font size="2">com.sun.star.comp.framework.FontSizeMenuController</font>
 +
| width="34%" |
 +
<font size="2">Provides a popup menu with all supported font sizes.</font>
 +
|- valign="TOP"
 +
| width="24%" |
 +
<font size="2">.uno:ObjectMenue</font>
 +
| width="12%" |
 +
<font size="2">all</font>
 +
| width="31%" |
 +
<font size="2">com.sun.star.comp.framework.ObjectMenuController</font>
 +
| width="34%" |
 +
<font size="2">Provides a popup menu with all supported commands of an embedded object.</font>
 +
|- valign="TOP"
 +
| width="24%" |
 +
<font size="2">.uno:InsertPageHeader</font>
 +
| width="12%" |
 +
<font size="2">all</font>
 +
| width="31%" |
 +
<font size="2">com.sun.star.comp.framework.HeaderMenuController</font>
 +
| width="34%" |
 +
<font size="2">Provides a popup menu to insert pages headers.</font>
 +
|- valign="TOP"
 +
| width="24%" |
 +
<font size="2">.uno:InsertPageFooter</font>
 +
| width="12%" |
 +
<font size="2">all</font>
 +
| width="31%" |
 +
<font size="2">com.sun.star.comp.framework.FooterMenuController</font>
 +
| width="34%" |
 +
<font size="2">Provides a popup menu to insert page footers.</font>
 +
|- valign="TOP"
 +
| width="24%" |
 +
<font size="2">.uno:ChangeControlType</font>
 +
| width="12%" |
 +
<font size="2">all</font>
 +
| width="31%" |
 +
<font size="2">com.sun.star.comp.framework.ControlMenuController</font>
 +
| width="34%" |
 +
<font size="2">Provides a popup menu to change the control type of a selected form control.</font>
 +
|- valign="TOP"
 +
| width="24%" |
 +
<font size="2">.uno:AvailableToolbars</font>
 +
| width="12%" |
 +
<font size="2">all</font>
 +
| width="31%" |
 +
<font size="2">com.sun.star.comp.framework.ToolBarsMenuController</font>
 +
| width="34%" |
 +
<font size="2">Provides a popup menu to show/hide toolbars.</font>
 +
|- valign="TOP"
 +
| width="24%" |
 +
<font size="2">.uno:ScriptOrganizer</font>
 +
| width="12%" |
 +
<font size="2">all</font>
 +
| width="31%" |
 +
<font size="2">com.sun.star.comp.framework.MacrosMenuController</font>
 +
| width="34%" |
 +
<font size="2">Provides a popup menu with all available scripting languages.</font>
 +
|- valign="TOP"
 +
| width="24%" |
 +
<font size="2">.uno:RecentFileList</font>
 +
| width="12%" |
 +
<font size="2">all</font>
 +
| width="31%" |
 +
<font size="2">com.sun.star.comp.framework.RecentFilesMenuController</font>
 +
| width="34%" |
 +
<font size="2">Provides a popup menu with recently opened files.</font>
 +
|- valign="TOP"
 +
| width="24%" |
 +
<font size="2">.uno:AddDirect</font>
 +
| width="12%" |
 +
<font size="2">all</font>
 +
| width="31%" |
 +
<font size="2">com.sun.star.comp.framework.NewMenuController</font>
 +
| width="34%" |
 +
<font size="2">Provides a popup menu to create document for all available application modules.</font>
 +
|- valign="TOP"
 +
| width="24%" |
 +
<font size="2">.uno:AutoPilotMenu</font>
 +
| width="12%" |
 +
<font size="2">all</font>
 +
| width="31%" |
 +
<font size="2">com.sun.star.comp.framework.NewMenuController</font>
 +
| width="34%" |
 +
<font size="2">Provides a popup menu with all available wizards.</font>
 +
|}
  
 
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  
 
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  
Line 54: Line 167:
 
         provided as com::sun::star::beans::PropertyValue:
 
         provided as com::sun::star::beans::PropertyValue:
 
          
 
          
−
         Frame  specifies the com::sun::star::frame::XFrame
+
         Frame   
−
              instance to which the popup menu controller belongs to.
+
        specifies the com::sun::star::frame::XFrame instance to which the
−
         CommandURL specifies which popup menu controller should be created.
+
        popup menu controller belongs to.
 +
       
 +
         CommandURL  
 +
        specifies which popup menu controller should be created.
  
 
         @see PopupMenuControllerFactory
 
         @see PopupMenuControllerFactory

Revision as of 10:44, 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 controller

Popup menu controllers are used in OpenOffice.org when the content of the popup menu is dynamic (e.g. changes at runtime). 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;

};

}; }; }; };

//=============================================================================

Retrieved from "https://wiki.openoffice.org/w/index.php?title=Framework/Tutorial/Popup_Menu_Controller&oldid=20731"
Personal tools