X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/00393283ff4ad9e2185096e355e1d58ec95899d1..19b44116d5c04181f9a20f92546cff26405ed115:/contrib/include/wx/xrc/xmlres.h diff --git a/contrib/include/wx/xrc/xmlres.h b/contrib/include/wx/xrc/xmlres.h index 143664514b..76dbd1e972 100644 --- a/contrib/include/wx/xrc/xmlres.h +++ b/contrib/include/wx/xrc/xmlres.h @@ -11,7 +11,7 @@ #ifndef _WX_XMLRES_H_ #define _WX_XMLRES_H_ -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(__APPLE__) #pragma interface "xmlres.h" #endif @@ -24,8 +24,17 @@ #include "wx/filesys.h" #include "wx/bitmap.h" #include "wx/icon.h" +#include "wx/artprov.h" -#include "wx/xrc/xml.h" +#include "wx/xml/xml.h" + +#ifdef WXMAKINGDLL_XRC + #define WXDLLIMPEXP_XRC WXEXPORT +#elif defined(WXUSINGDLL) + #define WXDLLIMPEXP_XRC WXIMPORT +#else // not making nor using DLL + #define WXDLLIMPEXP_XRC +#endif class WXDLLEXPORT wxMenu; class WXDLLEXPORT wxMenuBar; @@ -35,26 +44,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_STRING _T("2.3.0.1") #define WX_XMLRES_CURRENT_VERSION \ (WX_XMLRES_CURRENT_VERSION_MAJOR * 256*256*256 + \ @@ -62,7 +74,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()) {} @@ -74,25 +86,39 @@ 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 +}; // 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: - // Ctor. If use_locale is TRUE, translatable strings are - // translated via _(). You can disable it by passing use_locale=FALSE - // (for example if you provide resource file for each locale) - wxXmlResource(bool use_locale = TRUE); - wxXmlResource(const wxString& filemask, bool use_locale = TRUE); + // Constructor. + // Flags: wxXRC_USE_LOCALE + // translatable strings will be translated via _() + // wxXRC_NO_SUBCLASSING + // subclass property of object nodes will be ignored + // (useful for previews in XRC editors) + wxXmlResource(int flags = wxXRC_USE_LOCALE); + + // Constructor. + // Flags: wxXRC_USE_LOCALE + // translatable strings will be translated via _() + // 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); + + // Destructor. ~wxXmlResource(); // Loads resources from XML files that match given filemask. @@ -101,62 +127,92 @@ public: // Initialize handlers for all supported controls/windows. This will // make the executable quite big because it forces linking against - // most of wxWin library + // most of the wxWidgets library. void InitAllHandlers(); - // Initialize only specific handler (or custom handler). Convention says - // that handler name is equal to control's name plus 'XmlHandler', e.g. - // wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. XML resource compiler - // (xmlres) can create include file that contains initialization code for - // all controls used within the resource. + // 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. void AddHandler(wxXmlResourceHandler *handler); + // Add a new handler at the begining of the handler list + void InsertHandler(wxXmlResourceHandler *handler); + // 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); // Loads menubar from resource. Returns NULL on failure. - wxMenuBar *LoadMenuBar(const wxString& name); + wxMenuBar *LoadMenuBar(wxWindow *parent, const wxString& name); + + // Loads menubar from resource. Returns NULL on failure. + wxMenuBar *LoadMenuBar(const wxString& name) { return LoadMenuBar(NULL, name); } #if wxUSE_TOOLBAR - // Loads toolbar + // Loads a toolbar. wxToolBar *LoadToolBar(wxWindow *parent, const wxString& name); #endif - // Loads dialog. dlg points to parent window (if any). Second form + // Loads a dialog. dlg points to parent window (if any). + wxDialog *LoadDialog(wxWindow *parent, const wxString& name); + + // Loads a dialog. dlg points to parent window (if any). This form // is used to finish creation of already existing instance (main reason // for this is that you may want to use derived class with new event table) // Example (typical usage): // MyDialog dlg; // wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog"); // dlg->ShowModal(); - wxDialog *LoadDialog(wxWindow *parent, const wxString& name); bool LoadDialog(wxDialog *dlg, wxWindow *parent, const wxString& name); - // Loads panel. panel points to parent window (if any). Second form - // is used to finish creation of already existing instance. + // Loads a panel. panel points to parent window (if any). wxPanel *LoadPanel(wxWindow *parent, const wxString& name); + + // Loads a panel. panel points to parent window (if any). This form + // is used to finish creation of already existing instance. bool LoadPanel(wxPanel *panel, wxWindow *parent, const wxString& name); + // Loads a frame. + wxFrame *LoadFrame(wxWindow* parent, const wxString& name); bool LoadFrame(wxFrame* frame, wxWindow *parent, const wxString& name); - // Loads bitmap or icon resource from file: + // 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); + + // 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); + + // Loads a bitmap resource from a file. wxBitmap LoadBitmap(const wxString& name); + + // Loads an icon resource from a file. wxIcon LoadIcon(const wxString& name); - // Attaches unknown control into given panel/window/dialog: - // (unknown controls are used in conjunction with ) + // Attaches an unknown control to the given panel/window/dialog. + // Unknown controls are used in conjunction with . bool AttachUnknownControl(const wxString& name, wxWindow *control, wxWindow *parent = NULL); - // Returns numeric ID that is equivalent to string id used in XML - // resource. To be used in event tables - // Macro XMLID is provided for convenience - static int GetXMLID(const wxChar *str_id); + // 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 version info (a.b.c.d = d+ 256*c + 256^2*b + 256^3*a) + // 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 @@ -165,27 +221,40 @@ public: { return GetVersion() - (major*256*256*256 + minor*256*256 + release*256 + revision); } +//// Singleton accessors. + + // Gets the global resources object or creates one if none exists. + static wxXmlResource *Get(); + + // Sets the global resources object and returns a pointer to the previous one (may be NULL). + static wxXmlResource *Set(wxXmlResource *res); + + // Returns flags, which may be a bitlist of wxXRC_USE_LOCALE and wxXRC_NO_SUBCLASSING. + int GetFlags() const { return m_flags; } + // Set flags after construction. + void SetFlags(int flags) { m_flags = flags; } + protected: - // Scans resources list for unloaded files and loads them. Also reloads + // Scans the resources list for unloaded files and loads them. Also reloads // files that have been modified since last loading. - void UpdateResources(); - - // Finds resource (calls UpdateResources) and returns node containing it - wxXmlNode *FindResource(const wxString& name, const wxString& classname); + bool UpdateResources(); - // Creates resource from info in given node: - wxObject *CreateResFromNode(wxXmlNode *node, wxObject *parent, wxObject *instance = NULL); + // Finds a resource (calls UpdateResources) and returns a node containing it. + wxXmlNode *FindResource(const wxString& name, const wxString& classname, bool recursive = false); - // Remove nodes with property "platform" that does not - // match current platform - void ProcessPlatformProperty(wxXmlNode *node); + // 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); - bool GetUseLocale() { return m_useLocale; } + // 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; - bool m_useLocale; + int m_flags; wxList m_handlers; wxXmlResourceDataRecords m_data; #if wxUSE_FILESYSTEM @@ -194,25 +263,28 @@ private: #endif friend class wxXmlResourceHandler; -}; + friend class wxXmlResourceModule; + static wxXmlSubclassFactoriesList *ms_subclassFactories; + + // singleton instance: + static wxXmlResource *ms_instance; +}; -// Global instance of resource class. For your convenience. -extern WXXMLDLLEXPORT wxXmlResource *wxTheXmlResource; // 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(XMLID("quit"), MyFrame::OnQuit) -// EVT_MENU(XMLID("about"), MyFrame::OnAbout) -// EVT_MENU(XMLID("new"), MyFrame::OnNew) -// EVT_MENU(XMLID("open"), MyFrame::OnOpen) +// EVT_MENU(XRCID("quit"), MyFrame::OnQuit) +// EVT_MENU(XRCID("about"), MyFrame::OnAbout) +// EVT_MENU(XRCID("new"), MyFrame::OnNew) +// EVT_MENU(XRCID("open"), MyFrame::OnOpen) // END_EVENT_TABLE() -#define XMLID(str_id) \ - wxXmlResource::GetXMLID(wxT(str_id)) +#define XRCID(str_id) \ + wxXmlResource::GetXRCID(wxT(str_id)) // This macro returns pointer to particular control in dialog @@ -220,46 +292,51 @@ extern WXXMLDLLEXPORT wxXmlResource *wxTheXmlResource; // controls. // Example: // wxDialog dlg; -// wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog"); -// XMLCTRL(dlg, "my_textctrl", wxTextCtrl)->SetValue(wxT("default value")); +// wxXmlResource::Get()->LoadDialog(&dlg, mainFrame, "my_dialog"); +// XRCCTRL(dlg, "my_textctrl", wxTextCtrl)->SetValue(wxT("default value")); #ifdef __WXDEBUG__ -#define XMLCTRL(window, id, type) \ - (wxDynamicCast((window).FindWindow(XMLID(id)), type)) +#define XRCCTRL(window, id, type) \ + (wxDynamicCast((window).FindWindow(XRCID(id)), type)) #else -#define XMLCTRL(window, id, type) \ - ((type*)((window).FindWindow(XMLID(id)))) +#define XRCCTRL(window, id, type) \ + ((type*)((window).FindWindow(XRCID(id)))) #endif +// 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(); + + // Destructor. virtual ~wxXmlResourceHandler() {} - // Creates object (menu, dialog, control, ...) from XML node. + // Creates an object (menu, dialog, control, ...) from an XML node. // Should check for validity. - // parent is higher-level object (usually window, dialog or panel) - // that is often neccessary to create resource - // if instance != NULL it should not create new instance via 'new' but - // rather use this one and call its Create method + // parent is a higher-level object (usually window, dialog or panel) + // that is often neccessary 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, wxObject *instance); // This one is called from CreateResource after variables - // were filled + // were filled. virtual wxObject *DoCreateResource() = 0; - // Returns TRUE if it understands this node and can create - // 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. void SetParentResource(wxXmlResource *res) { m_resource = res; } - protected: - wxXmlResource *m_resource; wxArrayString m_styleNames; wxArrayInt m_styleValues; @@ -272,87 +349,144 @@ protected: // --- Handy methods: - // Returns true if the node has property class equal to classname, - // e.g. + // 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; } // Gets node content from wxXML_ENTITY_NODE - // (the problem is, content is represented as + // 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); - // Check to see if a param exists + // Check to see if a parameter exists. bool HasParam(const wxString& param); - // Finds the node or returns NULL + // Finds the node or returns NULL. wxXmlNode *GetParamNode(const wxString& param); + + // Finds the parameter value or returns the empty string. wxString GetParamValue(const wxString& param); - // Add style flag (e.g. wxMB_DOCKABLE) to list of flags - // understood by this handler + // Add a style flag (e.g. wxMB_DOCKABLE) to the list of flags + // understood by this handler. void AddStyle(const wxString& name, int value); - // Add styles common to all wxWindow-derived classes + // Add styles common to all wxWindow-derived classes. void AddWindowStyles(); // Gets style flags from text in form "flag | flag2| flag3 |..." // Only understads flags added with AddStyle int GetStyle(const wxString& param = wxT("style"), int defaults = 0); - // Gets text from param and does some convertions: + // 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) + // - replaces _ by & and __ by _ (needed for _File => &File because of XML) // - calls wxGetTranslations (unless disabled in wxXmlResource) - wxString GetText(const wxString& param); + wxString GetText(const wxString& param, bool translate = true); - // Return XMLID + // Returns the XRCID. int GetID(); + + // Returns the resource name. wxString GetName(); - // Get 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); - // Get integer value from param + // Gets the integer value from the parameter. long GetLong( const wxString& param, long defaultv = 0 ); - // Get colour in HTML syntax (#RRGGBB) + // Gets colour in HTML syntax (#RRGGBB). wxColour GetColour(const wxString& param); - // Get size/position (may be in dlg units): + // Gets the size (may be in dialog units). wxSize GetSize(const wxString& param = wxT("size")); + + // Gets the position (may be in dialog units). wxPoint GetPosition(const wxString& param = wxT("pos")); - // Get dimension (may be in dlg units): + // Gets a dimension (may be in dialog units). wxCoord GetDimension(const wxString& param, wxCoord defaultv = 0); - // Get bitmap: + // Gets a bitmap. wxBitmap GetBitmap(const wxString& param = wxT("bitmap"), + 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); - // Get font: + // Gets a font. wxFont GetFont(const wxString& param = wxT("font")); - // Sets common window options: + // Sets common window options. void SetupWindow(wxWindow *wnd); - void CreateChildren(wxObject *parent, bool this_hnd_only = FALSE); + // Creates children. + void CreateChildren(wxObject *parent, bool this_hnd_only = false); + + // Helper function. void CreateChildrenPrivately(wxObject *parent, wxXmlNode *rootnode = NULL); + + // Creates a resource from a node. wxObject *CreateResFromNode(wxXmlNode *node, wxObject *parent, wxObject *instance = NULL) { return m_resource->CreateResFromNode(node, parent, instance); } // helper +#if wxUSE_FILESYSTEM wxFileSystem& GetCurFileSystem() { return m_resource->GetCurFileSystem(); } +#endif }; -#define ADD_STYLE(style) AddStyle(wxT(#style), style) +// Programmer-friendly macros for writing XRC handlers: + +#define XRC_ADD_STYLE(style) AddStyle(wxT(#style), style) + +#define XRC_MAKE_INSTANCE(variable, classname) \ + classname *variable = NULL; \ + if (m_instance) \ + variable = wxStaticCast(m_instance, classname); \ + if (!variable) \ + variable = new classname; + + +// FIXME -- remove this $%^#$%#$@# as soon as Ron checks his changes in!! +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! + ------------------------------------------------------------------------- */ +#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 -void wxXmlInitResourceModule(); #endif // _WX_XMLRES_H_