X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/86909f4c893e043dd3695d7510f2cc758e8b2cfb..7344108e8a129a3f9b4df5ab0f98a1713db03b89:/include/wx/xrc/xmlres.h diff --git a/include/wx/xrc/xmlres.h b/include/wx/xrc/xmlres.h index 7420d84729..1d226c11af 100644 --- a/include/wx/xrc/xmlres.h +++ b/include/wx/xrc/xmlres.h @@ -17,6 +17,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" @@ -30,6 +31,10 @@ #include "wx/xml/xml.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; @@ -44,7 +49,6 @@ 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 +65,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 +112,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); @@ -180,13 +188,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,6 +246,15 @@ 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; } @@ -220,7 +264,7 @@ public: { return GetVersion() - (major*256*256*256 + minor*256*256 + release*256 + revision); } -//// Singleton accessors. + //// Singleton accessors. // Gets the global resources object or creates one if none exists. static wxXmlResource *Get(); @@ -238,22 +282,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 +361,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; @@ -286,6 +395,8 @@ private: friend class wxXmlResourceHandler; friend class wxXmlResourceModule; + friend class wxIdRangeManager; + friend class wxIdRange; static wxXmlSubclassFactories *ms_subclassFactories; @@ -327,10 +438,10 @@ private: // 400, 300 // // -// wxSizerItem* item = XRCSIZERITEM(*this, wxT("area")) +// wxSizerItem* item = XRCSIZERITEM(*this, "area") #define XRCSIZERITEM(window, id) \ - ((window).GetSizer() ? (window).GetSizer()->GetItemById(id) : NULL) + ((window).GetSizer() ? (window).GetSizer()->GetItemById(XRCID(id)) : NULL) // wxXmlResourceHandler is an abstract base class for resource handlers // capable of creating a control from an XML node. @@ -380,14 +491,14 @@ protected: // Returns true if the node has a property class equal to classname, // e.g. . - bool IsOfClass(wxXmlNode *node, const wxString& classname); + static bool IsOfClass(wxXmlNode *node, const wxString& classname); // Gets node content from wxXML_ENTITY_NODE // The problem is, content is represented as // wxXML_ENTITY_NODE name="tag", content="" // |-- wxXML_TEXT_NODE or // wxXML_CDATA_SECTION_NODE name="" content="content" - wxString GetNodeContent(wxXmlNode *node); + wxString GetNodeContent(const wxXmlNode *node); // Check to see if a parameter exists. bool HasParam(const wxString& param); @@ -398,6 +509,9 @@ protected: // Finds the parameter value or returns the empty string. wxString GetParamValue(const wxString& param); + // Returns the parameter value from given node. + wxString GetParamValue(const wxXmlNode* node); + // Add a style flag (e.g. wxMB_DOCKABLE) to the list of flags // understood by this handler. void AddStyle(const wxString& name, int value); @@ -444,16 +558,36 @@ protected: wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0, wxWindow *windowToUse = NULL); + // Gets a direction, complains if the value is invalid. + wxDirection GetDirection(const wxString& param, wxDirection dir = wxLEFT); + // Gets a bitmap. wxBitmap GetBitmap(const wxString& param = wxT("bitmap"), const wxArtClient& defaultArtClient = wxART_OTHER, wxSize size = wxDefaultSize); + // Gets a bitmap from an XmlNode. + wxBitmap GetBitmap(const wxXmlNode* node, + const wxArtClient& defaultArtClient = wxART_OTHER, + wxSize size = wxDefaultSize); + // Gets an icon. wxIcon GetIcon(const wxString& param = wxT("icon"), const wxArtClient& defaultArtClient = wxART_OTHER, wxSize size = wxDefaultSize); + // Gets an icon from an XmlNode. + wxIcon GetIcon(const wxXmlNode* node, + const wxArtClient& defaultArtClient = wxART_OTHER, + wxSize size = wxDefaultSize); + + // Gets an icon bundle. + wxIconBundle GetIconBundle(const wxString& param, + const wxArtClient& defaultArtClient = wxART_OTHER); + + // Gets an image list. + wxImageList *GetImageList(const wxString& param = wxT("imagelist")); + #if wxUSE_ANIMATIONCTRL // Gets an animation. wxAnimation GetAnimation(const wxString& param = wxT("animation")); @@ -462,6 +596,10 @@ protected: // Gets a font. wxFont GetFont(const wxString& param = wxT("font")); + // Gets the value of a boolean attribute (only "0" and "1" are valid values) + bool GetBoolAttr(const wxString& attr, bool defaultv); + + // Sets common window options. void SetupWindow(wxWindow *wnd); @@ -480,6 +618,13 @@ protected: #if wxUSE_FILESYSTEM wxFileSystem& GetCurFileSystem() { return m_resource->GetCurFileSystem(); } #endif + + // reports input error at position 'context' + void ReportError(wxXmlNode *context, const wxString& message); + // reports input error at m_node + void ReportError(const wxString& message); + // reports input error when parsing parameter with given name + void ReportParamError(const wxString& param, const wxString& message); };