summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/FormComponent.idl
blob: 9c46a5e1b9cef72632749ed2ce9e20b5abca9668 (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
/*************************************************************************
 *
 *  $RCSfile: FormComponent.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mi $ $Date: 2002-10-03 13:04:24 $
 *
 *  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_form_FormComponent_idl__ 
#define __com_sun_star_form_FormComponent_idl__ 
 
#ifndef __com_sun_star_form_XFormComponent_idl__ 
#include <com/sun/star/form/XFormComponent.idl> 
#endif 
 
#ifndef __com_sun_star_lang_XComponent_idl__ 
#include <com/sun/star/lang/XComponent.idl> 
#endif 
 
#ifndef __com_sun_star_container_XNamed_idl__ 
#include <com/sun/star/container/XNamed.idl> 
#endif 
 
#ifndef __com_sun_star_beans_XPropertySet_idl__ 
#include <com/sun/star/beans/XPropertySet.idl> 
#endif 
 
#ifndef __com_sun_star_io_XPersistObject_idl__ 
#include <com/sun/star/io/XPersistObject.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module form {  
 
//============================================================================= 
 
/** specifies a component which can be part of a form.

    @see FormControlModel 
    @see com::sun::star::form::component::Form
 */
service FormComponent
{ 
    /** identifies the component as a candidate for being part of a form.
        <p>This interface also provides the access to the component's parent.</p>
     */
    interface com::sun::star::form::XFormComponent; 
 
     
    /** allows life-time control of form components.
     */
    interface com::sun::star::lang::XComponent; 
 
     
    /** Each FormComponent must supply a name for identification.
     */
    interface com::sun::star::container::XNamed; 
    
    /** gives access to the properties.
    */
    interface com::sun::star::beans::XPropertySet; 
 
     
    /** Each FormComponent must be able to be stored into and read from a stream.
     */
    interface com::sun::star::io::XPersistObject; 
 
    //------------------------------------------------------------------------- 
     
    /** the name of the component.
        <p>Note that the name accessed here is the same as when using the
        <type scope="com::sun::star::container">XNamed</type> interface.</p>
     */
    [property] string Name; 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
    $Log: not supported by cvs2svn $
    Revision 1.4.20.3  2002/07/26 09:59:54  fs
    IDL review form layer
    
    Revision 1.4.20.2  2002/02/18 15:22:01  oj
    #96946# parameter,return value and exception description
    
    Revision 1.4.20.1  2002/02/18 14:49:19  oj
    #96946# parameter,return value and exception description
    
    Revision 1.4  2000/12/21 08:35:08  mi
    @see interface/service/... ident -> @see ident - for new docu generator
    
    Revision 1.3  2000/11/08 12:42:52  mi
    moved from api
    
    Revision 1.2  2000/10/09 14:24:55  mi
    #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)
    
    Revision 1.1.1.1  2000/09/18 23:35:16  hjs
    initial import
    
    Revision 1.6  2000/09/11 11:52:24  mi
    documentation merged from XML
     
    Revision 1.4  2000/02/21 16:18:00  mi 
    string documentation from stardiv...*.idl-files 
     
    Revision 1.3  2000/02/07 11:24:31  mi 
    zu #70728# missing documentation marked 
     
    Revision 1.2  1999/11/18 11:49:56  mi 
    XComponent now in module lang 
     
    Revision 1.1.1.1  1999/11/11 09:48:42  jsc 
    new 
     
 
=============================================================================*/ 
#endif