LibreOffice Module registry (master)  1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
typereg::Writer Class Reference

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

#include <writer.hxx>

Public Member Functions

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

Private Member Functions

 Writer (Writer const &)=delete
 
Writeroperator= (Writer const &)=delete
 

Private Attributes

voidm_handle
 

Detailed Description

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

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

Available since:
UDK 3.2.0

Definition at line 42 of file writer.hxx.

Constructor & Destructor Documentation

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

Creates a type writer.

Parameters
versionthe version of the created type writer; must not be negative
documentationthe documentation
fileNamethe file name (deprecated, use an empty string)
typeClassthe type class of the created type writer
publishedwhether the created type writer is published; for a type class that cannot be published, this should be false
typeNamethe type name of the created type writer
superTypeCountthe number of super types of the created type writer
fieldCountthe number of fields of the created type writer
methodCountthe number of methods of the created type writer
referenceCountthe number of references of the created type writer
Exceptions
std::bad_allocis raised if an out-of-memory condition occurs

Definition at line 72 of file writer.hxx.

References m_handle, and pData.

typereg::Writer::~Writer ( )
inline

Destroys this Writer instance.

Definition at line 92 of file writer.hxx.

References m_handle, and typereg_writer_destroy().

typereg::Writer::Writer ( Writer const &  )
privatedelete

Member Function Documentation

void const* typereg::Writer::getBlob ( sal_uInt32 *  size)
inline

Returns the blob of this type writer.

Parameters
sizean 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_allocis raised if an out-of-memory condition occurs (in which case size is not modified

Definition at line 272 of file writer.hxx.

References m_handle, p, and typereg_writer_getBlob().

Writer& typereg::Writer::operator= ( Writer const &  )
privatedelete
void typereg::Writer::setFieldData ( sal_uInt16  index,
OUString const &  documentation,
OUString const &  fileName,
RTFieldAccess  flags,
OUString const &  name,
OUString const &  typeName,
RTConstValue const &  value 
)
inline

Sets the data of a field of this type writer.

Parameters
indexa valid index into the range of fields of this type writer
documentationthe documentation of the field
fileNamethe file name of the field (deprecated, use an empty string)
flagsthe flags of the field
namethe name of the field
typeNamethe type name of the field
valuethe value of the field
Exceptions
std::bad_allocis raised if an out-of-memory condition occurs

Definition at line 131 of file writer.hxx.

References m_handle, RTConstValue::m_type, RTConstValue::m_value, and typereg_writer_setFieldData().

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

Sets the data of a method of this type writer.

Parameters
indexa valid index into the range of methods of this type writer
documentationthe documentation of the method
flagsthe flags of the method
namethe name of the method
returnTypeNamethe return type name of the method
parameterCountthe number of parameters of the method
exceptionCountthe number of exceptions of the method
Exceptions
std::bad_allocis raised if an out-of-memory condition occurs

Definition at line 163 of file writer.hxx.

References m_handle, and typereg_writer_setMethodData().

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

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

Parameters
methodIndexa valid index into the range of methods of this type writer
exceptionIndexa valid index into the range of exceptions of the given method
typeNamethe exception type name
Exceptions
std::bad_allocis raised if an out-of-memory condition occurs

Definition at line 220 of file writer.hxx.

References m_handle, and typereg_writer_setMethodExceptionTypeName().

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

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

Parameters
methodIndexa valid index into the range of methods of this type writer
parameterIndexa valid index into the range of parameters of the given method
flagsthe flags of the parameter
namethe name of the parameter
typeNamethe type name of the parameter
Exceptions
std::bad_allocis raised if an out-of-memory condition occurs

Definition at line 194 of file writer.hxx.

References m_handle, and typereg_writer_setMethodParameterData().

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

Sets the data of a reference of this type writer.

Parameters
indexa valid index into the range of references of this type writer
documentationthe documentation of the reference
sortthe sort of the reference
flagsthe flags of the reference
typeNamethe type name of the reference
Exceptions
std::bad_allocis raised if an out-of-memory condition occurs

Definition at line 247 of file writer.hxx.

References m_handle, and typereg_writer_setReferenceData().

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

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

Parameters
indexa valid index into the range of super types of this type writer
typeNamethe super type name
Exceptions
std::bad_allocis raised if an out-of-memory condition occurs

Definition at line 106 of file writer.hxx.

References m_handle, and typereg_writer_setSuperTypeName().

Member Data Documentation

void* typereg::Writer::m_handle
private

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