Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: rtl ::

template< typename reference_type >

class Reference


Base Classes
None.
Known Derived Classes
None.

virtual abstract interface template
NO NO NO YES
Summary
Template reference class for reference type derived from IReference.
File
ref.hxx

Public Members

Methods


Reference( );
Constructor...

Reference( reference_type * pBody );
Constructor...

Reference( const Reference< reference_type > & handle );
Copy constructor...

~Reference( );
Destructor...
Reference< reference_type > &
set( reference_type * pBody );
Set... Similar to assignment.
Reference< reference_type > &
operator=( const Reference< reference_type > & handle );
Reference< reference_type > &
operator=( reference_type * pBody );
Assignment...
Reference< reference_type > &
clear( );
reference_type *
get( ) const;
reference_type *
operator->( ) const;
Probably most common used: handle->someBodyOp().
reference_type &
operator*( ) const;
Allows (*handle).someBodyOp().
sal_Bool
is( ) const;
Returns True if the handle does point to a valid body.
sal_Bool
operator==( const reference_type * pBody ) const;
Returns True if this points to pBody.
sal_Bool
operator==( const Reference< reference_type > & handle ) const;
Returns True if handle points to the same body.
sal_Bool
operator!=( const Reference< reference_type > & handle ) const;
Needed to place References into STL collection.
sal_Bool
operator<( const Reference< reference_type > & handle ) const;
Needed to place References into STL collection.
sal_Bool
operator>( const Reference< reference_type > & handle ) const;
Needed to place References into STL collection.

Private Members

Data

reference_type * m_pBody; The <b>reference_type</b> body pointer.

Top of Page

Apache Software Foundation

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

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