| LibreOffice
    LibreOffice 25.2 SDK C/C++ API Reference | 
| Classes | |
| class | Any | 
| C++ class representing an IDL any.  More... | |
| class | Array | 
| Helper class to specify a type pointer for idl arrays.  More... | |
| class | BaseReference | 
| This base class serves as a base class for all template reference classes and has been introduced due to compiler problems with templated operators ==, =!  More... | |
| class | ContextLayer | 
| Objects of this class are used for applying a current context until they are destructed, i.e.  More... | |
| class | Environment | 
| C++ wrapper for binary C uno_Environment.  More... | |
| class | Mapping | 
| C++ wrapper for C uno_Mapping.  More... | |
| class | Reference | 
| Template reference class for interface type derived from BaseReference.  More... | |
| class | Sequence | 
| Template C++ class representing an IDL sequence.  More... | |
| class | Sequence< bool > | 
| class | Type | 
| C++ class representing an IDL meta type.  More... | |
| class | TypeDescription | 
| C++ wrapper for typelib_TypeDescription.  More... | |
| class | WeakReference | 
| The WeakReference<> holds a weak reference to an object.  More... | |
| class | WeakReferenceHelper | 
| The WeakReferenceHelper holds a weak reference to an object.  More... | |
| Enumerations | |
| enum | UnoReference_NoAcquire { UNO_REF_NO_ACQUIRE } | 
| Enum defining UNO_REF_NO_ACQUIRE for setting reference without acquiring a given interface.  More... | |
| enum | UnoReference_Query { UNO_QUERY } | 
| Enum defining UNO_QUERY for implicit interface query.  More... | |
| enum | UnoReference_QueryThrow { UNO_QUERY_THROW } | 
| Enum defining UNO_QUERY_THROW for implicit interface query.  More... | |
| enum | UnoReference_SetThrow { UNO_SET_THROW } | 
| Enum defining UNO_SET_THROW for throwing if attempts are made to assign a null interface.  More... | |
| enum | UnoType_NoAcquire { UNO_TYPE_NO_ACQUIRE } | 
| Enum defining UNO_TYPE_NO_ACQUIRE for type description reference transfer.  More... | |
| Functions | |
| Reference< XCurrentContext > | getCurrentContext () | 
| Getting the current context. | |
| bool | setCurrentContext (Reference< XCurrentContext > const &xContext) | 
| Setting the current context. | |
| template<class C> | |
| bool | mapToCpp (Reference< C > *ppRet, uno_Interface *pUnoI) | 
| Deprecated. | |
| template<class C> | |
| bool | mapToUno (uno_Interface **ppRet, const Reference< C > &x) | 
| Deprecated. | |
| template<class C> | |
| Any | makeAny (const C &value) | 
| Template function to generically construct an any from a C++ value. | |
| template<> | |
| Any | makeAny (sal_uInt16 const &value) | 
| template<> | |
| Any | makeAny (Any const &) SAL_DELETED_FUNCTION | 
| template<typename T> | |
| Any | toAny (T const &value) | 
| Wrap a value in an Any, if necessary. | |
| template<> | |
| Any | toAny (Any const &value) | 
| template<class C> | |
| void | operator<<= (Any &rAny, const C &value) | 
| Template binary <<= operator to set the value of an any. | |
| template<> | |
| void | operator<<= (Any &rAny, bool const &value) | 
| template<class C> | |
| bool | operator>>= (const Any &rAny, C &value) | 
| Template binary >>= operator to assign a value from an any. | |
| template<class C> | |
| bool | operator== (const Any &rAny, const C &value) | 
| Template equality operator: compares set value of left side any to right side value. | |
| template<class C> | |
| bool | operator!= (const Any &rAny, const C &value) | 
| Template inequality operator: compares set value of left side any to right side value. | |
| template<> | |
| bool | operator>>= (const Any &rAny, sal_Bool &value) | 
| template<> | |
| bool | operator== (const Any &rAny, const sal_Bool &value) | 
| template<> | |
| bool | operator>>= (Any const &rAny, bool &value) | 
| template<> | |
| bool | operator== (Any const &rAny, bool const &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_Int8 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_Int16 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_uInt16 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_Int32 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_uInt32 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_Int64 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_uInt64 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, float &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, double &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, ::rtl::OUString &value) | 
| template<> | |
| bool | operator== (const Any &rAny, const ::rtl::OUString &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, Type &value) | 
| template<> | |
| bool | operator== (const Any &rAny, const Type &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, Any &value) | 
| template<> | |
| bool | operator== (const Any &rAny, const BaseReference &value) | 
| template<> | |
| Any | makeAny (sal_uInt16 const &value) | 
| template<> | |
| Any | toAny (Any const &value) | 
| template<> | |
| void | operator<<= (Any &rAny, bool const &value) | 
| template<> | |
| bool | operator>>= (const ::com::sun::star::uno::Any &rAny, sal_Bool &value) | 
| template<> | |
| bool | operator== (const Any &rAny, const sal_Bool &value) | 
| template<> | |
| bool | operator>>= (Any const &rAny, bool &value) | 
| template<> | |
| bool | operator== (Any const &rAny, bool const &value) | 
| template<> | |
| bool | operator>>= (const ::com::sun::star::uno::Any &rAny, sal_Int8 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_Int16 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_uInt16 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_Int32 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_uInt32 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_Int64 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, sal_uInt64 &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, float &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, double &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, ::rtl::OUString &value) | 
| template<> | |
| bool | operator== (const Any &rAny, const ::rtl::OUString &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, Type &value) | 
| template<> | |
| bool | operator== (const Any &rAny, const Type &value) | 
| template<> | |
| bool | operator>>= (const Any &rAny, Any &value) | 
| template<> | |
| bool | operator== (const Any &rAny, const BaseReference &value) | 
| template<typename charT, typename traits> | |
| std::basic_ostream< charT, traits > & | operator<< (std::basic_ostream< charT, traits > &o, Any const &any) | 
| Support for Any in std::ostream (and thus in CPPUNIT_ASSERT or SAL_INFO macros, for example). | |
| void | cpp_acquire (void *pCppI) | 
| Function to acquire a C++ interface. | |
| void | cpp_release (void *pCppI) | 
| Function to release a C++ interface. | |
| void * | cpp_queryInterface (void *pCppI, typelib_TypeDescriptionReference *pType) | 
| Function to query for a C++ interface. | |
| inline ::com::sun::star::uno::Sequence< sal_Int8 > | toUnoSequence (const ::rtl::ByteSequence &rByteSequence) | 
| Creates a UNO byte sequence from a SAL byte sequence. | |
| Variables | |
| template<class T> | |
| typelib_TypeDescriptionReference * | Array< T >::s_pType = NULL | 
Enum defining UNO_TYPE_NO_ACQUIRE for type description reference transfer.
| Enumerator | |
|---|---|
| UNO_TYPE_NO_ACQUIRE | This enum value can be used for creating a Type object granting a given type description reference, i.e. transferring ownership to it. | 
| 
 | inline | 
