]>
Commit | Line | Data |
---|---|---|
56d2f750 | 1 | ///////////////////////////////////////////////////////////////////////////// |
e8a793f0 | 2 | // Name: wx/xrc/xmlres.h |
56d2f750 VS |
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 | ||
56d2f750 | 14 | #include "wx/defs.h" |
a1e4ec87 | 15 | |
621be1ec | 16 | #if wxUSE_XRC |
a1e4ec87 | 17 | |
56d2f750 VS |
18 | #include "wx/string.h" |
19 | #include "wx/dynarray.h" | |
7f5b84c2 | 20 | #include "wx/arrstr.h" |
56d2f750 | 21 | #include "wx/datetime.h" |
8e8a4e85 | 22 | #include "wx/list.h" |
56d2f750 | 23 | #include "wx/gdicmn.h" |
792064e9 VS |
24 | #include "wx/filesys.h" |
25 | #include "wx/bitmap.h" | |
26 | #include "wx/icon.h" | |
af1337b0 | 27 | #include "wx/artprov.h" |
836724c3 | 28 | #include "wx/colour.h" |
9e29cd0a | 29 | #include "wx/animate.h" |
eb2d0d23 | 30 | #include "wx/vector.h" |
56d2f750 | 31 | |
a90d7e68 VS |
32 | #include "wx/xml/xml.h" |
33 | ||
159852ae VS |
34 | class WXDLLIMPEXP_FWD_BASE wxFileName; |
35 | ||
1c60f644 | 36 | class WXDLLIMPEXP_FWD_CORE wxIconBundle; |
326462ae | 37 | class WXDLLIMPEXP_FWD_CORE wxImageList; |
b5dbe15d VS |
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; | |
eb2d0d23 | 48 | class wxXmlSubclassFactories; |
2b5f62a0 | 49 | class wxXmlResourceModule; |
eb2d0d23 | 50 | class wxXmlResourceDataRecords; |
56d2f750 | 51 | |
1ce70313 VS |
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: | |
30dc3455 VS |
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. | |
1ce70313 VS |
59 | // - if you change version number, follow these steps: |
60 | // - set major, minor and release numbers to respective version numbers of | |
be5a51fb | 61 | // the wxWidgets library (see wx/version.h) |
30dc3455 VS |
62 | // - reset revision to 0 unless the first three are same as before, |
63 | // in which case you should increase revision by one | |
1ce70313 | 64 | #define WX_XMLRES_CURRENT_VERSION_MAJOR 2 |
984c33c9 VS |
65 | #define WX_XMLRES_CURRENT_VERSION_MINOR 5 |
66 | #define WX_XMLRES_CURRENT_VERSION_RELEASE 3 | |
67 | #define WX_XMLRES_CURRENT_VERSION_REVISION 0 | |
9a83f860 | 68 | #define WX_XMLRES_CURRENT_VERSION_STRING wxT("2.5.3.0") |
1ce70313 VS |
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) | |
56d2f750 | 75 | |
daa85ee3 VS |
76 | enum wxXmlResourceFlags |
77 | { | |
78 | wxXRC_USE_LOCALE = 1, | |
648db587 VS |
79 | wxXRC_NO_SUBCLASSING = 2, |
80 | wxXRC_NO_RELOADING = 4 | |
daa85ee3 | 81 | }; |
ea89ec17 RD |
82 | |
83 | // This class holds XML resources from one or more .xml files | |
56d2f750 | 84 | // (or derived forms, either binary or zipped -- see manual for |
ea89ec17 | 85 | // details). |
30dc3455 | 86 | class WXDLLIMPEXP_XRC wxXmlResource : public wxObject |
56d2f750 | 87 | { |
eb8671f2 | 88 | public: |
273b399f | 89 | // Constructor. |
daa85ee3 VS |
90 | // Flags: wxXRC_USE_LOCALE |
91 | // translatable strings will be translated via _() | |
d4a724d4 | 92 | // using the given domain if specified |
daa85ee3 VS |
93 | // wxXRC_NO_SUBCLASSING |
94 | // subclass property of object nodes will be ignored | |
95 | // (useful for previews in XRC editors) | |
cd900c59 VZ |
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 | |
d4a724d4 | 99 | wxXmlResource(int flags = wxXRC_USE_LOCALE, |
d7a80cf5 | 100 | const wxString& domain = wxEmptyString); |
273b399f JS |
101 | |
102 | // Constructor. | |
103 | // Flags: wxXRC_USE_LOCALE | |
104 | // translatable strings will be translated via _() | |
d4a724d4 | 105 | // using the given domain if specified |
273b399f JS |
106 | // wxXRC_NO_SUBCLASSING |
107 | // subclass property of object nodes will be ignored | |
108 | // (useful for previews in XRC editors) | |
d4a724d4 | 109 | wxXmlResource(const wxString& filemask, int flags = wxXRC_USE_LOCALE, |
d7a80cf5 | 110 | const wxString& domain = wxEmptyString); |
273b399f JS |
111 | |
112 | // Destructor. | |
d3c7fc99 | 113 | virtual ~wxXmlResource(); |
92e898b0 | 114 | |
eb8671f2 | 115 | // Loads resources from XML files that match given filemask. |
04ae32cd | 116 | // This method understands wxFileSystem URLs if wxUSE_FILESYS. |
eb8671f2 VS |
117 | bool Load(const wxString& filemask); |
118 | ||
04ae32cd VS |
119 | // Loads resources from single XRC file. |
120 | bool LoadFile(const wxFileName& file); | |
121 | ||
2bb9a404 VS |
122 | // Loads all XRC files from a directory. |
123 | bool LoadAllFiles(const wxString& dirname); | |
124 | ||
60fd818a VZ |
125 | // Unload resource from the given XML file (wildcards not allowed) |
126 | bool Unload(const wxString& filename); | |
127 | ||
eb8671f2 VS |
128 | // Initialize handlers for all supported controls/windows. This will |
129 | // make the executable quite big because it forces linking against | |
be5a51fb | 130 | // most of the wxWidgets library. |
eb8671f2 VS |
131 | void InitAllHandlers(); |
132 | ||
273b399f | 133 | // Initialize only a specific handler (or custom handler). Convention says |
30dc3455 VS |
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. | |
eb8671f2 VS |
138 | void AddHandler(wxXmlResourceHandler *handler); |
139 | ||
6f2df68e | 140 | // Add a new handler at the beginning of the handler list |
92e898b0 RD |
141 | void InsertHandler(wxXmlResourceHandler *handler); |
142 | ||
eb8671f2 VS |
143 | // Removes all handlers |
144 | void ClearHandlers(); | |
408ac1b8 | 145 | |
2b5f62a0 VZ |
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); | |
eb8671f2 VS |
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. | |
4a1b9596 | 155 | wxMenuBar *LoadMenuBar(wxWindow *parent, const wxString& name); |
273b399f JS |
156 | |
157 | // Loads menubar from resource. Returns NULL on failure. | |
4a1b9596 | 158 | wxMenuBar *LoadMenuBar(const wxString& name) { return LoadMenuBar(NULL, name); } |
56d2f750 | 159 | |
792064e9 | 160 | #if wxUSE_TOOLBAR |
273b399f | 161 | // Loads a toolbar. |
eb8671f2 | 162 | wxToolBar *LoadToolBar(wxWindow *parent, const wxString& name); |
792064e9 VS |
163 | #endif |
164 | ||
273b399f JS |
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 | |
eb8671f2 VS |
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(); | |
eb8671f2 VS |
175 | bool LoadDialog(wxDialog *dlg, wxWindow *parent, const wxString& name); |
176 | ||
273b399f | 177 | // Loads a panel. panel points to parent window (if any). |
eb8671f2 | 178 | wxPanel *LoadPanel(wxWindow *parent, const wxString& name); |
273b399f JS |
179 | |
180 | // Loads a panel. panel points to parent window (if any). This form | |
181 | // is used to finish creation of already existing instance. | |
eb8671f2 VS |
182 | bool LoadPanel(wxPanel *panel, wxWindow *parent, const wxString& name); |
183 | ||
273b399f | 184 | // Loads a frame. |
92e898b0 | 185 | wxFrame *LoadFrame(wxWindow* parent, const wxString& name); |
eb8671f2 VS |
186 | bool LoadFrame(wxFrame* frame, wxWindow *parent, const wxString& name); |
187 | ||
92e898b0 RD |
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, | |
af0ac990 VZ |
191 | const wxString& classname) |
192 | { | |
193 | return DoLoadObject(parent, name, classname, false /* !recursive */); | |
194 | } | |
92e898b0 RD |
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. | |
af0ac990 VZ |
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 | } | |
92e898b0 | 225 | |
273b399f | 226 | // Loads a bitmap resource from a file. |
eb8671f2 | 227 | wxBitmap LoadBitmap(const wxString& name); |
273b399f JS |
228 | |
229 | // Loads an icon resource from a file. | |
eb8671f2 | 230 | wxIcon LoadIcon(const wxString& name); |
ea89ec17 | 231 | |
273b399f JS |
232 | // Attaches an unknown control to the given panel/window/dialog. |
233 | // Unknown controls are used in conjunction with <object class="unknown">. | |
e6c3f404 VS |
234 | bool AttachUnknownControl(const wxString& name, wxWindow *control, |
235 | wxWindow *parent = NULL); | |
eb8671f2 | 236 | |
9b2a7469 VZ |
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 | |
9249d38d | 241 | // wxWindow::NewControlId(). Otherwise value_if_not_found is used. |
9b2a7469 | 242 | // Macro XRCID(name) is provided for convenient use in event tables. |
c560da98 VS |
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); | |
ea89ec17 | 248 | |
cc378c2d VZ |
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 | ||
273b399f | 258 | // Returns version information (a.b.c.d = d+ 256*c + 256^2*b + 256^3*a). |
1ce70313 | 259 | long GetVersion() const { return m_version; } |
ea89ec17 | 260 | |
1ce70313 VS |
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 | |
ea89ec17 | 264 | { return GetVersion() - |
1ce70313 | 265 | (major*256*256*256 + minor*256*256 + release*256 + revision); } |
92e898b0 | 266 | |
23239d94 | 267 | //// Singleton accessors. |
92e898b0 | 268 | |
273b399f | 269 | // Gets the global resources object or creates one if none exists. |
824e8eaa | 270 | static wxXmlResource *Get(); |
273b399f JS |
271 | |
272 | // Sets the global resources object and returns a pointer to the previous one (may be NULL). | |
824e8eaa | 273 | static wxXmlResource *Set(wxXmlResource *res); |
eb8671f2 | 274 | |
74c107ba | 275 | // Returns flags, which may be a bitlist of wxXRC_USE_LOCALE and wxXRC_NO_SUBCLASSING. |
2b5f62a0 VZ |
276 | int GetFlags() const { return m_flags; } |
277 | // Set flags after construction. | |
278 | void SetFlags(int flags) { m_flags = flags; } | |
74c107ba | 279 | |
d7a80cf5 VS |
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 | ||
23239d94 VZ |
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 | ||
eb8671f2 | 294 | protected: |
819559b2 | 295 | // reports input error at position 'context' |
1f6ea935 | 296 | void ReportError(const wxXmlNode *context, const wxString& message); |
819559b2 VS |
297 | |
298 | // override this in derived class to customize errors reporting | |
1f6ea935 | 299 | virtual void DoReportError(const wxString& xrcFile, const wxXmlNode *position, |
819559b2 VS |
300 | const wxString& message); |
301 | ||
9fc5a47c VZ |
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 | ||
273b399f | 306 | // Scans the resources list for unloaded files and loads them. Also reloads |
eb8671f2 | 307 | // files that have been modified since last loading. |
d614f51b | 308 | bool UpdateResources(); |
eb8671f2 | 309 | |
273b399f | 310 | |
23239d94 VZ |
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; | |
eb8671f2 | 338 | |
e5db1609 VS |
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, | |
af0ac990 VZ |
343 | wxXmlResourceHandler *handlerToUse = NULL) |
344 | { | |
345 | return node ? DoCreateResFromNode(*node, parent, instance, handlerToUse) | |
346 | : NULL; | |
347 | } | |
eb8671f2 | 348 | |
60fd818a VZ |
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 | ||
eb2d0d23 VS |
360 | private: |
361 | wxXmlResourceDataRecords& Data() { return *m_data; } | |
362 | const wxXmlResourceDataRecords& Data() const { return *m_data; } | |
363 | ||
af0ac990 VZ |
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 | ||
eb8671f2 | 382 | private: |
1ce70313 | 383 | long m_version; |
ea89ec17 | 384 | |
daa85ee3 | 385 | int m_flags; |
b85e0ae0 | 386 | wxVector<wxXmlResourceHandler*> m_handlers; |
eb2d0d23 | 387 | wxXmlResourceDataRecords *m_data; |
792064e9 | 388 | #if wxUSE_FILESYSTEM |
eb8671f2 VS |
389 | wxFileSystem m_curFileSystem; |
390 | wxFileSystem& GetCurFileSystem() { return m_curFileSystem; } | |
792064e9 VS |
391 | #endif |
392 | ||
d4a724d4 | 393 | // domain to pass to translation functions, if any. |
d7a80cf5 VS |
394 | wxString m_domain; |
395 | ||
eb8671f2 | 396 | friend class wxXmlResourceHandler; |
2b5f62a0 | 397 | friend class wxXmlResourceModule; |
0526c8cc VZ |
398 | friend class wxIdRangeManager; |
399 | friend class wxIdRange; | |
2b5f62a0 | 400 | |
eb2d0d23 | 401 | static wxXmlSubclassFactories *ms_subclassFactories; |
92e898b0 | 402 | |
824e8eaa VS |
403 | // singleton instance: |
404 | static wxXmlResource *ms_instance; | |
56d2f750 VS |
405 | }; |
406 | ||
407 | ||
56d2f750 VS |
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 | |
be5a51fb | 410 | // wxWidgets event tables. |
56d2f750 VS |
411 | // Example: |
412 | // BEGIN_EVENT_TABLE(MyFrame, wxFrame) | |
5ed345b7 VS |
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) | |
ea89ec17 | 417 | // END_EVENT_TABLE() |
45a24817 | 418 | |
5ed345b7 | 419 | #define XRCID(str_id) \ |
c560da98 | 420 | wxXmlResource::DoGetXRCID(str_id) |
45a24817 VS |
421 | |
422 | ||
45a24817 VS |
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; | |
546b0006 | 428 | // wxXmlResource::Get()->LoadDialog(&dlg, mainFrame, "my_dialog"); |
5ed345b7 | 429 | // XRCCTRL(dlg, "my_textctrl", wxTextCtrl)->SetValue(wxT("default value")); |
45a24817 | 430 | |
5ed345b7 | 431 | #define XRCCTRL(window, id, type) \ |
ae688b64 | 432 | (wxStaticCast((window).FindWindow(XRCID(id)), type)) |
56d2f750 | 433 | |
86909f4c VZ |
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 | // | |
03cf4aa6 | 441 | // wxSizerItem* item = XRCSIZERITEM(*this, "area") |
86909f4c VZ |
442 | |
443 | #define XRCSIZERITEM(window, id) \ | |
03cf4aa6 | 444 | ((window).GetSizer() ? (window).GetSizer()->GetItemById(XRCID(id)) : NULL) |
86909f4c | 445 | |
273b399f JS |
446 | // wxXmlResourceHandler is an abstract base class for resource handlers |
447 | // capable of creating a control from an XML node. | |
56d2f750 | 448 | |
30dc3455 | 449 | class WXDLLIMPEXP_XRC wxXmlResourceHandler : public wxObject |
56d2f750 | 450 | { |
854e189f | 451 | DECLARE_ABSTRACT_CLASS(wxXmlResourceHandler) |
eb8671f2 | 452 | public: |
273b399f | 453 | // Constructor. |
eb8671f2 | 454 | wxXmlResourceHandler(); |
273b399f JS |
455 | |
456 | // Destructor. | |
eb8671f2 VS |
457 | virtual ~wxXmlResourceHandler() {} |
458 | ||
273b399f | 459 | // Creates an object (menu, dialog, control, ...) from an XML node. |
eb8671f2 | 460 | // Should check for validity. |
273b399f | 461 | // parent is a higher-level object (usually window, dialog or panel) |
3103e8a9 | 462 | // that is often necessary to create the resource. |
273b399f JS |
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. | |
ea89ec17 | 465 | wxObject *CreateResource(wxXmlNode *node, wxObject *parent, |
eb8671f2 VS |
466 | wxObject *instance); |
467 | ||
468 | // This one is called from CreateResource after variables | |
273b399f | 469 | // were filled. |
eb8671f2 VS |
470 | virtual wxObject *DoCreateResource() = 0; |
471 | ||
f80ea77b WS |
472 | // Returns true if it understands this node and can create |
473 | // a resource from it, false otherwise. | |
eb8671f2 VS |
474 | virtual bool CanHandle(wxXmlNode *node) = 0; |
475 | ||
273b399f | 476 | // Sets the parent resource. |
eb8671f2 VS |
477 | void SetParentResource(wxXmlResource *res) { m_resource = res; } |
478 | ||
eb8671f2 | 479 | protected: |
eb8671f2 VS |
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; | |
9a8d8c5a | 488 | wxWindow *m_parentAsWindow; |
eb8671f2 VS |
489 | |
490 | // --- Handy methods: | |
491 | ||
273b399f JS |
492 | // Returns true if the node has a property class equal to classname, |
493 | // e.g. <object class="wxDialog">. | |
8ec22772 | 494 | static bool IsOfClass(wxXmlNode *node, const wxString& classname); |
eb8671f2 VS |
495 | |
496 | // Gets node content from wxXML_ENTITY_NODE | |
273b399f | 497 | // The problem is, <tag>content<tag> is represented as |
eb8671f2 | 498 | // wxXML_ENTITY_NODE name="tag", content="" |
ea89ec17 | 499 | // |-- wxXML_TEXT_NODE or |
eb8671f2 | 500 | // wxXML_CDATA_SECTION_NODE name="" content="content" |
326462ae | 501 | wxString GetNodeContent(const wxXmlNode *node); |
eb8671f2 | 502 | |
273b399f | 503 | // Check to see if a parameter exists. |
ea89ec17 | 504 | bool HasParam(const wxString& param); |
eb8671f2 | 505 | |
273b399f | 506 | // Finds the node or returns NULL. |
eb8671f2 | 507 | wxXmlNode *GetParamNode(const wxString& param); |
273b399f JS |
508 | |
509 | // Finds the parameter value or returns the empty string. | |
eb8671f2 VS |
510 | wxString GetParamValue(const wxString& param); |
511 | ||
326462ae VZ |
512 | // Returns the parameter value from given node. |
513 | wxString GetParamValue(const wxXmlNode* node); | |
514 | ||
273b399f JS |
515 | // Add a style flag (e.g. wxMB_DOCKABLE) to the list of flags |
516 | // understood by this handler. | |
eb8671f2 VS |
517 | void AddStyle(const wxString& name, int value); |
518 | ||
273b399f | 519 | // Add styles common to all wxWindow-derived classes. |
eb8671f2 VS |
520 | void AddWindowStyles(); |
521 | ||
522 | // Gets style flags from text in form "flag | flag2| flag3 |..." | |
43e8916f | 523 | // Only understands flags added with AddStyle |
eb8671f2 VS |
524 | int GetStyle(const wxString& param = wxT("style"), int defaults = 0); |
525 | ||
273b399f | 526 | // Gets text from param and does some conversions: |
eb8671f2 | 527 | // - replaces \n, \r, \t by respective chars (according to C syntax) |
ee1046d1 | 528 | // - replaces _ by & and __ by _ (needed for _File => &File because of XML) |
eb8671f2 | 529 | // - calls wxGetTranslations (unless disabled in wxXmlResource) |
f80ea77b | 530 | wxString GetText(const wxString& param, bool translate = true); |
eb8671f2 | 531 | |
5ed345b7 | 532 | // Returns the XRCID. |
eb8671f2 | 533 | int GetID(); |
273b399f JS |
534 | |
535 | // Returns the resource name. | |
eb8671f2 VS |
536 | wxString GetName(); |
537 | ||
f80ea77b WS |
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); | |
eb8671f2 | 540 | |
1df61962 VS |
541 | // Gets an integer value from the parameter. |
542 | long GetLong(const wxString& param, long defaultv = 0); | |
0c00c86f | 543 | |
1df61962 VS |
544 | // Gets a float value from the parameter. |
545 | float GetFloat(const wxString& param, float defaultv = 0); | |
eb8671f2 | 546 | |
273b399f | 547 | // Gets colour in HTML syntax (#RRGGBB). |
984f1d84 | 548 | wxColour GetColour(const wxString& param, const wxColour& defaultv = wxNullColour); |
eb8671f2 | 549 | |
273b399f | 550 | // Gets the size (may be in dialog units). |
0c00c86f VS |
551 | wxSize GetSize(const wxString& param = wxT("size"), |
552 | wxWindow *windowToUse = NULL); | |
273b399f JS |
553 | |
554 | // Gets the position (may be in dialog units). | |
eb8671f2 VS |
555 | wxPoint GetPosition(const wxString& param = wxT("pos")); |
556 | ||
273b399f | 557 | // Gets a dimension (may be in dialog units). |
0c00c86f VS |
558 | wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0, |
559 | wxWindow *windowToUse = NULL); | |
eb8671f2 | 560 | |
50c20291 VZ |
561 | // Gets a direction, complains if the value is invalid. |
562 | wxDirection GetDirection(const wxString& param, wxDirection dir = wxLEFT); | |
563 | ||
273b399f | 564 | // Gets a bitmap. |
1ce70313 | 565 | wxBitmap GetBitmap(const wxString& param = wxT("bitmap"), |
7a442f31 | 566 | const wxArtClient& defaultArtClient = wxART_OTHER, |
eb8671f2 | 567 | wxSize size = wxDefaultSize); |
273b399f | 568 | |
326462ae VZ |
569 | // Gets a bitmap from an XmlNode. |
570 | wxBitmap GetBitmap(const wxXmlNode* node, | |
571 | const wxArtClient& defaultArtClient = wxART_OTHER, | |
572 | wxSize size = wxDefaultSize); | |
573 | ||
273b399f | 574 | // Gets an icon. |
1ce70313 | 575 | wxIcon GetIcon(const wxString& param = wxT("icon"), |
7a442f31 | 576 | const wxArtClient& defaultArtClient = wxART_OTHER, |
eb8671f2 VS |
577 | wxSize size = wxDefaultSize); |
578 | ||
326462ae VZ |
579 | // Gets an icon from an XmlNode. |
580 | wxIcon GetIcon(const wxXmlNode* node, | |
581 | const wxArtClient& defaultArtClient = wxART_OTHER, | |
582 | wxSize size = wxDefaultSize); | |
583 | ||
1c60f644 VS |
584 | // Gets an icon bundle. |
585 | wxIconBundle GetIconBundle(const wxString& param, | |
586 | const wxArtClient& defaultArtClient = wxART_OTHER); | |
587 | ||
326462ae VZ |
588 | // Gets an image list. |
589 | wxImageList *GetImageList(const wxString& param = wxT("imagelist")); | |
590 | ||
9e29cd0a RR |
591 | #if wxUSE_ANIMATIONCTRL |
592 | // Gets an animation. | |
593 | wxAnimation GetAnimation(const wxString& param = wxT("animation")); | |
594 | #endif | |
595 | ||
273b399f | 596 | // Gets a font. |
45df4bb6 | 597 | wxFont GetFont(const wxString& param = wxT("font"), wxWindow* parent = NULL); |
eb8671f2 | 598 | |
8758875e VZ |
599 | // Gets the value of a boolean attribute (only "0" and "1" are valid values) |
600 | bool GetBoolAttr(const wxString& attr, bool defaultv); | |
601 | ||
602 | ||
273b399f | 603 | // Sets common window options. |
eb8671f2 VS |
604 | void SetupWindow(wxWindow *wnd); |
605 | ||
273b399f | 606 | // Creates children. |
f80ea77b | 607 | void CreateChildren(wxObject *parent, bool this_hnd_only = false); |
273b399f JS |
608 | |
609 | // Helper function. | |
eb8671f2 | 610 | void CreateChildrenPrivately(wxObject *parent, wxXmlNode *rootnode = NULL); |
273b399f JS |
611 | |
612 | // Creates a resource from a node. | |
ea89ec17 | 613 | wxObject *CreateResFromNode(wxXmlNode *node, |
eb8671f2 VS |
614 | wxObject *parent, wxObject *instance = NULL) |
615 | { return m_resource->CreateResFromNode(node, parent, instance); } | |
616 | ||
617 | // helper | |
150e58d8 | 618 | #if wxUSE_FILESYSTEM |
eb8671f2 | 619 | wxFileSystem& GetCurFileSystem() { return m_resource->GetCurFileSystem(); } |
150e58d8 | 620 | #endif |
819559b2 VS |
621 | |
622 | // reports input error at position 'context' | |
623 | void ReportError(wxXmlNode *context, const wxString& message); | |
624 | // reports input error at m_node | |
625 | void ReportError(const wxString& message); | |
626 | // reports input error when parsing parameter with given name | |
627 | void ReportParamError(const wxString& param, const wxString& message); | |
56d2f750 VS |
628 | }; |
629 | ||
daa85ee3 VS |
630 | |
631 | // Programmer-friendly macros for writing XRC handlers: | |
632 | ||
633 | #define XRC_ADD_STYLE(style) AddStyle(wxT(#style), style) | |
daa85ee3 VS |
634 | |
635 | #define XRC_MAKE_INSTANCE(variable, classname) \ | |
636 | classname *variable = NULL; \ | |
637 | if (m_instance) \ | |
638 | variable = wxStaticCast(m_instance, classname); \ | |
639 | if (!variable) \ | |
640 | variable = new classname; | |
56d2f750 VS |
641 | |
642 | ||
daa85ee3 | 643 | // FIXME -- remove this $%^#$%#$@# as soon as Ron checks his changes in!! |
408ac1b8 | 644 | WXDLLIMPEXP_XRC void wxXmlInitResourceModule(); |
56d2f750 | 645 | |
546b0006 | 646 | |
2b5f62a0 VZ |
647 | // This class is used to create instances of XRC "object" nodes with "subclass" |
648 | // property. It is _not_ supposed to be used by XRC users, you should instead | |
be5a51fb | 649 | // register your subclasses via wxWidgets' RTTI mechanism. This class is useful |
2b5f62a0 | 650 | // only for language bindings developer who need a way to implement subclassing |
be5a51fb | 651 | // in wxWidgets ports that don't support wxRTTI (e.g. wxPython). |
30dc3455 | 652 | class WXDLLIMPEXP_XRC wxXmlSubclassFactory |
2b5f62a0 VZ |
653 | { |
654 | public: | |
30dc3455 VS |
655 | // Try to create instance of given class and return it, return NULL on |
656 | // failure: | |
2b5f62a0 VZ |
657 | virtual wxObject *Create(const wxString& className) = 0; |
658 | virtual ~wxXmlSubclassFactory() {} | |
659 | }; | |
660 | ||
661 | ||
92e898b0 | 662 | /* ------------------------------------------------------------------------- |
546b0006 VS |
663 | Backward compatibility macros. Do *NOT* use, they may disappear in future |
664 | versions of the XRC library! | |
665 | ------------------------------------------------------------------------- */ | |
546b0006 | 666 | |
621be1ec | 667 | #endif // wxUSE_XRC |
546b0006 | 668 | |
56d2f750 | 669 | #endif // _WX_XMLRES_H_ |