Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished service PopupMenuController
Usage Restrictions
not published
Description
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

Exported Interfaces - Summary
XPopupMenuController

supports functions to initialize and update a popup menu controller implementation. (details)

::com::sun::star::lang::XInitialization

provides functions to initialize a popup menu controller with specific data which are needed. (details)

XStatusListener

used to brief the popup menu controller with new status information. (details)

XDispatchProvider

used to query for commands supported by the popup menu controller to execute them directly. (details)

::com::sun::star::lang::XComponent

used to dispose popup menu controller by the owner instance. (details)

Exported Interfaces - Details
XPopupMenuController
Description
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.

::com::sun::star::lang::XInitialization
Description
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 XFrame instance to which the popup menu controller belongs to.
  • CommandURL
    specifies which popup menu controller should be created.

See also
PopupMenuControllerFactory
XStatusListener
Description
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.

XDispatchProvider
Usage Restrictions
optional
Description
used to query for commands supported by the popup menu controller to execute them directly.

A popup menu controller provides special functions which should be available by the normal dispatch API. This optional interface enables popup menu controller to be normal dispatch providers.
Attention:
Popup menu controller functions must be specified using the following the dispatch URL scheme: "vnd.sun.star.popup:" opaque_part [ "?" query ].

Since
OOo 2.2
::com::sun::star::lang::XComponent
Usage Restrictions
optional
Description
used to dispose popup menu controller by the owner instance.

A popup menu controller resides in a menu which has a limited life-time. For correct life-time handling a popup menu controller should support this interface.

Since
OOo 2.2

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.