TSE3::App::ChoiceHandler Class Reference

Choice save/load base class. More...

#include <Choices.h>

Inheritance diagram for TSE3::App::ChoiceHandler:

[legend]Collaboration diagram for TSE3::App::ChoiceHandler:

[legend]List of all members.

Public Member Functions
	ChoiceHandler (const std::string &choicename)
virtual	~ChoiceHandler ()
const std::string &	name () const
Protected Attributes
std::string	_name

---

Detailed Description

Choice save/load base class.

ChoiceHandlers are used by the object. You access the choices save/load mechanism through that object.

This is a base class for objects that can save a particular block of choices. ChoiceHandlers are registered with the ChoicesManager which delegates responsibility for saving/loading to each ChoiceHandler.

ChoiceHandlers implement the Serializable interface as the mechansim with which to perform saving, however they differ from the normal TSE3::Song hierarchy save method since the object whose state is being saved is not the TSE3::Serializable object - it is a ChoiceHandler based on it that does the saving.

A number of stock implementations of ChoiceHandler are provided to save the common TSE3 objects that are not directly related to a Song. However, an application will want to add many more ChoiceHandlers to save it's internal settings (e.g. window positions, feature statuses end so on).

Author:

Pete Goodliffe

Version:

1.00

See also:

ChoicesManager

---

Constructor & Destructor Documentation

TSE3::App::ChoiceHandler::ChoiceHandler (  const std::string &  choicename  )

Create a ChoiceHandler with the given name.

virtual TSE3::App::ChoiceHandler::~ChoiceHandler (   )  [virtual]

---

Member Function Documentation

const std::string& TSE3::App::ChoiceHandler::name (   )  const [inline]

Returns the name of this ChoiceHandler. This is a unique text string that will identify a block of data in the choices file as having been saved by this ChoiceHandler.

---

Member Data Documentation

std::string TSE3::App::ChoiceHandler::_name [protected]

---

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

• /home/pete/Work/TSE3.svn/tse3/src/tse3/app/Choices.h

---