File indexing completed on 2024-05-12 05:39:27

0001 /***************************************************************************
0002  *   Copyright (C) 2015 by Renaud Guezennec                                *
0003  *   http:://www.rolisteam.org/contact                                     *
0004  *                                                                         *
0005  *   rolisteam is free software; you can redistribute it and/or modify     *
0006  *   it under the terms of the GNU General Public License as published by  *
0007  *   the Free Software Foundation; either version 2 of the License, or     *
0008  *   (at your option) any later version.                                   *
0009  *                                                                         *
0010  *   This program is distributed in the hope that it will be useful,       *
0011  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
0012  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
0013  *   GNU General Public License for more details.                          *
0014  *                                                                         *
0015  *   You should have received a copy of the GNU General Public License     *
0016  *   along with this program; if not, write to the                         *
0017  *   Free Software Foundation, Inc.,                                       *
0018  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
0019  ***************************************************************************/
0020 #ifndef HELPNODE_H
0021 #define HELPNODE_H
0022 #include "executionnode.h"
0023 
0024 #include <QObject>
0025 #include <QString>
0026 
0027 #include "result/stringresult.h"
0028 
0029 /**
0030  * @brief The HelpNode class
0031  */
0032 class HelpNode : public ExecutionNode
0033 {
0034 public:
0035     /**
0036      * @brief HelpNode
0037      */
0038     HelpNode();
0039     /**
0040      * @brief run
0041      * @param previous
0042      */
0043     void run(ExecutionNode* previous);
0044     /**
0045      * @brief toString
0046      * @return
0047      */
0048     virtual QString toString(bool) const;
0049     /**
0050      * @brief getPriority
0051      * @return
0052      */
0053     virtual qint64 getPriority() const;
0054     /**
0055      * @brief setHelpPath
0056      * @param path
0057      */
0058     void setHelpPath(QString path);
0059     /**
0060      * @brief getCopy
0061      * @return
0062      */
0063     virtual ExecutionNode* getCopy() const;
0064 
0065 private:
0066     QString m_path;
0067 };
0068 
0069 #endif // HELPNODE_H