UDK 3.2.7 C/C++ API Reference
|
RegistryTypeReades reads a binary type blob. More...
#include <reflread.hxx>
Public Member Functions | |
RegistryTypeReader (const sal_uInt8 *buffer, sal_uInt32 bufferLen, sal_Bool copyData) | |
Constructor. | |
RegistryTypeReader (const RegistryTypeReader &toCopy) | |
Copy constructcor. | |
~RegistryTypeReader () | |
Destructor. The Destructor frees the data block if the copyData flag was TRUE. | |
RegistryTypeReader & | operator== (const RegistryTypeReader &toAssign) |
Assign operator. | |
sal_Bool | isValid () const |
checks if the registry type reader points to a valid Api. | |
sal_uInt16 | getMinorVersion () const |
sal_uInt16 | getMajorVersion () const |
RTTypeClass | getTypeClass () const |
returns the typeclass of the type represented by this blob. | |
inline::rtl::OUString | getTypeName () const |
returns the full qualified name of the type. | |
inline::rtl::OUString | getSuperTypeName () const |
returns the full qualified name of the supertype. | |
void | getUik (RTUik &uik) const |
inline::rtl::OUString | getDoku () const |
returns the documentation string of this type. | |
inline::rtl::OUString | getFileName () const |
returns the IDL filename where the type is defined. | |
sal_uInt32 | getFieldCount () const |
returns the number of fields (attributes/properties, enum values or number of constants in a module). | |
inline::rtl::OUString | getFieldName (sal_uInt16 index) const |
returns the name of the field specified by index. | |
inline::rtl::OUString | getFieldType (sal_uInt16 index) const |
returns the full qualified name of the field specified by index. | |
RTFieldAccess | getFieldAccess (sal_uInt16 index) const |
returns the access mode of the field specified by index. | |
RTConstValue | getFieldConstValue (sal_uInt16 index) const |
returns the value of the field specified by index. | |
inline::rtl::OUString | getFieldDoku (sal_uInt16 index) const |
returns the documentation string for the field specified by index. | |
inline::rtl::OUString | getFieldFileName (sal_uInt16 index) const |
returns the IDL filename of the field specified by index. | |
sal_uInt32 | getMethodCount () const |
returns the number of methods of an interface type. | |
inline::rtl::OUString | getMethodName (sal_uInt16 index) const |
returns the name of the method specified by index. | |
sal_uInt32 | getMethodParamCount (sal_uInt16 index) const |
returns number of parameters of the method specified by index. | |
inline::rtl::OUString | getMethodParamType (sal_uInt16 index, sal_uInt16 paramIndex) const |
returns the full qualified parameter typename. | |
inline::rtl::OUString | getMethodParamName (sal_uInt16 index, sal_uInt16 paramIndex) const |
returns the name of a parameter. | |
RTParamMode | getMethodParamMode (sal_uInt16 index, sal_uInt16 paramIndex) const |
returns the parameter mode, if it is an in, out or inout parameter. | |
sal_uInt32 | getMethodExcCount (sal_uInt16 index) const |
returns the number of exceptions which are declared for the method specified by index. | |
inline::rtl::OUString | getMethodExcType (sal_uInt16 index, sal_uInt16 excIndex) const |
returns the full qualified exception type of the specified exception. | |
inline::rtl::OUString | getMethodReturnType (sal_uInt16 index) const |
returns the full qualified return type of the method specified by index. | |
RTMethodMode | getMethodMode (sal_uInt16 index) const |
returns the full qualified exception type of the specified exception. | |
inline::rtl::OUString | getMethodDoku (sal_uInt16 index) const |
returns the documentation string of the method specified by index. | |
sal_uInt32 | getReferenceCount () const |
returns the number of references (supported interfaces, exported services). | |
inline::rtl::OUString | getReferenceName (sal_uInt16 index) const |
returns the full qualified typename of the reference specified by index. | |
RTReferenceType | getReferenceType (sal_uInt16 index) const |
returns the type of the reference specified by index. | |
inline::rtl::OUString | getReferenceDoku (sal_uInt16 index) const |
returns the documentation string of the reference specified by index. | |
RTFieldAccess | getReferenceAccess (sal_uInt16 index) const |
returns the access mode of the reference specified by index. | |
Protected Attributes | |
const RegistryTypeReader_Api * | m_pApi |
stores the registry type reader Api. | |
TypeReaderImpl | m_hImpl |
stores the handle of an implementation class |
RegistryTypeReades reads a binary type blob.
This class provides the necessary functions to read type informations for all kinds of types of a type blob. The class is inline and use a C-Api.
RegistryTypeReader::RegistryTypeReader | ( | const sal_uInt8 * | buffer, |
sal_uInt32 | bufferLen, | ||
sal_Bool | copyData | ||
) | [inline] |
Constructor.
buffer | points to the binary data block. |
bufferLen | specifies the size of the binary data block. |
copyData | specifies if the data block should be copied. The block can be copied to ensure that the data is valid for the lifetime of this instance. |
RegistryTypeReader::RegistryTypeReader | ( | const RegistryTypeReader & | toCopy | ) | [inline] |
Copy constructcor.
RegistryTypeReader::~RegistryTypeReader | ( | ) | [inline] |
Destructor. The Destructor frees the data block if the copyData flag was TRUE.
rtl::OUString RegistryTypeReader::getDoku | ( | ) | const [inline] |
returns the documentation string of this type.
RTFieldAccess RegistryTypeReader::getFieldAccess | ( | sal_uInt16 | index | ) | const [inline] |
returns the access mode of the field specified by index.
RTConstValue RegistryTypeReader::getFieldConstValue | ( | sal_uInt16 | index | ) | const [inline] |
returns the value of the field specified by index.
This function returns the value of an enum value or of a constant.
sal_uInt32 RegistryTypeReader::getFieldCount | ( | ) | const [inline] |
returns the number of fields (attributes/properties, enum values or number of constants in a module).
rtl::OUString RegistryTypeReader::getFieldDoku | ( | sal_uInt16 | index | ) | const [inline] |
returns the documentation string for the field specified by index.
Each field of a type can have their own documentation.
rtl::OUString RegistryTypeReader::getFieldFileName | ( | sal_uInt16 | index | ) | const [inline] |
returns the IDL filename of the field specified by index.
The IDL filename of a field can differ from the filename of the ype itself because modules and also constants can be defined in different IDL files.
rtl::OUString RegistryTypeReader::getFieldName | ( | sal_uInt16 | index | ) | const [inline] |
returns the name of the field specified by index.
rtl::OUString RegistryTypeReader::getFieldType | ( | sal_uInt16 | index | ) | const [inline] |
returns the full qualified name of the field specified by index.
rtl::OUString RegistryTypeReader::getFileName | ( | ) | const [inline] |
returns the IDL filename where the type is defined.
sal_uInt16 RegistryTypeReader::getMajorVersion | ( | ) | const [inline] |
We currently don't support a versioning concept of IDL interfaces and so this function is currently not used.
sal_uInt32 RegistryTypeReader::getMethodCount | ( | ) | const [inline] |
returns the number of methods of an interface type.
rtl::OUString RegistryTypeReader::getMethodDoku | ( | sal_uInt16 | index | ) | const [inline] |
returns the documentation string of the method specified by index.
index | indicates the method. |
sal_uInt32 RegistryTypeReader::getMethodExcCount | ( | sal_uInt16 | index | ) | const [inline] |
returns the number of exceptions which are declared for the method specified by index.
index | indicates the method |
rtl::OUString RegistryTypeReader::getMethodExcType | ( | sal_uInt16 | index, |
sal_uInt16 | excIndex | ||
) | const [inline] |
returns the full qualified exception type of the specified exception.
index | indicates the method |
excIndex | indeciates the exception which typename will be returned. |
RTMethodMode RegistryTypeReader::getMethodMode | ( | sal_uInt16 | index | ) | const [inline] |
returns the full qualified exception type of the specified exception.
index | indicates the method |
rtl::OUString RegistryTypeReader::getMethodName | ( | sal_uInt16 | index | ) | const [inline] |
returns the name of the method specified by index.
sal_uInt32 RegistryTypeReader::getMethodParamCount | ( | sal_uInt16 | index | ) | const [inline] |
returns number of parameters of the method specified by index.
RTParamMode RegistryTypeReader::getMethodParamMode | ( | sal_uInt16 | index, |
sal_uInt16 | paramIndex | ||
) | const [inline] |
returns the parameter mode, if it is an in, out or inout parameter.
index | indicates the method |
paramIndex | indeciates the parameter which mode will be returned. |
rtl::OUString RegistryTypeReader::getMethodParamName | ( | sal_uInt16 | index, |
sal_uInt16 | paramIndex | ||
) | const [inline] |
returns the name of a parameter.
index | indicates the method |
paramIndex | indiciates the parameter which name will be returned. |
rtl::OUString RegistryTypeReader::getMethodParamType | ( | sal_uInt16 | index, |
sal_uInt16 | paramIndex | ||
) | const [inline] |
returns the full qualified parameter typename.
index | indicates the method |
paramIndex | indeciates the parameter which type will be returned. |
rtl::OUString RegistryTypeReader::getMethodReturnType | ( | sal_uInt16 | index | ) | const [inline] |
returns the full qualified return type of the method specified by index.
sal_uInt16 RegistryTypeReader::getMinorVersion | ( | ) | const [inline] |
We currently don't support a versioning concept of IDL interfaces and so this function is currently not used.
RTFieldAccess RegistryTypeReader::getReferenceAccess | ( | sal_uInt16 | index | ) | const [inline] |
returns the access mode of the reference specified by index.
The only valid value is RT_ACCESS_OPTIONAL in the context of references.
index | indicates the reference. |
sal_uInt32 RegistryTypeReader::getReferenceCount | ( | ) | const [inline] |
returns the number of references (supported interfaces, exported services).
rtl::OUString RegistryTypeReader::getReferenceDoku | ( | sal_uInt16 | index | ) | const [inline] |
returns the documentation string of the reference specified by index.
index | indicates the reference. |
rtl::OUString RegistryTypeReader::getReferenceName | ( | sal_uInt16 | index | ) | const [inline] |
returns the full qualified typename of the reference specified by index.
index | indicates the reference. |
RTReferenceType RegistryTypeReader::getReferenceType | ( | sal_uInt16 | index | ) | const [inline] |
returns the type of the reference specified by index.
index | indicates the reference. |
rtl::OUString RegistryTypeReader::getSuperTypeName | ( | ) | const [inline] |
returns the full qualified name of the supertype.
RTTypeClass RegistryTypeReader::getTypeClass | ( | ) | const [inline] |
returns the typeclass of the type represented by this blob.
This function will always return the type class without the internal RT_TYPE_PUBLISHED flag set.
rtl::OUString RegistryTypeReader::getTypeName | ( | ) | const [inline] |
returns the full qualified name of the type.
void RegistryTypeReader::getUik | ( | RTUik & | uik | ) | const [inline] |
An earlier version of UNO used an unique identifier for interfaces. In the current version of UNO this uik was eliminated and this function is not longer used.
sal_Bool RegistryTypeReader::isValid | ( | void | ) | const [inline] |
checks if the registry type reader points to a valid Api.
RegistryTypeReader & RegistryTypeReader::operator== | ( | const RegistryTypeReader & | toAssign | ) | [inline] |
Assign operator.
TypeReaderImpl RegistryTypeReader::m_hImpl [protected] |
stores the handle of an implementation class
const RegistryTypeReader_Api* RegistryTypeReader::m_pApi [protected] |
stores the registry type reader Api.