]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/xrc/xmlres.h
Add *wxTopLevelWindowGTK*RequestUserAttention*int*;
[wxWidgets.git] / include / wx / xrc / xmlres.h
index 952dc616e1bb77ddea7522b857d2c7248148705b..5f0a85cef51cb19e7b21b003e2e5104f58d597f7 100644 (file)
 #ifndef _WX_XMLRES_H_
 #define _WX_XMLRES_H_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
+#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,9 +39,9 @@ class WXDLLEXPORT wxWindow;
 class WXDLLEXPORT wxFrame;
 class WXDLLEXPORT wxToolBar;
 
-class WXXMLDLLEXPORT wxXmlResourceHandler;
-class WXXMLDLLEXPORT wxXmlSubclassFactory;
-class WXXMLDLLEXPORT wxXmlSubclassFactoriesList;
+class WXDLLIMPEXP_XRC wxXmlResourceHandler;
+class WXDLLIMPEXP_XRC wxXmlSubclassFactory;
+class WXDLLIMPEXP_XRC wxXmlSubclassFactoriesList;
 class wxXmlResourceModule;
 
 
@@ -46,19 +49,19 @@ class wxXmlResourceModule;
 // 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,7 +69,7 @@ class wxXmlResourceModule;
                  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()) {}
@@ -78,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.
@@ -102,6 +104,9 @@ public:
     //        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);
 
     // Constructor.
@@ -119,16 +124,21 @@ public:
     // This method understands VFS (see filesys.h).
     bool Load(const wxString& filemask);
 
+#if wxABI_VERSION > 20601
+    // Unload resource from the given XML file (wildcards not allowed)
+    bool Unload(const wxString& filename);
+#endif // wxABI_VERSION
+
     // 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 +146,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.
@@ -231,10 +241,10 @@ public:
 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,6 +255,20 @@ protected:
                                 wxObject *instance = NULL,
                                 wxXmlResourceHandler *handlerToUse = NULL);
 
+#if wxABI_VERSION > 20601
+    // 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
+
+#endif // wxABI_VERSION
+
 private:
     long m_version;
 
@@ -268,7 +292,7 @@ private:
 
 // This macro translates string identifier (as used in XML resource,
 // e.g. <menuitem id="my_menu">...</menuitem>) 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)
@@ -289,18 +313,13 @@ 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:
@@ -313,7 +332,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,
@@ -323,8 +342,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.
@@ -339,7 +358,7 @@ protected:
     wxXmlNode *m_node;
     wxString m_class;
     wxObject *m_parent, *m_instance;
-    wxWindow *m_parentAsWindow, *m_instanceAsWindow;
+    wxWindow *m_parentAsWindow;
 
     // --- Handy methods:
 
@@ -372,14 +391,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();
@@ -387,23 +406,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 an integer value from the parameter.
+    long GetLong(const wxString& param, long defaultv = 0);
 
-    // Gets the 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);
 
     // 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"),
@@ -422,7 +446,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);
@@ -452,18 +476,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() {}
 };
@@ -481,5 +506,6 @@ public:
     #define GetXMLID          GetXRCID
 #endif
 
+#endif // wxUSE_XRC
 
 #endif // _WX_XMLRES_H_