Methods of Class RegistryTypeWriter

RegistryTypeWriter

RegistryTypeWriter(

const RegistryTypeWriter_Api *	pApi,
RTTypeClass	RTTypeClass,
const ::rtl::OUString &	typeName,
const ::rtl::OUString &	superTypeName,
sal_uInt16	fieldCount,
sal_uInt16	methodCount,
sal_uInt16	referenceCount );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Constructor using the registry Api directly.

Description

The constructor is used if the api is known.

Parameters

RTTypeClass	specifies the type of the new blob.
typeName	specifies the full qualified type name with '/' as separator.
superTypeName	specifies the full qualified type name of the base type with '/' as separator.
fieldCount	specifies the number of fields (eg. number of attrbutes/properties, enum values or constants).
methodCount	specifies the number of methods.
referenceCount	specifies the number of references (eg. number of supported interfaces, exported services ...)

RegistryTypeWriter

RegistryTypeWriter(

const RegistryTypeWriterLoader &	rLoader,
RTTypeClass	RTTypeClass,
const ::rtl::OUString &	typeName,
const ::rtl::OUString &	superTypeName,
sal_uInt16	fieldCount,
sal_uInt16	methodCount,
sal_uInt16	referenceCount );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

Constructor using the loader mechanism.

Description

This constructor is called with a RegistryTypeWriterLoader. The RegistryTypeWriterLoader loads the needed DLL and provides the needed Api for the registry type writer.

Parameters

RTTypeClass	specifies the type of the new blob.
typeName	specifies the full qualified type name with '/' as separator.
superTypeName	specifies the full qualified type name of the base type with '/' as separator.
fieldCount	specifies the number of fields (eg. number of attrbutes/properties, enum values or constants).
methodCount	specifies the number of methods.
referenceCount	specifies the number of references (eg. number of supported interfaces, exported services ...)

RegistryTypeWriter

RegistryTypeWriter(

const RegistryTypeWriter &

toCopy );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary: Copy constructcor

~RegistryTypeWriter

~RegistryTypeWriter();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary: Destructor. The Destructor frees the internal data block.
Description: The pointer (returned by getBlop) will be set to NULL.

operator==

RegistryTypeWriter & operator==(

const RegistryTypeWriter &

toAssign );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary: Assign operator

setUik

void setUik(

const RTUik &

uik );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

D E P R E C A T E D
Summary: sets the unique identifier for an interface type.
Description: 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.

setDoku

void setDoku(

const ::rtl::OUString &

doku );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary: sets a documentation string for the type.
Description: This documentation should be the same as the documentation which is provided for this type in IDL.

setFileName

void setFileName(

const ::rtl::OUString &

fileName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary: sets the IDL filename where this type is defined.

setFieldData

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 );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

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

Parameters

index	indicates the index of the field.
name	specifies the name.
typeName	specifies the full qualified typename.
doku	specifies the documentation string of the field.
fileName	specifies the name of the IDL file where the field is defined.
access	specifies the access mode of the field.
constValue	specifies the value of the field. The value is only interesting for enum values or constants.

setMethodData

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 );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

sets the data for a method.

Parameters

index	indicates the index of the method.
name	specifies the name.
typeName	specifies the full qualified return typename.
mode	specifies the method mode.
paramCount	specifies the number of parameters.
excCount	specifies the number of exceptions.
doku	specifies the documentation string of the field.

setParamData

void setParamData(

sal_uInt16	index,
sal_uInt16	paramIndex,
const ::rtl::OUString &	type,
const ::rtl::OUString &	name,
RTParamMode	mode );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

sets the data for the specified parameter of a method.

Parameters

index	indicates the index of the method.
paramIndex	specifies the index of the parameter.
type	specifies the full qualified typename.
name	specifies the name.
mode	specifies the parameter mode.

setExcData

void setExcData(

sal_uInt16	index,
sal_uInt16	excIndex,
const ::rtl::OUString &	type );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

sets the data for the specified exception of a mehtod.

Parameters

index	indicates the index of the method.
excIndex	specifies the index of the exception.
type	specifies the full qualified typename of the exception.

getBlop

const sal_uInt8 * getBlop();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary: returns a pointer to the new type blob.
Description: The pointer will be invalid (NULL) if the instance of the RegistryTypeWriter will be destroyed.

getBlopSize

sal_uInt32 getBlopSize();

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary: returns the size of the new type blob in bytes.

setReferenceData

void setReferenceData(

sal_uInt16	index,
const ::rtl::OUString &	name,
RTReferenceType	refType,
const ::rtl::OUString &	doku,
RTFieldAccess	access = RT_ACCESS_INVALID );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	YES	NO

Summary

sets the data for a reference member.

Parameters

index	indicates the index of the reference.
name	specifies the name.
refType	specifies the full qualified typename of the reference.
doku	specifies the documentation string of the reference.
access	specifies the access mode of the reference.