summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/frame/XController2.idl
blob: ec4ae530feb08654b6a426c60f20d23e984fc761 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/*************************************************************************
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XController2.idl,v $
*
* $Revision: 1.2 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org.  If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
************************************************************************/

#ifndef __com_sun_star_frame_XController2_idl__
#define __com_sun_star_frame_XController2_idl__

#include <com/sun/star/frame/XController.idl>
#include <com/sun/star/awt/XWindow.idl>

//=============================================================================

module com {  module sun {  module star {  module frame {

//=============================================================================

/** extends the <type>XController</type> interface

    @since OOo 3.0
*/
interface XController2 : XController
{
    /** denotes the &quot;root window&quot; of the controller.

        <p>If the controller is plugged into a frame, this window acts as the
        frame's <code>ComponentWindow</code>.</p>

        @see XFrame
    */
    [readonly, attribute] ::com::sun::star::awt::XWindow    ComponentWindow;

    /** specifies the view name of the controller.

        <p>A view name is a logical name, which can be used to create views of the same
        type. The name is meaningful only in conjunction with <member>XModel2::createViewController</member>
        - if it's passed there, a view/controller pair of the same type will be created.</p>
    */
    [readonly, attribute] string                            ViewControllerName;
};

//=============================================================================

}; }; }; };

//=============================================================================

#endif