/************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 3 * only, as published by the Free Software Foundation. * * OpenOffice.org is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License version 3 for more details * (a copy is included in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU Lesser General Public License * version 3 along with OpenOffice.org. If not, see * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef __com_sun_star_frame_PopupMenuController_idl__ #define __com_sun_star_frame_PopupMenuController_idl__ #ifndef __com_sun_star_frame_XPopupMenuController_idl__ #include #endif #ifndef _com_sun_star_lang_XInitialization_idl__ #include #endif #ifndef __com_sun_star_frame_XStatusListener_idl__ #include #endif #ifndef __com_sun_star_frame_XDispatchProvider_idl__ #include #endif #ifndef __com_sun_star_lang_XComponent_idl__ #include #endif //============================================================================= 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 */ service PopupMenuController { //------------------------------------------------------------------------- /** supports functions to initialize and update a popup menu controller implementation.

A popup menu controller implementation gets initialized with a 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 PropertyValue:

  • Frame
    specifies the 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; //------------------------------------------------------------------------- /** 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 */ [optional] interface com::sun::star::frame::XDispatchProvider; //------------------------------------------------------------------------- /** 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 */ [optional] interface com::sun::star::lang::XComponent; }; }; }; }; }; //============================================================================= #endif