X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/984f1d84fd0d4a2da8c55ad0eb4a832523ac2d0f..a8519f6507f7b4389c0fe7dbae4ebd63120d5dd0:/include/wx/xrc/xmlres.h diff --git a/include/wx/xrc/xmlres.h b/include/wx/xrc/xmlres.h index e6ea2bee4d..7d29dd260d 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" @@ -24,22 +25,25 @@ #include "wx/bitmap.h" #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" -class WXDLLEXPORT wxMenu; -class WXDLLEXPORT wxMenuBar; -class WXDLLEXPORT wxDialog; -class WXDLLEXPORT wxPanel; -class WXDLLEXPORT wxWindow; -class WXDLLEXPORT wxFrame; -class WXDLLEXPORT wxToolBar; - -class WXDLLIMPEXP_XRC wxXmlResourceHandler; -class WXDLLIMPEXP_XRC wxXmlSubclassFactory; -class WXDLLIMPEXP_XRC wxXmlSubclassFactoriesList; +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). @@ -65,28 +69,6 @@ class wxXmlResourceModule; WX_XMLRES_CURRENT_VERSION_RELEASE * 256 + \ WX_XMLRES_CURRENT_VERSION_REVISION) -class WXDLLIMPEXP_XRC wxXmlResourceDataRecord -{ -public: - wxXmlResourceDataRecord() : Doc(NULL) { -#if wxUSE_DATETIME - Time = wxDateTime::Now(); -#endif - } - ~wxXmlResourceDataRecord() {delete Doc;} - - wxString File; - wxXmlDocument *Doc; -#if wxUSE_DATETIME - wxDateTime Time; -#endif -}; - - -WX_DECLARE_USER_EXPORTED_OBJARRAY(wxXmlResourceDataRecord, - wxXmlResourceDataRecords, - WXDLLIMPEXP_XRC); - enum wxXmlResourceFlags { wxXRC_USE_LOCALE = 1, @@ -103,24 +85,28 @@ 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) // 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); + 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). @@ -215,9 +201,22 @@ public: // 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 - // wxNewId(). Otherwise value_if_not_found is used. + // wxWindow::NewControlId(). Otherwise value_if_not_found is used. // Macro XRCID(name) is provided for convenient use in event tables. - static int GetXRCID(const wxChar *str_id, int value_if_not_found = wxID_NONE); + 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; } @@ -241,6 +240,11 @@ 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. @@ -269,21 +273,28 @@ protected: 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; @@ -302,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 @@ -316,6 +327,18 @@ private: #define XRCCTRL(window, id, type) \ (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. @@ -438,9 +461,18 @@ 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); @@ -497,13 +529,6 @@ public: Backward compatibility macros. Do *NOT* use, they may disappear in future versions of the XRC library! ------------------------------------------------------------------------- */ -#if WXWIN_COMPATIBILITY_2_4 - #define ADD_STYLE XRC_ADD_STYLE - #define wxTheXmlResource wxXmlResource::Get() - #define XMLID XRCID - #define XMLCTRL XRCCTRL - #define GetXMLID GetXRCID -#endif #endif // wxUSE_XRC