Frobby 0.9.5
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
23class 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
virtual void processNonParameter(const char *str)
virtual bool displayAction() const
Returns whether this action should be shown to the user by the help action.
string _topic
Definition HelpAction.h:40
virtual void perform()
static const char * staticGetName()
virtual void obtainParameters(vector< Parameter * > &parameters)
void displayIOHelp()
void displayActionHelp(Action &action)