#include <Help.h>
Inheritance diagram for Help:
Collaboration diagram for Help:
Public Member Functions | |
| Help () | |
| Exemplar constructor. More... | |
| virtual | ~Help () |
| virtual Help * | clone (const std::string &name) |
| Make clone. More... | |
| virtual void | execute () |
| Execute the command. More... | |
| virtual void | parse (Statement &) |
| Parse command (special for one-attribute command). More... | |
 Public Member Functions inherited from Action | |
| virtual | ~Action () |
| virtual bool | canReplaceBy (Object *object) |
| Test if replacement is allowed. More... | |
| virtual const std::string | getCategory () const |
| Return the object category as a string. More... | |
| virtual bool | shouldTrace () const |
| Trace flag. More... | |
| virtual bool | shouldUpdate () const |
| Update flag. More... | |
| Public Member Functions inherited from Object | |
| virtual | ~Object () |
| virtual bool | canReplaceBy (Object *object) |
| Test if replacement is allowed. More... | |
| virtual Object * | clone (const std::string &name)=0 |
| Return a clone. More... | |
| void | copyAttributes (const Object &) |
| Copy attributes from another object. More... | |
| virtual void | execute () |
| Execute the command. More... | |
| virtual Attribute * | findAttribute (const std::string &name) |
| Find an attribute by name. More... | |
| virtual const Attribute * | findAttribute (const std::string &name) const |
| Find an attribute by name. More... | |
| virtual const std::string | getCategory () const =0 |
| Return the object category as a string. More... | |
| virtual bool | shouldTrace () const =0 |
| Trace flag. More... | |
| virtual bool | shouldUpdate () const =0 |
| Update flag. More... | |
| virtual Object * | makeTemplate (const std::string &, TokenStream &, Statement &) |
| Macro handler function. More... | |
| virtual Object * | makeInstance (const std::string &name, Statement &, const Parser *) |
| Macro handler function. More... | |
| virtual void | parse (Statement &) |
| Parse the object. More... | |
| virtual void | parseShortcut (Statement &, bool eval=true) |
| Parser for single-attribute commands. More... | |
| virtual void | print (std::ostream &) const |
| Print the object. More... | |
| virtual void | printValue (std::ostream &) const |
| virtual void | printHelp (std::ostream &) const |
| Print help. More... | |
| virtual void | replace (Object *oldObject, Object *newObject) |
| Replace references. More... | |
| virtual void | update () |
| Update this object. More... | |
| bool | isBuiltin () const |
| True, if [b]this[/b] is a built-in object. More... | |
| virtual bool | isShared () const |
| Shared flag. More... | |
| virtual void | setShared (bool) |
| Set/reset shared flag. More... | |
| void | setDirty (bool) |
| Set/reset the [b]modified[/b] flag. More... | |
| bool | isDirty () const |
| True, if the [b]modified[/b] flag is set. More... | |
| void | setFlag (bool) |
| Flag/unflag this object, e. g. to control output of objects for. More... | |
| bool | isFlagged () const |
| True, if [b]this[/b] is flagged by setFlag(true). More... | |
| const Object * | getBaseObject () const |
| Return the object's base type object. More... | |
| const std::string & | getOpalName () const |
| Return object name. More... | |
| Object * | getParent () const |
| Return parent pointer. More... | |
| bool | isTreeMember (const Object *subTree) const |
| Test for tree membership. More... | |
| void | setOpalName (const std::string &name) |
| Set object name. More... | |
| void | setParent (Object *) |
| Set parent object. More... | |
| void | clear () |
| Clear the occurrence counter. More... | |
| int | increment () |
| Increment and return the occurrence counter. More... | |
| int | occurrenceCount () |
| Return the occurrence counter. More... | |
| void | registerReference (Invalidator *a) |
| Register a reference to this object. More... | |
| void | unregisterReference (Invalidator *a) |
| Unegister a reference to this object. More... | |
| void | registerOwnership (const AttributeHandler::OwnerType &itsClass) const |
| Public Member Functions inherited from RCObject | |
| int | addReference () const |
| Increment reference count. More... | |
| int | removeReference () const |
| Decrement the reference count. More... | |
| bool | isShared () const |
| Test for sharing. More... | |
Private Member Functions | |
| Help (const Help &) | |
| void | operator= (const Help &) |
| Help (const std::string &name, Help *parent) | |
Additional Inherited Members | |
| Public Attributes inherited from Object | |
| std::vector< Attribute > | itsAttr |
| The object attributes. More... | |
| Protected Member Functions inherited from Action | |
| Action (int size, const char *name, const char *help) | |
| Constructor for exemplars. More... | |
| Action (const std::string &name, Action *parent) | |
| Constructor for cloning. More... | |
| Protected Member Functions inherited from Object | |
| Object (int size, const char *name, const char *help) | |
| Constructor for exemplars. More... | |
| Object (const std::string &name, Object *parent) | |
| Constructor for clones. More... | |
| Protected Member Functions inherited from RCObject | |
| RCObject () | |
| Default constructor. More... | |
| RCObject (const RCObject &) | |
| Copy constructor. More... | |
| virtual | ~RCObject ()=0 |
| RCObject & | operator= (const RCObject &right) |
| Protected Attributes inherited from Object | |
| bool | builtin |
| Built-in flag. More... | |
| bool | modified |
| Dirty flag. More... | |
| bool | flagged |
| Object flag. More... | |
Detailed Description
Constructor & Destructor Documentation
◆ Help() [1/3]
| Help::Help | ( | ) |
Exemplar constructor.
Definition at line 28 of file Help.cpp.
References Object::itsAttr, Attributes::makeString(), Object::registerOwnership(), and AttributeHandler::STATEMENT.
Referenced by clone().
Here is the call graph for this function:
◆ ~Help()
◆ Help() [2/3]
|
private |
◆ Help() [3/3]
|
private |
Member Function Documentation
◆ clone()
|
virtual |
◆ execute()
|
virtual |
Execute the command.
Reimplemented from Object.
Definition at line 53 of file Help.cpp.
References endl(), ERRORMSG, Expressions::find(), OpalData::getInstance(), Attributes::getString(), Object::itsAttr, name, and Object::printHelp().
Here is the call graph for this function:
◆ operator=()
|
private |
◆ parse()
|
virtual |
Parse command (special for one-attribute command).
Reimplemented from Object.
Definition at line 69 of file Help.cpp.
References Object::parseShortcut().
Here is the call graph for this function:
The documentation for this class was generated from the following files:
