X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/74c107ba4831e588b219f1c28161f2707f30d0c3..a76d8a29531683cc1c82294ce0c894886f09c404:/include/wx/xrc/xmlres.h diff --git a/include/wx/xrc/xmlres.h b/include/wx/xrc/xmlres.h index 0962b297aa..2525bf733d 100644 --- a/include/wx/xrc/xmlres.h +++ b/include/wx/xrc/xmlres.h @@ -11,11 +11,14 @@ #ifndef _WX_XMLRES_H_ #define _WX_XMLRES_H_ -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "xmlres.h" #endif #include "wx/defs.h" + +#if wxUSE_XRC + #include "wx/string.h" #include "wx/dynarray.h" #include "wx/datetime.h" @@ -26,7 +29,7 @@ #include "wx/icon.h" #include "wx/artprov.h" -#include "wx/xrc/xml.h" +#include "wx/xml/xml.h" class WXDLLEXPORT wxMenu; class WXDLLEXPORT wxMenuBar; @@ -36,26 +39,29 @@ class WXDLLEXPORT wxWindow; class WXDLLEXPORT wxFrame; class WXDLLEXPORT wxToolBar; -class WXXMLDLLEXPORT wxXmlResourceHandler; +class WXDLLIMPEXP_XRC wxXmlResourceHandler; +class WXDLLIMPEXP_XRC wxXmlSubclassFactory; +class WXDLLIMPEXP_XRC wxXmlSubclassFactoriesList; +class wxXmlResourceModule; // 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 "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 + \ @@ -63,7 +69,7 @@ class WXXMLDLLEXPORT wxXmlResourceHandler; WX_XMLRES_CURRENT_VERSION_RELEASE * 256 + \ WX_XMLRES_CURRENT_VERSION_REVISION) -class WXXMLDLLEXPORT wxXmlResourceDataRecord +class WXDLLIMPEXP_XRC wxXmlResourceDataRecord { public: wxXmlResourceDataRecord() : Doc(NULL), Time(wxDateTime::Now()) {} @@ -75,22 +81,21 @@ public: }; -#ifdef WXXMLISDLL -WX_DECLARE_EXPORTED_OBJARRAY(wxXmlResourceDataRecord, wxXmlResourceDataRecords); -#else -WX_DECLARE_OBJARRAY(wxXmlResourceDataRecord, wxXmlResourceDataRecords); -#endif +WX_DECLARE_USER_EXPORTED_OBJARRAY(wxXmlResourceDataRecord, + wxXmlResourceDataRecords, + WXDLLIMPEXP_XRC); 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. @@ -118,14 +123,14 @@ public: // 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 @@ -134,6 +139,11 @@ 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. + static void AddSubclassFactory(wxXmlSubclassFactory *factory); + // Loads menu from resource. Returns NULL on failure. wxMenu *LoadMenu(const wxString& name); @@ -216,21 +226,26 @@ public: static wxXmlResource *Set(wxXmlResource *res); // Returns flags, which may be a bitlist of wxXRC_USE_LOCALE and wxXRC_NO_SUBCLASSING. - int GetFlags() { return m_flags; } + int GetFlags() const { return m_flags; } + // Set flags after construction. + void SetFlags(int flags) { m_flags = flags; } 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); - // Creates a resource from information in the given node. - wxObject *CreateResFromNode(wxXmlNode *node, wxObject *parent, wxObject *instance = NULL); + // 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); private: long m_version; @@ -244,6 +259,9 @@ private: #endif friend class wxXmlResourceHandler; + friend class wxXmlResourceModule; + + static wxXmlSubclassFactoriesList *ms_subclassFactories; // singleton instance: static wxXmlResource *ms_instance; @@ -252,7 +270,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) @@ -273,19 +291,15 @@ 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)) // 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(); @@ -306,8 +320,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. @@ -322,7 +336,7 @@ protected: wxXmlNode *m_node; wxString m_class; wxObject *m_parent, *m_instance; - wxWindow *m_parentAsWindow, *m_instanceAsWindow; + wxWindow *m_parentAsWindow; // --- Handy methods: @@ -362,7 +376,7 @@ protected: // - 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(); @@ -370,11 +384,14 @@ 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); @@ -405,7 +422,7 @@ protected: 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); @@ -435,18 +452,36 @@ 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 wxWidgets' RTTI mechanism. This class is useful +// only for language bindings developer who need a way to implement subclassing +// 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: + virtual wxObject *Create(const wxString& className) = 0; + virtual ~wxXmlSubclassFactory() {} +}; /* ------------------------------------------------------------------------- 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 +#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 #endif // _WX_XMLRES_H_