Frobby  0.9.0
HelpAction.h
Go to the documentation of this file.
1 /* Frobby: Software for monomial ideal computations.
2  Copyright (C) 2007 Bjarke Hammersholt Roune (www.broune.com)
3 
4  This program is free software; you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or
7  (at your option) any later version.
8 
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with this program. If not, see http://www.gnu.org/licenses/.
16 */
17 #ifndef HELP_ACTION_GUARD
18 #define HELP_ACTION_GUARD
19 
20 #include "Action.h"
21 #include <string>
22 
23 class HelpAction : public Action {
24  public:
25  HelpAction();
26  virtual void obtainParameters(vector<Parameter*>& parameters);
27 
28  virtual void processNonParameter(const char* str);
29 
30  virtual void perform();
31 
32  static const char* staticGetName();
33 
34  virtual bool displayAction() const;
35 
36  private:
37  void displayActionHelp(Action& action);
38  void displayIOHelp();
39 
40  string _topic;
41 };
42 
43 #endif
HelpAction::displayAction
virtual bool displayAction() const
Returns whether this action should be shown to the user by the help action.
Definition: HelpAction.cpp:198
HelpAction::staticGetName
static const char * staticGetName()
Definition: HelpAction.cpp:194
Action.h
Action
Definition: Action.h:25
HelpAction::displayIOHelp
void displayIOHelp()
Definition: HelpAction.cpp:86
HelpAction::HelpAction
HelpAction()
Definition: HelpAction.cpp:30
HelpAction::perform
virtual void perform()
Definition: HelpAction.cpp:146
HelpAction::_topic
string _topic
Definition: HelpAction.h:40
HelpAction::obtainParameters
virtual void obtainParameters(vector< Parameter * > &parameters)
Definition: HelpAction.cpp:43
HelpAction
Definition: HelpAction.h:23
HelpAction::displayActionHelp
void displayActionHelp(Action &action)
Definition: HelpAction.cpp:59
HelpAction::processNonParameter
virtual void processNonParameter(const char *str)
Definition: HelpAction.cpp:46