include/qerplugin.h

   1 /*
   2 Copyright (C) 1999-2006 Id Software, Inc. and contributors.
   3 For a list of contributors, see the accompanying CONTRIBUTORS file.
   4
   5 This file is part of GtkRadiant.
   6
   7 GtkRadiant 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 GtkRadiant 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 GtkRadiant; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20 */
  21
  22 // QERadiant PlugIns
  23 //
  24 //
  25
  26 #ifndef __QERPLUGIN_H__
  27 #define __QERPLUGIN_H__
  28
  29 #include "generic/constant.h"
  30
  31
  32 // ========================================
  33 // GTK+ helper functions
  34
  35 // NOTE: parent can be 0 in all functions but it's best to set them
  36
  37 // this API does not depend on gtk+ or glib
  38 typedef struct _GtkWidget GtkWidget;
  39
  40 enum EMessageBoxType
  41 {
  42   eMB_OK,
  43   eMB_OKCANCEL,
  44   eMB_YESNO,
  45   eMB_YESNOCANCEL,
  46   eMB_NOYES,
  47 };
  48
  49 enum EMessageBoxIcon
  50 {
  51   eMB_ICONDEFAULT,
  52   eMB_ICONERROR,
  53   eMB_ICONWARNING,
  54   eMB_ICONQUESTION,
  55   eMB_ICONASTERISK,
  56 };
  57
  58 enum EMessageBoxReturn
  59 {
  60   eIDOK,
  61   eIDCANCEL,
  62   eIDYES,
  63   eIDNO,
  64 };
  65
  66 // simple Message Box, see above for the 'type' flags
  67
  68 typedef EMessageBoxReturn (* PFN_QERAPP_MESSAGEBOX) (GtkWidget *parent, const char* text, const char* caption/* = "GtkRadiant"*/, EMessageBoxType type/* = eMB_OK*/, EMessageBoxIcon icon/* = eMB_ICONDEFAULT*/);
  69
  70 // file and directory selection functions return null if the user hits cancel
  71 // - 'title' is the dialog title (can be null)
  72 // - 'path' is used to set the initial directory (can be null)
  73 // - 'pattern': the first pattern is for the win32 mode, then comes the Gtk pattern list, see Radiant source for samples
  74 typedef const char* (* PFN_QERAPP_FILEDIALOG) (GtkWidget *parent, bool open, const char* title, const char* path/* = 0*/, const char* pattern/* = 0*/);
  75
  76 // returns a gchar* string that must be g_free'd by the user
  77 typedef char* (* PFN_QERAPP_DIRDIALOG) (GtkWidget *parent, const char* title/* = "Choose Directory"*/, const char* path/* = 0*/);
  78
  79 // return true if the user closed the dialog with 'Ok'
  80 // 'color' is used to set the initial value and store the selected value
  81 template<typename Element> class BasicVector3;
  82 typedef BasicVector3<float> Vector3;
  83 typedef bool (* PFN_QERAPP_COLORDIALOG) (GtkWidget *parent, Vector3& color,
  84                                                const char* title/* = "Choose Color"*/);
  85
  86 // load a .bmp file and create a GtkImage widget from it
  87 // NOTE: 'filename' is relative to <radiant_path>/plugins/bitmaps/
  88 typedef struct _GtkImage GtkImage;
  89 typedef GtkImage* (* PFN_QERAPP_NEWIMAGE) (const char* filename);
  90
  91 // ========================================
  92
  93 class ModuleObserver;
  94
  95 // the radiant core API
  96 struct _QERFuncTable_1
  97 {
  98   INTEGER_CONSTANT(Version, 1);
  99   STRING_CONSTANT(Name, "radiant");
 100
 101   const char* (*getEnginePath)();
 102   const char* (*getGameToolsPath)();
 103   const char* (*getAppPath)();
 104   const char* (*getSettingsPath)();
 105
 106   const char* (*getGameName)();
 107   const char* (*getGameMode)();
 108
 109   const char* (*getGameDescriptionKeyValue)(const char* key);
 110   const char* (*getRequiredGameDescriptionKeyValue)(const char* key);
 111
 112   void (*attachGameToolsPathObserver)(ModuleObserver& observer);
 113   void (*detachGameToolsPathObserver)(ModuleObserver& observer);
 114   void (*attachEnginePathObserver)(ModuleObserver& observer);
 115   void (*detachEnginePathObserver)(ModuleObserver& observer);
 116   void (*attachGameNameObserver)(ModuleObserver& observer);
 117   void (*detachGameNameObserver)(ModuleObserver& observer);
 118   void (*attachGameModeObserver)(ModuleObserver& observer);
 119   void (*detachGameModeObserver)(ModuleObserver& observer);
 120
 121   // GTK+ functions
 122   PFN_QERAPP_MESSAGEBOX  m_pfnMessageBox;
 123   PFN_QERAPP_FILEDIALOG  m_pfnFileDialog;
 124   PFN_QERAPP_DIRDIALOG   m_pfnDirDialog;
 125   PFN_QERAPP_COLORDIALOG m_pfnColorDialog;
 126   PFN_QERAPP_NEWIMAGE  m_pfnNewImage;
 127
 128 };
 129
 130 #include "modulesystem.h"
 131
 132 template<typename Type>
 133 class GlobalModule;
 134 typedef GlobalModule<_QERFuncTable_1> GlobalRadiantModule;
 135
 136 template<typename Type>
 137 class GlobalModuleRef;
 138 typedef GlobalModuleRef<_QERFuncTable_1> GlobalRadiantModuleRef;
 139
 140 inline _QERFuncTable_1& GlobalRadiant()
 141 {
 142   return GlobalRadiantModule::getTable();
 143 }
 144
 145 #endif