Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: reflection ::
interface XIdlClass
Description Provides information reflecting an UNO type.

Methods' Summary
getClasses | [ DEPRECATED ] Deprecated. Do not call.
getClass | [ DEPRECATED ] Deprecated. Do not call.
equals | Tests whether two reflecting objects reflect the same type.
isAssignableFrom | Tests whether values of this reflected type are assignable from values of a second one (`xType`).
getTypeClass | Returns the ::com::sun::star::uno::TypeClass of the reflected type.
getName | Returns the fully-qualified name of the reflected type.
getUik | [ DEPRECATED ] Deprecated. Do not call.
getSuperclasses | If the reflected type is an interface, then the returned sequence of XIdlClass reflect the base interfaces. If the reflected type is not an interface or an interface that is not derived from another, then an empty sequence is returned.
getInterfaces | [ DEPRECATED ] Deprecated. Do not call.
getComponentType | If the reflected type is an array or sequence, then this method returns a XIdlClass interface reflecting the element.
getField | If the reflected type is an interface, struct or union, then you get a XIdlField interface reflecting the demanded field (/interface attribute) by name. If the reflected type is not an interface, struct or union or the interace, struct or union does not have a field (/interface attribute) with the demanded name, then a null-reference is returned.
getFields | If the reflected type is an interface, struct or union, then you get a sequence of XIdlField interfaces reflecting all fields (/interface attributes). This also includes all inherited fields (/interface attributes) of the interface, struct of union. If the reflected type is not an interface, struct or union or the interface, struct or union does not have any field (/interface attribute), then an empty sequence is returned.
getMethod | If the reflected type is an interface, then you get a XIdlMethod interface reflecting the demanded method by name. If the reflected type is not an interface or the interface does not have a method with the demanded name (including inherited methods), then a null-reference is returned.
getMethods | If the reflected type is an interface, then you get a sequence of XIdlMethod interfaces reflecting all methods of the interface. This also includes the inherited methods of the interface. If the reflected type is not an interface or the interface does not have any methods, then a null-reference is returned.
getArray | If the reflected type is an array, then you get a XIdlArray interface to modify instances of the array type. If the reflected type is not an array, then a null-reference is returned.
createObject | This method creates instances of the reflected type. @attention Instances of type `any` can not be passed using an `any`, because anys cannot be nested. So if the reflected type is an `any`, then the returned value is empty.

Methods' Details
getClasses
sequence< XIdlClass >
getClasses();
Usage Restrictions deprecated Description Deprecated. Do not call.
getClass
XIdlClass
getClass( | [in] string | aName );
Usage Restrictions deprecated Description Deprecated. Do not call.
equals
boolean
equals( | [in] XIdlClass | Type );
Description Tests whether two reflecting objects reflect the same type. Returns true, if the objects reflect the same type, false otherwise.
isAssignableFrom
boolean
isAssignableFrom( | [in] XIdlClass | xType );
Description Tests whether values of this reflected type are assignable from values of a second one (`xType`). Parameter xType another reflected type Returns true, if values of this reflected type are assignable from values of `xType`.
getTypeClass
::com::sun::star::uno::TypeClass
getTypeClass();
Description Returns the ::com::sun::star::uno::TypeClass of the reflected type. Returns type class of the reflected type.
getName
string
getName();
Description Returns the fully-qualified name of the reflected type. Returns the fully-qualified name of the type
getUik
::com::sun::star::uno::Uik
getUik();
Usage Restrictions deprecated Description Deprecated. Do not call.
getSuperclasses
sequence< XIdlClass >
getSuperclasses();
Description If the reflected type is an interface, then the returned sequence of XIdlClass reflect the base interfaces. If the reflected type is not an interface or an interface that is not derived from another, then an empty sequence is returned. Returns all base interfaces of an interface type or an empty sequence.
getInterfaces
sequence< XIdlClass >
getInterfaces();
Usage Restrictions deprecated Description Deprecated. Do not call.
getComponentType
XIdlClass
getComponentType();
Description If the reflected type is an array or sequence, then this method returns a XIdlClass interface reflecting the element. Returns reflection interface of the element type of an array or sequence type (null-reference otherwise).
getField
XIdlField
getField( | [in] string | aName );
Description If the reflected type is an interface, struct or union, then you get a XIdlField interface reflecting the demanded field (/interface attribute) by name. If the reflected type is not an interface, struct or union or the interace, struct or union does not have a field (/interface attribute) with the demanded name, then a null-reference is returned. Parameter aName name of the demanded field reflection Returns demanded field (/interface attribute) reflection (or null-reference)
getFields
sequence< XIdlField >
getFields();
Description If the reflected type is an interface, struct or union, then you get a sequence of XIdlField interfaces reflecting all fields (/interface attributes). This also includes all inherited fields (/interface attributes) of the interface, struct of union. If the reflected type is not an interface, struct or union or the interface, struct or union does not have any field (/interface attribute), then an empty sequence is returned. Returns all field (/interface attribute) reflections (or empty sequence)
getMethod
XIdlMethod
getMethod( | [in] string | aName );
Description If the reflected type is an interface, then you get a XIdlMethod interface reflecting the demanded method by name. If the reflected type is not an interface or the interface does not have a method with the demanded name (including inherited methods), then a null-reference is returned. Parameter aName name of demanded method reflection Returns demanded method reflection (or null-reference)
getMethods
sequence< XIdlMethod >
getMethods();
Description If the reflected type is an interface, then you get a sequence of XIdlMethod interfaces reflecting all methods of the interface. This also includes the inherited methods of the interface. If the reflected type is not an interface or the interface does not have any methods, then a null-reference is returned. Returns all method reflections (or empty sequence)
getArray
XIdlArray
getArray();
Description If the reflected type is an array, then you get a XIdlArray interface to modify instances of the array type. If the reflected type is not an array, then a null-reference is returned. Returns inteface to modify array instances (or null-reference)
createObject
void
createObject( | [out] any | obj );
Description This method creates instances of the reflected type. @attention Instances of type `any` can not be passed using an `any`, because anys cannot be nested. So if the reflected type is an `any`, then the returned value is empty. Parameter obj pure out parameter to pass the created instance

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.