|
LibreOffice
LibreOffice 24.8 SDK C/C++ API Reference
|
Template reference class for interface type derived from BaseReference. More...
#include <Reference.h>
Public Member Functions | |
| ~Reference () COVERITY_NOEXCEPT_FALSE | |
| Destructor: Releases interface if set. | |
| Reference () | |
| Default Constructor: Sets null reference. | |
| Reference (const Reference< interface_type > &rRef) | |
| Copy constructor: Copies interface reference. | |
| Reference (interface_type *pInterface) | |
| Constructor: Sets given interface pointer. | |
| Reference (interface_type *pInterface, __sal_NoAcquire dummy) | |
| Constructor: Sets given interface pointer without acquiring it. | |
| Reference (interface_type *pInterface, UnoReference_NoAcquire dummy) | |
| Constructor: Sets given interface pointer without acquiring it. | |
| Reference (const BaseReference &rRef, UnoReference_Query dummy) | |
| Constructor: Queries given interface for reference interface type (interface_type). | |
| Reference (XInterface *pInterface, UnoReference_Query dummy) | |
| Constructor: Queries given interface for reference interface type (interface_type). | |
| Reference (const Any &rAny, UnoReference_Query dummy) | |
| Constructor: Queries given any for reference interface type (interface_type). | |
| Reference (const BaseReference &rRef, UnoReference_QueryThrow dummy) | |
| Constructor: Queries given interface for reference interface type (interface_type). | |
| Reference (XInterface *pInterface, UnoReference_QueryThrow dummy) | |
| Constructor: Queries given interface for reference interface type (interface_type). | |
| Reference (const Any &rAny, UnoReference_QueryThrow dummy) | |
| Constructor: Queries given any for reference interface type (interface_type). | |
| Reference (const Reference< interface_type > &rRef, UnoReference_SetThrow dummy) | |
| Constructor: assigns from the given interface of the same type. | |
| Reference (interface_type *pInterface, UnoReference_SetThrow dummy) | |
| Constructor: assigns from the given interface of the same type. | |
| operator const Reference< XInterface > & () const | |
| 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 |
| Dereference operator: Used to call interface methods. | |
| interface_type & | operator* () const |
| Indirection operator. | |
| interface_type * | get () const |
| Gets interface pointer. | |
| void | clear () |
| Clears reference, i.e. | |
| bool | set (const Reference< interface_type > &rRef) |
| Sets the given interface. | |
| bool | set (interface_type *pInterface) |
| Sets the given interface. | |
| bool | set (interface_type *pInterface, __sal_NoAcquire dummy) |
| Sets interface pointer without acquiring it. | |
| bool | set (interface_type *pInterface, UnoReference_NoAcquire dummy) |
| Sets interface pointer without acquiring it. | |
| bool | set (XInterface *pInterface, UnoReference_Query dummy) |
| Queries given interface for reference interface type (interface_type) and sets it. | |
| bool | set (const BaseReference &rRef, UnoReference_Query dummy) |
| 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) |
| Queries given interface for reference interface type (interface_type) and sets it. | |
| void | set (const BaseReference &rRef, UnoReference_QueryThrow dummy) |
| 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) |
| sets the given interface An interface already set will be released. | |
| void | set (const Reference< interface_type > &rRef, UnoReference_SetThrow dummy) |
| sets the given interface An interface already set will be released. | |
| Reference< interface_type > & | operator= (interface_type *pInterface) |
| Assignment operator: Acquires given interface pointer and sets reference. | |
| Reference< interface_type > & | operator= (const Reference< interface_type > &rRef) |
| Assignment operator: Acquires given interface reference and sets reference. | |
| Public Member Functions inherited from com::sun::star::uno::BaseReference | |
| XInterface * | get () const |
| Gets interface pointer. | |
| bool | is () const |
| Checks if reference is null. | |
| bool | operator== (XInterface *pInterface) const |
| Equality operator: compares two interfaces Checks if both references are null or refer to the same object. | |
| bool | operator!= (XInterface *pInterface) const |
| Inequality operator: compares two interfaces Checks if both references are null or refer to the same object. | |
| bool | operator== (const BaseReference &rRef) const |
| Equality operator: compares two interfaces Checks if both references are null or refer to the same object. | |
| bool | operator!= (const BaseReference &rRef) const |
| Inequality operator: compares two interfaces Checks if both references are null or refer to the same object. | |
| bool | operator< (const BaseReference &rRef) const |
| Needed by some STL containers. | |
Static Public Member Functions | |
| static SAL_WARN_UNUSED_RESULT Reference< interface_type > | query (const BaseReference &rRef) |
| Queries given interface reference for type interface_type. | |
| static SAL_WARN_UNUSED_RESULT Reference< interface_type > | query (XInterface *pInterface) |
| Queries given interface for type interface_type. | |
Additional Inherited Members | |
| Static Protected Member Functions inherited from com::sun::star::uno::BaseReference | |
| static XInterface * | iquery (XInterface *pInterface, const Type &rType) |
| Queries given interface for type rType. | |
| static XInterface * | iquery_throw (XInterface *pInterface, const Type &rType) |
| Queries given interface for type rType. | |
| Protected Attributes inherited from com::sun::star::uno::BaseReference | |
| XInterface * | _pInterface |
| the interface pointer | |
Template reference class for interface type derived from BaseReference.
A special constructor given the UNO_QUERY identifier queries interfaces for reference type.
|
inline |
Destructor: Releases interface if set.
|
inline |
Default Constructor: Sets null reference.
|
inline |
Copy constructor: Copies interface reference.
| rRef | another reference |
|
inline |
Constructor: Sets given interface pointer.
| pInterface | an interface pointer |
|
inline |
Constructor: Sets given interface pointer without acquiring it.
| pInterface | another reference |
| dummy | SAL_NO_ACQUIRE to force obvious distinction to other constructors |
|
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 |
|
inline |
Constructor: Queries given interface for reference interface type (interface_type).
| rRef | another reference |
| dummy | UNO_QUERY to force obvious distinction to other constructors |
|
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 |
|
inline |
Constructor: Queries given any for reference interface type (interface_type).
| rAny | an any |
| dummy | UNO_QUERY to force obvious distinction to other constructors |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |
|
inline |
|
inline |
Gets interface pointer.
This call does not acquire the interface.
|
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.
|
inline |
Indirection operator.
|
inline |
Dereference operator: Used to call interface methods.
|
inline |
Assignment operator: Acquires given interface reference and sets reference.
An interface already set will be released.
| rRef | an interface reference |
|
inline |
Assignment operator: Acquires given interface pointer and sets reference.
An interface already set will be released.
| pInterface | an interface pointer |
|
inlinestatic |
Queries given interface reference for type interface_type.
| rRef | interface reference |
|
inlinestatic |
Queries given interface for type interface_type.
| pInterface | interface pointer |
|
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 |
|
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 |
|
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 |
|
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 |
|
inline |
Sets the given interface.
An interface already set will be released.
| rRef | another reference |
|
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 |
|
inline |
Sets the given interface.
An interface already set will be released.
| pInterface | another interface |
|
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 |
|
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 |
|
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 |
|
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 |
|
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 |