]>
Commit | Line | Data |
---|---|---|
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(const wxXmlNode *context, const wxString& message); | |
297 | ||
298 | // override this in derived class to customize errors reporting | |
299 | virtual void DoReportError(const wxString& xrcFile, const wxXmlNode *position, | |
300 | const wxString& message); | |
301 | ||
302 | // Load the contents of a single file and returns its contents as a new | |
303 | // wxXmlDocument (which will be owned by caller) on success or NULL. | |
304 | wxXmlDocument *DoLoadFile(const wxString& file); | |
305 | ||
306 | // Scans the resources list for unloaded files and loads them. Also reloads | |
307 | // files that have been modified since last loading. | |
308 | bool UpdateResources(); | |
309 | ||
310 | ||
311 | // Common implementation of GetResourceNode() and FindResource(): searches | |
312 | // all top-level or all (if recursive == true) nodes if all loaded XRC | |
313 | // files and returns the node, if found, as well as the path of the file it | |
314 | // was found in if path is non-NULL | |
315 | wxXmlNode *GetResourceNodeAndLocation(const wxString& name, | |
316 | const wxString& classname, | |
317 | bool recursive = false, | |
318 | wxString *path = NULL) const; | |
319 | ||
320 | ||
321 | // Note that these functions are used outside of wxWidgets itself, e.g. | |
322 | // there are several known cases of inheriting from wxXmlResource just to | |
323 | // be able to call FindResource() so we keep them for compatibility even if | |
324 | // their names are not really consistent with GetResourceNode() public | |
325 | // function and FindResource() is also non-const because it changes the | |
326 | // current path of m_curFileSystem to ensure that relative paths work | |
327 | // correctly when CreateResFromNode() is called immediately afterwards | |
328 | // (something const public function intentionally does not do) | |
329 | ||
330 | // Returns the node containing the resource with the given name and class | |
331 | // name unless it's empty (then any class matches) or NULL if not found. | |
332 | wxXmlNode *FindResource(const wxString& name, const wxString& classname, | |
333 | bool recursive = false); | |
334 | ||
335 | // Helper function used by FindResource() to look under the given node. | |
336 | wxXmlNode *DoFindResource(wxXmlNode *parent, const wxString& name, | |
337 | const wxString& classname, bool recursive) const; | |
338 | ||
339 | // Creates a resource from information in the given node | |
340 | // (Uses only 'handlerToUse' if != NULL) | |
341 | wxObject *CreateResFromNode(wxXmlNode *node, wxObject *parent, | |
342 | wxObject *instance = NULL, | |
343 | wxXmlResourceHandler *handlerToUse = NULL) | |
344 | { | |
345 | return node ? DoCreateResFromNode(*node, parent, instance, handlerToUse) | |
346 | : NULL; | |
347 | } | |
348 | ||
349 | // Helper of Load() and Unload(): returns the URL corresponding to the | |
350 | // given file if it's indeed a file, otherwise returns the original string | |
351 | // unmodified | |
352 | static wxString ConvertFileNameToURL(const wxString& filename); | |
353 | ||
354 | // loading resources from archives is impossible without wxFileSystem | |
355 | #if wxUSE_FILESYSTEM | |
356 | // Another helper: detect if the filename is a ZIP or XRS file | |
357 | static bool IsArchive(const wxString& filename); | |
358 | #endif // wxUSE_FILESYSTEM | |
359 | ||
360 | private: | |
361 | wxXmlResourceDataRecords& Data() { return *m_data; } | |
362 | const wxXmlResourceDataRecords& Data() const { return *m_data; } | |
363 | ||
364 | // the real implementation of CreateResFromNode(): this should be only | |
365 | // called if node is non-NULL | |
366 | wxObject *DoCreateResFromNode(wxXmlNode& node, | |
367 | wxObject *parent, | |
368 | wxObject *instance, | |
369 | wxXmlResourceHandler *handlerToUse = NULL); | |
370 | ||
371 | // common part of LoadObject() and LoadObjectRecursively() | |
372 | wxObject *DoLoadObject(wxWindow *parent, | |
373 | const wxString& name, | |
374 | const wxString& classname, | |
375 | bool recursive); | |
376 | bool DoLoadObject(wxObject *instance, | |
377 | wxWindow *parent, | |
378 | const wxString& name, | |
379 | const wxString& classname, | |
380 | bool recursive); | |
381 | ||
382 | private: | |
383 | long m_version; | |
384 | ||
385 | int m_flags; | |
386 | wxVector<wxXmlResourceHandler*> m_handlers; | |
387 | wxXmlResourceDataRecords *m_data; | |
388 | #if wxUSE_FILESYSTEM | |
389 | wxFileSystem m_curFileSystem; | |
390 | wxFileSystem& GetCurFileSystem() { return m_curFileSystem; } | |
391 | #endif | |
392 | ||
393 | // domain to pass to translation functions, if any. | |
394 | wxString m_domain; | |
395 | ||
396 | friend class wxXmlResourceHandler; | |
397 | friend class wxXmlResourceModule; | |
398 | friend class wxIdRangeManager; | |
399 | friend class wxIdRange; | |
400 | ||
401 | static wxXmlSubclassFactories *ms_subclassFactories; | |
402 | ||
403 | // singleton instance: | |
404 | static wxXmlResource *ms_instance; | |
405 | }; | |
406 | ||
407 | ||
408 | // This macro translates string identifier (as used in XML resource, | |
409 | // e.g. <menuitem id="my_menu">...</menuitem>) to integer id that is needed by | |
410 | // wxWidgets event tables. | |
411 | // Example: | |
412 | // BEGIN_EVENT_TABLE(MyFrame, wxFrame) | |
413 | // EVT_MENU(XRCID("quit"), MyFrame::OnQuit) | |
414 | // EVT_MENU(XRCID("about"), MyFrame::OnAbout) | |
415 | // EVT_MENU(XRCID("new"), MyFrame::OnNew) | |
416 | // EVT_MENU(XRCID("open"), MyFrame::OnOpen) | |
417 | // END_EVENT_TABLE() | |
418 | ||
419 | #define XRCID(str_id) \ | |
420 | wxXmlResource::DoGetXRCID(str_id) | |
421 | ||
422 | ||
423 | // This macro returns pointer to particular control in dialog | |
424 | // created using XML resources. You can use it to set/get values from | |
425 | // controls. | |
426 | // Example: | |
427 | // wxDialog dlg; | |
428 | // wxXmlResource::Get()->LoadDialog(&dlg, mainFrame, "my_dialog"); | |
429 | // XRCCTRL(dlg, "my_textctrl", wxTextCtrl)->SetValue(wxT("default value")); | |
430 | ||
431 | #define XRCCTRL(window, id, type) \ | |
432 | (wxStaticCast((window).FindWindow(XRCID(id)), type)) | |
433 | ||
434 | // This macro returns pointer to sizer item | |
435 | // Example: | |
436 | // | |
437 | // <object class="spacer" name="area"> | |
438 | // <size>400, 300</size> | |
439 | // </object> | |
440 | // | |
441 | // wxSizerItem* item = XRCSIZERITEM(*this, "area") | |
442 | ||
443 | #define XRCSIZERITEM(window, id) \ | |
444 | ((window).GetSizer() ? (window).GetSizer()->GetItemById(XRCID(id)) : NULL) | |
445 | ||
446 | // wxXmlResourceHandler is an abstract base class for resource handlers | |
447 | // capable of creating a control from an XML node. | |
448 | ||
449 | class WXDLLIMPEXP_XRC wxXmlResourceHandler : public wxObject | |
450 | { | |
451 | DECLARE_ABSTRACT_CLASS(wxXmlResourceHandler) | |
452 | public: | |
453 | // Constructor. | |
454 | wxXmlResourceHandler(); | |
455 | ||
456 | // Destructor. | |
457 | virtual ~wxXmlResourceHandler() {} | |
458 | ||
459 | // Creates an object (menu, dialog, control, ...) from an XML node. | |
460 | // Should check for validity. | |
461 | // parent is a higher-level object (usually window, dialog or panel) | |
462 | // that is often necessary to create the resource. | |
463 | // If instance is non-NULL it should not create a new instance via 'new' but | |
464 | // should rather use this one, and call its Create method. | |
465 | wxObject *CreateResource(wxXmlNode *node, wxObject *parent, | |
466 | wxObject *instance); | |
467 | ||
468 | // This one is called from CreateResource after variables | |
469 | // were filled. | |
470 | virtual wxObject *DoCreateResource() = 0; | |
471 | ||
472 | // Returns true if it understands this node and can create | |
473 | // a resource from it, false otherwise. | |
474 | virtual bool CanHandle(wxXmlNode *node) = 0; | |
475 | ||
476 | // Sets the parent resource. | |
477 | void SetParentResource(wxXmlResource *res) { m_resource = res; } | |
478 | ||
479 | protected: | |
480 | wxXmlResource *m_resource; | |
481 | wxArrayString m_styleNames; | |
482 | wxArrayInt m_styleValues; | |
483 | ||
484 | // Variables (filled by CreateResource) | |
485 | wxXmlNode *m_node; | |
486 | wxString m_class; | |
487 | wxObject *m_parent, *m_instance; | |
488 | wxWindow *m_parentAsWindow; | |
489 | ||
490 | // --- Handy methods: | |
491 | ||
492 | // Returns true if the node has a property class equal to classname, | |
493 | // e.g. <object class="wxDialog">. | |
494 | static bool IsOfClass(wxXmlNode *node, const wxString& classname); | |
495 | ||
496 | // Gets node content from wxXML_ENTITY_NODE | |
497 | // The problem is, <tag>content<tag> is represented as | |
498 | // wxXML_ENTITY_NODE name="tag", content="" | |
499 | // |-- wxXML_TEXT_NODE or | |
500 | // wxXML_CDATA_SECTION_NODE name="" content="content" | |
501 | wxString GetNodeContent(const wxXmlNode *node); | |
502 | ||
503 | // Check to see if a parameter exists. | |
504 | bool HasParam(const wxString& param); | |
505 | ||
506 | // Finds the node or returns NULL. | |
507 | wxXmlNode *GetParamNode(const wxString& param); | |
508 | ||
509 | // Finds the parameter value or returns the empty string. | |
510 | wxString GetParamValue(const wxString& param); | |
511 | ||
512 | // Returns the parameter value from given node. | |
513 | wxString GetParamValue(const wxXmlNode* node); | |
514 | ||
515 | // Add a style flag (e.g. wxMB_DOCKABLE) to the list of flags | |
516 | // understood by this handler. | |
517 | void AddStyle(const wxString& name, int value); | |
518 | ||
519 | // Add styles common to all wxWindow-derived classes. | |
520 | void AddWindowStyles(); | |
521 | ||
522 | // Gets style flags from text in form "flag | flag2| flag3 |..." | |
523 | // Only understands flags added with AddStyle | |
524 | int GetStyle(const wxString& param = wxT("style"), int defaults = 0); | |
525 | ||
526 | // Gets text from param and does some conversions: | |
527 | // - replaces \n, \r, \t by respective chars (according to C syntax) | |
528 | // - replaces _ by & and __ by _ (needed for _File => &File because of XML) | |
529 | // - calls wxGetTranslations (unless disabled in wxXmlResource) | |
530 | wxString GetText(const wxString& param, bool translate = true); | |
531 | ||
532 | // Returns the XRCID. | |
533 | int GetID(); | |
534 | ||
535 | // Returns the resource name. | |
536 | wxString GetName(); | |
537 | ||
538 | // Gets a bool flag (1, t, yes, on, true are true, everything else is false). | |
539 | bool GetBool(const wxString& param, bool defaultv = false); | |
540 | ||
541 | // Gets an integer value from the parameter. | |
542 | long GetLong(const wxString& param, long defaultv = 0); | |
543 | ||
544 | // Gets a float value from the parameter. | |
545 | float GetFloat(const wxString& param, float defaultv = 0); | |
546 | ||
547 | // Gets colour in HTML syntax (#RRGGBB). | |
548 | wxColour GetColour(const wxString& param, const wxColour& defaultv = wxNullColour); | |
549 | ||
550 | // Gets the size (may be in dialog units). | |
551 | wxSize GetSize(const wxString& param = wxT("size"), | |
552 | wxWindow *windowToUse = NULL); | |
553 | ||
554 | // Gets the position (may be in dialog units). | |
555 | wxPoint GetPosition(const wxString& param = wxT("pos")); | |
556 | ||
557 | // Gets a dimension (may be in dialog units). | |
558 | wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0, | |
559 | wxWindow *windowToUse = NULL); | |
560 | ||
561 | // Gets a bitmap. | |
562 | wxBitmap GetBitmap(const wxString& param = wxT("bitmap"), | |
563 | const wxArtClient& defaultArtClient = wxART_OTHER, | |
564 | wxSize size = wxDefaultSize); | |
565 | ||
566 | // Gets a bitmap from an XmlNode. | |
567 | wxBitmap GetBitmap(const wxXmlNode* node, | |
568 | const wxArtClient& defaultArtClient = wxART_OTHER, | |
569 | wxSize size = wxDefaultSize); | |
570 | ||
571 | // Gets an icon. | |
572 | wxIcon GetIcon(const wxString& param = wxT("icon"), | |
573 | const wxArtClient& defaultArtClient = wxART_OTHER, | |
574 | wxSize size = wxDefaultSize); | |
575 | ||
576 | // Gets an icon from an XmlNode. | |
577 | wxIcon GetIcon(const wxXmlNode* node, | |
578 | const wxArtClient& defaultArtClient = wxART_OTHER, | |
579 | wxSize size = wxDefaultSize); | |
580 | ||
581 | // Gets an icon bundle. | |
582 | wxIconBundle GetIconBundle(const wxString& param, | |
583 | const wxArtClient& defaultArtClient = wxART_OTHER); | |
584 | ||
585 | // Gets an image list. | |
586 | wxImageList *GetImageList(const wxString& param = wxT("imagelist")); | |
587 | ||
588 | #if wxUSE_ANIMATIONCTRL | |
589 | // Gets an animation. | |
590 | wxAnimation GetAnimation(const wxString& param = wxT("animation")); | |
591 | #endif | |
592 | ||
593 | // Gets a font. | |
594 | wxFont GetFont(const wxString& param = wxT("font")); | |
595 | ||
596 | // Gets the value of a boolean attribute (only "0" and "1" are valid values) | |
597 | bool GetBoolAttr(const wxString& attr, bool defaultv); | |
598 | ||
599 | ||
600 | // Sets common window options. | |
601 | void SetupWindow(wxWindow *wnd); | |
602 | ||
603 | // Creates children. | |
604 | void CreateChildren(wxObject *parent, bool this_hnd_only = false); | |
605 | ||
606 | // Helper function. | |
607 | void CreateChildrenPrivately(wxObject *parent, wxXmlNode *rootnode = NULL); | |
608 | ||
609 | // Creates a resource from a node. | |
610 | wxObject *CreateResFromNode(wxXmlNode *node, | |
611 | wxObject *parent, wxObject *instance = NULL) | |
612 | { return m_resource->CreateResFromNode(node, parent, instance); } | |
613 | ||
614 | // helper | |
615 | #if wxUSE_FILESYSTEM | |
616 | wxFileSystem& GetCurFileSystem() { return m_resource->GetCurFileSystem(); } | |
617 | #endif | |
618 | ||
619 | // reports input error at position 'context' | |
620 | void ReportError(wxXmlNode *context, const wxString& message); | |
621 | // reports input error at m_node | |
622 | void ReportError(const wxString& message); | |
623 | // reports input error when parsing parameter with given name | |
624 | void ReportParamError(const wxString& param, const wxString& message); | |
625 | }; | |
626 | ||
627 | ||
628 | // Programmer-friendly macros for writing XRC handlers: | |
629 | ||
630 | #define XRC_ADD_STYLE(style) AddStyle(wxT(#style), style) | |
631 | ||
632 | #define XRC_MAKE_INSTANCE(variable, classname) \ | |
633 | classname *variable = NULL; \ | |
634 | if (m_instance) \ | |
635 | variable = wxStaticCast(m_instance, classname); \ | |
636 | if (!variable) \ | |
637 | variable = new classname; | |
638 | ||
639 | ||
640 | // FIXME -- remove this $%^#$%#$@# as soon as Ron checks his changes in!! | |
641 | WXDLLIMPEXP_XRC void wxXmlInitResourceModule(); | |
642 | ||
643 | ||
644 | // This class is used to create instances of XRC "object" nodes with "subclass" | |
645 | // property. It is _not_ supposed to be used by XRC users, you should instead | |
646 | // register your subclasses via wxWidgets' RTTI mechanism. This class is useful | |
647 | // only for language bindings developer who need a way to implement subclassing | |
648 | // in wxWidgets ports that don't support wxRTTI (e.g. wxPython). | |
649 | class WXDLLIMPEXP_XRC wxXmlSubclassFactory | |
650 | { | |
651 | public: | |
652 | // Try to create instance of given class and return it, return NULL on | |
653 | // failure: | |
654 | virtual wxObject *Create(const wxString& className) = 0; | |
655 | virtual ~wxXmlSubclassFactory() {} | |
656 | }; | |
657 | ||
658 | ||
659 | /* ------------------------------------------------------------------------- | |
660 | Backward compatibility macros. Do *NOT* use, they may disappear in future | |
661 | versions of the XRC library! | |
662 | ------------------------------------------------------------------------- */ | |
663 | ||
664 | #endif // wxUSE_XRC | |
665 | ||
666 | #endif // _WX_XMLRES_H_ |