Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

unpublished interface XPopupMenuController
Usage Restrictions
not published
Description
provides data to a popup menu controller implementation to fill and update a popup menu dynamically.

A popup menu controller gets a ::com::sun::star::awt::XPopupMenu from its parent menu implementation. The controller has to fill this popup menu with a set of menu items and/or sub menus. The parent menu implementation briefs the controller whenever the popup menu gets activated by a user.

Since
OOo 2.0

Methods' Summary
setPopupMenu provides a ::com::sun::star::awt::XPopupMenu to a popup menu controller implementation. The controller must fill this popup menu with its functions.  
updatePopupMenu briefs the popup menu controller to update the contents of the provided popup menu to reflect the current state.  
Methods' Details
setPopupMenu
void
setPopupMenu( [in] ::com::sun::star::awt::XPopupMenu  PopupMenu );

Description
provides a ::com::sun::star::awt::XPopupMenu to a popup menu controller implementation. The controller must fill this popup menu with its functions.
Parameter PopupMenu
An empty popup menu that must be filled by the popup menu controller.
updatePopupMenu
void
updatePopupMenu();

Description
briefs the popup menu controller to update the contents of the provided popup menu to reflect the current state.

A controller should never update the popup menu structure on its own to prevent performance problems. A better way would be that a controller registers itself as status listener to for a command URL and immediately deregister after that. Therefor status updates will not be send regularly for a non visible popup menu.

Top of Page

Apache Software Foundation

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

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