udkapi/com/sun/star/reflection/XIdlClass.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XIdlClass.idl,v $
  10  * $Revision: 1.14 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_reflection_XIdlClass_idl__
  31 #define __com_sun_star_reflection_XIdlClass_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_uno_TypeClass_idl__
  38 #include <com/sun/star/uno/TypeClass.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_uno_Uik_idl__
  42 #include <com/sun/star/uno/Uik.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module reflection {
  48
  49  published interface XIdlField;
  50  published interface XIdlMethod;
  51  published interface XIdlArray;
  52
  53 //=============================================================================
  54
  55 /** Provides information reflecting an UNO type.
  56 */
  57 published interface XIdlClass: com::sun::star::uno::XInterface
  58 {
  59     /** Deprecated.  Do not call.
  60         @deprecated
  61     */
  62     sequence<XIdlClass> getClasses();
  63     /** Deprecated.  Do not call.
  64         @deprecated
  65     */
  66     XIdlClass getClass( [in] string aName );
  67
  68     /** Tests whether two reflecting objects reflect the same type.
  69
  70         @returns
  71                 true, if the objects reflect the same type, false otherwise.
  72     */
  73     boolean equals( [in] XIdlClass Type );
  74
  75     /** Tests whether values of this reflected type are assignable from values
  76         of a second one (<code>xType</code>).
  77
  78         @param xType
  79                another reflected type
  80         @return
  81                 true, if values of this reflected type are assignable
  82                 from values of <code>xType</code>.
  83     */
  84     boolean isAssignableFrom( [in] XIdlClass xType );
  85
  86     /** Returns the <type scope="com::sun::star::uno">TypeClass</type>
  87         of the reflected type.
  88
  89         @returns
  90                   type class of the reflected type.
  91     */
  92     com::sun::star::uno::TypeClass getTypeClass();
  93
  94     /** Returns the fully-qualified name of the reflected type.
  95
  96         @returns
  97                   the fully-qualified name of the type
  98     */
  99     string getName();
 100
 101     /** Deprecated.  Do not call.
 102
 103         @deprecated
 104     */
 105     com::sun::star::uno::Uik getUik();
 106
 107     /** If the reflected type is an interface, then the returned
 108         sequence of <type>XIdlClass</type> reflect the base interfaces.
 109         <br>
 110         If the reflected type is not an interface or an interface that is
 111         not derived from another, then an empty sequence is returned.
 112
 113         @return
 114                 all base interfaces of an interface type or an empty sequence.
 115     */
 116     sequence<XIdlClass> getSuperclasses();
 117
 118     /** Deprecated.  Do not call.
 119         @deprecated
 120     */
 121     sequence<XIdlClass> getInterfaces();
 122
 123     /** If the reflected type is an array or sequence, then this method
 124         returns a <type>XIdlClass</type> interface reflecting
 125         the element.
 126
 127         @return
 128                 reflection interface of the element type of an array or
 129                 sequence type (null-reference otherwise).
 130     */
 131     XIdlClass getComponentType();
 132
 133     /** If the reflected type is an interface, struct or union, then you
 134         get a <type>XIdlField</type> interface reflecting the demanded
 135         field (/interface attribute) by name.
 136         <br>
 137         If the reflected type is not an interface, struct or union or the
 138         interace, struct or union does not have a field (/interface attribute)
 139         with the demanded name, then a null-reference is returned.
 140
 141         @param aName
 142                name of the demanded field reflection
 143         @return
 144                 demanded field (/interface attribute) reflection (or null-reference)
 145     */
 146     XIdlField getField( [in] string aName );
 147
 148     /** If the reflected type is an interface, struct or union, then you
 149         get a sequence of <type>XIdlField</type> interfaces reflecting all fields
 150         (/interface attributes).  This also includes all inherited
 151         fields (/interface attributes) of the interface, struct of union.
 152         <br>
 153         If the reflected type is not an interface, struct or union or the
 154         interface, struct or union does not have any field (/interface attribute),
 155         then an empty sequence is returned.
 156
 157         @return
 158                 all field (/interface attribute) reflections (or empty sequence)
 159     */
 160     sequence<XIdlField> getFields();
 161
 162     /** If the reflected type is an interface, then you get
 163         a <type>XIdlMethod</type> interface reflecting the demanded method by name.
 164         <br>
 165         If the reflected type is not an interface or the interface does not have
 166         a method with the demanded name (including inherited methods),
 167         then a null-reference is returned.
 168
 169         @param aName
 170                name of demanded method reflection
 171         @return
 172                 demanded method reflection (or null-reference)
 173     */
 174     XIdlMethod getMethod( [in] string aName );
 175
 176     /** If the reflected type is an interface, then you get
 177         a sequence of <type>XIdlMethod</type> interfaces reflecting all methods
 178         of the interface.  This also includes the inherited methods of the interface.
 179         <br>
 180         If the reflected type is not an interface or the interface
 181         does not have any methods, then a null-reference is returned.
 182
 183         @return
 184                 all method reflections (or empty sequence)
 185     */
 186     sequence<XIdlMethod> getMethods();
 187
 188     /** If the reflected type is an array, then you get
 189         a <type>XIdlArray</type> interface to modify instances of the array type.
 190         <br>
 191         If the reflected type is not an array, then a null-reference is returned.
 192
 193         @return
 194                 inteface to modify array instances (or null-reference)
 195     */
 196     XIdlArray getArray();
 197
 198     /** This method creates instances of the reflected type.
 199
 200         @attention
 201         Instances of type <code>any</code> can not be passed using an <code>any</code>, because
 202         anys cannot be nested.  So if the reflected type is an <code>any</code>, then the
 203         returned value is empty.
 204
 205         @param obj
 206                pure out parameter to pass the created instance
 207     */
 208     void createObject( [out] any obj );
 209 };
 210
 211 //=============================================================================
 212
 213 }; }; }; };
 214
 215 /*=============================================================================
 216
 217 =============================================================================*/
 218 #endif