Ceylan::MVCEvent Class Reference

Specialized event exchanged through Model-View-Controller (MVC) framework. More...

#include <CeylanModel.h>

Inheritance diagram for Ceylan::MVCEvent:
Inheritance graph
[legend]
Collaboration diagram for Ceylan::MVCEvent:
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

 MVCEvent (EventSource &source)
 Source should be either a Controller or a Model.
virtual ~MVCEvent () 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.

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

EventSource_source
 The source of this event.

Static Protected Attributes

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

Private Member Functions

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

Detailed Description

Specialized event exchanged through Model-View-Controller (MVC) framework.

Note that the communication between the MVC components could also be performed thanks to direct method call, if no distributed operation is targeted.

See also:
also the generic alternative MVC framework, for more lightweight and flexible exchanges: Ceylan::BaseView, Ceylan::BaseModel and Ceylan::BaseController.

Definition at line 56 of file CeylanModel.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

MVCEvent::MVCEvent ( EventSource source  )  [explicit]

Source should be either a Controller or a Model.

Definition at line 53 of file CeylanModel.cc.

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

Virtual destructor.

Definition at line 60 of file CeylanModel.cc.

Ceylan::MVCEvent::MVCEvent ( const MVCEvent source  )  [private]

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

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


Member Function Documentation

TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat (  )  [static, inherited]
MVCEvent& Ceylan::MVCEvent::operator= ( const MVCEvent source  )  [private]

Assignment operator made private to ensure that it will be never 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().

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 Event::toString ( Ceylan::VerbosityLevels  level = Ceylan::high  )  const [virtual, inherited]

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

Implements Ceylan::TextDisplayable.

Definition at line 73 of file CeylanEvent.cc.

References Ceylan::Event::_source, and Ceylan::EventSource::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().

EventSource* Ceylan::Event::_source [protected, inherited]

The source of this event.

Definition at line 120 of file CeylanEvent.h.

Referenced by Ceylan::Event::toString().


The documentation for this class was generated from the following files:
Generated on Mon Nov 29 13:40:45 2010 for Ceylan by  doxygen 1.6.3