summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XControl.idl
blob: ebda17d65a108bac09ac61bed43b5f2639585c3c (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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
/*************************************************************************
 *
 *  $RCSfile: XControl.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 13:14:20 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#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 {

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

// DocMerge from xml: interface com::sun::star::awt::XControl
/** Implementations of this interface are abstract windows.

    The main reason to instanciate this implementation is to show it
    on a screen. A control has a context.  Set the context with the
    "set context" method.<br>

    Before the window appears on a screen, the createPeer(...) must
    be called.<br>

    If the implementation of the control does not distinguish
    between model, view or controller, then it must allow you to set
    a new XGraphics in the view so you can print the control.
 */
[ uik(E227A468-33D6-11D1-AABE00A0-249D5590), ident( "XControl", 1.0 ) ]
interface XControl: com::sun::star::lang::XComponent
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::awt::XControl::setContext
    /** sets the context for the control.
     */
    [oneway] void setContext( [in] com::sun::star::uno::XInterface Context );

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

    // DocMerge from xml: method com::sun::star::awt::XControl::getContext
    /** gets the context which was previously set with
        setContext.
     */
    [const] com::sun::star::uno::XInterface getContext();

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

    // DocMerge from xml: method com::sun::star::awt::XControl::createPeer
    /** creates a "child" window on the screen. If the
        parent is NULL, then the desktop window of the toolkit
        is the parent.
     */
    [oneway] void createPeer( [in] com::sun::star::awt::XToolkit Toolkit,
             [in] com::sun::star::awt::XWindowPeer Parent );

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

    // DocMerge from xml: method com::sun::star::awt::XControl::getPeer
    /** returns the peer which was previously created or set.
     */
    [const] com::sun::star::awt::XWindowPeer getPeer();

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

    // DocMerge from xml: method com::sun::star::awt::XControl::setModel
    /** sets a model for the control. The control gets
        the persistent data from this interface and sets update
        links to the model data. The main interface to the
        model is the XPropertySet.
     */
    boolean setModel( [in] com::sun::star::awt::XControlModel Model );

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

    // DocMerge from xml: method com::sun::star::awt::XControl::getModel
    /** returns the model for this control. The model
        allows access to data like "test," "font," etc. for the
        control. If there is no extra model, this method must
        return the "com::sun::star::uno::XInterface" from the control.
     */
    [const] com::sun::star::awt::XControlModel getModel();

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

    // DocMerge from xml: method com::sun::star::awt::XControl::getView
    /** returns the view of this control.
     */
    [const] com::sun::star::awt::XView getView();

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

    // DocMerge from xml: method com::sun::star::awt::XControl::setDesignMode
    /** sets the design mode for use in a design editor.
        Normally the control will be painted directly without a peer.
     */
    [oneway] void setDesignMode( [in] boolean bOn );

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

    // DocMerge from idl: method com::sun::star::awt::XControl::isDesignMode
    /** @returns
                    <true/> if the control is in design mode,
                    <false/> otherwise.
     */
    boolean isDesignMode();

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

    // DocMerge from idl: method com::sun::star::awt::XControl::isTransparent
    /** @returns
                    <true/> if the control is transparent,
                    <false/> otherwise.
     */
    boolean isTransparent();

};

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

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.2  2000/10/09 14:24:53  mi
    #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)

    Revision 1.1.1.1  2000/09/18 23:34:52  hjs
    initial import

    Revision 1.6  2000/09/11 11:52:08  mi
    documentation merged from XML

    Revision 1.4  2000/05/16 12:19:52  mi
    documentation

    Revision 1.3  2000/02/07 11:24:15  mi
    zu #70728# missing documentation marked

    Revision 1.2  1999/11/18 11:49:54  mi
    XComponent now in module lang

    Revision 1.1.1.1  1999/11/11 09:48:40  jsc
    new


=============================================================================*/
#endif