LibreOffice LibreOffice 4.3 SDK C/C++ API Reference

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
com::sun::star::uno::Any Class Reference

C++ class representing an IDL any. More...

`#include <Any.h>`

Inheritance diagram for com::sun::star::uno::Any:

## Public Member Functions
| Any () SAL_THROW(())
| Default constructor: Any holds no value; its type is void. More...
template<typename T >
| Any (T const &value)
| Templated ctor. More...
| Any (bool value)
| Ctor support for C++ bool. More...
| Any (const Any &rAny) SAL_THROW(())
| Copy constructor: Sets value of the given any. More...
| Any (const void *pData_, const Type &rType) SAL_THROW(())
| Constructor: Sets a copy of the given data. More...
| Any (const void *pData_, typelib_TypeDescription *pTypeDescr) SAL_THROW(())
| Constructor: Sets a copy of the given data. More...
| Any (const void *pData_, typelib_TypeDescriptionReference *pType) SAL_THROW(())
| Constructor: Sets a copy of the given data. More...
| ~Any () SAL_THROW(())
| Destructor: Destructs any content and frees memory. More...
Any & | operator= (const Any &rAny) SAL_THROW(())
| Assignment operator: Sets the value of the given any. More...
const Type & | getValueType () const SAL_THROW(())
| Gets the type of the set value. More...
typelib_TypeDescriptionReference * | getValueTypeRef () const SAL_THROW(())
| Gets the type of the set value. More...
void | getValueTypeDescription (typelib_TypeDescription **ppTypeDescr) const SAL_THROW(())
| Gets the type description of the set value. More...
TypeClass | getValueTypeClass () const SAL_THROW(())
| Gets the type class of the set value. More...
inline::rtl::OUString | getValueTypeName () const SAL_THROW(())
| Gets the type name of the set value. More...
bool | hasValue () const SAL_THROW(())
| Tests if any contains a value. More...
const void * | getValue () const SAL_THROW(())
| Gets a pointer to the set value. More...
template<typename T >
T | get () const
| Provides a value of specified type, so you can easily write e.g. More...
void | setValue (const void *pData_, const Type &rType) SAL_THROW(())
| Sets a value. More...
void | setValue (const void *pData_, typelib_TypeDescriptionReference *pType) SAL_THROW(())
| Sets a value. More...
void | setValue (const void *pData_, typelib_TypeDescription *pTypeDescr) SAL_THROW(())
| Sets a value. More...
void | clear () SAL_THROW(())
| Clears this any. More...
bool | isExtractableTo (const Type &rType) const SAL_THROW(())
| Tests whether this any is extractable to a value of given type. More...
template<typename T >
bool | has () const
| Tests whether this any can provide a value of specified type. More...
bool | operator== (const Any &rAny) const SAL_THROW(())
| Equality operator: compares two anys. More...
bool | operator!= (const Any &rAny) const SAL_THROW(())
| Unequality operator: compares two anys. More...
template<>
bool | has () const
template<>
sal_uInt16 | get () const

## Additional Inherited Members
Public Attributes inherited from _uno_Any
struct _typelib_TypeDescriptionReference * | pType
| type of value More...
void * | pData
| pointer to value; this may point to pReserved and thus the uno_Any is not anytime mem-copyable! You may have to correct the pData pointer to pReserved. More...
void * | pReserved
| reserved space for storing value More...

## Detailed Description

C++ class representing an IDL any.

This class is used to transport any type defined in IDL. The class inherits from the binary C representation of uno_Any. You can insert a value by either using the <<= operators or the template function makeAny(). No any can hold an any. You can extract values from an any by using the >>= operators which return true if the any contains an assignable value (no data loss), e.g. the any contains a short and you >>= it into a long variable.

## Constructor & Destructor Documentation

com::sun::star::uno::Any::Any | ( |  | ) |
| inline

Default constructor: Any holds no value; its type is void.

template<typename T >

com::sun::star::uno::Any::Any | ( | T const & | value | ) |
| inline explicit

Templated ctor.

Sets a copy of the given value.

Parameters

  value | value of the Any

com::sun::star::uno::Any::Any | ( | bool | value | ) |
| inline explicit

Ctor support for C++ bool.

com::sun::star::uno::Any::Any | ( | const Any & | rAny | ) |
| inline

Copy constructor: Sets value of the given any.

Parameters

  rAny | another any

com::sun::star::uno::Any::Any | ( | const void * | pData_,
|  | const Type & | rType
| ) |  |
| inline

Constructor: Sets a copy of the given data.

Parameters

  pData_ | value
  rType | type of value

com::sun::star::uno::Any::Any | ( | const void * | pData_,
|  | typelib_TypeDescription * | pTypeDescr
| ) |  |
| inline

Constructor: Sets a copy of the given data.

Parameters

  pData_ | value
  pTypeDescr | type of value

