typereg::Writer Class Reference

A type writer working on a binary blob that represents a UNOIDL type. More...

#include <writer.hxx>

List of all members.

Public Member Functions
	Writer (typereg_Version version, rtl::OUString const &documentation, rtl::OUString const &fileName, RTTypeClass typeClass, bool published, rtl::OUString const &typeName, sal_uInt16 superTypeCount, sal_uInt16 fieldCount, sal_uInt16 methodCount, sal_uInt16 referenceCount)
	Creates a type writer.
	~Writer ()
	Destroys this Writer instance.
void	setSuperTypeName (sal_uInt16 index, rtl::OUString const &typeName)
	Sets the type name of a super type of this type writer.
void	setFieldData (sal_uInt16 index, rtl::OUString const &documentation, rtl::OUString const &fileName, RTFieldAccess flags, rtl::OUString const &name, rtl::OUString const &typeName, RTConstValue const &value)
	Sets the data of a field of this type writer.
void	setMethodData (sal_uInt16 index, rtl::OUString const &documentation, RTMethodMode flags, rtl::OUString const &name, rtl::OUString const &returnTypeName, sal_uInt16 parameterCount, sal_uInt16 exceptionCount)
	Sets the data of a method of this type writer.
void	setMethodParameterData (sal_uInt16 methodIndex, sal_uInt16 parameterIndex, RTParamMode flags, rtl::OUString const &name, rtl::OUString const &typeName)
	Sets the data of a parameter of a method of this type writer.
void	setMethodExceptionTypeName (sal_uInt16 methodIndex, sal_uInt16 exceptionIndex, rtl::OUString const &typeName)
	Sets an exception type name of a method of this type writer.
void	setReferenceData (sal_uInt16 index, rtl::OUString const &documentation, RTReferenceType sort, RTFieldAccess flags, rtl::OUString const &typeName)
	Sets the data of a reference of this type writer.
void const *	getBlob (sal_uInt32 *size)
	Returns the blob of this type writer.

---

Detailed Description

A type writer working on a binary blob that represents a UNOIDL type.

Instances of this class are not multi-thread–safe.

Since:

UDK 3.2.0

---

Constructor & Destructor Documentation

typereg::Writer::Writer	(	typereg_Version	version,
		rtl::OUString const &	documentation,
		rtl::OUString const &	fileName,
		RTTypeClass	typeClass,
		bool	published,
		rtl::OUString const &	typeName,
		sal_uInt16	superTypeCount,
		sal_uInt16	fieldCount,
		sal_uInt16	methodCount,
		sal_uInt16	referenceCount
	)		[inline]

Creates a type writer.

Parameters:

version	the version of the created type writer; must not be negative
documentation	the documentation
fileName	the file name (deprecated, use an empty string)
typeClass	the type class of the created type writer
published	whether the created type writer is published; for a type class that cannot be published, this should be false
typeName	the type name of the created type writer
superTypeCount	the number of super types of the created type writer
fieldCount	the number of fields of the created type writer
methodCount	the number of methods of the created type writer
referenceCount	the number of references of the created type writer

Exceptions:

std::bad_alloc

is raised if an out-of-memory condition occurs

typereg::Writer::~Writer

(

)

[inline]

Destroys this Writer instance.

---

Member Function Documentation

void const* typereg::Writer::getBlob

(

sal_uInt32 *

size

)

[inline]

Returns the blob of this type writer.

Parameters:

size	an out-parameter obtaining the size of the blob

Returns:

a (byte-aligned) pointer to the blob; the returned pointer and the returned size remain valid until the next function is called on this type writer

Exceptions:

std::bad_alloc

is raised if an out-of-memory condition occurs (in which case siez is not modified

void typereg::Writer::setFieldData	(	sal_uInt16	index,
		rtl::OUString const &	documentation,
		rtl::OUString const &	fileName,
		RTFieldAccess	flags,
		rtl::OUString const &	name,
		rtl::OUString const &	typeName,
		RTConstValue const &	value
	)		[inline]

Sets the data of a field of this type writer.

Parameters:

index	a valid index into the range of fields of this type writer
documentation	the documentation of the field
fileName	the file name of the field (deprecated, use an empty string)
flags	the flags of the field
name	the name of the field
typeName	the type name of the field
value	the value of the field

Exceptions:

std::bad_alloc

is raised if an out-of-memory condition occurs

void typereg::Writer::setMethodData	(	sal_uInt16	index,
		rtl::OUString const &	documentation,
		RTMethodMode	flags,
		rtl::OUString const &	name,
		rtl::OUString const &	returnTypeName,
		sal_uInt16	parameterCount,
		sal_uInt16	exceptionCount
	)		[inline]

Sets the data of a method of this type writer.

Parameters:

index	a valid index into the range of methods of this type writer
documentation	the documentation of the method
flags	the flags of the method
name	the name of the method
returnTypeName	the return type name of the method
parameterCount	the number of parameters of the method
exceptionCount	the number of exceptions of the method

Exceptions:

std::bad_alloc

is raised if an out-of-memory condition occurs

void typereg::Writer::setMethodExceptionTypeName	(	sal_uInt16	methodIndex,
		sal_uInt16	exceptionIndex,
		rtl::OUString const &	typeName
	)		[inline]

Sets an exception type name of a method of this type writer.

Parameters:

methodIndex	a valid index into the range of methods of this type writer
exceptionIndex	a valid index into the range of exceptions of the given method
typeName	the exception type name

Exceptions:

std::bad_alloc

is raised if an out-of-memory condition occurs

void typereg::Writer::setMethodParameterData	(	sal_uInt16	methodIndex,
		sal_uInt16	parameterIndex,
		RTParamMode	flags,
		rtl::OUString const &	name,
		rtl::OUString const &	typeName
	)		[inline]

Sets the data of a parameter of a method of this type writer.

Parameters:

methodIndex	a valid index into the range of methods of this type writer
parameterIndex	a valid index into the range of parameters of the given method
flags	the flags of the parameter
name	the name of the parameter
typeName	the type name of the parameter

Exceptions:

std::bad_alloc

is raised if an out-of-memory condition occurs

void typereg::Writer::setReferenceData	(	sal_uInt16	index,
		rtl::OUString const &	documentation,
		RTReferenceType	sort,
		RTFieldAccess	flags,
		rtl::OUString const &	typeName
	)		[inline]

Sets the data of a reference of this type writer.

Parameters:

index	a valid index into the range of references of this type writer
documentation	the documentation of the reference
sort	the sort of the reference
flags	the flags of the reference
typeName	the type name of the reference

Exceptions:

std::bad_alloc

is raised if an out-of-memory condition occurs

void typereg::Writer::setSuperTypeName	(	sal_uInt16	index,
		rtl::OUString const &	typeName
	)		[inline]

Sets the type name of a super type of this type writer.

Parameters:

index	a valid index into the range of super types of this type writer
typeName	the super type name

Exceptions:

std::bad_alloc

is raised if an out-of-memory condition occurs

---

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

• registry/writer.hxx