Methods of Class Reference
-
~Reference
- ~Reference() throw();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Destructor: Releases interface if set.
-
Reference
- Reference() throw();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Default Constructor: Sets null reference.
-
Reference
- Reference(
const Reference< interface_type > & |
rRef ) throw(); |
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Copy constructor: Copies interface reference.
- Parameters
-
-
Reference
- Reference(
interface_type * |
pInterface ) throw(); |
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Constructor: Sets given interface pointer.
- Parameters
pInterface |
an interface pointer
|
-
Reference
- Reference(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Constructor: Sets given interface pointer without acquiring it.
- Parameters
pInterface |
another reference
|
dummy |
SAL_NO_ACQUIRE to force obvious distinction to other constructors
|
-
Reference
- Reference(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- D E P R E C A T E D
- Summary
- Constructor: Sets given interface pointer without acquiring it.
Deprecated, please use SAL_NO_ACQUIRE version.
- Parameters
pInterface |
another reference
|
dummy |
UNO_REF_NO_ACQUIRE to force obvious distinction to other constructors
|
-
Reference
- Reference(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Constructor: Queries given interface for reference interface type (interface_type).
- Parameters
rRef |
another reference
|
dummy |
UNO_QUERY or UNO_REF_QUERY to force obvious distinction to other constructors
|
-
Reference
- Reference(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Constructor: Queries given interface for reference interface type (interface_type).
- Parameters
pInterface |
an interface pointer
|
dummy |
UNO_QUERY to force obvious distinction to other constructors
|
-
Reference
- Reference(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Constructor: Queries given any for reference interface type (interface_type).
- Parameters
rAny |
an any
|
dummy |
UNO_QUERY to force obvious distinction to other constructors
|
-
operator const Reference< XInterface > &
- operator const Reference< XInterface > &() throw();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Description
- 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.
-
operator->
- interface_type * operator->() throw();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Dereference operator: Used to call interface methods.
- Return
- UNacquired interface pointer
-
get
- interface_type * get() throw();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Gets interface pointer. This call does not acquire the interface.
- Return
- UNacquired interface pointer
-
clear
- void clear() throw();
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Clears reference, i.e. releases interface. Reference is null after clear() call.
-
set
- sal_Bool set(
const Reference< interface_type > & |
rRef ) throw(); |
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Sets the given interface. An interface already set will be released.
- Parameters
-
- Return
- true, if non-null interface was set
-
set
- sal_Bool set(
interface_type * |
pInterface ) throw(); |
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Sets the given interface. An interface already set will be released.
- Parameters
pInterface |
another interface
|
- Return
- true, if non-null interface was set
-
set
- sal_Bool set(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Sets interface pointer without acquiring it. An interface already set will be released.
- Parameters
pInterface |
an interface pointer
|
- Return
- true, if non-null interface was set
-
set
- sal_Bool set(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- D E P R E C A T E D
- Summary
- Sets interface pointer without acquiring it. An interface already set will be released.
Deprecated, please use SAL_NO_ACQUIRE version.
- Parameters
pInterface |
an interface pointer
|
- Return
- true, if non-null interface was set
-
set
- sal_Bool set(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Queries given interface for reference interface type (interface_type) and sets it.
An interface already set will be released.
- Parameters
pInterface |
an interface pointer
|
- Return
- true, if non-null interface was set
-
set
- sal_Bool set(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Queries given interface for reference interface type (interface_type) and sets it.
An interface already set will be released.
- Parameters
-
- Return
- true, if non-null interface was set
-
operator=
- Reference< interface_type > & operator=(
interface_type * |
pInterface ) throw(); |
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Assignment operator: Acquires given interface pointer and sets reference.
An interface already set will be released.
- Parameters
pInterface |
an interface pointer
|
- Return
- this reference
-
operator=
- Reference< interface_type > & operator=(
const Reference< interface_type > & |
rRef ) throw(); |
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
NO |
- Summary
- Assignment operator: Acquires given interface reference and sets reference.
An interface already set will be released.
- Parameters
rRef |
an interface reference
|
- Return
- this reference
-
__query
- static interface_type * __query(
XInterface * |
pInterface ) |
| throw( RuntimeException ); |
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
YES |
YES |
NO |
- Summary
- Queries given interface reference for type interface_type.
- Parameters
pInterface |
interface pointer
|
- Return
- interface of demanded type (may be null)
-
query
- static Reference< interface_type > query(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
YES |
YES |
NO |
- Summary
- Queries given interface reference for type interface_type.
- Parameters
-
- Return
- interface reference of demanded type (may be null)
-
query
- static Reference< interface_type > query(
XInterface * |
pInterface ) |
| throw( RuntimeException ); |
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
YES |
YES |
NO |
- Summary
- Queries given interface for type interface_type.
- Parameters
pInterface |
interface pointer
|
- Return
- interface reference of demanded type (may be null)
Top of Page
Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.