com::sun::star::uno::Any::Any | ( | const void * | pData_,
|  | typelib_TypeDescriptionReference * | pType
| ) |  |
| inline

Constructor: Sets a copy of the given data.

Parameters

  pData_ | value
  pType | type of value

com::sun::star::uno::Any::~Any | ( |  | ) |
| inline

Destructor: Destructs any content and frees memory.

## Member Function Documentation

void com::sun::star::uno::Any::clear | ( |  | ) |
| inline

Clears this any.

If the any already contains a value, that value will be destructed and its memory freed. After this has been called, the any does not contain a value.

template<typename T >

T com::sun::star::uno::Any::get | ( |  | ) | const
| inline

Provides a value of specified type, so you can easily write e.g.

    sal_Int32 myVal = myAny.get<sal_Int32>();

Widening conversion without data loss is taken into account. Throws a com::sun::star::uno::RuntimeException if the specified type cannot be provided.

Returns
  value of specified type

Exceptions

  com::sun::star::uno::RuntimeException | in case the specified type cannot be provided

template<>

sal_uInt16 com::sun::star::uno::Any::get | ( |  | ) | const

const void* com::sun::star::uno::Any::getValue | ( |  | ) | const
| inline

Gets a pointer to the set value.

Returns
  a pointer to the set value

const Type& com::sun::star::uno::Any::getValueType | ( |  | ) | const
| inline

Gets the type of the set value.

Returns
  a Type object of the set value

TypeClass com::sun::star::uno::Any::getValueTypeClass | ( |  | ) | const
| inline

Gets the type class of the set value.

Returns
  the type class of the set value

void com::sun::star::uno::Any::getValueTypeDescription | ( | typelib_TypeDescription ** | ppTypeDescr | ) | const
| inline

Gets the type description of the set value.

Provides ownership of the type description! Call an explicit typelib_typedescription_release() to release afterwards.

Parameters

  ppTypeDescr | a pointer to type description pointer

rtl::OUString com::sun::star::uno::Any::getValueTypeName | ( |  | ) | const
| inline

Gets the type name of the set value.

Returns
  the type name of the set value

typelib_TypeDescriptionReference* com::sun::star::uno::Any::getValueTypeRef | ( |  | ) | const
| inline

Gets the type of the set value.

Returns
  the unacquired type description reference of the set value

template<>

bool com::sun::star::uno::Any::has | ( |  | ) | const

template<typename T >

bool com::sun::star::uno::Any::has | ( |  | ) | const
| inline

Tests whether this any can provide a value of specified type.

Widening conversion without data loss is taken into account.

Returns
  true if this any can provide a value of specified type (e.g. using >>= operator)

bool com::sun::star::uno::Any::hasValue | ( |  | ) | const
| inline

Tests if any contains a value.

Returns
  true if any has a value, false otherwise

bool com::sun::star::uno::Any::isExtractableTo | ( | const Type & | rType | ) | const
| inline

Tests whether this any is extractable to a value of given type.

Widening conversion without data loss is taken into account.

Parameters

  rType | destination type

Returns
  true if this any is extractable to value of given type (e.g. using >>= operator)

bool com::sun::star::uno::Any::operator!= | ( | const Any & | rAny | ) | const
| inline

Unequality operator: compares two anys.

The values need not be of equal type, e.g. a short integer is compared to a long integer.

Parameters

  rAny | another any (right side)

Returns
  true if both any contains unequal values

Any & com::sun::star::uno::Any::operator= | ( | const Any & | rAny | ) |
| inline

Assignment operator: Sets the value of the given any.

Parameters

  rAny | another any (right side)

Returns
  this any

bool com::sun::star::uno::Any::operator== | ( | const Any & | rAny | ) | const
| inline

Equality operator: compares two anys.

The values need not be of equal type, e.g. a short integer is compared to a long integer.

Parameters

  rAny | another any (right side)

Returns
  true if both any contains equal values

void com::sun::star::uno::Any::setValue | ( | const void * | pData_,
|  | const Type & | rType
| ) |  |
| inline

Sets a value.

If the any already contains a value, that value will be destructed and its memory freed.

Parameters

  pData_ | pointer to value
  rType | type of value

void com::sun::star::uno::Any::setValue | ( | const void * | pData_,
|  | typelib_TypeDescriptionReference * | pType
| ) |  |
| inline

Sets a value.

If the any already contains a value, that value will be destructed and its memory freed.

Parameters

  pData_ | pointer to value
  pType | type of value

void com::sun::star::uno::Any::setValue | ( | const void * | pData_,
|  | typelib_TypeDescription * | pTypeDescr
| ) |  |
| inline

Sets a value.

If the any already contains a value, that value will be destructed and its memory freed.

Parameters

  pData_ | pointer to value
  pTypeDescr | type description of value

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

- com/sun/star/uno/Any.h
- com/sun/star/uno/Any.hxx