summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/reflection/XIdlField.idl
blob: ec86813ff316e04602e96d3120e3dddde5669da8 (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
/*************************************************************************
 *
 *  $RCSfile: XIdlField.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-08 09:44:39 $
 *
 *  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_reflection_XIdlField_idl__ 
#define __com_sun_star_reflection_XIdlField_idl__ 
 
#ifndef __com_sun_star_reflection_XIdlMember_idl__ 
#include <com/sun/star/reflection/XIdlMember.idl> 
#endif 
 
#ifndef __com_sun_star_reflection_XIdlClass_idl__ 
#include <com/sun/star/reflection/XIdlClass.idl> 
#endif 
 
#ifndef __com_sun_star_reflection_FieldAccessMode_idl__ 
#include <com/sun/star/reflection/FieldAccessMode.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalAccessException_idl__ 
#include <com/sun/star/lang/IllegalAccessException.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module reflection {  
 
//============================================================================= 
 
// DocMerge: empty anyway
[ uik(E227A3A2-33D6-11D1-AABE00A0-249D5590), ident( "XIdlField", 1.0 ) ]
interface XIdlField: com::sun::star::reflection::XIdlMember
{ 
    //------------------------------------------------------------------------- 
     
    // DocMerge from idl: method com::sun::star::reflection::XIdlField::getType
    /** @returns  
                an <type>XIdlClass</type> object that identifies the declared 
                type for the field represented by this <type>XIdlField</type>.
     */
    com::sun::star::reflection::XIdlClass getType(); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from idl: method com::sun::star::reflection::XIdlField::getAccessMode
    /** @returns  
                an enumeration value which denotes whether the field is 
                "const", "readonly", "writeonly" or "readwrite".
     */
    com::sun::star::reflection::FieldAccessMode getAccessMode(); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from idl: method com::sun::star::reflection::XIdlField::get
    /** @returns  
                the value of the field represented by this field on the specified object.  
                 
                <p>The underlying field's value is obtained as follows: 
                 
                <ul> 
                <li>If the underlying field is a constant, the 
                object argument is ignored; it may be NULL. 
                 
                <li>Otherwise, the underlying field is an instance 
                field. If the specified object argument is 
                NULL, the method throws an 
                "IllegalArgumentException". If the specified 
                object is not an instance of the class, 
                interface, struct, union or enum declaring 
                the underlying field, the method throws an 
                "IllegalArgumentException". 
                 
                <li>Otherwise, the value is retrieved from the 
                underlying instance or constant.  
                </ul> 
                 
                @throws IllegalArgumentException   
                if the specified object is <NULL/> and if the 
                specified object is not an instance of the class or 
                interface declaring the underlying field.
     */
    any get( [in] any obj ) 
            raises( com::sun::star::lang::IllegalArgumentException ); 
 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: method com::sun::star::reflection::XIdlField::set
    /** sets the field represented by this <type>XIdlField</type> on the
        specified object argument to the specified new value. 
        
        
        
        <p>The operation proceeds as follows:
        
        </p>
        <ul>
        <li>If the specified object argument is NULL, the method
        throws an <type scope="com::sun::star::lang">IllegalArgumentException</type>. If
        the specified object argument is not an instance of
        the class or interface declaring the underlying field,
        then the method throws an
        <type scope="com::sun::star::lang">IllegalArgumentException</type>.
        
        </li>
        <li>If the underlying field is constant, the method throws an
        <type scope="com::sun::star::lang">IllegalAccessException</type>.
        
        <p>If the new value cannot be converted to the type
        of underlying field by an identity or widening
        conversion, the method throws an
        <type scope="com::sun::star::lang">IllegalArgumentException</type>.
        </p>
        </li>
        </ul>
        
        <p>The field is set to the possibly widened new value.
        
        </p>
     */
    void set( [in] any obj, 
             [in] any value ) 
            raises( com::sun::star::lang::IllegalArgumentException, 
                    com::sun::star::lang::IllegalAccessException ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:35:32  hjs
    initial import
    
    Revision 1.4  2000/09/11 11:52:36  mi
    documentation merged from XML
     
    Revision 1.2  2000/02/07 11:24:45  mi 
    zu #70728# missing documentation marked 
     
    Revision 1.1.1.1  1999/11/11 09:48:44  jsc 
    new 
     
 
=============================================================================*/ 
#endif