Src/DasherCore/DasherModule.h

   1 // DasherModule.h
   2 //
   3 // Copyright (c) 2008 The Dasher Team
   4 //
   5 // This file is part of Dasher.
   6 //
   7 // Dasher is free software; you can redistribute it and/or modify
   8 // it under the terms of the GNU General Public License as published by
   9 // the Free Software Foundation; either version 2 of the License, or
  10 // (at your option) any later version.
  11 //
  12 // Dasher is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with Dasher; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20
  21 #ifndef DASHER_MODULE_H
  22 #define DASHER_MODULE_H
  23
  24 #include <vector>
  25
  26 #include "../Common/ModuleSettings.h"
  27
  28 class CDasherModule;
  29 typedef std::vector<CDasherModule*>::size_type ModuleID_t;
  30
  31 /// \ingroup Core
  32 /// @{
  33 class CDasherModule {
  34  public:
  35   CDasherModule(ModuleID_t iID, int iType, const char *szName);
  36
  37   virtual ModuleID_t GetID();
  38   virtual void SetID(ModuleID_t);
  39   virtual int GetType();
  40   virtual const char *GetName();
  41
  42   virtual bool GetSettings(SModuleSettings **pSettings, int *iCount) {
  43     return false;
  44   };
  45
  46  private:
  47   ModuleID_t m_iID;
  48   int m_iType;
  49   const char *m_szName;
  50 };
  51 /// @}
  52
  53 #endif