Ceylan::MVC::MultipleViewModel Class Reference

Generic model class, for models specifically linked to multiple (i.e. More...

#include <CeylanGenericModel.h>

Inheritance diagram for Ceylan::MVC::MultipleViewModel:

Collaboration diagram for Ceylan::MVC::MultipleViewModel:

List of all members.

Public Types

enum TextOutputFormat { rawText, html }

Defines what text output formats for TextDisplayable instances are available. More...

Public Member Functions

MultipleViewModel (const BaseView &view)

Creates a new generic model, which will be linked to specified view, whose ownership is taken, and to no controller.

MultipleViewModel (const std::list< const BaseView * > &views)

Creates a new generic model, which will be linked to specified views, whose ownership is taken, and to no controller.

MultipleViewModel ()

Creates a new generic model, which will be linked afterwards to views, and to no controller.

virtual ~MultipleViewModel () throw ()

Virtual destructor.

virtual void setViews (const std::list< const BaseView * > &views)

Sets the list of views this model should be linked.

virtual void addView (const BaseView &view) const

Adds specified view to the already registered views.

virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const

Returns a user-friendly description of the state of this object.

Static Public Member Functions

static const std::string ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high)

Returns a user-friendly description of this list of pointers to text displayable instances.

static TextOutputFormat GetOutputFormat ()

Returns the current overall text format to be used by TextDisplayable instances.

static void SetOutputFormat (TextOutputFormat newOutputFormat)

Sets the current overall text format to be used by TextDisplayable instances.

Protected Member Functions

virtual void deleteViews ()

Deletes all referenced views.

Protected Attributes

std::list< const BaseView * > _views

The associated views.

Static Protected Attributes

static TextOutputFormat _OutputFormat = rawText

The text format to be used currently by TextDisplayable instances.

Private Member Functions

MultipleViewModel (const MultipleViewModel &source)

Copy constructor made private to ensure that it will never be called.

MultipleViewModel & operator= (const MultipleViewModel &source)

Assignment operator made private to ensure that it will never be called.

Detailed Description

Generic model class, for models specifically linked to multiple (i.e.

any number of) views, which the model owns, and with no known specific controller.

See also:: testCeylanGenericMVC.cc for examples.

Definition at line 1102 of file CeylanGenericModel.h.

Member Enumeration Documentation

enum Ceylan::TextDisplayable::TextOutputFormat [inherited]

Defines what text output formats for TextDisplayable instances are available.

Enumerator:

rawText
html

Definition at line 124 of file CeylanTextDisplayable.h.

Constructor & Destructor Documentation

MultipleViewModel::MultipleViewModel ( const BaseView & view ) [explicit]

Creates a new generic model, which will be linked to specified view, whose ownership is taken, and to no controller.

Note:: Generally cannot be used because of the chicken-and-egg problem: on creation the view needs its model, and this model needs its view, both cannot be satisfied.

Definition at line 215 of file CeylanGenericModel.cc.

References _views.

MultipleViewModel::MultipleViewModel ( const std::list< const BaseView * > & views ) [explicit]

Creates a new generic model, which will be linked to specified views, whose ownership is taken, and to no controller.

Note:: Generally cannot be used because of the chicken-and-egg problem: on creation the views need their model, and this model needs its views, both cannot be satisfied.

Definition at line 224 of file CeylanGenericModel.cc.

References _views.

MultipleViewModel::MultipleViewModel ( )

Creates a new generic model, which will be linked afterwards to views, and to no controller.

Note:: Generally used because of the chicken-and-egg problem: on creation the views need their model, so these views cannot be specified directly when creating this model.

Definition at line 234 of file CeylanGenericModel.cc.

MultipleViewModel::~MultipleViewModel ( ) throw () [virtual]

Virtual destructor.

Note:: All associated views will be removed.

Definition at line 241 of file CeylanGenericModel.cc.

References deleteViews().

Ceylan::MVC::MultipleViewModel::MultipleViewModel ( const MultipleViewModel & source ) [private]

Copy constructor made private to ensure that it will never be called.

The compiler should complain whenever this undefined constructor is called, implicitly or not.

Member Function Documentation

void MultipleViewModel::addView ( const BaseView & view ) const [virtual]

Adds specified view to the already registered views.

Parameters:

view

the view, whose ownership is taken.

Exceptions:

GenericMVCException

if the operation failed.

Note:: This is nevertheless a 'const' method, as adding a view is deemed not to change the state of the model itself; moreover if it was non-const, then views (which have const references to models) could not auto-register themselves to the models).

Implements Ceylan::MVC::BaseModel.

Definition at line 264 of file CeylanGenericModel.cc.

References _views.

void MultipleViewModel::deleteViews ( ) [protected, virtual]

Deletes all referenced views.

Definition at line 309 of file CeylanGenericModel.cc.

References _views.

Referenced by ~MultipleViewModel().

TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat ( ) [static, inherited]

