Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Methods of Class BaseReference


get
XInterface * 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

is
sal_Bool is() throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Checks if reference is null.
Return
true if reference acquires an interface, i.e. true if it is not null

operator==
sal_Bool operator==(
XInterface * pInterface ) const throw();

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Equality operator: compares two interfaces Checks if both references are null or refer to the same object.
Parameters
rRef
another interface
Return
true if both references are null or refer to the same object, false otherwise

operator!=
sal_Bool operator!=(
XInterface * pInterface ) const throw();

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Unequality operator: compares two interfaces Checks if both references are null or refer to the same object.
Parameters
rRef
another interface
Return
false if both references are null or refer to the same object, true otherwise

operator==
sal_Bool operator==(
const BaseReference & rRef ) const throw();

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Equality operator: compares two interfaces Checks if both references are null or refer to the same object.
Parameters
rRef
another reference
Return
true if both references are null or refer to the same object, false otherwise

operator!=
sal_Bool operator!=(
const BaseReference & rRef ) const throw();

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Unequality operator: compares two interfaces Checks if both references are null or refer to the same object.
Parameters
rRef
another reference
Return
false if both references are null or refer to the same object, true otherwise

operator<
sal_Bool operator<(
const BaseReference & rRef ) const throw();

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Needed by some STL containers.
Parameters
rRef
another reference
Return
true, if this reference is less than rRef

iquery
static XInterface * iquery(
XInterface * pInterface,
const Type & rType )
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 rType.
Parameters
pInterface
interface pointer
rType
interface type
Return
interface of demanded type (may be null)

iquery_throw
static XInterface * iquery_throw(
XInterface * pInterface,
const Type & rType )
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 rType. Throws a RuntimeException if the demanded interface cannot be queried.
Parameters
pInterface
interface pointer
rType
interface type
Return
interface of demanded type

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.