Ceylan::MVC::SingleModelGenericView< ActualModel > Class Template Reference

Generic view template, for views specifically linked to a given model, whose class is the typename. More...

#include <CeylanGenericView.h>

Inheritance diagram for Ceylan::MVC::SingleModelGenericView< ActualModel >:

Collaboration diagram for Ceylan::MVC::SingleModelGenericView< ActualModel >:

List of all members.

Public Types

enum TextOutputFormat { rawText, html }

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

Public Member Functions

SingleModelGenericView (const ActualModel &model)

Creates a new generic view, which will be linked to specified model.

virtual ~SingleModelGenericView () throw ()

Virtual destructor.

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

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

virtual void render ()=0

Requests that view to generate its interpretation of the model(s) it is linked to.

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 Attributes

const ActualModel * _model

The associated (unique) model.

Static Protected Attributes

static TextOutputFormat _OutputFormat = rawText

The text format to be used currently by TextDisplayable instances.

Private Member Functions

SingleModelGenericView (const SingleModelGenericView &source)

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

SingleModelGenericView & operator= (const SingleModelGenericView &source)

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

Detailed Description

template<typename ActualModel>
class Ceylan::MVC::SingleModelGenericView< ActualModel >

Generic view template, for views specifically linked to a given model, whose class is the typename.

This generic view is linked to exactly one model and is owned by that model.

Note:: No CEYLAN_DLL declaration for templates.

See also:: testCeylanGenericMVC.cc for an example of such implementation.

Definition at line 189 of file CeylanGenericView.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

template<typename ActualModel >

Ceylan::MVC::SingleModelGenericView< ActualModel >::SingleModelGenericView ( const ActualModel & model ) [inline, explicit]

Creates a new generic view, which will be linked to specified model.

Parameters:

model

the model that view will render.

Note:: This view will automatically registers to the model, which will take ownership of that view.

Definition at line 275 of file CeylanGenericView.h.

References Ceylan::MVC::SingleModelGenericView< ActualModel >::_model.

template<typename ActualModel >

Ceylan::MVC::SingleModelGenericView< ActualModel >::~SingleModelGenericView ( ) throw () [inline, virtual]

Virtual destructor.

Definition at line 287 of file CeylanGenericView.h.

template<typename ActualModel >

Ceylan::MVC::SingleModelGenericView< ActualModel >::SingleModelGenericView ( const SingleModelGenericView< ActualModel > & 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

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

template<typename ActualModel >

SingleModelGenericView& Ceylan::MVC::SingleModelGenericView< ActualModel >::operator= ( const SingleModelGenericView< ActualModel > & 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.

virtual void Ceylan::MVC::BaseView::render ( ) [pure virtual, inherited]

Requests that view to generate its interpretation of the model(s) it is linked to.

Note:: There is intentionally no throw specification.

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

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

template<typename ActualModel >

const std::string Ceylan::MVC::SingleModelGenericView< ActualModel >::toString ( Ceylan::VerbosityLevels level = Ceylan::high ) const [inline, 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::BaseView.

Definition at line 297 of file CeylanGenericView.h.

References Ceylan::MVC::SingleModelGenericView< ActualModel >::_model, and Ceylan::low.

Member Data Documentation

template<typename ActualModel >

const ActualModel* Ceylan::MVC::SingleModelGenericView< ActualModel >::_model [protected]

The associated (unique) model.

Definition at line 239 of file CeylanGenericView.h.

Referenced by Ceylan::MVC::SingleModelGenericView< ActualModel >::SingleModelGenericView(), and Ceylan::MVC::SingleModelGenericView< ActualModel >::toString().

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

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

CeylanGenericView.h


Public Types
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
Public Member Functions
	SingleModelGenericView (const ActualModel &model)
	Creates a new generic view, which will be linked to specified model.
virtual	~SingleModelGenericView () throw ()
	Virtual destructor.
virtual const std::string	toString (Ceylan::VerbosityLevels level=Ceylan::high) const
	Returns a user-friendly description of the state of this object.
virtual void	render ()=0
	Requests that view to generate its interpretation of the model(s) it is linked to.
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 Attributes
const ActualModel *	_model
	The associated (unique) model.
Static Protected Attributes
static TextOutputFormat	_OutputFormat = rawText
	The text format to be used currently by TextDisplayable instances.
Private Member Functions
	SingleModelGenericView (const SingleModelGenericView &source)
	Copy constructor made private to ensure that it will never be called.
SingleModelGenericView &	operator= (const SingleModelGenericView &source)
	Assignment operator made private to ensure that it will never be called.

Ceylan::MVC::SingleModelGenericView< ActualModel > Class Template Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

template<typename ActualModel> class Ceylan::MVC::SingleModelGenericView< ActualModel >

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename ActualModel>
class Ceylan::MVC::SingleModelGenericView< ActualModel >