LibreOffice
LibreOffice 24.8 SDK API Reference
Loading...
Searching...
No Matches
XPopupMenuController Interface Reference

provides data to a pop-up menu controller implementation to fill and update a pop-up menu dynamically. More...

import <XPopupMenuController.idl;

Inheritance diagram for XPopupMenuController:
XInterface PopupMenuController

Public Member Functions

void setPopupMenu ([in] com::sun::star::awt::XPopupMenu PopupMenu)
 provides a com::sun::star::awt::XPopupMenu to a pop-up menu controller implementation.
 
void updatePopupMenu ()
 briefs the pop-up menu controller to update the contents of the provided pop-up menu to reflect the current state.
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object.
 
void acquire ()
 increases the reference counter by one.
 
void release ()
 decreases the reference counter by one.
 

Detailed Description

provides data to a pop-up menu controller implementation to fill and update a pop-up menu dynamically.

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

Since
OOo 2.0

Member Function Documentation

◆ setPopupMenu()

void setPopupMenu ( [in] com::sun::star::awt::XPopupMenu PopupMenu)

provides a com::sun::star::awt::XPopupMenu to a pop-up menu controller implementation.

The controller must fill this pop-up menu with its functions.

Parameters
PopupMenuAn empty pop-up menu that must be filled by the pop-up menu controller.

◆ updatePopupMenu()

void updatePopupMenu ( )

briefs the pop-up menu controller to update the contents of the provided pop-up menu to reflect the current state.

A controller should never update the pop-up 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. Therefore status updates will not be send regularly for a non visible pop-up menu.


The documentation for this interface was generated from the following file: