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 Reference


Reference
Reference();

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

Summary
Constructor...

Reference
Reference(
reference_type * pBody );

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

Summary
Constructor...

Reference
Reference(
const Reference< reference_type > & handle );

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

Summary
Copy constructor...

~Reference
~Reference();

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

Summary
Destructor...

set
Reference< reference_type > & set(
reference_type * pBody );

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

Summary
Set... Similar to assignment.

operator=
Reference< reference_type > & operator=(
const Reference< reference_type > & handle );

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

Description
Assignment. Unbinds this instance from its body (if bound) and bind it to the body represented by the handle.

operator=
Reference< reference_type > & operator=(
reference_type * pBody );

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

Summary
Assignment...

clear
Reference< reference_type > & clear();

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

Description
Unbind the body from this handle. Note that for a handle representing a large body, "handle.clear().set(new body());" _might_ perform a little bit better than "handle.set(new body());", since in the second case two large objects exist in memory (the old body and the new body).

get
reference_type * get();

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

Description
Get the body. Can be used instead of operator->(). I.e. handle->someBodyOp() and handle.get()->someBodyOp() are the same.

operator->
reference_type * operator->();

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

Summary
Probably most common used: handle->someBodyOp().

operator*
reference_type & operator*();

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

Summary
Allows (*handle).someBodyOp().

is
sal_Bool is();

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

Summary
Returns True if the handle does point to a valid body.

operator==
sal_Bool operator==(
const reference_type * pBody ) const;

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

Summary
Returns True if this points to pBody.

operator==
sal_Bool operator==(
const Reference< reference_type > & handle ) const;

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

Summary
Returns True if handle points to the same body.

operator!=
sal_Bool operator!=(
const Reference< reference_type > & handle ) const;

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

Summary
Needed to place References into STL collection.

operator<
sal_Bool operator<(
const Reference< reference_type > & handle ) const;

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

Summary
Needed to place References into STL collection.

operator>
sal_Bool operator>(
const Reference< reference_type > & handle ) const;

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

Summary
Needed to place References into STL collection.

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.