Function to acquire a C++ interface.
| pCppI | C++ interface pointer | 
| 
 | inline | 
Function to query for a C++ interface.
| pCppI | C++ interface pointer | 
| pType | demanded interface type | 
| 
 | inline | 
Function to release a C++ interface.
| pCppI | C++ interface pointer | 
| 
 | inline | 
Getting the current context.
| 
 | inline | 
Template function to generically construct an any from a C++ value.
| C | value type | 
| value | a value | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
Deprecated.
This function DOES NOT WORK with Purpose Environments (http://wiki.openoffice.org/wiki/Uno/Binary/Spec/Purpose Environments)
Maps a binary C UNO interface to be used in the currently used compiler environment.
| C | interface type | 
| ppRet | inout returned interface pointer | 
| pUnoI | binary C UNO interface | 
| 
 | inline | 
Deprecated.
This function DOES NOT WORK with Purpose Environments (http://wiki.openoffice.org/wiki/Uno/Binary/Spec/Purpose Environments)
Maps a UNO interface of the currently used compiler environment to binary C UNO.
| C | interface type | 
| ppRet | inout returned interface pointer | 
| x | interface reference | 
| 
 | inline | 
Template inequality operator: compares set value of left side any to right side value.
The values need not be of equal type, e.g. a short integer is compared to a long integer. This operator can be implemented as template member function, if all supported compilers can cope with template member functions.
| C | value type | 
| rAny | another any (left side) | 
| value | a value (right side) | 
| 
 | inline | 
Support for Any in std::ostream (and thus in CPPUNIT_ASSERT or SAL_INFO macros, for example).
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
Template binary <<= operator to set the value of an any.
| C | value type | 
| rAny | destination any (left side) | 
| value | source value (right side) | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
Template equality operator: compares set value of left side any to right side value.
The values need not be of equal type, e.g. a short integer is compared to a long integer. This operator can be implemented as template member function, if all supported compilers can cope with template member functions.
| C | value type | 
| rAny | another any (left side) | 
| value | a value (right side) | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
Template binary >>= operator to assign a value from an any.
If the any does not contain a value that can be assigned without data loss, then this operation will fail returning false.
| C | value type | 
| rAny | source any (left side) | 
| value | destination value (right side) | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
Setting the current context.
| xContext | current context to be set | 
| 
 | inline | 
| com::sun::star::uno::Sequence< sal_Int8 > com::sun::star::uno::toUnoSequence | ( | const ::rtl::ByteSequence & | rByteSequence | ) | 
Creates a UNO byte sequence from a SAL byte sequence.
| rByteSequence | a byte sequence | 
| typelib_TypeDescriptionReference* com::sun::star::uno::Array< T >::s_pType = NULL |