contrib/include/wx/xml/xmlres.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        xmlres.h
   3 // Purpose:     XML resources
   4 // Author:      Vaclav Slavik
   5 // Created:     2000/03/05
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2000 Vaclav Slavik
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_XMLRES_H_
  12 #define _WX_XMLRES_H_
  13
  14 #ifdef __GNUG__
  15 #pragma interface "xmlres.h"
  16 #endif
  17
  18 #include "wx/defs.h"
  19 #include "wx/string.h"
  20 #include "wx/dynarray.h"
  21 #include "wx/datetime.h"
  22 #include "wx/list.h"
  23 #include "wx/gdicmn.h"
  24 #include "wx/filesys.h"
  25 #include "wx/bitmap.h"
  26 #include "wx/icon.h"
  27
  28 class WXDLLEXPORT wxMenu;
  29 class WXDLLEXPORT wxMenuBar;
  30 class WXDLLEXPORT wxDialog;
  31 class WXDLLEXPORT wxPanel;
  32 class WXDLLEXPORT wxWindow;
  33 class WXDLLEXPORT wxFrame;
  34 class WXDLLEXPORT wxToolBar;
  35
  36 class WXDLLEXPORT wxXmlResourceHandler;
  37
  38 #include "wx/xml/xml.h"
  39
  40
  41 class WXDLLEXPORT wxXmlResourceDataRecord
  42 {
  43 public:
  44     wxXmlResourceDataRecord() : Doc(NULL), Time(wxDateTime::Now()) {}
  45     ~wxXmlResourceDataRecord() {delete Doc;}
  46
  47     wxString File;
  48     wxXmlDocument *Doc;
  49     wxDateTime Time;
  50 };
  51
  52 WX_DECLARE_EXPORTED_OBJARRAY(wxXmlResourceDataRecord, wxXmlResourceDataRecords);
  53
  54 // This class holds XML resources from one or more .xml files
  55 // (or derived forms, either binary or zipped -- see manual for
  56 // details).
  57
  58 class WXDLLEXPORT wxXmlResource : public wxObject
  59 {
  60 public:
  61     // Ctor. If use_locale is TRUE, translatable strings are
  62     // translated via _(). You can disable it by passing use_locale=FALSE
  63     // (for example if you provide resource file for each locale)
  64     wxXmlResource(bool use_locale = TRUE);
  65     wxXmlResource(const wxString& filemask, bool use_locale = TRUE);
  66     ~wxXmlResource();
  67
  68     // Loads resources from XML files that match given filemask.
  69     // This method understands VFS (see filesys.h).
  70     bool Load(const wxString& filemask);
  71
  72     // Initialize handlers for all supported controls/windows. This will
  73     // make the executable quite big because it forces linking against
  74     // most of wxWin library
  75     void InitAllHandlers();
  76
  77     // Initialize only specific handler (or custom handler). Convention says
  78     // that handler name is equal to control's name plus 'XmlHandler', e.g.
  79     // wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. XML resource compiler
  80     // (xmlres) can create include file that contains initialization code for
  81     // all controls used within the resource.
  82     void AddHandler(wxXmlResourceHandler *handler);
  83
  84     // Removes all handlers
  85     void ClearHandlers();
  86
  87     // Loads menu from resource. Returns NULL on failure.
  88     wxMenu *LoadMenu(const wxString& name);
  89
  90     // Loads menubar from resource. Returns NULL on failure.
  91     wxMenuBar *LoadMenuBar(const wxString& name);
  92
  93 #if wxUSE_TOOLBAR
  94     // Loads toolbar
  95     wxToolBar *LoadToolBar(wxWindow *parent, const wxString& name);
  96 #endif
  97
  98     // Loads dialog. dlg points to parent window (if any). Second form
  99     // is used to finish creation of already existing instance (main reason
 100     // for this is that you may want to use derived class with new event table)
 101     // Example (typical usage):
 102     //      MyDialog dlg;
 103     //      wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog");
 104     //      dlg->ShowModal();
 105     wxDialog *LoadDialog(wxWindow *parent, const wxString& name);
 106     bool LoadDialog(wxDialog *dlg, wxWindow *parent, const wxString& name);
 107
 108     // Loads panel. panel points to parent window (if any). Second form
 109     // is used to finish creation of already existing instance.
 110     wxPanel *LoadPanel(wxWindow *parent, const wxString& name);
 111     bool LoadPanel(wxPanel *panel, wxWindow *parent, const wxString& name);
 112
 113     bool LoadFrame(wxFrame* frame, wxWindow *parent, const wxString& name);
 114
 115     // Loads bitmap or icon resource from file:
 116     wxBitmap LoadBitmap(const wxString& name);
 117     wxIcon LoadIcon(const wxString& name);
 118
 119     // Returns numeric ID that is equivalent to string id used in XML
 120     // resource. To be used in event tables
 121     // Macro XMLID is provided for convenience
 122     static int GetXMLID(const char *str_id);
 123
 124 protected:
 125     // Scans resources list for unloaded files and loads them. Also reloads
 126     // files that have been modified since last loading.
 127     void UpdateResources();
 128
 129     // Finds resource (calls UpdateResources) and returns node containing it
 130     wxXmlNode *FindResource(const wxString& name, const wxString& classname);
 131
 132     // Creates resource from info in given node:
 133     wxObject *CreateResFromNode(wxXmlNode *node, wxObject *parent, wxObject *instance = NULL);
 134
 135     // Remove nodes with property "platform" that does not
 136     // match current platform
 137     void ProcessPlatformProperty(wxXmlNode *node);
 138
 139     bool GetUseLocale() { return m_useLocale; }
 140
 141 private:
 142     bool m_useLocale;
 143     wxList m_handlers;
 144     wxXmlResourceDataRecords m_data;
 145 #if wxUSE_FILESYSTEM
 146     wxFileSystem m_curFileSystem;
 147     wxFileSystem& GetCurFileSystem() { return m_curFileSystem; }
 148 #endif
 149
 150     friend class wxXmlResourceHandler;
 151 };
 152
 153
 154 // Global instance of resource class. For your convenience.
 155 extern wxXmlResource *wxTheXmlResource;
 156
 157 // This macro translates string identifier (as used in XML resource,
 158 // e.g. <menuitem id="my_menu">...</menuitem>) to integer id that is needed by
 159 // wxWindows event tables.
 160 // Example:
 161 //    BEGIN_EVENT_TABLE(MyFrame, wxFrame)
 162 //       EVT_MENU(XMLID("quit"), MyFrame::OnQuit)
 163 //       EVT_MENU(XMLID("about"), MyFrame::OnAbout)
 164 //       EVT_MENU(XMLID("new"), MyFrame::OnNew)
 165 //       EVT_MENU(XMLID("open"), MyFrame::OnOpen)
 166 //    END_EVENT_TABLE()
 167
 168 #define XMLID(str_id) \
 169     wxXmlResource::GetXMLID(wxT(str_id))
 170
 171
 172 // This macro returns pointer to particular control in dialog
 173 // created using XML resources. You can use it to set/get values from
 174 // controls.
 175 // Example:
 176 //    wxDialog dlg;
 177 //    wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog");
 178 //    XMLCTRL(dlg, "my_textctrl", wxTextCtrl)->SetValue(wxT("default value"));
 179
 180 #define XMLCTRL(window, id, type) \
 181     ((type*)((window).FindWindow(XMLID(id))))
 182
 183
 184
 185 class WXDLLEXPORT wxXmlResourceHandler : public wxObject
 186 {
 187 public:
 188     wxXmlResourceHandler();
 189     virtual ~wxXmlResourceHandler() {}
 190
 191     // Creates object (menu, dialog, control, ...) from XML node.
 192     // Should check for validity.
 193     // parent is higher-level object (usually window, dialog or panel)
 194     // that is often neccessary to create resource
 195     // if instance != NULL it should not create new instance via 'new' but
 196     // rather use this one and call its Create method
 197     wxObject *CreateResource(wxXmlNode *node, wxObject *parent,
 198                              wxObject *instance);
 199
 200     // This one is called from CreateResource after variables
 201     // were filled
 202     virtual wxObject *DoCreateResource() = 0;
 203
 204     // Returns TRUE if it understands this node and can create
 205     // resource from it, FALSE otherwise.
 206     virtual bool CanHandle(wxXmlNode *node) = 0;
 207
 208     void SetParentResource(wxXmlResource *res) { m_resource = res; }
 209
 210
 211 protected:
 212
 213     wxXmlResource *m_resource;
 214     wxArrayString m_styleNames;
 215     wxArrayInt m_styleValues;
 216
 217     // Variables (filled by CreateResource)
 218     wxXmlNode *m_node;
 219     wxString m_class;
 220     wxObject *m_parent, *m_instance;
 221     wxWindow *m_parentAsWindow, *m_instanceAsWindow;
 222
 223     // --- Handy methods:
 224
 225     // Returns true if the node has property class equal to classname,
 226     // e.g. <object class="wxDialog">
 227     bool IsOfClass(wxXmlNode *node, const wxString& classname)
 228         { return node->GetPropVal(wxT("class"), wxEmptyString) == classname; }
 229
 230     // Gets node content from wxXML_ENTITY_NODE
 231     // (the problem is, <tag>content<tag> is represented as
 232     // wxXML_ENTITY_NODE name="tag", content=""
 233     //    |-- wxXML_TEXT_NODE or
 234     //        wxXML_CDATA_SECTION_NODE name="" content="content"
 235     wxString GetNodeContent(wxXmlNode *node);
 236
 237     // Check to see if a param exists
 238     bool HasParam(const wxString& param);
 239
 240     // Finds the node or returns NULL
 241     wxXmlNode *GetParamNode(const wxString& param);
 242     wxString GetParamValue(const wxString& param);
 243
 244     // Add style flag (e.g. wxMB_DOCKABLE) to list of flags
 245     // understood by this handler
 246     void AddStyle(const wxString& name, int value);
 247
 248     // Add styles common to all wxWindow-derived classes
 249     void AddWindowStyles();
 250
 251     // Gets style flags from text in form "flag | flag2| flag3 |..."
 252     // Only understads flags added with AddStyle
 253     int GetStyle(const wxString& param = wxT("style"), int defaults = 0);
 254
 255     // Gets text from param and does some convertions:
 256     // - replaces \n, \r, \t by respective chars (according to C syntax)
 257     // - replaces $ by & and $$ by $ (needed for $File => &File because of XML)
 258     // - calls wxGetTranslations (unless disabled in wxXmlResource)
 259     wxString GetText(const wxString& param);
 260
 261     // Return XMLID
 262     int GetID();
 263     wxString GetName();
 264
 265     // Get bool flag (1,t,yes,on,true are TRUE, everything else is FALSE)
 266     bool GetBool(const wxString& param, bool defaultv = FALSE);
 267
 268     // Get integer value from param
 269     long GetLong( const wxString& param, long defaultv = 0 );
 270
 271     // Get colour in HTML syntax (#RRGGBB)
 272     wxColour GetColour(const wxString& param);
 273
 274     // Get size/position (may be in dlg units):
 275     wxSize GetSize(const wxString& param = wxT("size"));
 276     wxPoint GetPosition(const wxString& param = wxT("pos"));
 277
 278     // Get dimension (may be in dlg units):
 279     wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0);
 280
 281     // Get bitmap:
 282     wxBitmap GetBitmap(const wxString& param = wxT("bitmap"),
 283                        wxSize size = wxDefaultSize);
 284     wxIcon GetIcon(const wxString& param = wxT("icon"),
 285                    wxSize size = wxDefaultSize);
 286
 287     // Get font:
 288     wxFont GetFont(const wxString& param = wxT("font"));
 289
 290     // Sets common window options:
 291     void SetupWindow(wxWindow *wnd);
 292
 293     void CreateChildren(wxObject *parent, bool this_hnd_only = FALSE);
 294     void CreateChildrenPrivately(wxObject *parent, wxXmlNode *rootnode = NULL);
 295     wxObject *CreateResFromNode(wxXmlNode *node,
 296                                 wxObject *parent, wxObject *instance = NULL)
 297         { return m_resource->CreateResFromNode(node, parent, instance); }
 298
 299     // helper
 300     wxFileSystem& GetCurFileSystem() { return m_resource->GetCurFileSystem(); }
 301 };
 302
 303 #define ADD_STYLE(style) AddStyle(wxT(#style), style)
 304
 305
 306
 307 #endif // _WX_XMLRES_H_