X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e5db16098ce132675f2ec7cc7e50f26c405eb1e8..d19ce8c49127a8550a784b4d54464c81003a102b:/include/wx/xrc/xmlres.h?ds=inline diff --git a/include/wx/xrc/xmlres.h b/include/wx/xrc/xmlres.h index 7da09a94a5..7d29dd260d 100644 --- a/include/wx/xrc/xmlres.h +++ b/include/wx/xrc/xmlres.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: xmlres.h +// Name: wx/xrc/xmlres.h // Purpose: XML resources // Author: Vaclav Slavik // Created: 2000/03/05 @@ -11,13 +11,13 @@ #ifndef _WX_XMLRES_H_ #define _WX_XMLRES_H_ -#if defined(__GNUG__) && !defined(__APPLE__) -#pragma interface "xmlres.h" -#endif - #include "wx/defs.h" + +#if wxUSE_XRC + #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,40 +25,43 @@ #include "wx/bitmap.h" #include "wx/icon.h" #include "wx/artprov.h" - -#include "wx/xrc/xml.h" - -class WXDLLEXPORT wxMenu; -class WXDLLEXPORT wxMenuBar; -class WXDLLEXPORT wxDialog; -class WXDLLEXPORT wxPanel; -class WXDLLEXPORT wxWindow; -class WXDLLEXPORT wxFrame; -class WXDLLEXPORT wxToolBar; - -class WXXMLDLLEXPORT wxXmlResourceHandler; -class WXXMLDLLEXPORT wxXmlSubclassFactory; -class WXXMLDLLEXPORT wxXmlSubclassFactoriesList; +#include "wx/colour.h" +#include "wx/animate.h" +#include "wx/vector.h" + +#include "wx/xml/xml.h" + +class WXDLLIMPEXP_FWD_CORE wxMenu; +class WXDLLIMPEXP_FWD_CORE wxMenuBar; +class WXDLLIMPEXP_FWD_CORE wxDialog; +class WXDLLIMPEXP_FWD_CORE wxPanel; +class WXDLLIMPEXP_FWD_CORE wxWindow; +class WXDLLIMPEXP_FWD_CORE wxFrame; +class WXDLLIMPEXP_FWD_CORE wxToolBar; + +class WXDLLIMPEXP_FWD_XRC wxXmlResourceHandler; +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). // // Rules for increasing version number: -// - change it only if you made incompatible change to the format. Addition of new -// attribute to control handler is _not_ incompatible change, because older -// versions of the library may ignore it. +// - change it only if you made incompatible change to the format. Addition +// of new attribute to control handler is _not_ incompatible change, because +// older versions of the library may ignore it. // - if you change version number, follow these steps: // - set major, minor and release numbers to respective version numbers of -// the wxWindows library (see wx/version.h) -// - reset revision to 0 unless the first three are same as before, in which -// case you should increase revision by one +// the wxWidgets library (see wx/version.h) +// - reset revision to 0 unless the first three are same as before, +// in which case you should increase revision by one #define WX_XMLRES_CURRENT_VERSION_MAJOR 2 -#define WX_XMLRES_CURRENT_VERSION_MINOR 3 -#define WX_XMLRES_CURRENT_VERSION_RELEASE 0 -#define WX_XMLRES_CURRENT_VERSION_REVISION 1 -#define WX_XMLRES_CURRENT_VERSION_STRING _T("2.3.0.1") +#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 \ (WX_XMLRES_CURRENT_VERSION_MAJOR * 256*256*256 + \ @@ -66,69 +69,62 @@ class wxXmlResourceModule; WX_XMLRES_CURRENT_VERSION_RELEASE * 256 + \ WX_XMLRES_CURRENT_VERSION_REVISION) -class WXXMLDLLEXPORT wxXmlResourceDataRecord -{ -public: - wxXmlResourceDataRecord() : Doc(NULL), Time(wxDateTime::Now()) {} - ~wxXmlResourceDataRecord() {delete Doc;} - - wxString File; - wxXmlDocument *Doc; - wxDateTime Time; -}; - - -#ifdef WXXMLISDLL -WX_DECLARE_EXPORTED_OBJARRAY(wxXmlResourceDataRecord, wxXmlResourceDataRecords); -#else -WX_DECLARE_OBJARRAY(wxXmlResourceDataRecord, wxXmlResourceDataRecords); -#endif - enum wxXmlResourceFlags { wxXRC_USE_LOCALE = 1, - wxXRC_NO_SUBCLASSING = 2 + wxXRC_NO_SUBCLASSING = 2, + wxXRC_NO_RELOADING = 4 }; // This class holds XML resources from one or more .xml files // (or derived forms, either binary or zipped -- see manual for // details). -class WXXMLDLLEXPORT wxXmlResource : public wxObject +class WXDLLIMPEXP_XRC wxXmlResource : public wxObject { public: // Constructor. // Flags: wxXRC_USE_LOCALE // translatable strings will be translated via _() + // using the given domain if specified // wxXRC_NO_SUBCLASSING // subclass property of object nodes will be ignored // (useful for previews in XRC editors) - wxXmlResource(int flags = wxXRC_USE_LOCALE); + // wxXRC_NO_RELOADING + // don't check the modification time of the XRC files and + // reload them if they have changed on disk + wxXmlResource(int flags = wxXRC_USE_LOCALE, + const wxString& domain = wxEmptyString); // Constructor. // Flags: wxXRC_USE_LOCALE // translatable strings will be translated via _() + // using the given domain if specified // wxXRC_NO_SUBCLASSING // subclass property of object nodes will be ignored // (useful for previews in XRC editors) - wxXmlResource(const wxString& filemask, int flags = wxXRC_USE_LOCALE); + wxXmlResource(const wxString& filemask, int flags = wxXRC_USE_LOCALE, + const wxString& domain = wxEmptyString); // Destructor. - ~wxXmlResource(); + virtual ~wxXmlResource(); // Loads resources from XML files that match given filemask. // This method understands VFS (see filesys.h). bool Load(const wxString& filemask); + // Unload resource from the given XML file (wildcards not allowed) + bool Unload(const wxString& filename); + // Initialize handlers for all supported controls/windows. This will // make the executable quite big because it forces linking against - // most of the wxWindows library. + // most of the wxWidgets library. void InitAllHandlers(); // Initialize only a specific handler (or custom handler). Convention says - // that handler name is equal to the control's name plus 'XmlHandler', for example - // wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler - // (xmlres) can create include file that contains initialization code for - // all controls used within the resource. + // that handler name is equal to the control's name plus 'XmlHandler', for + // example wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource + // compiler (xmlres) can create include file that contains initialization + // code for all controls used within the resource. void AddHandler(wxXmlResourceHandler *handler); // Add a new handler at the begining of the handler list @@ -136,7 +132,7 @@ public: // Removes all handlers void ClearHandlers(); - + // Registers subclasses factory for use in XRC. This function is not meant // for public use, please see the comment above wxXmlSubclassFactory // definition. @@ -201,10 +197,26 @@ public: bool AttachUnknownControl(const wxString& name, wxWindow *control, wxWindow *parent = NULL); - // Returns a numeric ID that is equivalent to the string id used in an XML - // resource. To be used in event tables. - // Macro XRCID is provided for convenience - static int GetXRCID(const wxChar *str_id); + // Returns a numeric ID that is equivalent to the string ID used in an XML + // resource. If an unknown str_id is requested (i.e. other than wxID_XXX + // or integer), a new record is created which associates the given string + // with a number. If value_if_not_found == wxID_NONE, the number is obtained via + // wxWindow::NewControlId(). Otherwise value_if_not_found is used. + // Macro XRCID(name) is provided for convenient use in event tables. + static int GetXRCID(const wxString& str_id, int value_if_not_found = wxID_NONE) + { return DoGetXRCID(str_id.mb_str(), value_if_not_found); } + + // 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; } @@ -228,13 +240,18 @@ public: // Set flags after construction. void SetFlags(int flags) { m_flags = flags; } + // Get/Set the domain to be passed to the translation functions, defaults + // to empty string (no domain). + const wxString& GetDomain() const { return m_domain; } + void SetDomain(const wxString& domain); + protected: // Scans the resources list for unloaded files and loads them. Also reloads // files that have been modified since last loading. - void UpdateResources(); + bool UpdateResources(); // Finds a resource (calls UpdateResources) and returns a node containing it. - wxXmlNode *FindResource(const wxString& name, const wxString& classname, bool recursive = FALSE); + 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); @@ -245,21 +262,39 @@ protected: wxObject *instance = NULL, wxXmlResourceHandler *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 + // unmodified + static wxString ConvertFileNameToURL(const wxString& filename); + + // loading resources from archives is impossible without wxFileSystem +#if wxUSE_FILESYSTEM + // Another helper: detect if the filename is a ZIP or XRS file + static bool IsArchive(const wxString& filename); +#endif // wxUSE_FILESYSTEM + +private: + wxXmlResourceDataRecords& Data() { return *m_data; } + const wxXmlResourceDataRecords& Data() const { return *m_data; } + private: long m_version; int m_flags; - wxList m_handlers; - wxXmlResourceDataRecords m_data; + wxVector m_handlers; + wxXmlResourceDataRecords *m_data; #if wxUSE_FILESYSTEM wxFileSystem m_curFileSystem; wxFileSystem& GetCurFileSystem() { return m_curFileSystem; } #endif + // domain to pass to translation functions, if any. + wxString m_domain; + friend class wxXmlResourceHandler; friend class wxXmlResourceModule; - static wxXmlSubclassFactoriesList *ms_subclassFactories; + static wxXmlSubclassFactories *ms_subclassFactories; // singleton instance: static wxXmlResource *ms_instance; @@ -268,7 +303,7 @@ private: // This macro translates string identifier (as used in XML resource, // e.g. ...) to integer id that is needed by -// wxWindows event tables. +// wxWidgets event tables. // Example: // BEGIN_EVENT_TABLE(MyFrame, wxFrame) // EVT_MENU(XRCID("quit"), MyFrame::OnQuit) @@ -278,7 +313,7 @@ private: // END_EVENT_TABLE() #define XRCID(str_id) \ - wxXmlResource::GetXRCID(wxT(str_id)) + wxXmlResource::DoGetXRCID(str_id) // This macro returns pointer to particular control in dialog @@ -289,19 +324,27 @@ private: // wxXmlResource::Get()->LoadDialog(&dlg, mainFrame, "my_dialog"); // XRCCTRL(dlg, "my_textctrl", wxTextCtrl)->SetValue(wxT("default value")); -#ifdef __WXDEBUG__ #define XRCCTRL(window, id, type) \ - (wxDynamicCast((window).FindWindow(XRCID(id)), type)) -#else -#define XRCCTRL(window, id, type) \ - ((type*)((window).FindWindow(XRCID(id)))) -#endif + (wxStaticCast((window).FindWindow(XRCID(id)), type)) + +// This macro returns pointer to sizer item +// Example: +// +// +// 400, 300 +// +// +// wxSizerItem* item = XRCSIZERITEM(*this, "area") + +#define XRCSIZERITEM(window, id) \ + ((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. -class WXXMLDLLEXPORT wxXmlResourceHandler : public wxObject +class WXDLLIMPEXP_XRC wxXmlResourceHandler : public wxObject { +DECLARE_ABSTRACT_CLASS(wxXmlResourceHandler) public: // Constructor. wxXmlResourceHandler(); @@ -312,7 +355,7 @@ public: // Creates an object (menu, dialog, control, ...) from an XML node. // Should check for validity. // parent is a higher-level object (usually window, dialog or panel) - // that is often neccessary to create the resource. + // that is often necessary to create the resource. // If instance is non-NULL it should not create a new instance via 'new' but // should rather use this one, and call its Create method. wxObject *CreateResource(wxXmlNode *node, wxObject *parent, @@ -322,8 +365,8 @@ public: // were filled. virtual wxObject *DoCreateResource() = 0; - // Returns TRUE if it understands this node and can create - // a resource from it, FALSE otherwise. + // 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. @@ -338,14 +381,13 @@ protected: wxXmlNode *m_node; wxString m_class; wxObject *m_parent, *m_instance; - wxWindow *m_parentAsWindow, *m_instanceAsWindow; + wxWindow *m_parentAsWindow; // --- Handy methods: // Returns true if the node has a property class equal to classname, // e.g. . - bool IsOfClass(wxXmlNode *node, const wxString& classname) - { return node->GetPropVal(wxT("class"), wxEmptyString) == classname; } + bool IsOfClass(wxXmlNode *node, const wxString& classname); // Gets node content from wxXML_ENTITY_NODE // The problem is, content is represented as @@ -371,14 +413,14 @@ protected: void AddWindowStyles(); // Gets style flags from text in form "flag | flag2| flag3 |..." - // Only understads flags added with AddStyle + // Only understands flags added with AddStyle int GetStyle(const wxString& param = wxT("style"), int defaults = 0); // Gets text from param and does some conversions: // - replaces \n, \r, \t by respective chars (according to C syntax) // - replaces _ by & and __ by _ (needed for _File => &File because of XML) // - calls wxGetTranslations (unless disabled in wxXmlResource) - wxString GetText(const wxString& param, bool translate = TRUE); + wxString GetText(const wxString& param, bool translate = true); // Returns the XRCID. int GetID(); @@ -386,23 +428,28 @@ protected: // Returns the resource name. wxString GetName(); - // Gets a bool flag (1, t, yes, on, true are TRUE, everything else is FALSE). - bool GetBool(const wxString& param, bool defaultv = FALSE); + // Gets a bool flag (1, t, yes, on, true are true, everything else is false). + bool GetBool(const wxString& param, bool defaultv = false); - // Gets the integer value from the parameter. - long GetLong( const wxString& param, long defaultv = 0 ); + // Gets an integer value from the parameter. + long GetLong(const wxString& param, long defaultv = 0); + + // Gets a float value from the parameter. + float GetFloat(const wxString& param, float defaultv = 0); // Gets colour in HTML syntax (#RRGGBB). - wxColour GetColour(const wxString& param); + wxColour GetColour(const wxString& param, const wxColour& defaultv = wxNullColour); // Gets the size (may be in dialog units). - wxSize GetSize(const wxString& param = wxT("size")); + wxSize GetSize(const wxString& param = wxT("size"), + wxWindow *windowToUse = NULL); // Gets the position (may be in dialog units). wxPoint GetPosition(const wxString& param = wxT("pos")); // Gets a dimension (may be in dialog units). - wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0); + wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0, + wxWindow *windowToUse = NULL); // Gets a bitmap. wxBitmap GetBitmap(const wxString& param = wxT("bitmap"), @@ -414,14 +461,23 @@ protected: const wxArtClient& defaultArtClient = wxART_OTHER, wxSize size = wxDefaultSize); +#if wxUSE_ANIMATIONCTRL + // Gets an animation. + wxAnimation GetAnimation(const wxString& param = wxT("animation")); +#endif + // 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); // Creates children. - void CreateChildren(wxObject *parent, bool this_hnd_only = FALSE); + void CreateChildren(wxObject *parent, bool this_hnd_only = false); // Helper function. void CreateChildrenPrivately(wxObject *parent, wxXmlNode *rootnode = NULL); @@ -451,18 +507,19 @@ protected: // FIXME -- remove this $%^#$%#$@# as soon as Ron checks his changes in!! -void wxXmlInitResourceModule(); +WXDLLIMPEXP_XRC void wxXmlInitResourceModule(); // This class is used to create instances of XRC "object" nodes with "subclass" // property. It is _not_ supposed to be used by XRC users, you should instead -// register your subclasses via wxWindows' RTTI mechanism. This class is useful +// register your subclasses via wxWidgets' RTTI mechanism. This class is useful // only for language bindings developer who need a way to implement subclassing -// in wxWindows ports that don't support wxRTTI (e.g. wxPython). -class WXXMLDLLEXPORT wxXmlSubclassFactory +// in wxWidgets ports that don't support wxRTTI (e.g. wxPython). +class WXDLLIMPEXP_XRC wxXmlSubclassFactory { public: - // Try to create instance of given class and return it, return NULL on failure: + // Try to create instance of given class and return it, return NULL on + // failure: virtual wxObject *Create(const wxString& className) = 0; virtual ~wxXmlSubclassFactory() {} }; @@ -472,11 +529,7 @@ public: Backward compatibility macros. Do *NOT* use, they may disappear in future versions of the XRC library! ------------------------------------------------------------------------- */ -#define ADD_STYLE XRC_ADD_STYLE -#define wxTheXmlResource wxXmlResource::Get() -#define XMLID XRCID -#define XMLCTRL XRCCTRL -#define GetXMLID GetXRCID +#endif // wxUSE_XRC #endif // _WX_XMLRES_H_