UDK 3.2.7 C/C++ API Reference
|
Template reference class for interface type derived from BaseReference. More...
#include <Reference.h>
Public Member Functions | |
~Reference () throw () | |
Destructor: Releases interface if set. | |
Reference () throw () | |
Default Constructor: Sets null reference. | |
Reference (const Reference< interface_type > &rRef) throw () | |
Copy constructor: Copies interface reference. | |
Reference (interface_type *pInterface) throw () | |
Constructor: Sets given interface pointer. | |
Reference (interface_type *pInterface, __sal_NoAcquire dummy) throw () | |
Constructor: Sets given interface pointer without acquiring it. | |
Reference (interface_type *pInterface, UnoReference_NoAcquire dummy) throw () | |
Constructor: Sets given interface pointer without acquiring it. | |
Reference (const BaseReference &rRef, UnoReference_Query dummy) throw (RuntimeException) | |
Constructor: Queries given interface for reference interface type (interface_type). | |
Reference (XInterface *pInterface, UnoReference_Query dummy) throw (RuntimeException) | |
Constructor: Queries given interface for reference interface type (interface_type). | |
Reference (const Any &rAny, UnoReference_Query dummy) throw (RuntimeException) | |
Constructor: Queries given any for reference interface type (interface_type). | |
Reference (const BaseReference &rRef, UnoReference_QueryThrow dummy) throw (RuntimeException) | |
Constructor: Queries given interface for reference interface type (interface_type). | |
Reference (XInterface *pInterface, UnoReference_QueryThrow dummy) throw (RuntimeException) | |
Constructor: Queries given interface for reference interface type (interface_type). | |
Reference (const Any &rAny, UnoReference_QueryThrow dummy) throw (RuntimeException) | |
Constructor: Queries given any for reference interface type (interface_type). | |
Reference (const Reference< interface_type > &rRef, UnoReference_SetThrow dummy) throw (RuntimeException) | |
Constructor: assigns from the given interface of the same type. | |
Reference (interface_type *pInterface, UnoReference_SetThrow dummy) throw (RuntimeException) | |
Constructor: assigns from the given interface of the same type. | |
operator const Reference< XInterface > & () const throw () | |
Cast operator to Reference< XInterface >: Reference objects are binary compatible and any interface must be derived from com.sun.star.uno.XInterface. | |
interface_type * | operator-> () const throw () |
Dereference operator: Used to call interface methods. | |
interface_type * | get () const throw () |
Gets interface pointer. | |
void | clear () throw () |
Clears reference, i.e. | |
sal_Bool | set (const Reference< interface_type > &rRef) throw () |
Sets the given interface. | |
sal_Bool | set (interface_type *pInterface) throw () |
Sets the given interface. | |
sal_Bool | set (interface_type *pInterface, __sal_NoAcquire dummy) throw () |
Sets interface pointer without acquiring it. | |
sal_Bool | set (interface_type *pInterface, UnoReference_NoAcquire dummy) throw () |
Sets interface pointer without acquiring it. | |
sal_Bool | set (XInterface *pInterface, UnoReference_Query dummy) throw (RuntimeException) |
Queries given interface for reference interface type (interface_type) and sets it. | |
sal_Bool | set (const BaseReference &rRef, UnoReference_Query dummy) throw (RuntimeException) |
Queries given interface for reference interface type (interface_type) and sets it. | |
bool | set (Any const &rAny, UnoReference_Query dummy) |
Queries given any for reference interface type (interface_type) and sets it. | |
void | set (XInterface *pInterface, UnoReference_QueryThrow dummy) throw (RuntimeException) |
Queries given interface for reference interface type (interface_type) and sets it. | |
void | set (const BaseReference &rRef, UnoReference_QueryThrow dummy) throw (RuntimeException) |
Queries given interface for reference interface type (interface_type) and sets it. | |
void | set (Any const &rAny, UnoReference_QueryThrow dummy) |
Queries given any for reference interface type (interface_type) and sets it. | |
void | set (interface_type *pInterface, UnoReference_SetThrow dummy) throw (RuntimeException) |
sets the given interface An interface already set will be released. | |
void | set (const Reference< interface_type > &rRef, UnoReference_SetThrow dummy) throw (RuntimeException) |
sets the given interface An interface already set will be released. | |
Reference< interface_type > & | operator= (interface_type *pInterface) throw () |
Assignment operator: Acquires given interface pointer and sets reference. | |
Reference< interface_type > & | operator= (const Reference< interface_type > &rRef) throw () |
Assignment operator: Acquires given interface reference and sets reference. | |
Static Public Member Functions | |
static Reference< interface_type > | query (const BaseReference &rRef) throw (RuntimeException) |
Queries given interface reference for type interface_type. | |
static Reference< interface_type > | query (XInterface *pInterface) throw (RuntimeException) |
Queries given interface for type interface_type. |
Template reference class for interface type derived from BaseReference.
A special constructor given the UNO_QUERY identifier queries interfaces for reference type.
com::sun::star::uno::Reference< interface_type >::~Reference | ( | ) | throw () [inline] |
Destructor: Releases interface if set.
com::sun::star::uno::Reference< interface_type >::Reference | ( | ) | throw () [inline] |
Default Constructor: Sets null reference.
com::sun::star::uno::Reference< interface_type >::Reference | ( | const Reference< interface_type > & | rRef | ) | throw () [inline] |
Copy constructor: Copies interface reference.
rRef | another reference |
com::sun::star::uno::Reference< interface_type >::Reference | ( | interface_type * | pInterface | ) | throw () [inline] |
Constructor: Sets given interface pointer.
pInterface | an interface pointer |
com::sun::star::uno::Reference< interface_type >::Reference | ( | interface_type * | pInterface, |
__sal_NoAcquire | dummy | ||
) | throw () [inline] |
Constructor: Sets given interface pointer without acquiring it.
pInterface | another reference |
dummy | SAL_NO_ACQUIRE to force obvious distinction to other constructors |
com::sun::star::uno::Reference< interface_type >::Reference | ( | interface_type * | pInterface, |
UnoReference_NoAcquire | dummy | ||
) | throw () [inline] |
Constructor: Sets given interface pointer without acquiring it.
Deprecated, please use SAL_NO_ACQUIRE version.
pInterface | another reference |
dummy | UNO_REF_NO_ACQUIRE to force obvious distinction to other constructors |
com::sun::star::uno::Reference< interface_type >::Reference | ( | const BaseReference< interface_type > & | rRef, |
UnoReference_Query | dummy | ||
) | throw (RuntimeException) [inline] |
Constructor: Queries given interface for reference interface type (interface_type).
rRef | another reference |
dummy | UNO_QUERY to force obvious distinction to other constructors |
com::sun::star::uno::Reference< interface_type >::Reference | ( | XInterface * | pInterface, |
UnoReference_Query | dummy | ||
) | throw (RuntimeException) [inline] |
Constructor: Queries given interface for reference interface type (interface_type).
pInterface | an interface pointer |
dummy | UNO_QUERY to force obvious distinction to other constructors |
com::sun::star::uno::Reference< interface_type >::Reference | ( | const Any & | rAny, |
UnoReference_Query | dummy | ||
) | throw (RuntimeException) [inline] |
Constructor: Queries given any for reference interface type (interface_type).
rAny | an any |
dummy | UNO_QUERY to force obvious distinction to other constructors |
com::sun::star::uno::Reference< interface_type >::Reference | ( | const BaseReference< interface_type > & | rRef, |
UnoReference_QueryThrow | dummy | ||
) | throw (RuntimeException) [inline] |
Constructor: Queries given interface for reference interface type (interface_type).
Throws a RuntimeException if the demanded interface cannot be queried.
rRef | another reference |
dummy | UNO_QUERY_THROW to force obvious distinction to other constructors |
com::sun::star::uno::Reference< interface_type >::Reference | ( | XInterface * | pInterface, |
UnoReference_QueryThrow | dummy | ||
) | throw (RuntimeException) [inline] |
Constructor: Queries given interface for reference interface type (interface_type).
Throws a RuntimeException if the demanded interface cannot be queried.
pInterface | an interface pointer |
dummy | UNO_QUERY_THROW to force obvious distinction to other constructors |
com::sun::star::uno::Reference< interface_type >::Reference | ( | const Any & | rAny, |
UnoReference_QueryThrow | dummy | ||
) | throw (RuntimeException) [inline] |
Constructor: Queries given any for reference interface type (interface_type).
Throws a RuntimeException if the demanded interface cannot be queried.
rAny | an any |
dummy | UNO_QUERY_THROW to force obvious distinction to other constructors |
com::sun::star::uno::Reference< interface_type >::Reference | ( | const Reference< interface_type > & | rRef, |
UnoReference_SetThrow | dummy | ||
) | throw (RuntimeException) [inline] |
Constructor: assigns from the given interface of the same type.
Throws a RuntimeException if the source interface is NULL.
rRef | another interface reference of the same type |
dummy | UNO_SET_THROW to distinguish from default copy constructor |
com::sun::star::uno::Reference< interface_type >::Reference | ( | interface_type * | pInterface, |
UnoReference_SetThrow | dummy | ||
) | throw (RuntimeException) [inline] |
Constructor: assigns from the given interface of the same type.
Throws a RuntimeException if the source interface is NULL.
pInterface | an interface pointer |
dummy | UNO_SET_THROW to distinguish from default assignment constructor |
void com::sun::star::uno::Reference< interface_type >::clear | ( | ) | throw () [inline] |
interface_type* com::sun::star::uno::Reference< interface_type >::get | ( | ) | const throw () [inline] |
Gets interface pointer.
This call does not acquire the interface.
Reimplemented from com::sun::star::uno::BaseReference.
com::sun::star::uno::Reference< interface_type >::operator const Reference< XInterface > & | ( | ) | const throw () [inline] |
Cast operator to Reference< XInterface >: Reference objects are binary compatible and any interface must be derived from com.sun.star.uno.XInterface.
This a useful direct cast possibility.
interface_type* com::sun::star::uno::Reference< interface_type >::operator-> | ( | ) | const throw () [inline] |
Dereference operator: Used to call interface methods.
Reference< interface_type > & com::sun::star::uno::Reference< interface_type >::operator= | ( | interface_type * | pInterface | ) | throw () [inline] |
Assignment operator: Acquires given interface pointer and sets reference.
An interface already set will be released.
pInterface | an interface pointer |
Reference< interface_type > & com::sun::star::uno::Reference< interface_type >::operator= | ( | const Reference< interface_type > & | rRef | ) | throw () [inline] |
Assignment operator: Acquires given interface reference and sets reference.
An interface already set will be released.
rRef | an interface reference |
Reference< interface_type > com::sun::star::uno::Reference< interface_type >::query | ( | XInterface * | pInterface | ) | throw (RuntimeException) [inline, static] |
Queries given interface for type interface_type.
pInterface | interface pointer |
Reference< interface_type > com::sun::star::uno::Reference< interface_type >::query | ( | const BaseReference< interface_type > & | rRef | ) | throw (RuntimeException) [inline, static] |
Queries given interface reference for type interface_type.
rRef | interface reference |
void com::sun::star::uno::Reference< interface_type >::set | ( | const BaseReference< interface_type > & | rRef, |
UnoReference_QueryThrow | dummy | ||
) | throw (RuntimeException) [inline] |
Queries given interface for reference interface type (interface_type) and sets it.
An interface already set will be released. Throws a RuntimeException if the demanded interface cannot be set.
rRef | another reference |
dummy | UNO_QUERY_THROW to force obvious distinction to set methods |
void com::sun::star::uno::Reference< interface_type >::set | ( | XInterface * | pInterface, |
UnoReference_QueryThrow | dummy | ||
) | throw (RuntimeException) [inline] |
Queries given interface for reference interface type (interface_type) and sets it.
An interface already set will be released. Throws a RuntimeException if the demanded interface cannot be set.
pInterface | an interface pointer |
dummy | UNO_QUERY_THROW to force obvious distinction to set methods |
bool com::sun::star::uno::Reference< interface_type >::set | ( | Any const & | rAny, |
UnoReference_Query | dummy | ||
) | [inline] |
Queries given any for reference interface type (interface_type) and sets it.
An interface already set will be released.
rAny | an Any containing an interface |
dummy | UNO_QUERY to force obvious distinction to set methods |
sal_Bool com::sun::star::uno::Reference< interface_type >::set | ( | const Reference< interface_type > & | rRef | ) | throw () [inline] |
Sets the given interface.
An interface already set will be released.
rRef | another reference |
sal_Bool com::sun::star::uno::Reference< interface_type >::set | ( | XInterface * | pInterface, |
UnoReference_Query | dummy | ||
) | throw (RuntimeException) [inline] |
Queries given interface for reference interface type (interface_type) and sets it.
An interface already set will be released.
pInterface | an interface pointer |
dummy | UNO_QUERY to force obvious distinction to set methods |
sal_Bool com::sun::star::uno::Reference< interface_type >::set | ( | const BaseReference< interface_type > & | rRef, |
UnoReference_Query | dummy | ||
) | throw (RuntimeException) [inline] |
Queries given interface for reference interface type (interface_type) and sets it.
An interface already set will be released.
rRef | another reference |
dummy | UNO_QUERY to force obvious distinction to set methods |
sal_Bool com::sun::star::uno::Reference< interface_type >::set | ( | interface_type * | pInterface, |
__sal_NoAcquire | dummy | ||
) | throw () [inline] |
Sets interface pointer without acquiring it.
An interface already set will be released.
pInterface | an interface pointer |
dummy | SAL_NO_ACQUIRE to force obvious distinction to set methods |
sal_Bool com::sun::star::uno::Reference< interface_type >::set | ( | interface_type * | pInterface | ) | throw () [inline] |
Sets the given interface.
An interface already set will be released.
pInterface | another interface |
void com::sun::star::uno::Reference< interface_type >::set | ( | const Reference< interface_type > & | rRef, |
UnoReference_SetThrow | dummy | ||
) | throw (RuntimeException) [inline] |
sets the given interface An interface already set will be released.
Throws a RuntimeException if the source interface is <NULL>.
rRef | an interface reference |
dummy | UNO_SET_THROW to force obvious distinction to other set methods |
sal_Bool com::sun::star::uno::Reference< interface_type >::set | ( | interface_type * | pInterface, |
UnoReference_NoAcquire | dummy | ||
) | throw () [inline] |
Sets interface pointer without acquiring it.
An interface already set will be released. Deprecated, please use SAL_NO_ACQUIRE version.
pInterface | an interface pointer |
dummy | UNO_REF_NO_ACQUIRE to force obvious distinction to set methods |
void com::sun::star::uno::Reference< interface_type >::set | ( | Any const & | rAny, |
UnoReference_QueryThrow | dummy | ||
) | [inline] |
Queries given any for reference interface type (interface_type) and sets it.
An interface already set will be released. Throws a RuntimeException if the demanded interface cannot be set.
rAny | an Any containing an interface |
dummy | UNO_QUERY_THROW to force obvious distinction to set methods |
void com::sun::star::uno::Reference< interface_type >::set | ( | interface_type * | pInterface, |
UnoReference_SetThrow | dummy | ||
) | throw (RuntimeException) [inline] |
sets the given interface An interface already set will be released.
Throws a RuntimeException if the source interface is <NULL>.
pInterface | an interface pointer |
dummy | UNO_SET_THROW to force obvious distinction to other set methods |