My Project
UDK 3.2.7 C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
RegistryTypeWriter Class Reference

RegistryTypeWriter writes/creates a binary type blob. More...

#include <reflwrit.hxx>

Public Member Functions

 RegistryTypeWriter (RTTypeClass RTTypeClass, const ::rtl::OUString &typeName, const ::rtl::OUString &superTypeName, sal_uInt16 fieldCount, sal_uInt16 methodCount, sal_uInt16 referenceCount)
 Constructor.
 RegistryTypeWriter (const RegistryTypeWriter &toCopy)
 Copy constructcor.
 ~RegistryTypeWriter ()
 Destructor.
RegistryTypeWriteroperator== (const RegistryTypeWriter &toAssign)
 Assign operator.
void setUik (const RTUik &uik)
void setDoku (const ::rtl::OUString &doku)
 sets a documentation string for the type.
void setFileName (const ::rtl::OUString &fileName)
 sets the IDL filename where this type is defined.
void setFieldData (sal_uInt16 index, const ::rtl::OUString &name, const ::rtl::OUString &typeName, const ::rtl::OUString &doku, const ::rtl::OUString &fileName, RTFieldAccess access, RTConstValue constValue=RTConstValue())
 sets the data for a field member of a type blob.
void setMethodData (sal_uInt16 index, const ::rtl::OUString &name, const ::rtl::OUString &returnTypeName, RTMethodMode mode, sal_uInt16 paramCount, sal_uInt16 excCount, const ::rtl::OUString &doku)
 sets the data for a method.
void setParamData (sal_uInt16 index, sal_uInt16 paramIndex, const ::rtl::OUString &type, const ::rtl::OUString &name, RTParamMode mode)
 sets the data for the specified parameter of a method.
void setExcData (sal_uInt16 index, sal_uInt16 excIndex, const ::rtl::OUString &type)
 sets the data for the specified exception of a mehtod.
const sal_uInt8getBlop ()
 returns a pointer to the new type blob.
sal_uInt32 getBlopSize ()
 returns the size of the new type blob in bytes.
void setReferenceData (sal_uInt16 index, const ::rtl::OUString &name, RTReferenceType refType, const ::rtl::OUString &doku, RTFieldAccess access=RT_ACCESS_INVALID)
 sets the data for a reference member.

Protected Attributes

const RegistryTypeWriter_Apim_pApi
 stores the registry type writer Api.
TypeWriterImpl m_hImpl
 stores the handle of an implementation class

Detailed Description

RegistryTypeWriter writes/creates a binary type blob.

This class provides the necessary functions to write type informations for all kinds of types into a blob. The class is inline and use a C-Api.

Deprecated:
use typereg::Writer instead

Constructor & Destructor Documentation

RegistryTypeWriter::RegistryTypeWriter ( RTTypeClass  RTTypeClass,
const ::rtl::OUString typeName,
const ::rtl::OUString superTypeName,
sal_uInt16  fieldCount,
sal_uInt16  methodCount,
sal_uInt16  referenceCount 
)
inline

Constructor.

Parameters
RTTypeClassspecifies the type of the new blob.
typeNamespecifies the full qualified type name with '/' as separator.
superTypeNamespecifies the full qualified type name of the base type with '/' as separator.
fieldCountspecifies the number of fields (eg. number of attrbutes/properties, enum values or constants).
methodCountspecifies the number of methods.
referenceCountspecifies the number of references (eg. number of supported interfaces, exported services ...)
RegistryTypeWriter::RegistryTypeWriter ( const RegistryTypeWriter toCopy)
inline

Copy constructcor.

RegistryTypeWriter::~RegistryTypeWriter ( )
inline

Destructor.

The Destructor frees the internal data block.

The pointer (returned by getBlop) will be set to NULL.

Member Function Documentation

const sal_uInt8 * RegistryTypeWriter::getBlop ( )
inline

returns a pointer to the new type blob.

The pointer will be invalid (NULL) if the instance of the RegistryTypeWriter will be destroyed.

sal_uInt32 RegistryTypeWriter::getBlopSize ( )
inline

returns the size of the new type blob in bytes.

RegistryTypeWriter & RegistryTypeWriter::operator== ( const RegistryTypeWriter toAssign)
inline

Assign operator.

void RegistryTypeWriter::setDoku ( const ::rtl::OUString doku)
inline

sets a documentation string for the type.

This documentation should be the same as the documentation which is provided for this type in IDL.

void RegistryTypeWriter::setExcData ( sal_uInt16  index,
sal_uInt16  excIndex,
const ::rtl::OUString type 
)
inline

sets the data for the specified exception of a mehtod.

Parameters
indexindicates the index of the method.
excIndexspecifies the index of the exception.
typespecifies the full qualified typename of the exception.
void RegistryTypeWriter::setFieldData ( sal_uInt16  index,
const ::rtl::OUString name,
const ::rtl::OUString typeName,
const ::rtl::OUString doku,
const ::rtl::OUString fileName,
RTFieldAccess  access,
RTConstValue  constValue = RTConstValue() 
)
inline

sets the data for a field member of a type blob.

Parameters
indexindicates the index of the field.
namespecifies the name.
typeNamespecifies the full qualified typename.
dokuspecifies the documentation string of the field.
fileNamespecifies the name of the IDL file where the field is defined.
accessspecifies the access mode of the field.
constValuespecifies the value of the field. The value is only interesting for enum values or constants.
void RegistryTypeWriter::setFileName ( const ::rtl::OUString fileName)
inline

sets the IDL filename where this type is defined.

void RegistryTypeWriter::setMethodData ( sal_uInt16  index,
const ::rtl::OUString name,
const ::rtl::OUString returnTypeName,
RTMethodMode  mode,
sal_uInt16  paramCount,
sal_uInt16  excCount,
const ::rtl::OUString doku 
)
inline

sets the data for a method.

Parameters
indexindicates the index of the method.
namespecifies the name.
returnTypeNamespecifies the full qualified return typename.
modespecifies the method mode.
paramCountspecifies the number of parameters.
excCountspecifies the number of exceptions.
dokuspecifies the documentation string of the field.
void RegistryTypeWriter::setParamData ( sal_uInt16  index,
sal_uInt16  paramIndex,
const ::rtl::OUString type,
const ::rtl::OUString name,
RTParamMode  mode 
)
inline

sets the data for the specified parameter of a method.

Parameters
indexindicates the index of the method.
paramIndexspecifies the index of the parameter.
typespecifies the full qualified typename.
namespecifies the name.
modespecifies the parameter mode.
void RegistryTypeWriter::setReferenceData ( sal_uInt16  index,
const ::rtl::OUString name,
RTReferenceType  refType,
const ::rtl::OUString doku,
RTFieldAccess  access = RT_ACCESS_INVALID 
)
inline

sets the data for a reference member.

Parameters
indexindicates the index of the reference.
namespecifies the name.
refTypespecifies the full qualified typename of the reference.
dokuspecifies the documentation string of the reference.
accessspecifies the access mode of the reference.
void RegistryTypeWriter::setUik ( const RTUik uik)
inline
Deprecated:
sets the unique identifier for an interface type.

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.

Member Data Documentation

TypeWriterImpl RegistryTypeWriter::m_hImpl
protected

stores the handle of an implementation class

const RegistryTypeWriter_Api* RegistryTypeWriter::m_pApi
protected

stores the registry type writer Api.


The documentation for this class was generated from the following file: