Ceylan::MVC::SingleViewModel Class Reference

Generic model class, linked to a given generic view (BaseView), which the model owns, and with no known specific controller. More...

#include <CeylanGenericModel.h>

Inheritance diagram for Ceylan::MVC::SingleViewModel:

Inheritance graph
[legend]
Collaboration diagram for Ceylan::MVC::SingleViewModel:

Collaboration graph
[legend]

List of all members.

Public Types

enum  TextOutputFormat { rawText, html }
 Defines what text output formats for TextDisplayable instances are available. More...

Public Member Functions

 SingleViewModel (const BaseView &view)
 Creates a new generic model, which will be linked to specified view, whose ownership is taken, and to no controller.
 SingleViewModel ()
 Creates a new generic model, which will be linked afterwards to a view and to no controller.
virtual ~SingleViewModel () throw ()
 Virtual destructor.
virtual void setView (const BaseView &view)
 Sets the unique view this model should have.
virtual void addView (const BaseView &view) const
 Sets the unique view this model should have.
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 Attributes

const BaseView_view
 The associated (unique, if any, and owned) view.

Static Protected Attributes

static TextOutputFormat _OutputFormat = rawText
 The text format to be used currently by TextDisplayable instances.

Private Member Functions

 SingleViewModel (const SingleViewModel &source)
 Copy constructor made private to ensure that it will never be called.
SingleViewModeloperator= (const SingleViewModel &source)
 Assignment operator made private to ensure that it will never be called.


Detailed Description

Generic model class, linked to a given generic view (BaseView), which the model owns, and with no known specific controller.

This generic model is linked to exactly one view, and knowing it is only useful to manage its lifecycle.

See also:
testCeylanGenericMVC.cc for examples.

Definition at line 626 of file CeylanGenericModel.h.


Member Enumeration Documentation

Defines what text output formats for TextDisplayable instances are available.

Enumerator:
rawText 
html 

Definition at line 124 of file CeylanTextDisplayable.h.


Constructor & Destructor Documentation

SingleViewModel::SingleViewModel ( 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 124 of file CeylanGenericModel.cc.

SingleViewModel::SingleViewModel (  ) 

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

Note:
Generally used because of the chicken-and-egg problem: on creation the view needs its model, so this view cannot be specified directly when creating this model.

Definition at line 132 of file CeylanGenericModel.cc.

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

Virtual destructor.

Note:
Any associated view will be removed.

Definition at line 140 of file CeylanGenericModel.cc.

References _view.

Ceylan::MVC::SingleViewModel::SingleViewModel ( const SingleViewModel 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 SingleViewModel::addView ( const BaseView view  )  const [virtual]

Sets the unique view this model should have.

If a view was already registered, it will be deallocated first.

Parameters:
view the view, whose ownership is taken.
Exceptions:
GenericMVCException if a view was already registered.
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).

The use of the setView method should be preferred, as its name is clearer than this inherited one.

Implements Ceylan::MVC::BaseModel.

Definition at line 164 of file CeylanGenericModel.cc.

References _view.

Referenced by setView().

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

SingleViewModel& Ceylan::MVC::SingleViewModel::operator= ( const SingleViewModel 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 SingleViewModel::setView ( const BaseView view  )  [virtual]

Sets the unique view this model should have.

If a view was already registered, it will be deallocated first.

Parameters:
view the view, whose ownership is taken.
Exceptions:
GenericMVCException if a view was already registered.
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).

Definition at line 155 of file CeylanGenericModel.cc.

References addView().

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 SingleViewModel::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 178 of file CeylanGenericModel.cc.

References _view, Ceylan::low, and Ceylan::MVC::BaseView::toString().


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

The associated (unique, if any, and owned) view.

Note:
A model should a priori never change its view(s), (the views are expected to retrieve information directly from their model), hence the const reference.

Definition at line 742 of file CeylanGenericModel.h.

Referenced by addView(), toString(), and ~SingleViewModel().


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

Generated on Thu Jun 4 20:40:38 2009 for Ceylan by  doxygen 1.5.8