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

com :: sun :: star :: beans ::

interface XIntrospection

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

Description
allows the inspection of an object's properties and functions.

For details see method XIntrospection::inspect .

See also
XIntrospectionAccess


Known Services which Export this Interface

com::sun::star::beans::Introspection makes it possible to inspect an object concerning its properties and functions.
com::sun::star::beans::Introspection makes it possible to inspect an object concerning its properties and functions.

Methods' Summary

inspect inspects the given object.

Methods' Details

inspect
 
com::sun::star::beans::XIntrospectionAccess
inspect(
[ in ] any aObject );

Description
inspects the given object.

It identifies all properties supported by the object if they are represented in one of the following ways:

property set
If the object supports an XPropertySet interface, all its properties are adopted.
attributes
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.
get/set methods
Every method RetType getX() 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 void setX( [in] RetType ) , the property "X" also allows write access; otherwise it is read-only.
Important note:
If an object implements XNameAccess , 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 XIntrospectionAccess::getProperties() . XNameAccess items have to be accessed separately by XIntrospectionAccess::getNameAccess() .

In addition, the inspect method identifies all listener access methods in the form add...Listener / remove...Listener (except methods of interface XPropertySet ) where "..." stands for the listener type.

Methods which do not belong to a property nor which represent a listener access nor which are methods of XPropertySet , XNameAccess , XIndexAccess , or XEnumerationAccess , are considered to be normal methods.

See also
XIntrospectionAccess

Top of Page