PopupMenuControllerFactory.idl (d1766043) PopupMenuControllerFactory.idl (dccf82be)
1/**************************************************************
1/**************************************************************
2 *
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
19 *
20 *************************************************************/
21
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_frame_PopupMenuControllerFactory_idl__
25#define __com_sun_star_frame_PopupMenuControllerFactory_idl__
26
22#ifndef __com_sun_star_frame_PopupMenuControllerFactory_idl__
23#define __com_sun_star_frame_PopupMenuControllerFactory_idl__
24
27#ifndef __com_sun_star_lang_XMultiComponentFactory_idl__
28#include <com/sun/star/lang/XMultiComponentFactory.idl>
29#endif
25#include <com/sun/star/frame/XUIControllerFactory.idl>
30
26
31#ifndef __com_sun_star_frame_XUIControllerRegistration_idl__
32#include <com/sun/star/frame/XUIControllerRegistration.idl>
33#endif
34
35//=============================================================================
36
37module com { module sun { module star { module frame {
38
27module com { module sun { module star { module frame {
28
39//=============================================================================
40
41/** specifies a factory that creates instances of registered popup menu controller.
42
43 <p>
29/** specifies a factory that creates instances of registered popup menu controller.
30
31 <p>
44 A popup menu controller can be registered for a command URL and a model service name.
45 A menu bar or context menu will automatically create a popup menu controller if
32 A popup menu controller can be registered for a command URL and a model service name.
33 A menu bar or context menu will automatically create a popup menu controller if
46 it contains a registered command URL.
47 </p>
48
49 @since OOo 2.0
50*/
34 it contains a registered command URL.
35 </p>
36
37 @since OOo 2.0
38*/
51
52service PopupMenuControllerFactory
39service PopupMenuControllerFactory : XUIControllerFactory
53{
40{
54 /** this interface provides functions to create new instances of a registered popup menu controller.
55
56 <p>
57 Use <member scope="com.sun.star.lang">XMultiComponentFactory::createInstanceWithArguments()</member> to create
58 a new popup menu controller instance. Use the CommandURL as the service specifier.
59
60 This call supports the following arguments provided as <type scope="com::sun::star::beans">PropertyValue</type>:
61 <ul>
62 <li><b>Frame</b><br>specifies the <type scope="com::sun::star::frame">XFrame</type>
63 instance to which the popup menu controller belongs to. This property must be provided to
64 the popup menu controller, otherwise it cannot dispatch its internal commands.</li>
65 <li><b>ModuleIdentifier</b><br>optional string that specifies in which module context the popup menu
66 controller should be created.</li>
67 </ul>
68 </p>
41 /** service constructor
69 */
42 */
70 interface com::sun::star::lang::XMultiComponentFactory;
71
72 /** provides functions to query for, register and deregister a popup menu controller.
73 */
74 interface com::sun::star::frame::XUIControllerRegistration;
43 create();
75};
76
77}; }; }; };
78
44};
45
46}; }; }; };
47
79//=============================================================================
80
81#endif
48#endif