summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XControl.idl
blob: dfa9c03507006330be4ebf5ee3f716e7e63b35b4 (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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/*************************************************************************
 *
 * 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: XControl.idl,v $
 * $Revision: 1.8 $
 *
 * 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_awt_XControl_idl__
#define __com_sun_star_awt_XControl_idl__

#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_XToolkit_idl__
#include <com/sun/star/awt/XToolkit.idl>
#endif

#ifndef __com_sun_star_awt_XWindowPeer_idl__
#include <com/sun/star/awt/XWindowPeer.idl>
#endif

#ifndef __com_sun_star_awt_XControlModel_idl__
#include <com/sun/star/awt/XControlModel.idl>
#endif

#ifndef __com_sun_star_awt_XView_idl__
#include <com/sun/star/awt/XView.idl>
#endif


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

 module com {  module sun {  module star {  module awt {

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

/** identifies a control.

    <p>Implementations of this interface are abstract windows.
    The main reason to instantiate this implementation is to show the window
    on the screen. Before the window appears on the screen, the
    <member>XControl::createPeer</member> method must be called.</p>

    <p>If the implementation of the control does not distinguish
    between model, view and controller, it must allow to set
    a new XGraphics in the view, so that the control can be printed.</p>
 */
published interface XControl: com::sun::star::lang::XComponent
{
    //-------------------------------------------------------------------------

    /** sets the context of the control.
     */
    [oneway] void setContext( [in] com::sun::star::uno::XInterface Context );

    //-------------------------------------------------------------------------

    /** gets the context of the control.
     */
    com::sun::star::uno::XInterface getContext();

    //-------------------------------------------------------------------------

    /** creates a "child" window on the screen.

        <p>If the parent is NULL, then the desktop window of the toolkit
        is the parent.</p>
     */
    [oneway] void createPeer( [in] com::sun::star::awt::XToolkit Toolkit,
             [in] com::sun::star::awt::XWindowPeer Parent );

    //-------------------------------------------------------------------------

    /** returns the peer which was previously created or set.
     */
    com::sun::star::awt::XWindowPeer getPeer();

    //-------------------------------------------------------------------------

    /** sets a model for the control.
     */
    boolean setModel( [in] com::sun::star::awt::XControlModel Model );

    //-------------------------------------------------------------------------

    /** returns the model for this control.
     */
    com::sun::star::awt::XControlModel getModel();

    //-------------------------------------------------------------------------

    /** returns the view of this control.
     */
    com::sun::star::awt::XView getView();

    //-------------------------------------------------------------------------

    /** sets the design mode for use in a design editor.

        <p>Normally the control will be painted directly without a peer.</p>
     */
    [oneway] void setDesignMode( [in] boolean bOn );

    //-------------------------------------------------------------------------

    /** returns <true/> if the control is in design mode, <false/> otherwise.
     */
    boolean isDesignMode();

    //-------------------------------------------------------------------------

    /** returns <true/> if the control is transparent, <false/> otherwise.
     */
    boolean isTransparent();

};

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

}; }; }; };

#endif