offapi/com/sun/star/frame/PopupMenuController.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PopupMenuController.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_frame_PopupMenuController_idl__
  32 #define __com_sun_star_frame_PopupMenuController_idl__
  33
  34 #ifndef __com_sun_star_frame_XPopupMenuController_idl__
  35 #include <com/sun/star/frame/XPopupMenuController.idl>
  36 #endif
  37
  38 #ifndef _com_sun_star_lang_XInitialization_idl__
  39 #include <com/sun/star/lang/XInitialization.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_frame_XStatusListener_idl__
  43 #include <com/sun/star/frame/XStatusListener.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_frame_XDispatchProvider_idl__
  47 #include <com/sun/star/frame/XDispatchProvider.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_lang_XComponent_idl__
  51 #include <com/sun/star/lang/XComponent.idl>
  52 #endif
  53
  54
  55 //=============================================================================
  56
  57 module com { module sun { module star { module frame {
  58
  59 //=============================================================================
  60
  61 /** provides access to a popup menu controller.
  62
  63     <p>
  64     A popup menu controller is used to make special functions available to
  65     users, which depend on runtime or context specific conditions.<br/>
  66     A typical example for a popup menu controller can be a recent file list
  67     implementation which provides a list of latest files that a user has
  68     worked on. This list gets changes consistently during a work session.
  69     </p>
  70
  71     @since OOo 2.0.0
  72 */
  73
  74 service PopupMenuController
  75 {
  76     //-------------------------------------------------------------------------
  77     /** supports functions to initialize and update a popup menu controller
  78         implementation.
  79
  80         <p>
  81         A popup menu controller implementation gets initialized with a
  82         <type scope="com::sun::star::awt">XPopupMenu</type> object. This assures
  83         that a popup menu controller can be implemented with any UNO based
  84         language.
  85         </p>
  86     */
  87     interface com::sun::star::frame::XPopupMenuController;
  88
  89     //-------------------------------------------------------------------------
  90     /** provides functions to initialize a popup menu controller with
  91         specific data which are needed.
  92
  93         <p>
  94         This interface should not directly used. A factory service is responsible to
  95         initialize every controller correctly.<br/>
  96
  97         A popup menu controller needs at least two additional arguments
  98         provided as <type scope="com::sun::star::beans">PropertyValue</type>:
  99         <ul>
 100             <li><b>Frame</b><br>specifies the <type scope="com::sun::star::frame">XFrame</type>
 101                    instance to which the popup menu controller belongs to.</li>
 102             <li><b>CommandURL</b><br>specifies which popup menu controller should be created.</li>
 103         </ul>
 104         </p>
 105
 106         @see PopupMenuControllerFactory
 107     */
 108     interface com::sun::star::lang::XInitialization;
 109
 110     //-------------------------------------------------------------------------
 111     /** used to brief the popup menu controller with new status information.
 112
 113         <p>
 114         A popup menu controller makes special functions available to users which
 115         normally depend on the state of other data. This interface is used to
 116         send this data to a controller implementation.
 117         </p>
 118     */
 119     interface com::sun::star::frame::XStatusListener;
 120
 121     //-------------------------------------------------------------------------
 122     /** used to query for commands supported by the popup menu controller to
 123         execute them directly.
 124
 125         <p>
 126         A popup menu controller provides special functions which should be
 127         available by the normal dispatch API. This optional interface enables
 128         popup menu controller to be normal dispatch providers.<br/>
 129         <b>Attention:</b><br/>
 130         Popup menu controller functions must be specified using the following
 131         the dispatch URL scheme: "vnd.sun.star.popup:" opaque_part [ "?" query ].
 132         </p>
 133
 134         @since OOo 2.2
 135     */
 136     [optional] interface com::sun::star::frame::XDispatchProvider;
 137
 138     //-------------------------------------------------------------------------
 139     /** used to dispose popup menu controller by the owner instance.
 140
 141         <p>
 142         A popup menu controller resides in a menu which has a limited
 143         life-time. For correct life-time handling a popup menu
 144         controller should support this interface.
 145         </p>
 146
 147         @since OOo 2.2
 148     */
 149     [optional] interface com::sun::star::lang::XComponent;
 150 };
 151
 152 }; }; }; };
 153
 154 //=============================================================================
 155
 156 #endif