AxResourceActivator Class Reference

This is a generic resource activator class that takes an AxResource object and queries the AxModule objects for a suitable activator object, which it then stores for use within Activate and other functions. More...

#include <ax_resource/ax_activator_resource.h>

Inheritance diagram for AxResourceActivator:

AxActivator AxAudioResourceActivator AxAudioResourceCommandActivator AxBookResourceActivator AxBookResourceCommandActivator List of all members.

Public Member Functions

 AxResourceActivator ()
 AxResourceActivator (const AxResourceActivator &activator)
 AxResourceActivator (AxResourceLibrary *library, AxResource *resource)
 ~AxResourceActivator ()
void Init ()
void Copy (const AxResourceActivator &activator)
virtual AxActivatorClone () const
virtual AxMenuActivate (AxMenuController *controller, AxMenuItem *item)
 Called when the user activates a menu item by pressing return or double-clicking.
virtual bool Reactivate (AxMenuController *controller, AxMenuItem *item)
 Called when a menu is reactivated, for example by going up.
virtual bool Select (AxMenuController *controller, AxMenuItem *item)
 Called when the user selects an item, for example to describe the item.
AxResourceGetResource () const
void SetResource (AxResource *resource)
AxResourceLibraryGetLibrary () const
void SetLibrary (AxResourceLibrary *library)
AxActivatorGetSpecificActivator () const
void SetSpecificActivator (AxActivator *activator)

Protected Attributes

AxResourceLibrarym_library
AxResourcem_resource
AxActivatorm_specificActivator

Detailed Description

This is a generic resource activator class that takes an AxResource object and queries the AxModule objects for a suitable activator object, which it then stores for use within Activate and other functions.

This saves the application code from doing the querying and creating an activator of the correct type.

It's also a useful base class for activators that need to store a pointer to a AxResource and the AxResourceLibrary.


Constructor & Destructor Documentation

AxResourceActivator::AxResourceActivator (  )  [inline]

AxResourceActivator::AxResourceActivator ( const AxResourceActivator activator  )  [inline]

AxResourceActivator::AxResourceActivator ( AxResourceLibrary library,
AxResource resource 
)

AxResourceActivator::~AxResourceActivator (  ) 


Member Function Documentation

void AxResourceActivator::Init (  ) 

Reimplemented from AxActivator.

Reimplemented in AxAudioResourceActivator, AxAudioResourceCommandActivator, AxBookResourceActivator, and AxBookResourceCommandActivator.

void AxResourceActivator::Copy ( const AxResourceActivator activator  ) 

virtual AxActivator* AxResourceActivator::Clone (  )  const [inline, virtual]

Implements AxActivator.

Reimplemented in AxAudioResourceActivator, AxAudioResourceCommandActivator, AxBookResourceActivator, and AxBookResourceCommandActivator.

AxMenu * AxResourceActivator::Activate ( AxMenuController controller,
AxMenuItem item 
) [virtual]

Called when the user activates a menu item by pressing return or double-clicking.

Implements AxActivator.

Reimplemented in AxAudioResourceActivator, AxAudioResourceCommandActivator, AxBookResourceActivator, and AxBookResourceCommandActivator.

bool AxResourceActivator::Reactivate ( AxMenuController controller,
AxMenuItem item 
) [virtual]

Called when a menu is reactivated, for example by going up.

This allows a view to be shown again, without generating all the menus.

Reimplemented in AxAudioResourceActivator, and AxBookResourceActivator.

bool AxResourceActivator::Select ( AxMenuController controller,
AxMenuItem item 
) [virtual]

Called when the user selects an item, for example to describe the item.

Reimplemented from AxActivator.

AxResource* AxResourceActivator::GetResource (  )  const [inline]

void AxResourceActivator::SetResource ( AxResource resource  )  [inline]

AxResourceLibrary* AxResourceActivator::GetLibrary (  )  const [inline]

void AxResourceActivator::SetLibrary ( AxResourceLibrary library  )  [inline]

AxActivator* AxResourceActivator::GetSpecificActivator (  )  const [inline]

void AxResourceActivator::SetSpecificActivator ( AxActivator activator  )  [inline]


Member Data Documentation

AxResourceLibrary* AxResourceActivator::m_library [protected]

AxResource* AxResourceActivator::m_resource [protected]

AxActivator* AxResourceActivator::m_specificActivator [protected]


The documentation for this class was generated from the following files:
Generated on Wed May 6 19:20:21 2009 for AxTk by  doxygen 1.5.1