X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eb2d0d232c7d9ba22c5e82d5b7413b2d647e6c9c..9869c26285dc51d13607cddaa04f65ce983653a5:/include/wx/xrc/xmlres.h
diff --git a/include/wx/xrc/xmlres.h b/include/wx/xrc/xmlres.h
index 159e9722f6..f69d9939d9 100644
--- a/include/wx/xrc/xmlres.h
+++ b/include/wx/xrc/xmlres.h
@@ -3,7 +3,6 @@
// Purpose: XML resources
// Author: Vaclav Slavik
// Created: 2000/03/05
-// RCS-ID: $Id$
// Copyright: (c) 2000 Vaclav Slavik
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
@@ -17,6 +16,7 @@
#include "wx/string.h"
#include "wx/dynarray.h"
+#include "wx/arrstr.h"
#include "wx/datetime.h"
#include "wx/list.h"
#include "wx/gdicmn.h"
@@ -25,11 +25,14 @@
#include "wx/icon.h"
#include "wx/artprov.h"
#include "wx/colour.h"
-#include "wx/animate.h"
#include "wx/vector.h"
-#include "wx/xml/xml.h"
+#include "wx/xrc/xmlreshandler.h"
+class WXDLLIMPEXP_FWD_BASE wxFileName;
+
+class WXDLLIMPEXP_FWD_CORE wxIconBundle;
+class WXDLLIMPEXP_FWD_CORE wxImageList;
class WXDLLIMPEXP_FWD_CORE wxMenu;
class WXDLLIMPEXP_FWD_CORE wxMenuBar;
class WXDLLIMPEXP_FWD_CORE wxDialog;
@@ -38,13 +41,13 @@ class WXDLLIMPEXP_FWD_CORE wxWindow;
class WXDLLIMPEXP_FWD_CORE wxFrame;
class WXDLLIMPEXP_FWD_CORE wxToolBar;
-class WXDLLIMPEXP_FWD_XRC wxXmlResourceHandler;
+class WXDLLIMPEXP_FWD_XML wxXmlDocument;
+class WXDLLIMPEXP_FWD_XML wxXmlNode;
class WXDLLIMPEXP_FWD_XRC wxXmlSubclassFactory;
class wxXmlSubclassFactories;
class wxXmlResourceModule;
class wxXmlResourceDataRecords;
-
// These macros indicate current version of XML resources (this information is
// encoded in root node of XRC file as "version" property).
//
@@ -61,7 +64,7 @@ class wxXmlResourceDataRecords;
#define WX_XMLRES_CURRENT_VERSION_MINOR 5
#define WX_XMLRES_CURRENT_VERSION_RELEASE 3
#define WX_XMLRES_CURRENT_VERSION_REVISION 0
-#define WX_XMLRES_CURRENT_VERSION_STRING _T("2.5.3.0")
+#define WX_XMLRES_CURRENT_VERSION_STRING wxT("2.5.3.0")
#define WX_XMLRES_CURRENT_VERSION \
(WX_XMLRES_CURRENT_VERSION_MAJOR * 256*256*256 + \
@@ -108,12 +111,16 @@ public:
// Destructor.
virtual ~wxXmlResource();
- wxXmlNode *GetFirstRoot();
-
// Loads resources from XML files that match given filemask.
- // This method understands VFS (see filesys.h).
+ // This method understands wxFileSystem URLs if wxUSE_FILESYS.
bool Load(const wxString& filemask);
+ // Loads resources from single XRC file.
+ bool LoadFile(const wxFileName& file);
+
+ // Loads all XRC files from a directory.
+ bool LoadAllFiles(const wxString& dirname);
+
// Unload resource from the given XML file (wildcards not allowed)
bool Unload(const wxString& filename);
@@ -129,7 +136,7 @@ public:
// code for all controls used within the resource.
void AddHandler(wxXmlResourceHandler *handler);
- // Add a new handler at the begining of the handler list
+ // Add a new handler at the beginning of the handler list
void InsertHandler(wxXmlResourceHandler *handler);
// Removes all handlers
@@ -180,13 +187,40 @@ public:
// Load an object from the resource specifying both the resource name and
// the classname. This lets you load nonstandard container windows.
wxObject *LoadObject(wxWindow *parent, const wxString& name,
- const wxString& classname);
+ const wxString& classname)
+ {
+ return DoLoadObject(parent, name, classname, false /* !recursive */);
+ }
// Load an object from the resource specifying both the resource name and
// the classname. This form lets you finish the creation of an existing
// instance.
- bool LoadObject(wxObject *instance, wxWindow *parent, const wxString& name,
- const wxString& classname);
+ bool LoadObject(wxObject *instance,
+ wxWindow *parent,
+ const wxString& name,
+ const wxString& classname)
+ {
+ return DoLoadObject(instance, parent, name, classname, false);
+ }
+
+ // These versions of LoadObject() look for the object with the given name
+ // recursively (breadth first) and can be used to instantiate an individual
+ // control defined anywhere in an XRC file. No check is done that the name
+ // is unique, it's up to the caller to ensure this.
+ wxObject *LoadObjectRecursively(wxWindow *parent,
+ const wxString& name,
+ const wxString& classname)
+ {
+ return DoLoadObject(parent, name, classname, true /* recursive */);
+ }
+
+ bool LoadObjectRecursively(wxObject *instance,
+ wxWindow *parent,
+ const wxString& name,
+ const wxString& classname)
+ {
+ return DoLoadObject(instance, parent, name, classname, true);
+ }
// Loads a bitmap resource from a file.
wxBitmap LoadBitmap(const wxString& name);
@@ -211,16 +245,33 @@ public:
// version for internal use only
static int DoGetXRCID(const char *str_id, int value_if_not_found = wxID_NONE);
+
+ // Find the string ID with the given numeric value, returns an empty string
+ // if no such ID is found.
+ //
+ // Notice that unlike GetXRCID(), which is fast, this operation is slow as
+ // it checks all the IDs used in XRC.
+ static wxString FindXRCIDById(int numId);
+
+
// Returns version information (a.b.c.d = d+ 256*c + 256^2*b + 256^3*a).
long GetVersion() const { return m_version; }
// Compares resources version to argument. Returns -1 if resources version
// is less than the argument, +1 if greater and 0 if they equal.
int CompareVersion(int major, int minor, int release, int revision) const
- { return GetVersion() -
- (major*256*256*256 + minor*256*256 + release*256 + revision); }
-
-//// Singleton accessors.
+ {
+ long diff = GetVersion() -
+ (major*256*256*256 + minor*256*256 + release*256 + revision);
+ if ( diff < 0 )
+ return -1;
+ else if ( diff > 0 )
+ return +1;
+ else
+ return 0;
+ }
+
+ //// Singleton accessors.
// Gets the global resources object or creates one if none exists.
static wxXmlResource *Get();
@@ -238,22 +289,69 @@ public:
const wxString& GetDomain() const { return m_domain; }
void SetDomain(const wxString& domain);
+
+ // This function returns the wxXmlNode containing the definition of the
+ // object with the given name or NULL.
+ //
+ // It can be used to access additional information defined in the XRC file
+ // and not used by wxXmlResource itself.
+ const wxXmlNode *GetResourceNode(const wxString& name) const
+ { return GetResourceNodeAndLocation(name, wxString(), true); }
+
protected:
+ // reports input error at position 'context'
+ void ReportError(const wxXmlNode *context, const wxString& message);
+
+ // override this in derived class to customize errors reporting
+ virtual void DoReportError(const wxString& xrcFile, const wxXmlNode *position,
+ const wxString& message);
+
+ // Load the contents of a single file and returns its contents as a new
+ // wxXmlDocument (which will be owned by caller) on success or NULL.
+ wxXmlDocument *DoLoadFile(const wxString& file);
+
// Scans the resources list for unloaded files and loads them. Also reloads
// files that have been modified since last loading.
bool UpdateResources();
- // Finds a resource (calls UpdateResources) and returns a node containing it.
- wxXmlNode *FindResource(const wxString& name, const wxString& classname, bool recursive = false);
- // Helper function: finds a resource (calls UpdateResources) and returns a node containing it.
- wxXmlNode *DoFindResource(wxXmlNode *parent, const wxString& name, const wxString& classname, bool recursive);
+ // Common implementation of GetResourceNode() and FindResource(): searches
+ // all top-level or all (if recursive == true) nodes if all loaded XRC
+ // files and returns the node, if found, as well as the path of the file it
+ // was found in if path is non-NULL
+ wxXmlNode *GetResourceNodeAndLocation(const wxString& name,
+ const wxString& classname,
+ bool recursive = false,
+ wxString *path = NULL) const;
+
+
+ // Note that these functions are used outside of wxWidgets itself, e.g.
+ // there are several known cases of inheriting from wxXmlResource just to
+ // be able to call FindResource() so we keep them for compatibility even if
+ // their names are not really consistent with GetResourceNode() public
+ // function and FindResource() is also non-const because it changes the
+ // current path of m_curFileSystem to ensure that relative paths work
+ // correctly when CreateResFromNode() is called immediately afterwards
+ // (something const public function intentionally does not do)
+
+ // Returns the node containing the resource with the given name and class
+ // name unless it's empty (then any class matches) or NULL if not found.
+ wxXmlNode *FindResource(const wxString& name, const wxString& classname,
+ bool recursive = false);
+
+ // Helper function used by FindResource() to look under the given node.
+ wxXmlNode *DoFindResource(wxXmlNode *parent, const wxString& name,
+ const wxString& classname, bool recursive) const;
// Creates a resource from information in the given node
// (Uses only 'handlerToUse' if != NULL)
wxObject *CreateResFromNode(wxXmlNode *node, wxObject *parent,
wxObject *instance = NULL,
- wxXmlResourceHandler *handlerToUse = NULL);
+ wxXmlResourceHandler *handlerToUse = NULL)
+ {
+ return node ? DoCreateResFromNode(*node, parent, instance, handlerToUse)
+ : NULL;
+ }
// Helper of Load() and Unload(): returns the URL corresponding to the
// given file if it's indeed a file, otherwise returns the original string
@@ -270,6 +368,24 @@ private:
wxXmlResourceDataRecords& Data() { return *m_data; }
const wxXmlResourceDataRecords& Data() const { return *m_data; }
+ // the real implementation of CreateResFromNode(): this should be only
+ // called if node is non-NULL
+ wxObject *DoCreateResFromNode(wxXmlNode& node,
+ wxObject *parent,
+ wxObject *instance,
+ wxXmlResourceHandler *handlerToUse = NULL);
+
+ // common part of LoadObject() and LoadObjectRecursively()
+ wxObject *DoLoadObject(wxWindow *parent,
+ const wxString& name,
+ const wxString& classname,
+ bool recursive);
+ bool DoLoadObject(wxObject *instance,
+ wxWindow *parent,
+ const wxString& name,
+ const wxString& classname,
+ bool recursive);
+
private:
long m_version;
@@ -284,8 +400,10 @@ private:
// domain to pass to translation functions, if any.
wxString m_domain;
- friend class wxXmlResourceHandler;
+ friend class wxXmlResourceHandlerImpl;
friend class wxXmlResourceModule;
+ friend class wxIdRangeManager;
+ friend class wxIdRange;
static wxXmlSubclassFactories *ms_subclassFactories;
@@ -320,18 +438,32 @@ private:
#define XRCCTRL(window, id, type) \
(wxStaticCast((window).FindWindow(XRCID(id)), type))
-// wxXmlResourceHandler is an abstract base class for resource handlers
-// capable of creating a control from an XML node.
+// This macro returns pointer to sizer item
+// Example:
+//
+//
+//
+// wxSizerItem* item = XRCSIZERITEM(*this, "area")
+
+#define XRCSIZERITEM(window, id) \
+ ((window).GetSizer() ? (window).GetSizer()->GetItemById(XRCID(id)) : NULL)
+
+
+// wxXmlResourceHandlerImpl is the back-end of the wxXmlResourceHander class to
+// really implementing all its functionality. It is defined in the "xrc"
+// library unlike wxXmlResourceHandler itself which is defined in "core" to
+// allow inheriting from it in the code from the other libraries too.
-class WXDLLIMPEXP_XRC wxXmlResourceHandler : public wxObject
+class WXDLLIMPEXP_XRC wxXmlResourceHandlerImpl : public wxXmlResourceHandlerImplBase
{
-DECLARE_ABSTRACT_CLASS(wxXmlResourceHandler)
public:
// Constructor.
- wxXmlResourceHandler();
+ wxXmlResourceHandlerImpl(wxXmlResourceHandler *handler);
// Destructor.
- virtual ~wxXmlResourceHandler() {}
+ virtual ~wxXmlResourceHandlerImpl() {}
// Creates an object (menu, dialog, control, ...) from an XML node.
// Should check for validity.
@@ -342,40 +474,19 @@ public:
wxObject *CreateResource(wxXmlNode *node, wxObject *parent,
wxObject *instance);
- // This one is called from CreateResource after variables
- // were filled.
- virtual wxObject *DoCreateResource() = 0;
-
- // Returns true if it understands this node and can create
- // a resource from it, false otherwise.
- virtual bool CanHandle(wxXmlNode *node) = 0;
-
- // Sets the parent resource.
- void SetParentResource(wxXmlResource *res) { m_resource = res; }
-
-protected:
- wxXmlResource *m_resource;
- wxArrayString m_styleNames;
- wxArrayInt m_styleValues;
-
- // Variables (filled by CreateResource)
- wxXmlNode *m_node;
- wxString m_class;
- wxObject *m_parent, *m_instance;
- wxWindow *m_parentAsWindow;
// --- Handy methods:
// Returns true if the node has a property class equal to classname,
// e.g.