Ceylan::Event Class Reference
Encapsulates the concept of high-level events. More...
#include <CeylanEvent.h>
Public Types | |
| enum | TextOutputFormat { rawText, html } |
| Defines what text output formats for TextDisplayable instances are available. More... | |
Public Member Functions | |
| Event (EventSource &source) | |
| All events should know where they come from. | |
| virtual | ~Event () throw () |
| Basic 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 | |
| Event (const Event &source) | |
| Copy constructor made private to ensure that it will never be called. | |
| Event & | operator= (const Event &source) |
| Assignment operator made private to ensure that it will never be called. | |
Detailed Description
Encapsulates the concept of high-level events.
- Note:
- In an event-driven system such as a graphical user interface (GUI), basic (raw) events might be too numerous to model them with this class, which is dedicated to higher-level, often user-centric, events. For example, instead of many 'mouse moved' basic events, an Event could be 'user pressed the quit button' or even 'user wants to quit'.
Definition at line 75 of file CeylanEvent.h.
Member Enumeration Documentation
enum Ceylan::TextDisplayable::TextOutputFormat [inherited] |
Defines what text output formats for TextDisplayable instances are available.
Definition at line 124 of file CeylanTextDisplayable.h.
Constructor & Destructor Documentation
| Event::Event | ( | EventSource & | source | ) | [explicit] |
All events should know where they come from.
- Note:
- Events have only breferences towards their source, of course they do not own it.
Definition at line 56 of file CeylanEvent.cc.
| Event::~Event | ( | ) | throw () [virtual] |
| Ceylan::Event::Event | ( | const Event & | 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().
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().
| 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] |
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 _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] |
The documentation for this class was generated from the following files:
