Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Methods of Class Writer


Writer
Writer(
typereg_Version version,
const rtl::OUString & documentation,
const rtl::OUString & fileName,
RTTypeClass typeClass,
bool published,
const rtl::OUString & typeName,
sal_uInt16 superTypeCount,
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
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

       

~Writer
~Writer();

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

Summary
Destroys this Writer instance.

setSuperTypeName
void setSuperTypeName(
sal_uInt16 index,
const rtl::OUString & typeName );

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

Summary
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

       

setFieldData
void setFieldData(
sal_uInt16 index,
const rtl::OUString & documentation,
const rtl::OUString & fileName,
RTFieldAccess flags,
const rtl::OUString & name,
const rtl::OUString & typeName,
const RTConstValue & value );

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

Summary
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

       
valueType
the type of the value of the field

       
valueValue
the value of the value of the field

       

setMethodData
void setMethodData(
sal_uInt16 index,
const rtl::OUString & documentation,
RTMethodMode flags,
const rtl::OUString & name,
const rtl::OUString & returnTypeName,
sal_uInt16 parameterCount,
sal_uInt16 exceptionCount );

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

Summary
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

       

setMethodParameterData
void setMethodParameterData(
sal_uInt16 methodIndex,
sal_uInt16 parameterIndex,
RTParamMode flags,
const rtl::OUString & name,
const rtl::OUString & typeName );

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

Summary
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

       

setMethodExceptionTypeName
void setMethodExceptionTypeName(
sal_uInt16 methodIndex,
sal_uInt16 exceptionIndex,
const rtl::OUString & typeName );

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

Summary
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

       

setReferenceData
void setReferenceData(
sal_uInt16 index,
const rtl::OUString & documentation,
RTReferenceType sort,
RTFieldAccess flags,
const rtl::OUString & typeName );

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

Summary
Sets the data of a reference of this type writer.
Parameters
handle
a handle on a type writer

       
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

       

getBlob
const void * getBlob(
sal_uInt32 * size );

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

Summary
Returns the blob of this type writer.
Parameters
size
an out-parameter obtaining the size of the blob

       
Return
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

Writer
Writer(
Writer & );

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


operator=
void operator=(
Writer );

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


Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.