include/wx/xrc/xmlres.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/xrc/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 #include "wx/defs.h"
  15
  16 #if wxUSE_XRC
  17
  18 #include "wx/string.h"
  19 #include "wx/dynarray.h"
  20 #include "wx/datetime.h"
  21 #include "wx/list.h"
  22 #include "wx/gdicmn.h"
  23 #include "wx/filesys.h"
  24 #include "wx/bitmap.h"
  25 #include "wx/icon.h"
  26 #include "wx/artprov.h"
  27 #include "wx/colour.h"
  28
  29 #include "wx/xml/xml.h"
  30
  31 class WXDLLEXPORT wxMenu;
  32 class WXDLLEXPORT wxMenuBar;
  33 class WXDLLEXPORT wxDialog;
  34 class WXDLLEXPORT wxPanel;
  35 class WXDLLEXPORT wxWindow;
  36 class WXDLLEXPORT wxFrame;
  37 class WXDLLEXPORT wxToolBar;
  38
  39 class WXDLLIMPEXP_XRC wxXmlResourceHandler;
  40 class WXDLLIMPEXP_XRC wxXmlSubclassFactory;
  41 class WXDLLIMPEXP_XRC wxXmlSubclassFactoriesList;
  42 class wxXmlResourceModule;
  43
  44
  45 // These macros indicate current version of XML resources (this information is
  46 // encoded in root node of XRC file as "version" property).
  47 //
  48 // Rules for increasing version number:
  49 //   - change it only if you made incompatible change to the format. Addition
  50 //     of new attribute to control handler is _not_ incompatible change, because
  51 //     older versions of the library may ignore it.
  52 //   - if you change version number, follow these steps:
  53 //       - set major, minor and release numbers to respective version numbers of
  54 //         the wxWidgets library (see wx/version.h)
  55 //       - reset revision to 0 unless the first three are same as before,
  56 //         in which case you should increase revision by one
  57 #define WX_XMLRES_CURRENT_VERSION_MAJOR            2
  58 #define WX_XMLRES_CURRENT_VERSION_MINOR            5
  59 #define WX_XMLRES_CURRENT_VERSION_RELEASE          3
  60 #define WX_XMLRES_CURRENT_VERSION_REVISION         0
  61 #define WX_XMLRES_CURRENT_VERSION_STRING       _T("2.5.3.0")
  62
  63 #define WX_XMLRES_CURRENT_VERSION \
  64                 (WX_XMLRES_CURRENT_VERSION_MAJOR * 256*256*256 + \
  65                  WX_XMLRES_CURRENT_VERSION_MINOR * 256*256 + \
  66                  WX_XMLRES_CURRENT_VERSION_RELEASE * 256 + \
  67                  WX_XMLRES_CURRENT_VERSION_REVISION)
  68
  69 class WXDLLIMPEXP_XRC wxXmlResourceDataRecord
  70 {
  71 public:
  72     wxXmlResourceDataRecord() : Doc(NULL) {
  73 #if wxUSE_DATETIME
  74         Time = wxDateTime::Now();
  75 #endif
  76     }
  77     ~wxXmlResourceDataRecord() {delete Doc;}
  78
  79     wxString File;
  80     wxXmlDocument *Doc;
  81 #if wxUSE_DATETIME
  82     wxDateTime Time;
  83 #endif
  84 };
  85
  86
  87 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxXmlResourceDataRecord,
  88                                   wxXmlResourceDataRecords,
  89                                   WXDLLIMPEXP_XRC);
  90
  91 enum wxXmlResourceFlags
  92 {
  93     wxXRC_USE_LOCALE     = 1,
  94     wxXRC_NO_SUBCLASSING = 2,
  95     wxXRC_NO_RELOADING   = 4
  96 };
  97
  98 // This class holds XML resources from one or more .xml files
  99 // (or derived forms, either binary or zipped -- see manual for
 100 // details).
 101 class WXDLLIMPEXP_XRC wxXmlResource : public wxObject
 102 {
 103 public:
 104     // Constructor.
 105     // Flags: wxXRC_USE_LOCALE
 106     //              translatable strings will be translated via _()
 107     //        wxXRC_NO_SUBCLASSING
 108     //              subclass property of object nodes will be ignored
 109     //              (useful for previews in XRC editors)
 110     //        wxXRC_NO_RELOADING
 111     //              don't check the modification time of the XRC files and
 112     //              reload them if they have changed on disk
 113     wxXmlResource(int flags = wxXRC_USE_LOCALE);
 114
 115     // Constructor.
 116     // Flags: wxXRC_USE_LOCALE
 117     //              translatable strings will be translated via _()
 118     //        wxXRC_NO_SUBCLASSING
 119     //              subclass property of object nodes will be ignored
 120     //              (useful for previews in XRC editors)
 121     wxXmlResource(const wxString& filemask, int flags = wxXRC_USE_LOCALE);
 122
 123     // Destructor.
 124     ~wxXmlResource();
 125
 126     // Loads resources from XML files that match given filemask.
 127     // This method understands VFS (see filesys.h).
 128     bool Load(const wxString& filemask);
 129
 130     // Unload resource from the given XML file (wildcards not allowed)
 131     bool Unload(const wxString& filename);
 132
 133     // Initialize handlers for all supported controls/windows. This will
 134     // make the executable quite big because it forces linking against
 135     // most of the wxWidgets library.
 136     void InitAllHandlers();
 137
 138     // Initialize only a specific handler (or custom handler). Convention says
 139     // that handler name is equal to the control's name plus 'XmlHandler', for
 140     // example wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource
 141     // compiler (xmlres) can create include file that contains initialization
 142     // code for all controls used within the resource.
 143     void AddHandler(wxXmlResourceHandler *handler);
 144
 145     // Add a new handler at the begining of the handler list
 146     void InsertHandler(wxXmlResourceHandler *handler);
 147
 148     // Removes all handlers
 149     void ClearHandlers();
 150
 151     // Registers subclasses factory for use in XRC. This function is not meant
 152     // for public use, please see the comment above wxXmlSubclassFactory
 153     // definition.
 154     static void AddSubclassFactory(wxXmlSubclassFactory *factory);
 155
 156     // Loads menu from resource. Returns NULL on failure.
 157     wxMenu *LoadMenu(const wxString& name);
 158
 159     // Loads menubar from resource. Returns NULL on failure.
 160     wxMenuBar *LoadMenuBar(wxWindow *parent, const wxString& name);
 161
 162     // Loads menubar from resource. Returns NULL on failure.
 163     wxMenuBar *LoadMenuBar(const wxString& name) { return LoadMenuBar(NULL, name); }
 164
 165 #if wxUSE_TOOLBAR
 166     // Loads a toolbar.
 167     wxToolBar *LoadToolBar(wxWindow *parent, const wxString& name);
 168 #endif
 169
 170     // Loads a dialog. dlg points to parent window (if any).
 171     wxDialog *LoadDialog(wxWindow *parent, const wxString& name);
 172
 173     // Loads a dialog. dlg points to parent window (if any). This form
 174     // is used to finish creation of already existing instance (main reason
 175     // for this is that you may want to use derived class with new event table)
 176     // Example (typical usage):
 177     //      MyDialog dlg;
 178     //      wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog");
 179     //      dlg->ShowModal();
 180     bool LoadDialog(wxDialog *dlg, wxWindow *parent, const wxString& name);
 181
 182     // Loads a panel. panel points to parent window (if any).
 183     wxPanel *LoadPanel(wxWindow *parent, const wxString& name);
 184
 185     // Loads a panel. panel points to parent window (if any). This form
 186     // is used to finish creation of already existing instance.
 187     bool LoadPanel(wxPanel *panel, wxWindow *parent, const wxString& name);
 188
 189     // Loads a frame.
 190     wxFrame *LoadFrame(wxWindow* parent, const wxString& name);
 191     bool LoadFrame(wxFrame* frame, wxWindow *parent, const wxString& name);
 192
 193     // Load an object from the resource specifying both the resource name and
 194     // the classname.  This lets you load nonstandard container windows.
 195     wxObject *LoadObject(wxWindow *parent, const wxString& name,
 196                          const wxString& classname);
 197
 198     // Load an object from the resource specifying both the resource name and
 199     // the classname.  This form lets you finish the creation of an existing
 200     // instance.
 201     bool LoadObject(wxObject *instance, wxWindow *parent, const wxString& name,
 202                     const wxString& classname);
 203
 204     // Loads a bitmap resource from a file.
 205     wxBitmap LoadBitmap(const wxString& name);
 206
 207     // Loads an icon resource from a file.
 208     wxIcon LoadIcon(const wxString& name);
 209
 210     // Attaches an unknown control to the given panel/window/dialog.
 211     // Unknown controls are used in conjunction with <object class="unknown">.
 212     bool AttachUnknownControl(const wxString& name, wxWindow *control,
 213                               wxWindow *parent = NULL);
 214
 215     // Returns a numeric ID that is equivalent to the string ID used in an XML
 216     // resource. If an unknown str_id is requested (i.e. other than wxID_XXX
 217     // or integer), a new record is created which associates the given string
 218     // with a number. If value_if_not_found == wxID_NONE, the number is obtained via
 219     // wxNewId(). Otherwise value_if_not_found is used.
 220     // Macro XRCID(name) is provided for convenient use in event tables.
 221     static int GetXRCID(const wxChar *str_id, int value_if_not_found = wxID_NONE);
 222
 223     // Returns version information (a.b.c.d = d+ 256*c + 256^2*b + 256^3*a).
 224     long GetVersion() const { return m_version; }
 225
 226     // Compares resources version to argument. Returns -1 if resources version
 227     // is less than the argument, +1 if greater and 0 if they equal.
 228     int CompareVersion(int major, int minor, int release, int revision) const
 229         { return GetVersion() -
 230                  (major*256*256*256 + minor*256*256 + release*256 + revision); }
 231
 232 //// Singleton accessors.
 233
 234     // Gets the global resources object or creates one if none exists.
 235     static wxXmlResource *Get();
 236
 237     // Sets the global resources object and returns a pointer to the previous one (may be NULL).
 238     static wxXmlResource *Set(wxXmlResource *res);
 239
 240     // Returns flags, which may be a bitlist of wxXRC_USE_LOCALE and wxXRC_NO_SUBCLASSING.
 241     int GetFlags() const { return m_flags; }
 242     // Set flags after construction.
 243     void SetFlags(int flags) { m_flags = flags; }
 244
 245 protected:
 246     // Scans the resources list for unloaded files and loads them. Also reloads
 247     // files that have been modified since last loading.
 248     bool UpdateResources();
 249
 250     // Finds a resource (calls UpdateResources) and returns a node containing it.
 251     wxXmlNode *FindResource(const wxString& name, const wxString& classname, bool recursive = false);
 252
 253     // Helper function: finds a resource (calls UpdateResources) and returns a node containing it.
 254     wxXmlNode *DoFindResource(wxXmlNode *parent, const wxString& name, const wxString& classname, bool recursive);
 255
 256     // Creates a resource from information in the given node
 257     // (Uses only 'handlerToUse' if != NULL)
 258     wxObject *CreateResFromNode(wxXmlNode *node, wxObject *parent,
 259                                 wxObject *instance = NULL,
 260                                 wxXmlResourceHandler *handlerToUse = NULL);
 261
 262     // Helper of Load() and Unload(): returns the URL corresponding to the
 263     // given file if it's indeed a file, otherwise returns the original string
 264     // unmodified
 265     static wxString ConvertFileNameToURL(const wxString& filename);
 266
 267     // loading resources from archives is impossible without wxFileSystem
 268 #if wxUSE_FILESYSTEM
 269     // Another helper: detect if the filename is a ZIP or XRS file
 270     static bool IsArchive(const wxString& filename);
 271 #endif // wxUSE_FILESYSTEM
 272
 273 private:
 274     long m_version;
 275
 276     int m_flags;
 277     wxList m_handlers;
 278     wxXmlResourceDataRecords m_data;
 279 #if wxUSE_FILESYSTEM
 280     wxFileSystem m_curFileSystem;
 281     wxFileSystem& GetCurFileSystem() { return m_curFileSystem; }
 282 #endif
 283
 284     friend class wxXmlResourceHandler;
 285     friend class wxXmlResourceModule;
 286
 287     static wxXmlSubclassFactoriesList *ms_subclassFactories;
 288
 289     // singleton instance:
 290     static wxXmlResource *ms_instance;
 291 };
 292
 293
 294 // This macro translates string identifier (as used in XML resource,
 295 // e.g. <menuitem id="my_menu">...</menuitem>) to integer id that is needed by
 296 // wxWidgets event tables.
 297 // Example:
 298 //    BEGIN_EVENT_TABLE(MyFrame, wxFrame)
 299 //       EVT_MENU(XRCID("quit"), MyFrame::OnQuit)
 300 //       EVT_MENU(XRCID("about"), MyFrame::OnAbout)
 301 //       EVT_MENU(XRCID("new"), MyFrame::OnNew)
 302 //       EVT_MENU(XRCID("open"), MyFrame::OnOpen)
 303 //    END_EVENT_TABLE()
 304
 305 #define XRCID(str_id) \
 306     wxXmlResource::GetXRCID(wxT(str_id))
 307
 308
 309 // This macro returns pointer to particular control in dialog
 310 // created using XML resources. You can use it to set/get values from
 311 // controls.
 312 // Example:
 313 //    wxDialog dlg;
 314 //    wxXmlResource::Get()->LoadDialog(&dlg, mainFrame, "my_dialog");
 315 //    XRCCTRL(dlg, "my_textctrl", wxTextCtrl)->SetValue(wxT("default value"));
 316
 317 #define XRCCTRL(window, id, type) \
 318     (wxStaticCast((window).FindWindow(XRCID(id)), type))
 319
 320 // wxXmlResourceHandler is an abstract base class for resource handlers
 321 // capable of creating a control from an XML node.
 322
 323 class WXDLLIMPEXP_XRC wxXmlResourceHandler : public wxObject
 324 {
 325 DECLARE_ABSTRACT_CLASS(wxXmlResourceHandler)
 326 public:
 327     // Constructor.
 328     wxXmlResourceHandler();
 329
 330     // Destructor.
 331     virtual ~wxXmlResourceHandler() {}
 332
 333     // Creates an object (menu, dialog, control, ...) from an XML node.
 334     // Should check for validity.
 335     // parent is a higher-level object (usually window, dialog or panel)
 336     // that is often necessary to create the resource.
 337     // If instance is non-NULL it should not create a new instance via 'new' but
 338     // should rather use this one, and call its Create method.
 339     wxObject *CreateResource(wxXmlNode *node, wxObject *parent,
 340                              wxObject *instance);
 341
 342     // This one is called from CreateResource after variables
 343     // were filled.
 344     virtual wxObject *DoCreateResource() = 0;
 345
 346     // Returns true if it understands this node and can create
 347     // a resource from it, false otherwise.
 348     virtual bool CanHandle(wxXmlNode *node) = 0;
 349
 350     // Sets the parent resource.
 351     void SetParentResource(wxXmlResource *res) { m_resource = res; }
 352
 353 protected:
 354     wxXmlResource *m_resource;
 355     wxArrayString m_styleNames;
 356     wxArrayInt m_styleValues;
 357
 358     // Variables (filled by CreateResource)
 359     wxXmlNode *m_node;
 360     wxString m_class;
 361     wxObject *m_parent, *m_instance;
 362     wxWindow *m_parentAsWindow;
 363
 364     // --- Handy methods:
 365
 366     // Returns true if the node has a property class equal to classname,
 367     // e.g. <object class="wxDialog">.
 368     bool IsOfClass(wxXmlNode *node, const wxString& classname);
 369
 370     // Gets node content from wxXML_ENTITY_NODE
 371     // The problem is, <tag>content<tag> is represented as
 372     // wxXML_ENTITY_NODE name="tag", content=""
 373     //    |-- wxXML_TEXT_NODE or
 374     //        wxXML_CDATA_SECTION_NODE name="" content="content"
 375     wxString GetNodeContent(wxXmlNode *node);
 376
 377     // Check to see if a parameter exists.
 378     bool HasParam(const wxString& param);
 379
 380     // Finds the node or returns NULL.
 381     wxXmlNode *GetParamNode(const wxString& param);
 382
 383     // Finds the parameter value or returns the empty string.
 384     wxString GetParamValue(const wxString& param);
 385
 386     // Add a style flag (e.g. wxMB_DOCKABLE) to the list of flags
 387     // understood by this handler.
 388     void AddStyle(const wxString& name, int value);
 389
 390     // Add styles common to all wxWindow-derived classes.
 391     void AddWindowStyles();
 392
 393     // Gets style flags from text in form "flag | flag2| flag3 |..."
 394     // Only understands flags added with AddStyle
 395     int GetStyle(const wxString& param = wxT("style"), int defaults = 0);
 396
 397     // Gets text from param and does some conversions:
 398     // - replaces \n, \r, \t by respective chars (according to C syntax)
 399     // - replaces _ by & and __ by _ (needed for _File => &File because of XML)
 400     // - calls wxGetTranslations (unless disabled in wxXmlResource)
 401     wxString GetText(const wxString& param, bool translate = true);
 402
 403     // Returns the XRCID.
 404     int GetID();
 405
 406     // Returns the resource name.
 407     wxString GetName();
 408
 409     // Gets a bool flag (1, t, yes, on, true are true, everything else is false).
 410     bool GetBool(const wxString& param, bool defaultv = false);
 411
 412     // Gets an integer value from the parameter.
 413     long GetLong(const wxString& param, long defaultv = 0);
 414
 415     // Gets a float value from the parameter.
 416     float GetFloat(const wxString& param, float defaultv = 0);
 417
 418     // Gets colour in HTML syntax (#RRGGBB).
 419     wxColour GetColour(const wxString& param, const wxColour& defaultv = wxNullColour);
 420
 421     // Gets the size (may be in dialog units).
 422     wxSize GetSize(const wxString& param = wxT("size"),
 423                    wxWindow *windowToUse = NULL);
 424
 425     // Gets the position (may be in dialog units).
 426     wxPoint GetPosition(const wxString& param = wxT("pos"));
 427
 428     // Gets a dimension (may be in dialog units).
 429     wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0,
 430                          wxWindow *windowToUse = NULL);
 431
 432     // Gets a bitmap.
 433     wxBitmap GetBitmap(const wxString& param = wxT("bitmap"),
 434                        const wxArtClient& defaultArtClient = wxART_OTHER,
 435                        wxSize size = wxDefaultSize);
 436
 437     // Gets an icon.
 438     wxIcon GetIcon(const wxString& param = wxT("icon"),
 439                    const wxArtClient& defaultArtClient = wxART_OTHER,
 440                    wxSize size = wxDefaultSize);
 441
 442     // Gets a font.
 443     wxFont GetFont(const wxString& param = wxT("font"));
 444
 445     // Sets common window options.
 446     void SetupWindow(wxWindow *wnd);
 447
 448     // Creates children.
 449     void CreateChildren(wxObject *parent, bool this_hnd_only = false);
 450
 451     // Helper function.
 452     void CreateChildrenPrivately(wxObject *parent, wxXmlNode *rootnode = NULL);
 453
 454     // Creates a resource from a node.
 455     wxObject *CreateResFromNode(wxXmlNode *node,
 456                                 wxObject *parent, wxObject *instance = NULL)
 457         { return m_resource->CreateResFromNode(node, parent, instance); }
 458
 459     // helper
 460 #if wxUSE_FILESYSTEM
 461     wxFileSystem& GetCurFileSystem() { return m_resource->GetCurFileSystem(); }
 462 #endif
 463 };
 464
 465
 466 // Programmer-friendly macros for writing XRC handlers:
 467
 468 #define XRC_ADD_STYLE(style) AddStyle(wxT(#style), style)
 469
 470 #define XRC_MAKE_INSTANCE(variable, classname) \
 471    classname *variable = NULL; \
 472    if (m_instance) \
 473        variable = wxStaticCast(m_instance, classname); \
 474    if (!variable) \
 475        variable = new classname;
 476
 477
 478 // FIXME -- remove this $%^#$%#$@# as soon as Ron checks his changes in!!
 479 WXDLLIMPEXP_XRC void wxXmlInitResourceModule();
 480
 481
 482 // This class is used to create instances of XRC "object" nodes with "subclass"
 483 // property. It is _not_ supposed to be used by XRC users, you should instead
 484 // register your subclasses via wxWidgets' RTTI mechanism. This class is useful
 485 // only for language bindings developer who need a way to implement subclassing
 486 // in wxWidgets ports that don't support wxRTTI (e.g. wxPython).
 487 class WXDLLIMPEXP_XRC wxXmlSubclassFactory
 488 {
 489 public:
 490     // Try to create instance of given class and return it, return NULL on
 491     // failure:
 492     virtual wxObject *Create(const wxString& className) = 0;
 493     virtual ~wxXmlSubclassFactory() {}
 494 };
 495
 496
 497 /* -------------------------------------------------------------------------
 498    Backward compatibility macros. Do *NOT* use, they may disappear in future
 499    versions of the XRC library!
 500    ------------------------------------------------------------------------- */
 501 #if WXWIN_COMPATIBILITY_2_4
 502     #define ADD_STYLE         XRC_ADD_STYLE
 503     #define wxTheXmlResource  wxXmlResource::Get()
 504     #define XMLID             XRCID
 505     #define XMLCTRL           XRCCTRL
 506     #define GetXMLID          GetXRCID
 507 #endif
 508
 509 #endif // wxUSE_XRC
 510
 511 #endif // _WX_XMLRES_H_