1/**************************************************************
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
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
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.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_frame_StatusbarControllerFactory_idl__
25#define __com_sun_star_frame_StatusbarControllerFactory_idl__
26
27#ifndef __com_sun_star_lang_XMultiComponentFactory_idl__
28#include <com/sun/star/lang/XMultiComponentFactory.idl>
29#endif
30
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
39//=============================================================================
40
41/** specifies a factory that creates instances of registered status bar
42    controller.
43
44    <p>
45    A status bar controller can be registered for a command URL and a model
46    service name. A status bar will automatically create a status bar controller
47    if it contains a registered command URL.
48    </p>
49
50    @since OOo 2.0
51*/
52
53service StatusbarControllerFactory
54{
55    /** this interface provides functions to create new instances of a registered
56        status bar controller.
57
58        <p>
59        Use <member scope="com.sun.star.lang">XMultiComponentFactory::createInstanceWithArguments()</member>
60        to create a new status bar controller instance. Use the CommandURL as the
61        service specifier.
62
63        This call supports the following arguments provided as
64        <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 status bar controller belongs to. This
68                   property must be provided to the status bar controller, otherwise it
69                   cannot dispatch its internal commands.</li>
70            <li><b>ModuleIdentifier</b><br>optional string that specifies in which module
71                   context the status bar controller should be created.</li>
72        </ul>
73        </p>
74     */
75    interface com::sun::star::lang::XMultiComponentFactory;
76
77    /** provides functions to query for, register and deregister a status bar
78        controller.
79     */
80    interface com::sun::star::frame::XUIControllerRegistration;
81};
82
83}; }; }; };
84
85//=============================================================================
86
87#endif
88