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