| 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/arrstr.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 | #include "wx/colour.h" |
| 29 | #include "wx/animate.h" |
| 30 | #include "wx/vector.h" |
| 31 | |
| 32 | #include "wx/xml/xml.h" |
| 33 | |
| 34 | class WXDLLIMPEXP_FWD_BASE wxFileName; |
| 35 | |
| 36 | class WXDLLIMPEXP_FWD_CORE wxIconBundle; |
| 37 | class WXDLLIMPEXP_FWD_CORE wxImageList; |
| 38 | class WXDLLIMPEXP_FWD_CORE wxMenu; |
| 39 | class WXDLLIMPEXP_FWD_CORE wxMenuBar; |
| 40 | class WXDLLIMPEXP_FWD_CORE wxDialog; |
| 41 | class WXDLLIMPEXP_FWD_CORE wxPanel; |
| 42 | class WXDLLIMPEXP_FWD_CORE wxWindow; |
| 43 | class WXDLLIMPEXP_FWD_CORE wxFrame; |
| 44 | class WXDLLIMPEXP_FWD_CORE wxToolBar; |
| 45 | |
| 46 | class WXDLLIMPEXP_FWD_XRC wxXmlResourceHandler; |
| 47 | class WXDLLIMPEXP_FWD_XRC wxXmlSubclassFactory; |
| 48 | class wxXmlSubclassFactories; |
| 49 | class wxXmlResourceModule; |
| 50 | class wxXmlResourceDataRecords; |
| 51 | |
| 52 | // These macros indicate current version of XML resources (this information is |
| 53 | // encoded in root node of XRC file as "version" property). |
| 54 | // |
| 55 | // Rules for increasing version number: |
| 56 | // - change it only if you made incompatible change to the format. Addition |
| 57 | // of new attribute to control handler is _not_ incompatible change, because |
| 58 | // older versions of the library may ignore it. |
| 59 | // - if you change version number, follow these steps: |
| 60 | // - set major, minor and release numbers to respective version numbers of |
| 61 | // the wxWidgets library (see wx/version.h) |
| 62 | // - reset revision to 0 unless the first three are same as before, |
| 63 | // in which case you should increase revision by one |
| 64 | #define WX_XMLRES_CURRENT_VERSION_MAJOR 2 |
| 65 | #define WX_XMLRES_CURRENT_VERSION_MINOR 5 |
| 66 | #define WX_XMLRES_CURRENT_VERSION_RELEASE 3 |
| 67 | #define WX_XMLRES_CURRENT_VERSION_REVISION 0 |
| 68 | #define WX_XMLRES_CURRENT_VERSION_STRING wxT("2.5.3.0") |
| 69 | |
| 70 | #define WX_XMLRES_CURRENT_VERSION \ |
| 71 | (WX_XMLRES_CURRENT_VERSION_MAJOR * 256*256*256 + \ |
| 72 | WX_XMLRES_CURRENT_VERSION_MINOR * 256*256 + \ |
| 73 | WX_XMLRES_CURRENT_VERSION_RELEASE * 256 + \ |
| 74 | WX_XMLRES_CURRENT_VERSION_REVISION) |
| 75 | |
| 76 | enum wxXmlResourceFlags |
| 77 | { |
| 78 | wxXRC_USE_LOCALE = 1, |
| 79 | wxXRC_NO_SUBCLASSING = 2, |
| 80 | wxXRC_NO_RELOADING = 4 |
| 81 | }; |
| 82 | |
| 83 | // This class holds XML resources from one or more .xml files |
| 84 | // (or derived forms, either binary or zipped -- see manual for |
| 85 | // details). |
| 86 | class WXDLLIMPEXP_XRC wxXmlResource : public wxObject |
| 87 | { |
| 88 | public: |
| 89 | // Constructor. |
| 90 | // Flags: wxXRC_USE_LOCALE |
| 91 | // translatable strings will be translated via _() |
| 92 | // using the given domain if specified |
| 93 | // wxXRC_NO_SUBCLASSING |
| 94 | // subclass property of object nodes will be ignored |
| 95 | // (useful for previews in XRC editors) |
| 96 | // wxXRC_NO_RELOADING |
| 97 | // don't check the modification time of the XRC files and |
| 98 | // reload them if they have changed on disk |
| 99 | wxXmlResource(int flags = wxXRC_USE_LOCALE, |
| 100 | const wxString& domain = wxEmptyString); |
| 101 | |
| 102 | // Constructor. |
| 103 | // Flags: wxXRC_USE_LOCALE |
| 104 | // translatable strings will be translated via _() |
| 105 | // using the given domain if specified |
| 106 | // wxXRC_NO_SUBCLASSING |
| 107 | // subclass property of object nodes will be ignored |
| 108 | // (useful for previews in XRC editors) |
| 109 | wxXmlResource(const wxString& filemask, int flags = wxXRC_USE_LOCALE, |
| 110 | const wxString& domain = wxEmptyString); |
| 111 | |
| 112 | // Destructor. |
| 113 | virtual ~wxXmlResource(); |
| 114 | |
| 115 | // Loads resources from XML files that match given filemask. |
| 116 | // This method understands wxFileSystem URLs if wxUSE_FILESYS. |
| 117 | bool Load(const wxString& filemask); |
| 118 | |
| 119 | // Loads resources from single XRC file. |
| 120 | bool LoadFile(const wxFileName& file); |
| 121 | |
| 122 | // Loads all XRC files from a directory. |
| 123 | bool LoadAllFiles(const wxString& dirname); |
| 124 | |
| 125 | // Unload resource from the given XML file (wildcards not allowed) |
| 126 | bool Unload(const wxString& filename); |
| 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 | return DoLoadObject(parent, name, classname, false /* !recursive */); |
| 194 | } |
| 195 | |
| 196 | // Load an object from the resource specifying both the resource name and |
| 197 | // the classname. This form lets you finish the creation of an existing |
| 198 | // instance. |
| 199 | bool LoadObject(wxObject *instance, |
| 200 | wxWindow *parent, |
| 201 | const wxString& name, |
| 202 | const wxString& classname) |
| 203 | { |
| 204 | return DoLoadObject(instance, parent, name, classname, false); |
| 205 | } |
| 206 | |
| 207 | // These versions of LoadObject() look for the object with the given name |
| 208 | // recursively (breadth first) and can be used to instantiate an individual |
| 209 | // control defined anywhere in an XRC file. No check is done that the name |
| 210 | // is unique, it's up to the caller to ensure this. |
| 211 | wxObject *LoadObjectRecursively(wxWindow *parent, |
| 212 | const wxString& name, |
| 213 | const wxString& classname) |
| 214 | { |
| 215 | return DoLoadObject(parent, name, classname, true /* recursive */); |
| 216 | } |
| 217 | |
| 218 | bool LoadObjectRecursively(wxObject *instance, |
| 219 | wxWindow *parent, |
| 220 | const wxString& name, |
| 221 | const wxString& classname) |
| 222 | { |
| 223 | return DoLoadObject(instance, parent, name, classname, true); |
| 224 | } |
| 225 | |
| 226 | // Loads a bitmap resource from a file. |
| 227 | wxBitmap LoadBitmap(const wxString& name); |
| 228 | |
| 229 | // Loads an icon resource from a file. |
| 230 | wxIcon LoadIcon(const wxString& name); |
| 231 | |
| 232 | // Attaches an unknown control to the given panel/window/dialog. |
| 233 | // Unknown controls are used in conjunction with <object class="unknown">. |
| 234 | bool AttachUnknownControl(const wxString& name, wxWindow *control, |
| 235 | wxWindow *parent = NULL); |
| 236 | |
| 237 | // Returns a numeric ID that is equivalent to the string ID used in an XML |
| 238 | // resource. If an unknown str_id is requested (i.e. other than wxID_XXX |
| 239 | // or integer), a new record is created which associates the given string |
| 240 | // with a number. If value_if_not_found == wxID_NONE, the number is obtained via |
| 241 | // wxWindow::NewControlId(). Otherwise value_if_not_found is used. |
| 242 | // Macro XRCID(name) is provided for convenient use in event tables. |
| 243 | static int GetXRCID(const wxString& str_id, int value_if_not_found = wxID_NONE) |
| 244 | { return DoGetXRCID(str_id.mb_str(), value_if_not_found); } |
| 245 | |
| 246 | // version for internal use only |
| 247 | static int DoGetXRCID(const char *str_id, int value_if_not_found = wxID_NONE); |
| 248 | |
| 249 | |
| 250 | // Find the string ID with the given numeric value, returns an empty string |
| 251 | // if no such ID is found. |
| 252 | // |
| 253 | // Notice that unlike GetXRCID(), which is fast, this operation is slow as |
| 254 | // it checks all the IDs used in XRC. |
| 255 | static wxString FindXRCIDById(int numId); |
| 256 | |
| 257 | |
| 258 | // Returns version information (a.b.c.d = d+ 256*c + 256^2*b + 256^3*a). |
| 259 | long GetVersion() const { return m_version; } |
| 260 | |
| 261 | // Compares resources version to argument. Returns -1 if resources version |
| 262 | // is less than the argument, +1 if greater and 0 if they equal. |
| 263 | int CompareVersion(int major, int minor, int release, int revision) const |
| 264 | { return GetVersion() - |
| 265 | (major*256*256*256 + minor*256*256 + release*256 + revision); } |
| 266 | |
| 267 | //// Singleton accessors. |
| 268 | |
| 269 | // Gets the global resources object or creates one if none exists. |
| 270 | static wxXmlResource *Get(); |
| 271 | |
| 272 | // Sets the global resources object and returns a pointer to the previous one (may be NULL). |
| 273 | static wxXmlResource *Set(wxXmlResource *res); |
| 274 | |
| 275 | // Returns flags, which may be a bitlist of wxXRC_USE_LOCALE and wxXRC_NO_SUBCLASSING. |
| 276 | int GetFlags() const { return m_flags; } |
| 277 | // Set flags after construction. |
| 278 | void SetFlags(int flags) { m_flags = flags; } |
| 279 | |
| 280 | // Get/Set the domain to be passed to the translation functions, defaults |
| 281 | // to empty string (no domain). |
| 282 | const wxString& GetDomain() const { return m_domain; } |
| 283 | void SetDomain(const wxString& domain); |
| 284 | |
| 285 | |
| 286 | // This function returns the wxXmlNode containing the definition of the |
| 287 | // object with the given name or NULL. |
| 288 | // |
| 289 | // It can be used to access additional information defined in the XRC file |
| 290 | // and not used by wxXmlResource itself. |
| 291 | const wxXmlNode *GetResourceNode(const wxString& name) const |
| 292 | { return GetResourceNodeAndLocation(name, wxString(), true); } |
| 293 | |
| 294 | protected: |
| 295 | // reports input error at position 'context' |
| 296 | void ReportError(wxXmlNode *context, const wxString& message); |
| 297 | |
| 298 | // override this in derived class to customize errors reporting |
| 299 | virtual void DoReportError(const wxString& xrcFile, wxXmlNode *position, |
| 300 | const wxString& message); |
| 301 | |
| 302 | // Scans the resources list for unloaded files and loads them. Also reloads |
| 303 | // files that have been modified since last loading. |
| 304 | bool UpdateResources(); |
| 305 | |
| 306 | |
| 307 | // Common implementation of GetResourceNode() and FindResource(): searches |
| 308 | // all top-level or all (if recursive == true) nodes if all loaded XRC |
| 309 | // files and returns the node, if found, as well as the path of the file it |
| 310 | // was found in if path is non-NULL |
| 311 | wxXmlNode *GetResourceNodeAndLocation(const wxString& name, |
| 312 | const wxString& classname, |
| 313 | bool recursive = false, |
| 314 | wxString *path = NULL) const; |
| 315 | |
| 316 | |
| 317 | // Note that these functions are used outside of wxWidgets itself, e.g. |
| 318 | // there are several known cases of inheriting from wxXmlResource just to |
| 319 | // be able to call FindResource() so we keep them for compatibility even if |
| 320 | // their names are not really consistent with GetResourceNode() public |
| 321 | // function and FindResource() is also non-const because it changes the |
| 322 | // current path of m_curFileSystem to ensure that relative paths work |
| 323 | // correctly when CreateResFromNode() is called immediately afterwards |
| 324 | // (something const public function intentionally does not do) |
| 325 | |
| 326 | // Returns the node containing the resource with the given name and class |
| 327 | // name unless it's empty (then any class matches) or NULL if not found. |
| 328 | wxXmlNode *FindResource(const wxString& name, const wxString& classname, |
| 329 | bool recursive = false); |
| 330 | |
| 331 | // Helper function used by FindResource() to look under the given node. |
| 332 | wxXmlNode *DoFindResource(wxXmlNode *parent, const wxString& name, |
| 333 | const wxString& classname, bool recursive) const; |
| 334 | |
| 335 | // Creates a resource from information in the given node |
| 336 | // (Uses only 'handlerToUse' if != NULL) |
| 337 | wxObject *CreateResFromNode(wxXmlNode *node, wxObject *parent, |
| 338 | wxObject *instance = NULL, |
| 339 | wxXmlResourceHandler *handlerToUse = NULL) |
| 340 | { |
| 341 | return node ? DoCreateResFromNode(*node, parent, instance, handlerToUse) |
| 342 | : NULL; |
| 343 | } |
| 344 | |
| 345 | // Helper of Load() and Unload(): returns the URL corresponding to the |
| 346 | // given file if it's indeed a file, otherwise returns the original string |
| 347 | // unmodified |
| 348 | static wxString ConvertFileNameToURL(const wxString& filename); |
| 349 | |
| 350 | // loading resources from archives is impossible without wxFileSystem |
| 351 | #if wxUSE_FILESYSTEM |
| 352 | // Another helper: detect if the filename is a ZIP or XRS file |
| 353 | static bool IsArchive(const wxString& filename); |
| 354 | #endif // wxUSE_FILESYSTEM |
| 355 | |
| 356 | private: |
| 357 | wxXmlResourceDataRecords& Data() { return *m_data; } |
| 358 | const wxXmlResourceDataRecords& Data() const { return *m_data; } |
| 359 | |
| 360 | // the real implementation of CreateResFromNode(): this should be only |
| 361 | // called if node is non-NULL |
| 362 | wxObject *DoCreateResFromNode(wxXmlNode& node, |
| 363 | wxObject *parent, |
| 364 | wxObject *instance, |
| 365 | wxXmlResourceHandler *handlerToUse = NULL); |
| 366 | |
| 367 | // common part of LoadObject() and LoadObjectRecursively() |
| 368 | wxObject *DoLoadObject(wxWindow *parent, |
| 369 | const wxString& name, |
| 370 | const wxString& classname, |
| 371 | bool recursive); |
| 372 | bool DoLoadObject(wxObject *instance, |
| 373 | wxWindow *parent, |
| 374 | const wxString& name, |
| 375 | const wxString& classname, |
| 376 | bool recursive); |
| 377 | |
| 378 | private: |
| 379 | long m_version; |
| 380 | |
| 381 | int m_flags; |
| 382 | wxVector<wxXmlResourceHandler*> m_handlers; |
| 383 | wxXmlResourceDataRecords *m_data; |
| 384 | #if wxUSE_FILESYSTEM |
| 385 | wxFileSystem m_curFileSystem; |
| 386 | wxFileSystem& GetCurFileSystem() { return m_curFileSystem; } |
| 387 | #endif |
| 388 | |
| 389 | // domain to pass to translation functions, if any. |
| 390 | wxString m_domain; |
| 391 | |
| 392 | friend class wxXmlResourceHandler; |
| 393 | friend class wxXmlResourceModule; |
| 394 | |
| 395 | static wxXmlSubclassFactories *ms_subclassFactories; |
| 396 | |
| 397 | // singleton instance: |
| 398 | static wxXmlResource *ms_instance; |
| 399 | }; |
| 400 | |
| 401 | |
| 402 | // This macro translates string identifier (as used in XML resource, |
| 403 | // e.g. <menuitem id="my_menu">...</menuitem>) to integer id that is needed by |
| 404 | // wxWidgets event tables. |
| 405 | // Example: |
| 406 | // BEGIN_EVENT_TABLE(MyFrame, wxFrame) |
| 407 | // EVT_MENU(XRCID("quit"), MyFrame::OnQuit) |
| 408 | // EVT_MENU(XRCID("about"), MyFrame::OnAbout) |
| 409 | // EVT_MENU(XRCID("new"), MyFrame::OnNew) |
| 410 | // EVT_MENU(XRCID("open"), MyFrame::OnOpen) |
| 411 | // END_EVENT_TABLE() |
| 412 | |
| 413 | #define XRCID(str_id) \ |
| 414 | wxXmlResource::DoGetXRCID(str_id) |
| 415 | |
| 416 | |
| 417 | // This macro returns pointer to particular control in dialog |
| 418 | // created using XML resources. You can use it to set/get values from |
| 419 | // controls. |
| 420 | // Example: |
| 421 | // wxDialog dlg; |
| 422 | // wxXmlResource::Get()->LoadDialog(&dlg, mainFrame, "my_dialog"); |
| 423 | // XRCCTRL(dlg, "my_textctrl", wxTextCtrl)->SetValue(wxT("default value")); |
| 424 | |
| 425 | #define XRCCTRL(window, id, type) \ |
| 426 | (wxStaticCast((window).FindWindow(XRCID(id)), type)) |
| 427 | |
| 428 | // This macro returns pointer to sizer item |
| 429 | // Example: |
| 430 | // |
| 431 | // <object class="spacer" name="area"> |
| 432 | // <size>400, 300</size> |
| 433 | // </object> |
| 434 | // |
| 435 | // wxSizerItem* item = XRCSIZERITEM(*this, "area") |
| 436 | |
| 437 | #define XRCSIZERITEM(window, id) \ |
| 438 | ((window).GetSizer() ? (window).GetSizer()->GetItemById(XRCID(id)) : NULL) |
| 439 | |
| 440 | // wxXmlResourceHandler is an abstract base class for resource handlers |
| 441 | // capable of creating a control from an XML node. |
| 442 | |
| 443 | class WXDLLIMPEXP_XRC wxXmlResourceHandler : public wxObject |
| 444 | { |
| 445 | DECLARE_ABSTRACT_CLASS(wxXmlResourceHandler) |
| 446 | public: |
| 447 | // Constructor. |
| 448 | wxXmlResourceHandler(); |
| 449 | |
| 450 | // Destructor. |
| 451 | virtual ~wxXmlResourceHandler() {} |
| 452 | |
| 453 | // Creates an object (menu, dialog, control, ...) from an XML node. |
| 454 | // Should check for validity. |
| 455 | // parent is a higher-level object (usually window, dialog or panel) |
| 456 | // that is often necessary to create the resource. |
| 457 | // If instance is non-NULL it should not create a new instance via 'new' but |
| 458 | // should rather use this one, and call its Create method. |
| 459 | wxObject *CreateResource(wxXmlNode *node, wxObject *parent, |
| 460 | wxObject *instance); |
| 461 | |
| 462 | // This one is called from CreateResource after variables |
| 463 | // were filled. |
| 464 | virtual wxObject *DoCreateResource() = 0; |
| 465 | |
| 466 | // Returns true if it understands this node and can create |
| 467 | // a resource from it, false otherwise. |
| 468 | virtual bool CanHandle(wxXmlNode *node) = 0; |
| 469 | |
| 470 | // Sets the parent resource. |
| 471 | void SetParentResource(wxXmlResource *res) { m_resource = res; } |
| 472 | |
| 473 | protected: |
| 474 | wxXmlResource *m_resource; |
| 475 | wxArrayString m_styleNames; |
| 476 | wxArrayInt m_styleValues; |
| 477 | |
| 478 | // Variables (filled by CreateResource) |
| 479 | wxXmlNode *m_node; |
| 480 | wxString m_class; |
| 481 | wxObject *m_parent, *m_instance; |
| 482 | wxWindow *m_parentAsWindow; |
| 483 | |
| 484 | // --- Handy methods: |
| 485 | |
| 486 | // Returns true if the node has a property class equal to classname, |
| 487 | // e.g. <object class="wxDialog">. |
| 488 | bool IsOfClass(wxXmlNode *node, const wxString& classname); |
| 489 | |
| 490 | // Gets node content from wxXML_ENTITY_NODE |
| 491 | // The problem is, <tag>content<tag> is represented as |
| 492 | // wxXML_ENTITY_NODE name="tag", content="" |
| 493 | // |-- wxXML_TEXT_NODE or |
| 494 | // wxXML_CDATA_SECTION_NODE name="" content="content" |
| 495 | wxString GetNodeContent(const wxXmlNode *node); |
| 496 | |
| 497 | // Check to see if a parameter exists. |
| 498 | bool HasParam(const wxString& param); |
| 499 | |
| 500 | // Finds the node or returns NULL. |
| 501 | wxXmlNode *GetParamNode(const wxString& param); |
| 502 | |
| 503 | // Finds the parameter value or returns the empty string. |
| 504 | wxString GetParamValue(const wxString& param); |
| 505 | |
| 506 | // Returns the parameter value from given node. |
| 507 | wxString GetParamValue(const wxXmlNode* node); |
| 508 | |
| 509 | // Add a style flag (e.g. wxMB_DOCKABLE) to the list of flags |
| 510 | // understood by this handler. |
| 511 | void AddStyle(const wxString& name, int value); |
| 512 | |
| 513 | // Add styles common to all wxWindow-derived classes. |
| 514 | void AddWindowStyles(); |
| 515 | |
| 516 | // Gets style flags from text in form "flag | flag2| flag3 |..." |
| 517 | // Only understands flags added with AddStyle |
| 518 | int GetStyle(const wxString& param = wxT("style"), int defaults = 0); |
| 519 | |
| 520 | // Gets text from param and does some conversions: |
| 521 | // - replaces \n, \r, \t by respective chars (according to C syntax) |
| 522 | // - replaces _ by & and __ by _ (needed for _File => &File because of XML) |
| 523 | // - calls wxGetTranslations (unless disabled in wxXmlResource) |
| 524 | wxString GetText(const wxString& param, bool translate = true); |
| 525 | |
| 526 | // Returns the XRCID. |
| 527 | int GetID(); |
| 528 | |
| 529 | // Returns the resource name. |
| 530 | wxString GetName(); |
| 531 | |
| 532 | // Gets a bool flag (1, t, yes, on, true are true, everything else is false). |
| 533 | bool GetBool(const wxString& param, bool defaultv = false); |
| 534 | |
| 535 | // Gets an integer value from the parameter. |
| 536 | long GetLong(const wxString& param, long defaultv = 0); |
| 537 | |
| 538 | // Gets a float value from the parameter. |
| 539 | float GetFloat(const wxString& param, float defaultv = 0); |
| 540 | |
| 541 | // Gets colour in HTML syntax (#RRGGBB). |
| 542 | wxColour GetColour(const wxString& param, const wxColour& defaultv = wxNullColour); |
| 543 | |
| 544 | // Gets the size (may be in dialog units). |
| 545 | wxSize GetSize(const wxString& param = wxT("size"), |
| 546 | wxWindow *windowToUse = NULL); |
| 547 | |
| 548 | // Gets the position (may be in dialog units). |
| 549 | wxPoint GetPosition(const wxString& param = wxT("pos")); |
| 550 | |
| 551 | // Gets a dimension (may be in dialog units). |
| 552 | wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0, |
| 553 | wxWindow *windowToUse = NULL); |
| 554 | |
| 555 | // Gets a bitmap. |
| 556 | wxBitmap GetBitmap(const wxString& param = wxT("bitmap"), |
| 557 | const wxArtClient& defaultArtClient = wxART_OTHER, |
| 558 | wxSize size = wxDefaultSize); |
| 559 | |
| 560 | // Gets a bitmap from an XmlNode. |
| 561 | wxBitmap GetBitmap(const wxXmlNode* node, |
| 562 | const wxArtClient& defaultArtClient = wxART_OTHER, |
| 563 | wxSize size = wxDefaultSize); |
| 564 | |
| 565 | // Gets an icon. |
| 566 | wxIcon GetIcon(const wxString& param = wxT("icon"), |
| 567 | const wxArtClient& defaultArtClient = wxART_OTHER, |
| 568 | wxSize size = wxDefaultSize); |
| 569 | |
| 570 | // Gets an icon from an XmlNode. |
| 571 | wxIcon GetIcon(const wxXmlNode* node, |
| 572 | const wxArtClient& defaultArtClient = wxART_OTHER, |
| 573 | wxSize size = wxDefaultSize); |
| 574 | |
| 575 | // Gets an icon bundle. |
| 576 | wxIconBundle GetIconBundle(const wxString& param, |
| 577 | const wxArtClient& defaultArtClient = wxART_OTHER); |
| 578 | |
| 579 | // Gets an image list. |
| 580 | wxImageList *GetImageList(const wxString& param = wxT("imagelist")); |
| 581 | |
| 582 | #if wxUSE_ANIMATIONCTRL |
| 583 | // Gets an animation. |
| 584 | wxAnimation GetAnimation(const wxString& param = wxT("animation")); |
| 585 | #endif |
| 586 | |
| 587 | // Gets a font. |
| 588 | wxFont GetFont(const wxString& param = wxT("font")); |
| 589 | |
| 590 | // Gets the value of a boolean attribute (only "0" and "1" are valid values) |
| 591 | bool GetBoolAttr(const wxString& attr, bool defaultv); |
| 592 | |
| 593 | |
| 594 | // Sets common window options. |
| 595 | void SetupWindow(wxWindow *wnd); |
| 596 | |
| 597 | // Creates children. |
| 598 | void CreateChildren(wxObject *parent, bool this_hnd_only = false); |
| 599 | |
| 600 | // Helper function. |
| 601 | void CreateChildrenPrivately(wxObject *parent, wxXmlNode *rootnode = NULL); |
| 602 | |
| 603 | // Creates a resource from a node. |
| 604 | wxObject *CreateResFromNode(wxXmlNode *node, |
| 605 | wxObject *parent, wxObject *instance = NULL) |
| 606 | { return m_resource->CreateResFromNode(node, parent, instance); } |
| 607 | |
| 608 | // helper |
| 609 | #if wxUSE_FILESYSTEM |
| 610 | wxFileSystem& GetCurFileSystem() { return m_resource->GetCurFileSystem(); } |
| 611 | #endif |
| 612 | |
| 613 | // reports input error at position 'context' |
| 614 | void ReportError(wxXmlNode *context, const wxString& message); |
| 615 | // reports input error at m_node |
| 616 | void ReportError(const wxString& message); |
| 617 | // reports input error when parsing parameter with given name |
| 618 | void ReportParamError(const wxString& param, const wxString& message); |
| 619 | }; |
| 620 | |
| 621 | |
| 622 | // Programmer-friendly macros for writing XRC handlers: |
| 623 | |
| 624 | #define XRC_ADD_STYLE(style) AddStyle(wxT(#style), style) |
| 625 | |
| 626 | #define XRC_MAKE_INSTANCE(variable, classname) \ |
| 627 | classname *variable = NULL; \ |
| 628 | if (m_instance) \ |
| 629 | variable = wxStaticCast(m_instance, classname); \ |
| 630 | if (!variable) \ |
| 631 | variable = new classname; |
| 632 | |
| 633 | |
| 634 | // FIXME -- remove this $%^#$%#$@# as soon as Ron checks his changes in!! |
| 635 | WXDLLIMPEXP_XRC void wxXmlInitResourceModule(); |
| 636 | |
| 637 | |
| 638 | // This class is used to create instances of XRC "object" nodes with "subclass" |
| 639 | // property. It is _not_ supposed to be used by XRC users, you should instead |
| 640 | // register your subclasses via wxWidgets' RTTI mechanism. This class is useful |
| 641 | // only for language bindings developer who need a way to implement subclassing |
| 642 | // in wxWidgets ports that don't support wxRTTI (e.g. wxPython). |
| 643 | class WXDLLIMPEXP_XRC wxXmlSubclassFactory |
| 644 | { |
| 645 | public: |
| 646 | // Try to create instance of given class and return it, return NULL on |
| 647 | // failure: |
| 648 | virtual wxObject *Create(const wxString& className) = 0; |
| 649 | virtual ~wxXmlSubclassFactory() {} |
| 650 | }; |
| 651 | |
| 652 | |
| 653 | /* ------------------------------------------------------------------------- |
| 654 | Backward compatibility macros. Do *NOT* use, they may disappear in future |
| 655 | versions of the XRC library! |
| 656 | ------------------------------------------------------------------------- */ |
| 657 | |
| 658 | #endif // wxUSE_XRC |
| 659 | |
| 660 | #endif // _WX_XMLRES_H_ |