Loading...
Searching...
No Matches
Antares::Action::Text< AutoExpandT > Class Template Reference
A dummy action, for displaying some text. More...
#include <text.h>
Inheritance diagram for Antares::Action::Text< AutoExpandT >:
Public Types | |
| using | Ptr = IAction::Ptr |
| The most suitable smart ptr for the class. | |
| using | ThreadingPolicy = IAction::ThreadingPolicy |
| The threading policy. | |
 Public Types inherited from Antares::Action::IAction | |
| using | AncestorType = Yuni::Core::TreeN<IAction> |
| The ancestor. | |
| using | Ptr = AncestorType::Ptr |
| The most suitable smart ptr for the class. | |
| using | ThreadingPolicy = AncestorType::ThreadingPolicy |
| The threading policy. | |
| using | Vector = std::vector<Ptr> |
| Vector. | |
| using | iterator = AncestorType::iterator |
| iterator | |
Constructor & Destructor | |
| template<class StringT > | |
| Text (const StringT &text) | |
| Default constructor. | |
| virtual | ~Text () |
| Destructor. | |
| virtual bool | bold () const |
| Get if the action should be represented with a bold font. | |
| virtual bool | autoExpand () const |
| Auto-expand. | |
| virtual bool | canDoSomething () const |
| virtual bool | prepareWL (Context &ctx) |
| Prepare the execution. | |
| virtual bool | performWL (Context &ctx) |
| Perform the action. | |
Additional Inherited Members | |
| Public Member Functions inherited from Antares::Action::IAction | |
| IAction () | |
| Default constructor. | |
| virtual | ~IAction () |
| Destructor. | |
| Yuni::String | caption () const |
| Get the caption of the action. | |
| Yuni::String | message () const |
| Get the message of the action. | |
| bool | prepare (Context &ctx) |
| Make preparations for the execution. | |
| void | registerViews (Context &ctx) |
| Register if possible the action into the appropriate view. | |
| void | datagridCaption (Yuni::String &title) |
| bool | prepareRootNode (Context &ctx) |
| Look for the root node and make preparations for the execution. | |
| bool | perform (Context &ctx, bool recursive=true) |
| Perform the action. | |
| void | dump () const |
| Dump the tree from this node to the stdcout. | |
| virtual bool | allowUpdate () const |
| virtual bool | allowSkip () const |
| virtual bool | allowOverwrite () const |
| virtual bool | shouldPrepareRootNode () const |
| virtual bool | visible () const |
| Get if the action should be visible to the user. | |
| Behavior | behavior () const |
| Get the behavior. | |
| void | behavior (Behavior newBehavior) |
| Set the behavior. | |
| bool | prepareStack (Vector &vector) |
| Prepare the whole list of actions to execute in the given order. | |
| State | state () const |
| virtual void | behaviorToText (Behavior behavior, Yuni::String &out) |
| void | createPostActions (const IAction::Ptr &node) |
| Create post actions if required. | |
| Protected Member Functions inherited from Antares::Action::IAction | |
| virtual void | prepareSkipWL (Context &) |
| Prepare the execution (when the behavior says that the action should be skipped) | |
| virtual void | registerViewsWL (Context &) |
| Register all views. | |
| virtual void | createPostActionsWL (const IAction::Ptr &node) |
| Create post actions (if any) | |
| Protected Attributes inherited from Antares::Action::IAction | |
| ActionInformations | pInfos |
| All data related to the action. | |
Detailed Description
template<bool AutoExpandT = true>
class Antares::Action::Text< AutoExpandT >
class Antares::Action::Text< AutoExpandT >
A dummy action, for displaying some text.
Member Function Documentation
◆ autoExpand()
template<bool AutoExpandT>
|
inlinevirtual |
Auto-expand.
Reimplemented from Antares::Action::IAction.
◆ bold()
template<bool AutoExpandT>
|
inlinevirtual |
Get if the action should be represented with a bold font.
Reimplemented from Antares::Action::IAction.
◆ canDoSomething()
template<bool AutoExpandT>
|
inlinevirtual |
Reimplemented from Antares::Action::IAction.
◆ performWL()
template<bool AutoExpandT>
|
inlineprotectedvirtual |
Perform the action.
Implements Antares::Action::IAction.
◆ prepareWL()
template<bool AutoExpandT>
|
inlineprotectedvirtual |
Prepare the execution.
Implements Antares::Action::IAction.
The documentation for this class was generated from the following files:
