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