Returns the current overall text format to be used by TextDisplayable instances.

Definition at line 63 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::formatStringList(), Ceylan::formatStringMap(), Ceylan::XML::XMLMarkup::toString(), Ceylan::Maths::Linear::Vector3::toString(), Ceylan::Maths::Linear::Vector2::toString(), Ceylan::Maths::Linear::Tripoint::toString(), Ceylan::Module::toString(), Ceylan::Maths::Linear::Matrix3::toString(), Ceylan::Maths::Linear::Matrix2::toString(), Ceylan::Maths::Linear::HomogeneousMatrix3::toString(), and Ceylan::Maths::Linear::Bipoint::toString().

MultipleViewModel& Ceylan::MVC::MultipleViewModel::operator= ( const MultipleViewModel & source ) [private]

Assignment operator made private to ensure that it will never be called.

The compiler should complain whenever this undefined operator is called, implicitly or not.

void TextDisplayable::SetOutputFormat ( TextOutputFormat newOutputFormat ) [static, inherited]

Sets the current overall text format to be used by TextDisplayable instances.

Parameters:

newOutputFormat

the new output format.

Definition at line 72 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::Log::LogHolder::LogHolder().

void MultipleViewModel::setViews ( const std::list< const BaseView * > & views ) [virtual]

Sets the list of views this model should be linked.

Parameters:

views

the list of views; the list is copied (ownership not taken), but the ownership of views is taken.

Exceptions:

GenericMVCException

if at least a view was already registered.

Definition at line 250 of file CeylanGenericModel.cc.

References _views.

const std::string TextDisplayable::ToString	(	std::list< TextDisplayable * >	displayables,
		Ceylan::VerbosityLevels	level = `Ceylan::high`
	)			`[static, inherited]`

Returns a user-friendly description of this list of pointers to text displayable instances.

Parameters:

	displayables	a list of pointers to TextDisplayable instances/
	level	the requested verbosity level.

Note:: Text output format is determined from overall settings.

See also:: toString, Ceylan::VerbosityLevels

Definition at line 45 of file CeylanTextDisplayable.cc.

References Ceylan::formatStringList().

const string MultipleViewModel::toString ( Ceylan::VerbosityLevels level = Ceylan::high ) const [virtual]

Returns a user-friendly description of the state of this object.

Parameters:

level

the requested verbosity level.

Note:: Text output format is determined from overall settings.

See also:: TextDisplayable

Reimplemented from Ceylan::MVC::BaseModel.

Definition at line 273 of file CeylanGenericModel.cc.

References _views, Ceylan::formatStringList(), and Ceylan::low.

Member Data Documentation

TextDisplayable::TextOutputFormat TextDisplayable::_OutputFormat = rawText [static, protected, inherited]

The text format to be used currently by TextDisplayable instances.

Note:: Defaults to raw text.

Definition at line 158 of file CeylanTextDisplayable.h.

Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().

std::list<const BaseView *> Ceylan::MVC::MultipleViewModel::_views [protected]

The associated views.

Definition at line 1221 of file CeylanGenericModel.h.

Referenced by addView(), deleteViews(), MultipleViewModel(), setViews(), and toString().

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


Public Types
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
Public Member Functions
	MultipleViewModel (const BaseView &view)
	Creates a new generic model, which will be linked to specified view, whose ownership is taken, and to no controller.
	MultipleViewModel (const std::list< const BaseView * > &views)
	Creates a new generic model, which will be linked to specified views, whose ownership is taken, and to no controller.
	MultipleViewModel ()
	Creates a new generic model, which will be linked afterwards to views, and to no controller.
virtual	~MultipleViewModel () throw ()
	Virtual destructor.
virtual void	setViews (const std::list< const BaseView * > &views)
	Sets the list of views this model should be linked.
virtual void	addView (const BaseView &view) const
	Adds specified view to the already registered views.
virtual const std::string	toString (Ceylan::VerbosityLevels level=Ceylan::high) const
	Returns a user-friendly description of the state of this object.
Static Public Member Functions
static const std::string	ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high)
	Returns a user-friendly description of this list of pointers to text displayable instances.
static TextOutputFormat	GetOutputFormat ()
	Returns the current overall text format to be used by TextDisplayable instances.
static void	SetOutputFormat (TextOutputFormat newOutputFormat)
	Sets the current overall text format to be used by TextDisplayable instances.
Protected Member Functions
virtual void	deleteViews ()
	Deletes all referenced views.
Protected Attributes
std::list< const BaseView * >	_views
	The associated views.
Static Protected Attributes
static TextOutputFormat	_OutputFormat = rawText
	The text format to be used currently by TextDisplayable instances.
Private Member Functions
	MultipleViewModel (const MultipleViewModel &source)
	Copy constructor made private to ensure that it will never be called.
MultipleViewModel &	operator= (const MultipleViewModel &source)
	Assignment operator made private to ensure that it will never be called.