Ceylan::XML::XMLElement Class Reference
Describes an abstract XML element in a XML document. More...
#include <CeylanXMLElement.h>
Public Types | |
| enum | TextOutputFormat { rawText, html } |
| Defines what text output formats for TextDisplayable instances are available. More... | |
Public Member Functions | |
| XMLElement () | |
| Creates an empty XML element. | |
| virtual | ~XMLElement () throw () |
| Virtual destructor. | |
| virtual void | saveTo (System::OutputStream &output) const =0 |
| Saves the instance state to specified stream. | |
| virtual const std::string | toString (Ceylan::VerbosityLevels level=Ceylan::high) const =0 |
| Returns an user-friendly description of the state of this object. | |
| virtual void | loadFrom (System::InputStream &input)=0 |
| Loads a new instance state from specified stream. | |
| virtual void | accept (Visitor &visitor)=0 |
| Allows given visitor to visit this object, thanks to a callback: 'visitor.visit( *this ) ;'. | |
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. | |
Static Protected Attributes | |
| static TextOutputFormat | _OutputFormat = rawText |
| The text format to be used currently by TextDisplayable instances. | |
Private Member Functions | |
| XMLElement (const XMLElement &source) | |
| Copy constructor made private to ensure that it will never be called. | |
| XMLElement & | operator= (const XMLElement &source) |
| Assignment operator made private to ensure that it will never be called. | |
Detailed Description
Describes an abstract XML element in a XML document.XML elements can be markups, text, binary content, etc.
Definition at line 77 of file CeylanXMLElement.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
| XMLElement::XMLElement | ( | ) |
| XMLElement::~XMLElement | ( | ) | throw () [virtual] |
| Ceylan::XML::XMLElement::XMLElement | ( | const XMLElement & | 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.
- Note:
- Made to avoid unwanted hidden clone of the Singleton.
Member Function Documentation
| virtual void Ceylan::Visitable::accept | ( | Visitor & | visitor | ) | [pure virtual, inherited] |
Allows given visitor to visit this object, thanks to a callback: 'visitor.visit( *this ) ;'.
- Exceptions:
-
VisitException if the visit failed.
- Note:
- This method cannot be implemented here, as the visitor must declare its 'visit' method which must accept a specific datatype, not a generic one such as Visitable. Otherwise, there would be ambiguous calls.
Implemented in Ceylan::Tree< Content >, Ceylan::XML::XMLMarkup, and Ceylan::XML::XMLText.
| 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().
| virtual void Ceylan::Serializable::loadFrom | ( | System::InputStream & | input | ) | [pure virtual, inherited] |
Loads a new instance state from specified stream.
- Parameters:
-
input the input stream from which the state will be read.
- Exceptions:
-
SerializationException if the operation failed.
Implemented in Ceylan::XML::XMLMarkup, and Ceylan::XML::XMLText.
| XMLElement& Ceylan::XML::XMLElement::operator= | ( | const XMLElement & | 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::XML::XMLElement::saveTo | ( | System::OutputStream & | output | ) | const [pure virtual] |
Saves the instance state to specified stream.
- Parameters:
-
output the output stream to which the state will be written.
- Exceptions:
-
SerializationException if the operation failed.
Implements Ceylan::Serializable.
Implemented in Ceylan::XML::XMLMarkup, and Ceylan::XML::XMLText.
| 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().
| virtual const std::string Ceylan::TextDisplayable::toString | ( | Ceylan::VerbosityLevels | level = Ceylan::high |
) | const [pure virtual, inherited] |
Returns an 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
Implemented in Ceylan::BasicResourceManager< Key >, Ceylan::CountedPointer< T >, Ceylan::Exception, Ceylan::Functor, Ceylan::LibtoolVersion, Ceylan::LocalizationSettings, Ceylan::Resource, Ceylan::ResourceManager< Key >, Ceylan::SmartResource, Ceylan::SmartResourceManager< Key >, Ceylan::TextBuffer, Ceylan::Timestamp, Ceylan::UnicodeString, Ceylan::Version, Ceylan::CallableEventSource, Ceylan::CallerEventListener, Ceylan::Controller, Ceylan::Event, Ceylan::EventListener, Ceylan::EventSource, Ceylan::MVC::BaseController, Ceylan::MVC::BaseModel, Ceylan::MVC::NoViewModel, Ceylan::MVC::SingleViewGenericModel< ActualView >, Ceylan::MVC::SingleViewModel, Ceylan::MVC::MultipleViewGenericModel< ActualView >, Ceylan::MVC::MultipleViewModel, Ceylan::MVC::SingleControllerNoViewGenericModel< ActualController >, Ceylan::MVC::BaseView, Ceylan::MVC::SingleModelGenericView< ActualModel >, Ceylan::Hashable, Ceylan::Identifier, Ceylan::IdentifierOwner, Ceylan::InputDevice, Ceylan::Locatable, Ceylan::Locatable2D, Ceylan::Lockable, Ceylan::Measurable, Ceylan::Model, Ceylan::Object, Ceylan::Log::ObjectChannel, Ceylan::Log::ObjectIdentifier, Ceylan::TextIdentifier, Ceylan::View, Ceylan::Visitor, Ceylan::Log::LogAggregator, Ceylan::Log::LogAggregatorConsole, Ceylan::Log::LogAggregatorHTML, Ceylan::Log::LogAggregatorRaw, Ceylan::Log::LogChannel, Ceylan::Log::LogHolder, Ceylan::Log::LogListener, Ceylan::Log::LogMessage, Ceylan::Log::LogSource, Ceylan::Log::LogTransport, Ceylan::Log::LogTransportListenerRaw, Ceylan::Log::MuteLogSource, Ceylan::Maths::Linear::Bipoint, Ceylan::Maths::Linear::Endomorphism2DFunctor, Ceylan::Maths::Linear::Rotation2DFunctor, Ceylan::Maths::Linear::Endomorphism3DFunctor, Ceylan::Maths::Linear::LineProjection3DFunctor, Ceylan::Maths::Linear::Rotation3DFunctor, Ceylan::Maths::Linear::HomogeneousMatrix3, Ceylan::Maths::IntToIntFunctor, Ceylan::Maths::Linear::Matrix, Ceylan::Maths::Linear::Matrix2, Ceylan::Maths::Linear::Matrix3, Ceylan::Maths::Random::NormalProbabilityFunction, Ceylan::Maths::Linear::Point, Ceylan::Maths::Random::ProbabilityFunction, Ceylan::Maths::Random::RandomGenerator, Ceylan::Maths::Random::RandomGeneratorFromPDF, Ceylan::Maths::Linear::Tripoint, Ceylan::Maths::Linear::Vector, Ceylan::Maths::Linear::Vector2, Ceylan::Maths::Linear::Vector3, Ceylan::Maths::Random::WhiteNoiseGenerator, Ceylan::Middleware::LightWeightMarshaller, Ceylan::Middleware::Marshaller, Ceylan::Middleware::ProtocolEndpoint, Ceylan::Middleware::ProtocolServer, Ceylan::Module, Ceylan::Plugin, Ceylan::XML::XMLMarkup, Ceylan::XML::XMLText, Ceylan::XML::XMLParser, Ceylan::XML::XMLVisitor, Ceylan::XML::XMLSavingVisitor, Ceylan::XML::XMLSearchingVisitor, Ceylan::Network::AnonymousProtocolAwareStreamSocket, Ceylan::Network::AnonymousStreamSocket, Ceylan::Network::ClientStreamSocket, Ceylan::Network::IPAddress, Ceylan::Network::IPAddressvFour, Ceylan::Network::MultiplexedProtocolBasedStreamServer, Ceylan::Network::MultiplexedServerStreamSocket, Ceylan::Network::HostDNSEntry, Ceylan::Network::SequentialServerStreamSocket, Ceylan::Network::ServerStreamSocket, Ceylan::Network::Socket, Ceylan::Network::StreamSocket, Ceylan::System::AnonymousInputOutputStream, Ceylan::System::AnonymousInputStream, Ceylan::System::Console, Ceylan::System::Directory, Ceylan::System::FIFO, Ceylan::System::File, Ceylan::System::FileLocator, Ceylan::System::FileSystemManager, Ceylan::System::InputOutputStream, Ceylan::System::InputStream, Ceylan::System::LibfatDirectory, Ceylan::System::LibfatFile, Ceylan::System::LibfatFileSystemManager, Ceylan::System::MemoryStream, Ceylan::System::Mutex, Ceylan::System::OutputStream, Ceylan::System::Process, Ceylan::System::Runnable, Ceylan::System::StandardDirectory, Ceylan::System::StandardFile, Ceylan::System::StandardFileSystemManager, Ceylan::System::Stream, Ceylan::System::Thread, and Ceylan::ResourceManager< Key >.
Referenced by operator<<().
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 documentation for this class was generated from the following files:
