offapi/com/sun/star/frame/PopupMenuControllerFactory.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: PopupMenuControllerFactory.idl,v $
  10  * $Revision: 1.5 $
  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_PopupMenuControllerFactory_idl__
  32 #define __com_sun_star_frame_PopupMenuControllerFactory_idl__
  33
  34 #ifndef __com_sun_star_lang_XMultiComponentFactory_idl__
  35 #include <com/sun/star/lang/XMultiComponentFactory.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_frame_XUIControllerRegistration_idl__
  39 #include <com/sun/star/frame/XUIControllerRegistration.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module frame {
  45
  46 //=============================================================================
  47
  48 /** specifies a factory that creates instances of registered popup menu controller.
  49
  50     <p>
  51     A popup menu controller can be registered for a command URL and a model service name.
  52     A menu bar or context menu will automatically create a popup menu controller if
  53     it contains a registered command URL.
  54     </p>
  55
  56     @since OOo 2.0.0
  57 */
  58
  59 service PopupMenuControllerFactory
  60 {
  61     /** this interface provides functions to create new instances of a registered popup menu controller.
  62
  63         <p>
  64         Use <member scope="com.sun.star.lang">XMultiComponentFactory::createInstanceWithArguments()</member> to create
  65         a new popup menu controller instance. Use the CommandURL as the service specifier.
  66
  67         This call supports the following arguments provided as <type scope="com::sun::star::beans">PropertyValue</type>:
  68         <ul>
  69             <li><b>Frame</b><br>specifies the <type scope="com::sun::star::frame">XFrame</type>
  70                    instance to which the popup menu controller belongs to. This property must be provided to
  71                    the popup menu controller, otherwise it cannot dispatch its internal commands.</li>
  72             <li><b>ModuleIdentifier</b><br>optional string that specifies in which module context the popup menu
  73                    controller should be created.</li>
  74         </ul>
  75         </p>
  76      */
  77     interface com::sun::star::lang::XMultiComponentFactory;
  78
  79     /** provides functions to query for, register and deregister a popup menu controller.
  80      */
  81     interface com::sun::star::frame::XUIControllerRegistration;
  82 };
  83
  84 }; }; }; };
  85
  86 //=============================================================================
  87
  88 #endif