Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: reflection ::

interface XIdlClass

Base Interface
com::sun::star::uno::XInterface

Description
provides information about a type or module in an UNO environment. Every array also belongs to a type that is reflected as an XIdlClass object that is shared by all arrays with the same element type and number of dimensions. Finally, any of the primitive IDL types are also represented as XIdlClass objects. These include "void, any, boolean, char, float, double, octet, short, long, hypher, unsigned octet, unsigned short, unsigned long, and unsigned hypher".


Methods' Summary

getClasses
getClass
equals
isAssignableFrom tests if the parameter xType is a subclass of this class.
getTypeClass
getName
getUik
getSuperclasses If this object represents an interface or a class, then the objects that represents the superclasses or superinterfaces of that class are returned.
getInterfaces Determines the interfaces implemented by the class or interface represented by this object.
getComponentType If this class represents an array or sequence type, this method returns the XIdlClass object representing the component type of the array or sequence; otherwise, it returns NULL .
getField
getFields Returns a sequence containing Field objects reflecting all the accessible fields of the class, interface, struct, union, or enum represented by this XIdlClass object. Returns a sequence of length 0 if the class or interface has no accessible fields, or if it represents an array, a sequence, or a primitive type.
getMethod
getMethods Returns a sequence containing XIdlMethod objects reflecting all the member methods of the class or interface represented by this XIdlClass object, including those declared by the class or interface and and those inherited from superclasses and superinterfaces. Returns a sequence of length 0 if the class or interface has no member methods.
getArray
createObject creates an instance of the type represented by this XIdlClass object if the represented type is a basic type, struct, enum, or sequence.

Methods' Details

getClasses
 
sequence< com::sun::star::reflection::XIdlClass >
getClasses();
Returns
all types and modules which are declared in this class.
getClass
 
com::sun::star::reflection::XIdlClass
getClass(
[ in ] string aName );

Returns
a type or module with the given name that is declared in this class.
equals
 
boolean
equals(
[ in ] com::sun::star::reflection::XIdlClass Type );

Returns
true if the instances describe the same type, otherwise false .
isAssignableFrom
 
boolean
isAssignableFrom(
[ in ] com::sun::star::reflection::XIdlClass xType );

Description
tests if the parameter xType is a subclass of this class.
getTypeClass
 
com::sun::star::uno::TypeClass
getTypeClass();
Returns
the type that this instance represents.
getName
 
string
getName();
Returns
the fully-qualified name of the type of object (class, interface, array, sequence, struct, union, enum, or primitive) represented by this XIdlClass .
getUik
 
com::sun::star::uno::Uik
getUik();
Returns
the UIK from this type. If the type has no UIK, then the returned UIK is zero.
getSuperclasses
 
sequence< com::sun::star::reflection::XIdlClass >
getSuperclasses();
Description
If this object represents an interface or a class, then the objects that represents the superclasses or superinterfaces of that class are returned.

If this object is the one that represents the topmost class or interface, an empty sequence is returned.

Returns
the superclass or interface of the type represented by this object.
getInterfaces
 
sequence< com::sun::star::reflection::XIdlClass >
getInterfaces();
Description
Determines the interfaces implemented by the class or interface represented by this object.

If the class or interface implements no interfaces, the method returns a sequence of length 0.

Returns
a sequence of interfaces implemented by this class.
getComponentType
 
com::sun::star::reflection::XIdlClass
getComponentType();
Description
If this class represents an array or sequence type, this method returns the XIdlClass object representing the component type of the array or sequence; otherwise, it returns NULL .
getField
 
com::sun::star::reflection::XIdlField
getField(
[ in ] string aName );

Returns
an XIdlField that reflects the specified member field of the class, interface, struct, union, enum, or exception represented by this XIdlClass object. If a field with the specified name is not found, 0 is returned.

The field to be reflected is located by searching all the member fields of the class, interface, struct, union, enum, or exception represented by this XIdlClass object for a field with the specified name or for NULL, if a field with the specified name is not found.

Parameter aName
specifies the simple name of the desired field.
getFields
 
sequence< com::sun::star::reflection::XIdlField >
getFields();
Description
Returns a sequence containing Field objects reflecting all the accessible fields of the class, interface, struct, union, or enum represented by this XIdlClass object. Returns a sequence of length 0 if the class or interface has no accessible fields, or if it represents an array, a sequence, or a primitive type.

Specifically, if this XIdlClass object represents a class, returns the fields of this class and of all its superclasses. If this XIdlClass object represents an interface, returns the fields of this interface and of all its superinterfaces. If this XIdlClass object represents an array, sequence or primitive type, returns a sequence of length 0.

getMethod
 
com::sun::star::reflection::XIdlMethod
getMethod(
[ in ] string aName );

Returns
an XIdlMethod that reflects the specified member method of the interface represented by this XIdlClass object. If a method with the specified name is not found, "0" is returned.

The method to be reflected is located by searching all the member methods of the interface represented by this XIdlClass object for a method with the specified name.

Parameter aName
specifies the simple name of the desired method.
getMethods
 
sequence< com::sun::star::reflection::XIdlMethod >
getMethods();
Description
Returns a sequence containing XIdlMethod objects reflecting all the member methods of the class or interface represented by this XIdlClass object, including those declared by the class or interface and and those inherited from superclasses and superinterfaces. Returns a sequence of length 0 if the class or interface has no member methods.
getArray
 
com::sun::star::reflection::XIdlArray
getArray();
Returns
the XIdlArray interface to get and set the elements by index if the represented type is an array or sequence.
createObject
 
void
createObject(
[ out ] any obj );

Description
creates an instance of the type represented by this XIdlClass object if the represented type is a basic type, struct, enum, or sequence.

Top of Page