rtl::Reference< reference_type > Class Template Reference

Template reference class for reference type derived from IReference. More...

#include <ref.hxx>

List of all members.

Public Member Functions
	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.
Reference< reference_type > &	operator= (const Reference< reference_type > &handle)
	Assignment.
Reference< reference_type > &	operator= (reference_type *pBody)
	Assignment.
Reference< reference_type > &	clear ()
	Unbind the body from this handle.
reference_type *	get () const
	Get the body.
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.

---

Detailed Description

template<class reference_type>
class rtl::Reference< reference_type >

Template reference class for reference type derived from IReference.

---

Constructor & Destructor Documentation

template<class reference_type>

rtl::Reference< reference_type >::Reference

(

)

[inline]

Constructor.

..

template<class reference_type>

rtl::Reference< reference_type >::Reference

(

reference_type *

pBody

)

[inline]

Constructor.

..

template<class reference_type>

rtl::Reference< reference_type >::Reference

(

const Reference< reference_type > &

handle

)

[inline]

Copy constructor.

..

template<class reference_type>

rtl::Reference< reference_type >::~Reference

(

)

[inline]

Destructor.

..

---

Member Function Documentation

template<class reference_type>

Reference<reference_type>& rtl::Reference< reference_type >::clear

(

)

[inline]

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).

template<class reference_type>

reference_type* rtl::Reference< reference_type >::get

(

)

const [inline]

Get the body.

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

template<class reference_type>

sal_Bool rtl::Reference< reference_type >::is

(

)

const [inline]

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

template<class reference_type>

sal_Bool rtl::Reference< reference_type >::operator!=

(

const Reference< reference_type > &

handle

)

const [inline]

Needed to place References into STL collection.

template<class reference_type>

reference_type& rtl::Reference< reference_type >::operator*

(

)

const [inline]

Allows (*handle).someBodyOp().

template<class reference_type>

reference_type* rtl::Reference< reference_type >::operator->

(

)

const [inline]

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

template<class reference_type>

sal_Bool rtl::Reference< reference_type >::operator<

(

const Reference< reference_type > &

handle

)

const [inline]

Needed to place References into STL collection.

template<class reference_type>

Reference<reference_type>& rtl::Reference< reference_type >::operator=

(

reference_type *

pBody

)

[inline]

Assignment.

..

template<class reference_type>

Reference<reference_type>& rtl::Reference< reference_type >::operator=

(

const Reference< reference_type > &

handle

)

[inline]

Assignment.

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

template<class reference_type>

sal_Bool rtl::Reference< reference_type >::operator==

(

const Reference< reference_type > &

handle

)

const [inline]

Returns True if handle points to the same body.

template<class reference_type>

sal_Bool rtl::Reference< reference_type >::operator==

(

const reference_type *

pBody

)

const [inline]

Returns True if this points to pBody.

template<class reference_type>

sal_Bool rtl::Reference< reference_type >::operator>

(

const Reference< reference_type > &

handle

)

const [inline]

Needed to place References into STL collection.

template<class reference_type>

Reference<reference_type>& rtl::Reference< reference_type >::set

(

reference_type *

pBody

)

[inline]

Set.

.. Similar to assignment.

---

The documentation for this class was generated from the following file:

• rtl/ref.hxx