1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_frame_PopupMenuControllerFactory_idl__
29#define __com_sun_star_frame_PopupMenuControllerFactory_idl__
30
31#ifndef __com_sun_star_lang_XMultiComponentFactory_idl__
32#include <com/sun/star/lang/XMultiComponentFactory.idl>
33#endif
34
35#ifndef __com_sun_star_frame_XUIControllerRegistration_idl__
36#include <com/sun/star/frame/XUIControllerRegistration.idl>
37#endif
38
39//=============================================================================
40
41module com { module sun { module star { module frame {
42
43//=============================================================================
44
45/** specifies a factory that creates instances of registered popup menu controller.
46
47    <p>
48    A popup menu controller can be registered for a command URL and a model service name.
49    A menu bar or context menu will automatically create a popup menu controller if
50    it contains a registered command URL.
51    </p>
52
53    @since OOo 2.0
54*/
55
56service PopupMenuControllerFactory
57{
58    /** this interface provides functions to create new instances of a registered popup menu controller.
59
60        <p>
61        Use <member scope="com.sun.star.lang">XMultiComponentFactory::createInstanceWithArguments()</member> to create
62        a new popup menu controller instance. Use the CommandURL as the service specifier.
63
64        This call supports the following arguments provided as <type scope="com::sun::star::beans">PropertyValue</type>:
65        <ul>
66            <li><b>Frame</b><br>specifies the <type scope="com::sun::star::frame">XFrame</type>
67                   instance to which the popup menu controller belongs to. This property must be provided to
68                   the popup menu controller, otherwise it cannot dispatch its internal commands.</li>
69            <li><b>ModuleIdentifier</b><br>optional string that specifies in which module context the popup menu
70                   controller should be created.</li>
71        </ul>
72        </p>
73     */
74    interface com::sun::star::lang::XMultiComponentFactory;
75
76    /** provides functions to query for, register and deregister a popup menu controller.
77     */
78    interface com::sun::star::frame::XUIControllerRegistration;
79};
80
81}; }; }; };
82
83//=============================================================================
84
85#endif
86