AeonGUI
A portable video game graphic user interface library.
Loading...
Searching...
No Matches
AeonGUI::DOM::Text Class Reference

Represents a DOM Text node. More...

#include <aeongui/dom/Text.hpp>

Inheritance diagram for AeonGUI::DOM::Text:
[legend]
Collaboration diagram for AeonGUI::DOM::Text:
[legend]

Public Member Functions

 Text (const std::string &aText, Node *aParent)
 Construct a Text node.
 ~Text () final
 Destructor.
NodeType nodeType () const final
 Get the node type (always TEXT_NODE).
std::string wholeText () const
 Get the concatenated text of this and adjacent text nodes.
Public Member Functions inherited from AeonGUI::DOM::Node
 Node (Node *aParent=nullptr)
 Construct a node with an optional parent.
NodeAddNode (std::unique_ptr< Node > aNode)
 Add a child node.
std::unique_ptr< NodeRemoveNode (const Node *aNode)
 Remove a child node.
void TraverseDepthFirstPreOrder (const std::function< void(Node &) > &aAction)
 Traverse the tree depth-first in pre-order.
void TraverseDepthFirstPreOrder (const std::function< void(const Node &) > &aAction) const
 Traverse the tree depth-first in pre-order (const).
void TraverseDepthFirstPostOrder (const std::function< void(Node &) > &aAction)
 Traverse the tree depth-first in post-order.
void TraverseDepthFirstPostOrder (const std::function< void(const Node &) > &aAction) const
 Traverse the tree depth-first in post-order (const).
void TraverseDepthFirstPreOrder (const std::function< void(Node &) > &aPreamble, const std::function< void(Node &) > &aPostamble)
 Traverse pre-order with separate pre and post callbacks.
void TraverseDepthFirstPreOrder (const std::function< void(const Node &) > &aPreamble, const std::function< void(const Node &) > &aPostamble) const
 Traverse pre-order with pre/post callbacks (const).
void TraverseDepthFirstPreOrder (const std::function< void(Node &) > &aPreamble, const std::function< void(Node &) > &aPostamble, const std::function< bool(Node &) > &aUnaryPredicate)
 Traverse pre-order with pre/post callbacks and a predicate filter.
void TraverseDepthFirstPreOrder (const std::function< void(const Node &) > &aPreamble, const std::function< void(const Node &) > &aPostamble, const std::function< bool(const Node &) > &aUnaryPredicate) const
 Traverse pre-order with pre/post callbacks and predicate (const).
virtual void DrawStart (Canvas &aCanvas) const
 Begin drawing this node on the canvas.
virtual void DrawFinish (Canvas &aCanvas) const
 Finish drawing this node on the canvas.
virtual void OnLoad ()
virtual void OnUnload ()
virtual bool IsDrawEnabled () const
NodeparentNode () const
 Get the parent node.
NodeparentElement () const
 Get the parent element (same as parentNode for elements).
const std::vector< std::unique_ptr< Node > > & childNodes () const
 Get the list of child nodes.
Public Member Functions inherited from AeonGUI::DOM::EventTarget
virtual ~EventTarget ()=0
 Virtual destructor.
void addEventListener (const DOMString &type, EventListener *callback, const std::variant< std::monostate, AddEventListenerOptions, bool > &options={})
 Register an event listener.
void removeEventListener (const DOMString &type, EventListener *callback, const std::variant< std::monostate, EventListenerOptions, bool > &options={})
 Unregister an event listener.
virtual bool dispatchEvent (Event &event)
 Dispatch an event to this target.

Additional Inherited Members

Public Types inherited from AeonGUI::DOM::Node
enum  NodeType {
  ELEMENT_NODE = 1 , ATTRIBUTE_NODE = 2 , TEXT_NODE = 3 , CDATA_SECTION_NODE = 4 ,
  ENTITY_REFERENCE_NODE = 5 , ENTITY_NODE = 6 , PROCESSING_INSTRUCTION_NODE = 7 , COMMENT_NODE = 8 ,
  DOCUMENT_NODE = 9 , DOCUMENT_TYPE_NODE = 10 , DOCUMENT_FRAGMENT_NODE = 11 , NOTATION_NODE = 12
}
 DOM node type constants. More...

Detailed Description

Represents a DOM Text node.

Contains character data as a child of an Element.

Constructor & Destructor Documentation

◆ Text()

AeonGUI::DOM::Text::Text ( const std::string & aText,
Node * aParent )

Construct a Text node.

Parameters
aTextThe text content.
aParentThe parent node.

Member Function Documentation

◆ nodeType()

Node::NodeType AeonGUI::DOM::Text::nodeType ( ) const
finalvirtual

Get the node type (always TEXT_NODE).

DOM Properties and Methods

Returns
NodeType::TEXT_NODE.

Implements AeonGUI::DOM::Node.

◆ wholeText()

std::string AeonGUI::DOM::Text::wholeText ( ) const

Get the concatenated text of this and adjacent text nodes.

Returns
The whole text content.

The documentation for this class was generated from the following files:
  • include/aeongui/dom/Text.hpp
  • core/dom/Text.cpp