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_XController2_idl__
25#define __com_sun_star_frame_XController2_idl__
26
27#include <com/sun/star/frame/XController.idl>
28#include <com/sun/star/awt/XWindow.idl>
29#include <com/sun/star/beans/PropertyValue.idl>
30
31//=============================================================================
32
33module com {  module sun {  module star {  module frame {
34
35//=============================================================================
36
37/** extends the <type>XController</type> interface
38
39    @since OpenOffice 3.0
40*/
41published interface XController2 : XController
42{
43    /** denotes the &quot;root window&quot; of the controller.
44
45        <p>If the controller is plugged into a frame, this window acts as the
46        frame's <code>ComponentWindow</code>.</p>
47
48        @see XFrame
49    */
50    [readonly, attribute] ::com::sun::star::awt::XWindow    ComponentWindow;
51
52    /** specifies the view name of the controller.
53
54        <p>A view name is a logical name, which can be used to create views of the same
55        type. The name is meaningful only in conjunction with <member>XModel2::createViewController</member>
56        - if it's passed there, a view/controller pair of the same type will be created.</p>
57    */
58    [readonly, attribute] string                            ViewControllerName;
59
60    /** denotes the arguments used to create the instance.
61
62        <p>Usually, controllers are created via <member>XModel2::createViewController</member>, where the
63        caller can pass not only a controller name, but also arguments parametrizing the to-be-created instance.
64        Those arguments used at creation time can subsequently be retrieved using the <code>CreationArguments</code>
65        member.</p>
66    */
67    [readonly, attribute] sequence< ::com::sun::star::beans::PropertyValue >
68                                                            CreationArguments;
69};
70
71//=============================================================================
72
73}; }; }; };
74
75//=============================================================================
76
77#endif
78
79