DWFCore::IDWFOwnable Class Reference

#include "dwfcore/Pointer.h"

Inheritance diagram for DWFCore::IDWFOwnable:

Inheritance graph
[legend]
List of all members.

Detailed Description

Generalization for classes that can be owned by others.

Since:
1.5
This is the interface of DWFOwnable

Definition at line 116 of file Owner.h.

Public Member Functions

virtual _DWFCORE_API void own (DWFOwner &rOwner)=0 throw ( DWFException )
virtual _DWFCORE_API bool disown (DWFOwner &rOwner, bool bForget)=0 throw ( DWFException )
virtual _DWFCORE_API DWFOwnerowner ()=0 throw ( DWFException )
virtual _DWFCORE_API void observe (DWFOwner &rObserver)=0 throw ( DWFException )
virtual _DWFCORE_API bool unobserve (DWFOwner &rObserver)=0 throw ( DWFException )
virtual _DWFCORE_API ~IDWFOwnable () throw ()


Constructor & Destructor Documentation

virtual _DWFCORE_API DWFCore::IDWFOwnable::~IDWFOwnable  )  throw () [inline, virtual]
 

Destructor

Exceptions:
None 

Definition at line 181 of file Owner.h.


Member Function Documentation

virtual _DWFCORE_API bool DWFCore::IDWFOwnable::disown DWFOwner rOwner,
bool  bForget
throw ( DWFException ) [pure virtual]
 

Orphans this object.

Parameters:
rOwner The previous owner.
bForget if true, the previous owner will be removed from the internal observer list and not receive ownership change and object deletion notification callbacks; if false, the previous owner will continue to receive these notifications.
Exceptions:
DWFException 

Implemented in DWFCore::DWFOwnable.

virtual _DWFCORE_API void DWFCore::IDWFOwnable::observe DWFOwner rObserver  )  throw ( DWFException ) [pure virtual]
 

Informs that this object is being held onto by an "owner", but without claims of ownership.

Parameters:
rObserver The observing "owner".
Exceptions:
DWFException 
Since:
7.2

Implemented in DWFCore::DWFOwnable.

virtual _DWFCORE_API void DWFCore::IDWFOwnable::own DWFOwner rOwner  )  throw ( DWFException ) [pure virtual]
 

Claims ownership of this object.

Parameters:
rOwner The new owner.
Exceptions:
DWFException 

Implemented in DWFCore::DWFOwnable.

virtual _DWFCORE_API DWFOwner* DWFCore::IDWFOwnable::owner  )  throw ( DWFException ) [pure virtual]
 

Returns the current owner of this object.

Returns:
A pointer to the current owner or NULL if this object is an orphan.
Exceptions:
DWFException 

Implemented in DWFCore::DWFOwnable.

virtual _DWFCORE_API bool DWFCore::IDWFOwnable::unobserve DWFOwner rObserver  )  throw ( DWFException ) [pure virtual]
 

Informs that this object is no longer being observed in a non-owning manner.

Parameters:
rObserver The object that was observing.
Exceptions:
DWFException 
Since:
7.2

Implemented in DWFCore::DWFOwnable.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:39:38 2009 for Autodesk DWF Core Library by  doxygen 1.4.5