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

unpublished service PopupMenuController
Usage Restrictions
not published
Description
provides access to a pop-up menu controller.

A pop-up menu controller is used to make special functions available to users, which depend on runtime or context specific conditions.
A typical example for a pop-up 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 pop-up menu controller implementation. (details)

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

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

XStatusListener

used to brief the pop-up menu controller with new status information. (details)

XDispatchProvider

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

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

used to dispose pop-up menu controller by the owner instance. (details)

Exported Interfaces - Details
XPopupMenuController
Description
supports functions to initialize and update a pop-up menu controller implementation.

A pop-up menu controller implementation gets initialized with a ::com::sun::star::awt::XPopupMenu object. This assures that a pop-up menu controller can be implemented with any UNO based language.

::com::sun::star::lang::XInitialization
Description
provides functions to initialize a pop-up 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 pop-up menu controller needs at least two additional arguments provided as ::com::sun::star::beans::PropertyValue:

  • Frame
    specifies the XFrame instance to which the pop-up menu controller belongs to.
  • CommandURL
    specifies which pop-up menu controller should be created.

See also
PopupMenuControllerFactory
XStatusListener
Description
used to brief the pop-up menu controller with new status information.

A pop-up 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 pop-up menu controller to execute them directly.

A pop-up menu controller provides special functions which should be available by the normal dispatch API. This optional interface enables pop-up menu controller to be normal dispatch providers.
Attention:
Po-pup 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 pop-up menu controller by the owner instance.

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

Since
OOo 2.2

 
Top of Page