summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/beans/XIntrospection.idl
blob: cc16fe30cfe62e4b0f1b4897ee0b476c07d4d78d (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
/*************************************************************************
 *
 *  $RCSfile: XIntrospection.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-08 09:44:00 $
 *
 *  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_beans_XIntrospection_idl__ 
#define __com_sun_star_beans_XIntrospection_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_beans_XIntrospectionAccess_idl__ 
#include <com/sun/star/beans/XIntrospectionAccess.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module beans {  
 
//============================================================================= 
 
// DocMerge from xml: interface com::sun::star::beans::XIntrospection
/** allows the inspection of an object's properties and functions. 
    
    
    
    <p>For details see method 
    
    
    
    
    .
    
    </p>@see XIntrospectionAccess
 */
[ uik(E227A4AA-33D6-11D1-AABE00A0-249D5590), ident( "XIntrospection", 1.0 ) ]
interface XIntrospection: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
     
    // DocMerge from xml: method com::sun::star::beans::XIntrospection::inspect
    /** inspects the given object.
        
        
        
        <p>It identifies all properties supported by the object
        if they are represented in one of the following ways:
        
        <dl>
        <dt>property set
        </dt>
        <dd>If the object supports an <type>XPropertySet</type> 
        interface, all its properties are adopted.
        
        </dd>
        <dt>attributes
        </dt>
        <dd>All of an object's attributes are considered as properties 
        with same name. If an attribute is read-only, the property 
        also is read-only.
        
        </dd>
        <dt>get/set methods
        </dt>
        <dd>Every method <code>RetType getX()</code> defines a 
        property where "X" stands for the property name and 
        "RetType" for its type. The method must not have any 
        parameters, or there is no property access method 
        and "X" has no property.  If there is also a method 
        <code>void setX( [in] RetType )</code>, the property
        "X" also allows write access; otherwise it is read-only.
        
        </dd>
        <dt>
        <strong>Important note:</strong>
        </dt>
        <dd>If an object implements <type scope="com::sun::star::container">XNameAccess</type>, the 
        items that can be accessed are not considered as properties 
        of the object and so are not included in the property list 
        offered by 
        
        
        
        
        . 
        <type scope="com::sun::star::container">XNameAccess</type> items have to be accessed separately 
        by 
        
        
        
        
        .
        </dd>
        </dl>
        
        </p>
        <p>In addition, the inspect method identifies all listener 
        access methods in the form <code>add...Listener</code>/
        <code>remove...Listener</code> (except methods of interface
        <type>XPropertySet</type>) where "..." stands for the listener type.
        
        </p>
        <p>Methods which do not belong to a property nor which represent 
        a listener access nor which are methods of <type>XPropertySet</type>, 
        <type scope="com::sun::star::container">XNameAccess</type>, 
        <type scope="com::sun::star::container">XIndexAccess</type> or
        <type scope="com::sun::star::container">XEnumerationAccess</type>, are considered to be normal 
        methods. </p>@see XIntrospectionAccess
     */
    com::sun::star::beans::XIntrospectionAccess inspect( [in] any aObject ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
    $Log: not supported by cvs2svn $
    Revision 1.1.1.1  2000/09/18 23:34:56  hjs
    initial import
    
    Revision 1.4  2000/09/11 11:52:11  mi
    documentation merged from XML
     
    Revision 1.2  2000/02/07 11:24:18  mi 
    zu #70728# missing documentation marked 
     
    Revision 1.1.1.1  1999/11/11 09:48:40  jsc 
    new 
     
 
=============================================================================*/ 
#endif