UDK 3.2.7 C/C++ API Reference
Public Member Functions
com::sun::star::uno::Type Class Reference

C++ class representing an IDL meta type. More...

#include <Type.h>

List of all members.

Public Member Functions

 Type () throw ()
 Default Constructor: Type is set to void.
 Type (TypeClass eTypeClass, const ::rtl::OUString &rTypeName) throw ()
 Constructor: Type is constructed by given name and type class.
 Type (TypeClass eTypeClass, const sal_Char *pTypeName) throw ()
 Constructor: Type is constructed by given name and type class.
 Type (typelib_TypeDescriptionReference *pType) throw ()
 Constructor: Type is (copy) constructed by given C type description reference.
 Type (typelib_TypeDescriptionReference *pType, UnoType_NoAcquire dummy) throw ()
 Constructor: Type is (copy) constructed by given C type description reference without acquiring it.
 Type (typelib_TypeDescriptionReference *pType, __sal_NoAcquire dummy) throw ()
 Constructor: Type is (copy) constructed by given C type description reference without acquiring it.
 Type (const Type &rType) throw ()
 Copy constructor: Type is copy constructed by given type.
 ~Type () throw ()
 Destructor: Releases acquired C type description reference.
Typeoperator= (const Type &rType) throw ()
 Assignment operator: Acquires right side type and releases previously set type.
TypeClass getTypeClass () const throw ()
 Gets the type class of set type.
inline::rtl::OUString getTypeName () const throw ()
 Gets the name of the set type.
void getDescription (typelib_TypeDescription **ppDescr) const throw ()
 Obtains a full type description of set type.
typelib_TypeDescriptionReferencegetTypeLibType () const throw ()
 Gets the C typelib type description reference pointer.
sal_Bool isAssignableFrom (const Type &rType) const throw ()
 Tests if values of this reflected type can be assigned by values of given type.
sal_Bool equals (const Type &rType) const throw ()
 Compares two types.
sal_Bool operator== (const Type &rType) const throw ()
 Equality operator: Compares two types.
sal_Bool operator!= (const Type &rType) const throw ()
 Unequality operator: Compares two types.

Detailed Description

C++ class representing an IDL meta type.

This class is used to represent a a type, i.e. a type name and its type class. Internally the type holds a C type description reference of the runtime. You can obtain a full type description of a type by calling member function getDescription().

See also:
typelib_TypeDescriptionReference

Constructor & Destructor Documentation

com::sun::star::uno::Type::Type ( ) throw () [inline]

Default Constructor: Type is set to void.

com::sun::star::uno::Type::Type ( TypeClass  eTypeClass,
const ::rtl::OUString rTypeName 
) throw () [inline]

Constructor: Type is constructed by given name and type class.

Parameters:
eTypeClasstype class of type
rTypeNamename of type
com::sun::star::uno::Type::Type ( TypeClass  eTypeClass,
const sal_Char pTypeName 
) throw () [inline]

Constructor: Type is constructed by given name and type class.

Parameters:
eTypeClasstype class of type
pTypeNamename of type
com::sun::star::uno::Type::Type ( typelib_TypeDescriptionReference pType) throw () [inline]

Constructor: Type is (copy) constructed by given C type description reference.

Parameters:
pTypeC type description reference
com::sun::star::uno::Type::Type ( typelib_TypeDescriptionReference pType,
UnoType_NoAcquire  dummy 
) throw () [inline]

Constructor: Type is (copy) constructed by given C type description reference without acquiring it.

Parameters:
pTypeC type description reference
dummyUNO_TYPE_NO_ACQUIRE to force obvious distinction to other constructors
com::sun::star::uno::Type::Type ( typelib_TypeDescriptionReference pType,
__sal_NoAcquire  dummy 
) throw () [inline]

Constructor: Type is (copy) constructed by given C type description reference without acquiring it.

Parameters:
pTypeC type description reference
dummySAL_NO_ACQUIRE to force obvious distinction to other constructors
com::sun::star::uno::Type::Type ( const Type rType) throw () [inline]

Copy constructor: Type is copy constructed by given type.

Parameters:
rTypeanother type
com::sun::star::uno::Type::~Type ( ) throw () [inline]

Destructor: Releases acquired C type description reference.


Member Function Documentation

sal_Bool com::sun::star::uno::Type::equals ( const Type rType) const throw () [inline]

Compares two types.

Parameters:
rTypeanother type
Returns:
true if both types refer the same type, false otherwise
void com::sun::star::uno::Type::getDescription ( typelib_TypeDescription **  ppDescr) const throw () [inline]

Obtains a full type description of set type.

Parameters:
ppDescr[inout] type description
TypeClass com::sun::star::uno::Type::getTypeClass ( ) const throw () [inline]

Gets the type class of set type.

Returns:
type class of set type
typelib_TypeDescriptionReference* com::sun::star::uno::Type::getTypeLibType ( ) const throw () [inline]

Gets the C typelib type description reference pointer.

Does not acquire the reference!

Returns:
UNacquired type description reference
rtl::OUString com::sun::star::uno::Type::getTypeName ( ) const throw () [inline]

Gets the name of the set type.

Returns:
name of the set type
sal_Bool com::sun::star::uno::Type::isAssignableFrom ( const Type rType) const throw () [inline]

Tests if values of this reflected type can be assigned by values of given type.

This includes widening conversion (e.g., long assignable from short), as long as there is no data loss.

Parameters:
rTypeanother type
Returns:
true if values of this type can be assigned from values of given type, false otherwise
sal_Bool com::sun::star::uno::Type::operator!= ( const Type rType) const throw () [inline]

Unequality operator: Compares two types.

Parameters:
rTypeanother type
Returns:
false if both types refer the same type, true otherwise
Type & com::sun::star::uno::Type::operator= ( const Type rType) throw () [inline]

Assignment operator: Acquires right side type and releases previously set type.

Parameters:
rTypeanother type (right side)
Returns:
this type
sal_Bool com::sun::star::uno::Type::operator== ( const Type rType) const throw () [inline]

Equality operator: Compares two types.

Parameters:
rTypeanother type
Returns:
true if both types refer the same type, false otherwise

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines