PassGuard Framework

00001 /*!
00002  * \file PassguardAbstractCommand.h
00003  * \brief Defines the command interface for the menu items
00004  *
00005  * \author Frederic RUAUDEL <grumz@users.sf.net>
00006  *
00007  * $Revision: 1.2 $
00008  * $Date: 2003/02/27 22:12:45 $
00009  *
00010  * \b GPassGuard
00011  * Copyleft (c) 2003 Frederic RUAUDEL, all rights reversed
00012  *
00013  * This program is free software which I release under the GNU General Public
00014  * License. You may redistribute and/or modify this program under the terms
00015  * of that license as published by the Free Software Foundation; either
00016  * version 2 of the License, or (at your option) any later version.
00017  *
00018  * This program is distributed in the hope that it will be useful,
00019  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00021  * GNU General Public License for more details.  Version 2 is in the
00022  * COPYING file in the top level directory of this distribution.
00023  *
00024  * To get a copy of the GNU General Public License, write to the Free Software
00025  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00026  **/
00027 
00028 #ifndef PASSGUARD_ABSTRACT_COMMAND_H
00029 #define PASSGUARD_ABSTRACT_COMMAND_H
00030 
00031 using namespace std;
00032 
00033 /*!
00034  * \brief the abstract command interface
00035  **/
00036 class PassguardAbstractCommand
00037 {
00038         public:
00039                 virtual ~PassguardAbstractCommand () {};
00040 
00041                 virtual string getName (void) = 0;
00042                 virtual string getDescription (void) = 0;
00043                 virtual void execute (void) = 0;
00044 
00045         protected:
00046                 PassguardAbstractCommand () {};
00047 };
00048 
00049 /*!
00050  * \fn PassguardAbstractCommand::PassguardAbstractCommand ()
00051  *
00052  * \brief Constructor of the abstract command interface
00053  *
00054  * \return none
00055  **/
00056 
00057 /*!
00058  * \fn PassguardAbstractCommand::~PassguardAbstractCommand ()
00059  *
00060  * \brief Destructor of the abstract command interface
00061  *
00062  * \return none
00063  **/
00064 
00065 /*!
00066  * \fn string PassguardAbstractCommand::getName (void)
00067  *
00068  * \brief Retrieves the name of the command for the menu label
00069  *
00070  * \return the string holding the name of the command
00071  **/
00072 
00073 /*!
00074  * \fn string PassguardAbstractCommand::getDescription (void)
00075  *
00076  * \brief Retrieves the description of the command for the menu tooltip
00077  *
00078  * \return the string holding the description of the command
00079  **/
00080 
00081 /*!
00082  * \fn void PassguardAbstractCommand::execute (void)
00083  *
00084  * \brief the function called when the command must be executed
00085  *
00086  * \return none
00087  **/
00088 
00089 #endif /* PASSGUARD_ABSTRACT_COMMAND_H */
00090