My Project
UDK 3.2.7 C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Enumerations | Functions
com::sun::star::uno Namespace Reference

Classes

class  TypeDescription
 C++ wrapper for typelib_TypeDescription. 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  WeakReferenceHelper
 The WeakReferenceHelper holds a weak reference to an object. More...
class  WeakReference
 The WeakReference<> holds a weak reference to an object. More...
class  Any
 C++ class representing an IDL any. 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  Reference
 Template reference class for interface type derived from BaseReference. More...
class  Sequence
 Template C++ class representing an IDL sequence. More...
class  Type
 C++ class representing an IDL meta type. More...
class  Array
 Helper class to specify a type pointer for idl arrays. 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 () throw ()
 Getting the current context.
bool setCurrentContext (Reference< XCurrentContext > const &xContext) throw ()
 Setting the current context.
template<class C >
sal_Bool mapToCpp (Reference< C > *ppRet, uno_Interface *pUnoI) throw ()
 Deprecated.
template<class C >
sal_Bool mapToUno (uno_Interface **ppRet, const Reference< C > &x) throw ()
 Deprecated.
template<class C >
Any makeAny (const C &value) throw ()
 Template function to generically construct an any from a C++ value.
template<>
Any makeAny (bool const &value) throw ()
template<class C >
void operator<<= (Any &rAny, const C &value) throw ()
 Template binary <<= operator to set the value of an any.
void operator<<= (Any &rAny, bool const &value) throw ()
template<class C >
sal_Bool operator>>= (const Any &rAny, C &value) throw ()
 Template binary >>= operator to assign a value from an any.
template<class C >
sal_Bool operator== (const Any &rAny, const C &value) throw ()
 Template equality operator: compares set value of left side any to right side value.
template<class C >
sal_Bool operator!= (const Any &rAny, const C &value) throw ()
 Template unequality operator: compares set value of left side any to right side value.
sal_Bool operator>>= (const Any &rAny, sal_Bool &value) throw ()
sal_Bool operator== (const Any &rAny, const sal_Bool &value) throw ()
template<>
sal_Bool operator>>= (Any const &rAny, bool &value) throw ()
template<>
sal_Bool operator== (Any const &rAny, bool const &value) throw ()
sal_Bool operator>>= (const Any &rAny, sal_Int8 &value) throw ()
sal_Bool operator>>= (const Any &rAny, sal_Int16 &value) throw ()
sal_Bool operator>>= (const Any &rAny, sal_uInt16 &value) throw ()
sal_Bool operator>>= (const Any &rAny, sal_Int32 &value) throw ()
sal_Bool operator>>= (const Any &rAny, sal_uInt32 &value) throw ()
sal_Bool operator>>= (const Any &rAny, sal_Int64 &value) throw ()
sal_Bool operator>>= (const Any &rAny, sal_uInt64 &value) throw ()
sal_Bool operator>>= (const Any &rAny, float &value) throw ()
sal_Bool operator>>= (const Any &rAny, double &value) throw ()
sal_Bool operator>>= (const Any &rAny,::rtl::OUString &value) throw ()
sal_Bool operator== (const Any &rAny, const ::rtl::OUString &value) throw ()
sal_Bool operator>>= (const Any &rAny, Type &value) throw ()
sal_Bool operator== (const Any &rAny, const Type &value) throw ()
sal_Bool operator>>= (const Any &rAny, Any &value) throw ()
sal_Bool operator== (const Any &rAny, const BaseReference &value) throw ()
sal_Bool operator>>= (const ::com::sun::star::uno::Any &rAny, sal_Bool &value) throw ()
sal_Bool operator>>= (const ::com::sun::star::uno::Any &rAny, sal_Int8 &value) throw ()
rtl_uString * cppu_Any_extraction_failure_msg (uno_Any const *pAny, typelib_TypeDescriptionReference *pType) SAL_THROW_EXTERN_C()
void cpp_acquire (void *pCppI) throw ()
 Function to acquire a C++ interface.
void cpp_release (void *pCppI) throw ()
 Function to release a C++ interface.
void * cpp_queryInterface (void *pCppI, typelib_TypeDescriptionReference *pType) throw ()
 Function to query for a C++ interface.
rtl_uString * cppu_unsatisfied_iquery_msg (typelib_TypeDescriptionReference *pType) SAL_THROW_EXTERN_C()
rtl_uString * cppu_unsatisfied_iset_msg (typelib_TypeDescriptionReference *pType) SAL_THROW_EXTERN_C()
inline::com::sun::star::uno::Sequence
< sal_Int8
toUnoSequence (const ::rtl::ByteSequence &rByteSequence) throw ()
 Creates a UNO byte sequence from a SAL byte sequence.

Enumeration Type Documentation

Enum defining UNO_REF_NO_ACQUIRE for setting reference without acquiring a given interface.

Deprecated, please use SAL_NO_ACQUIRE.

Deprecated:
Enumerator:
UNO_REF_NO_ACQUIRE 

This enum value can be used for creating a reference granting a given interface, i.e.

transferring ownership to it.

Enum defining UNO_QUERY for implicit interface query.

Enumerator:
UNO_QUERY 

This enum value can be used for implicit interface query.

Enum defining UNO_QUERY_THROW for implicit interface query.

If the demanded interface is unavailable, then a RuntimeException is thrown.

Enumerator:
UNO_QUERY_THROW 

This enum value can be used for implicit interface query.

Enum defining UNO_SET_THROW for throwing if attempts are made to assign a null interface.

Since
UDK 3.2.8
Enumerator:
UNO_SET_THROW 

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.

