include/wx/resource.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        resource.h
   3 // Purpose:     Resource processing
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_RESOURCEH__
  13 #define _WX_RESOURCEH__
  14
  15 #if defined(__GNUG__) && !defined(__APPLE__)
  16 #pragma interface "resource.h"
  17 #endif
  18
  19 #include "wx/setup.h"
  20
  21 #if wxUSE_WX_RESOURCES
  22
  23 #include "wx/bitmap.h"
  24 #include <stdio.h>
  25
  26 // A few further types not in wx_types.h
  27 #define wxRESOURCE_TYPE_SEPARATOR   1000
  28 #define wxRESOURCE_TYPE_XBM_DATA    1001
  29 #define wxRESOURCE_TYPE_XPM_DATA    1002
  30
  31 #define RESOURCE_PLATFORM_WINDOWS   1
  32 #define RESOURCE_PLATFORM_X         2
  33 #define RESOURCE_PLATFORM_MAC       3
  34 #define RESOURCE_PLATFORM_ANY       4
  35
  36 // Extended styles: for resource usage only
  37
  38 // Use dialog units instead of pixels
  39 #define wxRESOURCE_DIALOG_UNITS     0x0001
  40 // Use default system colour and font
  41 #define wxRESOURCE_USE_DEFAULTS     0x0002
  42 // Old-style vertical label
  43 #define wxRESOURCE_VERTICAL_LABEL   0x0004
  44 // Old-style horizontal label
  45 #define wxRESOURCE_HORIZONTAL_LABEL 0x0008
  46
  47 // Macros to help use dialog units
  48 #define wxDLG_POINT(x, y, parent, useDlgUnits) (useDlgUnits ? parent->ConvertDialogToPixel(wxPoint(x, y)) : wxPoint(x, y))
  49 #define wxDLG_SIZE(x, y, parent, useDlgUnits) (useDlgUnits ? parent->ConvertDialogToPixel(wxSize(x, y)) : wxSize(x, y))
  50
  51 #ifdef FindResource
  52 #undef FindResource
  53 #endif
  54
  55 class WXDLLEXPORT wxInputStream;
  56
  57 /*
  58  * Internal format for control/panel item
  59  */
  60
  61 class WXDLLEXPORT wxItemResource: public wxObject
  62 {
  63   DECLARE_DYNAMIC_CLASS(wxItemResource)
  64
  65  public:
  66
  67   wxItemResource();
  68   ~wxItemResource();
  69
  70   inline void SetType(const wxString& type) { m_itemType = type; }
  71   inline void SetStyle(long styl) { m_windowStyle = styl; }
  72   inline void SetId(int id) { m_windowId = id; }
  73   inline void SetBitmap(const wxBitmap& bm) { m_bitmap = bm; }
  74   inline wxBitmap& GetBitmap() const { return (wxBitmap&) m_bitmap; }
  75   inline void SetFont(const wxFont& font) { m_windowFont = font; }
  76   inline wxFont& GetFont() const { return (wxFont&) m_windowFont; }
  77   inline void SetSize(int xx, int yy, int ww, int hh)
  78   {  m_x = xx; m_y = yy; m_width = ww; m_height = hh; }
  79   inline void SetTitle(const wxString& title) { m_title = title; }
  80   inline void SetName(const wxString& name) { m_name = name; }
  81   inline void SetValue1(long v) { m_value1 = v; }
  82   inline void SetValue2(long v) { m_value2 = v; }
  83   inline void SetValue3(long v) { m_value3 = v; }
  84   inline void SetValue5(long v) { m_value5 = v; }
  85   inline void SetValue4(const wxString& v) { m_value4 = v; }
  86   inline void SetStringValues(const wxStringList& svalues) { m_stringValues = svalues; }
  87
  88   inline const wxString& GetType() const { return m_itemType; }
  89   inline int GetX() const { return m_x; }
  90   inline int GetY() const { return m_y; }
  91   inline int GetWidth() const { return m_width; }
  92   inline int GetHeight() const { return m_height; }
  93
  94   inline const wxString& GetTitle() const { return m_title; }
  95   inline const wxString& GetName() const { return m_name; }
  96   inline long GetStyle() const { return m_windowStyle; }
  97   inline int GetId() const { return m_windowId; }
  98
  99   inline wxInt32 GetValue1() const { return m_value1; }
 100   inline wxInt32 GetValue2() const { return m_value2; }
 101   inline wxInt32 GetValue3() const { return m_value3; }
 102   inline wxInt32 GetValue5() const { return m_value5; }
 103   inline wxString GetValue4() const { return m_value4; }
 104   inline wxList& GetChildren() const { return (wxList&) m_children; }
 105   inline wxStringList& GetStringValues() const { return (wxStringList&) m_stringValues; }
 106
 107   inline void SetBackgroundColour(const wxColour& col) { m_backgroundColour = col; }
 108   inline void SetLabelColour(const wxColour& col) { m_labelColour = col; }
 109   inline void SetButtonColour(const wxColour& col) { m_buttonColour = col; }
 110
 111   inline wxColour& GetBackgroundColour() const { return (wxColour&) m_backgroundColour; }
 112   inline wxColour& GetLabelColour() const { return (wxColour&) m_labelColour; }
 113   inline wxColour& GetButtonColour() const { return (wxColour&) m_buttonColour; }
 114
 115   inline void SetResourceStyle(long style) { m_exStyle = style; }
 116   inline wxInt32 GetResourceStyle() const { return m_exStyle; }
 117
 118  protected:
 119   wxList        m_children;
 120   wxString      m_itemType;
 121   int           m_x, m_y, m_width, m_height;
 122   wxString      m_title;
 123   wxString      m_name;
 124   long          m_windowStyle;
 125   long          m_value1, m_value2, m_value3, m_value5;
 126   wxString      m_value4;
 127   int           m_windowId;
 128   wxStringList  m_stringValues; // Optional string values
 129   wxBitmap      m_bitmap;
 130   wxColour      m_backgroundColour;
 131   wxColour      m_labelColour;
 132   wxColour      m_buttonColour;
 133   wxFont        m_windowFont;
 134   long          m_exStyle; // Extended, resource-specific styles
 135 };
 136
 137 /*
 138  * Resource table (normally only one of these)
 139  */
 140
 141 class WXDLLEXPORT wxResourceTable: public wxHashTable
 142 {
 143   DECLARE_DYNAMIC_CLASS(wxResourceTable)
 144
 145   protected:
 146
 147   public:
 148     wxHashTable identifiers;
 149
 150     wxResourceTable();
 151     ~wxResourceTable();
 152
 153     virtual wxItemResource *FindResource(const wxString& name) const;
 154     virtual void AddResource(wxItemResource *item);
 155     virtual bool DeleteResource(const wxString& name);
 156
 157     virtual bool ParseResourceFile(const wxString& filename);
 158     virtual bool ParseResourceFile(wxInputStream *is);
 159     virtual bool ParseResourceData(const wxString& data);
 160     virtual bool SaveResource(const wxString& filename);
 161
 162     // Register XBM/XPM data
 163     virtual bool RegisterResourceBitmapData(const wxString& name, char bits[], int width, int height);
 164     virtual bool RegisterResourceBitmapData(const wxString& name, char **data);
 165
 166     virtual wxControl *CreateItem(wxWindow *panel, const wxItemResource* childResource, const wxItemResource* parentResource) const;
 167
 168     virtual void ClearTable();
 169 };
 170
 171 WXDLLEXPORT extern void wxInitializeResourceSystem();
 172 WXDLLEXPORT extern void wxCleanUpResourceSystem();
 173
 174 WXDLLEXPORT_DATA(extern wxResourceTable*) wxDefaultResourceTable;
 175 WXDLLEXPORT extern long wxParseWindowStyle(const wxString& style);
 176
 177 class WXDLLEXPORT wxMenuBar;
 178 class WXDLLEXPORT wxMenu;
 179 class WXDLLEXPORT wxBitmap;
 180 class WXDLLEXPORT wxIcon;
 181 WXDLLEXPORT extern wxBitmap wxResourceCreateBitmap(const wxString& resource, wxResourceTable *table = (wxResourceTable *) NULL);
 182 WXDLLEXPORT extern wxIcon wxResourceCreateIcon(const wxString& resource, wxResourceTable *table = (wxResourceTable *) NULL);
 183 WXDLLEXPORT extern wxMenuBar* wxResourceCreateMenuBar(const wxString& resource, wxResourceTable *table = (wxResourceTable *) NULL, wxMenuBar *menuBar = (wxMenuBar *) NULL);
 184 WXDLLEXPORT extern wxMenu* wxResourceCreateMenu(const wxString& resource, wxResourceTable *table = (wxResourceTable *) NULL);
 185 WXDLLEXPORT extern bool wxResourceParseData(const wxString& resource, wxResourceTable *table = (wxResourceTable *) NULL);
 186 WXDLLEXPORT extern bool wxResourceParseData(const char* resource, wxResourceTable *table = (wxResourceTable *) NULL);
 187 WXDLLEXPORT extern bool wxResourceParseFile(const wxString& filename, wxResourceTable *table = (wxResourceTable *) NULL);
 188 WXDLLEXPORT extern bool wxResourceParseString(char* s, wxResourceTable *table = (wxResourceTable *) NULL);
 189 WXDLLEXPORT extern bool wxResourceParseString(const wxString& s, wxResourceTable *table = (wxResourceTable *) NULL);
 190 WXDLLEXPORT extern void wxResourceClear(wxResourceTable *table = (wxResourceTable *) NULL);
 191 // Register XBM/XPM data
 192 WXDLLEXPORT extern bool wxResourceRegisterBitmapData(const wxString& name, char bits[], int width, int height, wxResourceTable *table = (wxResourceTable *) NULL);
 193 WXDLLEXPORT extern bool wxResourceRegisterBitmapData(const wxString& name, char **data, wxResourceTable *table = (wxResourceTable *) NULL);
 194 #define wxResourceRegisterIconData wxResourceRegisterBitmapData
 195
 196 /*
 197  * Resource identifer code: #define storage
 198  */
 199
 200 WXDLLEXPORT extern bool wxResourceAddIdentifier(const wxString& name, int value, wxResourceTable *table = (wxResourceTable *) NULL);
 201 WXDLLEXPORT extern int wxResourceGetIdentifier(const wxString& name, wxResourceTable *table = (wxResourceTable *) NULL);
 202
 203 #if defined(__WXPM__)
 204 #include "wx/os2/wxrsc.h"
 205 #endif
 206 #endif
 207 #endif
 208     // _WX_RESOURCEH__