class Help : public Action

(Return to index)

The HELP commands.

Type:	Instantiable
Superclasses:	public Action
Include file:	./BasicActions/Help.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • Help () ;
  • virtual ~Help () ;
  • virtual Help* clone (const string&) ;
  • virtual void execute () ;
  • virtual void parse (Statement&) ;
  • virtual bool canReplaceBy (Object*) ;
  • virtual const string getCategory ()const ;
  • virtual bool shouldTrace ()const ;
  • virtual bool shouldUpdate ()const ;
  • void copyAttributes (const Object&) ;
  • virtual void doomGet (const DoomReader&) ;
  • virtual void doomPut (DoomWriter&)const ;
  • virtual Attribute* findAttribute (const string&) ;
  • virtual const Attribute* findAttribute (const string&)const ;
  • virtual Object* makeTemplate (const string&,TokenStream&,Statement&) ;
  • virtual Object* makeInstance (const string&,Statement&) ;
  • virtual void parseShortcut (Statement&) ;
  • virtual void print (std::ostream&)const ;
  • virtual void printHelp (std::ostream&)const ;
  • virtual void replace (Object*,Object*) ;
  • virtual void update () ;
  • bool isBuiltin ()const ;
  • virtual bool isShared ()const ;
  • virtual void setShared (bool) ;
  • void setDirty (bool) ;
  • bool isDirty ()const ;
  • void setFlag (bool) ;
  • bool isFlagged ()const ;
  • void setDoomTime (double) ;
  • double getDoomTime ()const ;
  • const Object* getBaseObject ()const ;
  • const string& getMadName ()const ;
  • Object* getParent ()const ;
  • bool isTreeMember (const Object*)const ;
  • void setMadName (const string&) ;
  • void setParent (Object*) ;
  • void clear () ;
  • int increment () ;
  • int occurrenceCount () ;
  • void registerReference (AttributeBase*) ;
  • void unregisterReference (AttributeBase*) ;
  • std::vector<Attribute> itsAttr ;

Documentation:

• Public members:

  Help () ;

  Exemplar constructor.

  virtual Help* clone (const string&) ;

  Make clone.

  virtual void execute () ;

  Execute the command.

  virtual void parse (Statement&) ;

  Parse command (special for one-attribute command).