Function Documentation

void com::sun::star::uno::cpp_acquire ( void *  pCppI) throw ()
inline

Function to acquire a C++ interface.

Parameters
pCppIC++ interface pointer
void * com::sun::star::uno::cpp_queryInterface ( void *  pCppI,
typelib_TypeDescriptionReference pType 
) throw ()
inline

Function to query for a C++ interface.

Parameters
pCppIC++ interface pointer
pTypedemanded interface type
Returns
acquired C++ interface pointer or null
void com::sun::star::uno::cpp_release ( void *  pCppI) throw ()
inline

Function to release a C++ interface.

Parameters
pCppIC++ interface pointer
rtl_uString* com::sun::star::uno::cppu_Any_extraction_failure_msg ( uno_Any const *  pAny,
typelib_TypeDescriptionReference pType 
)
rtl_uString* com::sun::star::uno::cppu_unsatisfied_iquery_msg ( typelib_TypeDescriptionReference pType)
rtl_uString* com::sun::star::uno::cppu_unsatisfied_iset_msg ( typelib_TypeDescriptionReference pType)
Reference< XCurrentContext > com::sun::star::uno::getCurrentContext ( ) throw ()
inline

Getting the current context.

Attention
Don't spread the returned interface around to other threads. Every thread has its own current context.
Returns
current context or null ref, if none is set
template<class C >
Any com::sun::star::uno::makeAny ( const C &  value) throw ()
inline

Template function to generically construct an any from a C++ value.

Template Parameters
Cvalue type
Parameters
valuea value
Returns
an any
template<>
Any com::sun::star::uno::makeAny ( bool const &  value) throw ()
inline
template<class C >
sal_Bool com::sun::star::uno::mapToCpp ( Reference< C > *  ppRet,
uno_Interface pUnoI 
) throw ()
inline

Deprecated.

This function DOES NOT WORK with Purpose Environments (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Purpose Environments)

Maps an binary C UNO interface to be used in the currently used compiler environment.

Template Parameters
Cinterface type
Parameters
ppRetinout returned interface pointer
pUnoIbinary C UNO interface
Returns
true if successful, false otherwise
Deprecated:
template<class C >
sal_Bool com::sun::star::uno::mapToUno ( uno_Interface **  ppRet,
const Reference< C > &  x 
) throw ()
inline

Deprecated.

This function DOES NOT WORK with Purpose Environments (http://wiki.services.openoffice.org/wiki/Uno/Binary/Spec/Purpose Environments)

Maps an UNO interface of the currently used compiler environment to binary C UNO.

Template Parameters
Cinterface type
Parameters
ppRetinout returned interface pointer
xinterface reference
Returns
true if successful, false otherwise
Deprecated:
template<class C >
sal_Bool com::sun::star::uno::operator!= ( const Any &  rAny,
const C &  value 
) throw ()
inline

Template unequality 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.

Template Parameters
Cvalue type
Parameters
rAnyanother any (left side)
valuea value (right side)
Returns
true if values are unequal, false otherwise
template<class C >
void com::sun::star::uno::operator<<= ( Any &  rAny,
const C &  value 
) throw ()
inline

Template binary <<= operator to set the value of an any.

Template Parameters
Cvalue type
Parameters
rAnydestination any (left side)
valuesource value (right side)
void com::sun::star::uno::operator<<= ( Any &  rAny,
bool const &  value 
) throw ()
inline
template<class C >
sal_Bool com::sun::star::uno::operator== ( const Any &  rAny,
const C &  value 
) throw ()
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.

Template Parameters
Cvalue type
Parameters
rAnyanother any (left side)
valuea value (right side)
Returns
true if values are equal, false otherwise
sal_Bool com::sun::star::uno::operator== ( const Any &  rAny,
const sal_Bool value 
) throw ()
inline
template<>
sal_Bool com::sun::star::uno::operator== ( Any const &  rAny,
bool const &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator== ( const Any &  rAny,
const ::rtl::OUString value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator== ( const Any &  rAny,
const Type &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator== ( const Any &  rAny,
const BaseReference &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const ::com::sun::star::uno::Any rAny,
sal_Bool value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const ::com::sun::star::uno::Any rAny,
sal_Int8 value 
) throw ()
inline
template<class C >
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
C &  value 
) throw ()
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.

Template Parameters
Cvalue type
Parameters
rAnysource any (left side)
valuedestination value (right side)
Returns
true if assignment was possible without data loss
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
sal_Bool value 
) throw ()
inline
template<>
sal_Bool com::sun::star::uno::operator>>= ( Any const &  rAny,
bool &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
sal_Int8 value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
sal_Int16 &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
sal_uInt16 &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
sal_Int32 &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
sal_uInt32 &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
sal_Int64 &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
sal_uInt64 &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
float &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
double &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
::rtl::OUString value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
Type &  value 
) throw ()
inline
sal_Bool com::sun::star::uno::operator>>= ( const Any &  rAny,
Any &  value 
) throw ()
inline
bool com::sun::star::uno::setCurrentContext ( Reference< XCurrentContext > const &  xContext) throw ()
inline

Setting the current context.

Parameters
xContextcurrent context to be set
Returns
true, if context has been successfully set
com::sun::star::uno::Sequence< sal_Int8 > com::sun::star::uno::toUnoSequence ( const ::rtl::ByteSequence rByteSequence) throw ()
inline

Creates a UNO byte sequence from a SAL byte sequence.

Parameters
rByteSequencea byte sequence
Returns
a UNO byte sequence