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 Any


Any
Any() throw();

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

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

Any
explicit Any(
bool value );

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

Summary
Ctor support for C++ bool.

Any
Any(
const Any & rAny ) throw();

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

Summary
Copy constructor: Sets value of the given any.
Parameters
rAny
another any

Any
Any(
const void * pData_,
const Type & rType ) throw();

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

Summary
Constructor: Sets a copy of the given data.
Parameters
pData_
value
rType
type of value

Any
Any(
const void * pData_,
typelib_TypeDescription * pTypeDescr ) throw();

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

Summary
Constructor: Sets a copy of the given data.
Parameters
pData_
value
pTypeDescr
type of value

Any
Any(
const void * pData_,
typelib_TypeDescriptionReference * pType ) throw();

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

Summary
Constructor: Sets a copy of the given data.
Parameters
pData_
value
pType
type of value

~Any
~Any() throw();

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

Summary
Destructor: Destructs any content and frees memory.

operator=
Any & operator=(
const Any & rAny ) throw();

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

Summary
Assignment operator: Sets the value of the given any.
Parameters
rAny
another any (right side)
Return
this any

getValueType
const Type & getValueType() throw();

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

Summary
Gets the type of the set value.
Return
a Type object of the set value

getValueTypeRef
typelib_TypeDescriptionReference * getValueTypeRef() throw();

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

Summary
Gets the type of the set value.
Return
the UNacquired type description reference of the set value

getValueTypeDescription
void getValueTypeDescription(
typelib_TypeDescription * * ppTypeDescr ) const throw();

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

Summary
Gets the type description of the set value. Provides ownership of the type description! Call an explicit typelib_typedescription_release() to release afterwards.
Parameters
a
pointer to type description pointer

getValueTypeClass
TypeClass getValueTypeClass() throw();

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

Summary
Gets the type class of the set value.
Return
the type class of the set value

getValueTypeName
::rtl::OUString getValueTypeName() throw();

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

Summary
Gets the type name of the set value.
Return
the type name of the set value

hasValue
sal_Bool hasValue() throw();

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

Summary
Tests if any contains a value.
Return
true if any has a value, false otherwise

getValue
const void * getValue() throw();

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

Summary
Gets a pointer to the set value.
Return
a pointer to the set value

setValue
void setValue(
const void * pData_,
const Type & rType ) throw();

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

Summary
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

setValue
void setValue(
const void * pData_,
typelib_TypeDescriptionReference * pType ) throw();

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

Summary
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

setValue
void setValue(
const void * pData_,
typelib_TypeDescription * pTypeDescr ) throw();

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

Summary
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

clear
void clear() throw();

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

Summary
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.

isExtractableTo
sal_Bool isExtractableTo(
const Type & rType ) const throw();

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

Summary
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
Return
true if this any is extractable to value of given type (e.g. using >>= operator)

operator==
sal_Bool operator==(
const Any & rAny ) const throw();

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

Summary
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)
Return
true if both any contains equal values

operator!=
sal_Bool operator!=(
const Any & rAny ) const throw();

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

Summary
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)
Return
true if both any contains unequal values

Any
explicit Any(
sal_uInt16 );

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.