implemented GetBestSize() (TODO: make this available in generic version as well)

[wxWidgets.git] / include / wx / xrc / xmlres.h

diff --git a/include/wx/xrc/xmlres.h b/include/wx/xrc/xmlres.h
index 607ed3f8d2402407f32da79b59332a2c3cffb3b1..e0b0aef5606b941e05a419c3a7da8432c0c823b4 100644 (file)
--- a/include/wx/xrc/xmlres.h
+++ b/include/wx/xrc/xmlres.h
@@ -11,11 +11,10 @@
 #ifndef _WX_XMLRES_H_
 #define _WX_XMLRES_H_
 
 #ifndef _WX_XMLRES_H_
 #define _WX_XMLRES_H_
 

-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface "xmlres.h"
-#endif
-

 #include "wx/defs.h"
 #include "wx/defs.h"

+
+#if wxUSE_XRC
+

 #include "wx/string.h"
 #include "wx/dynarray.h"
 #include "wx/datetime.h"
 #include "wx/string.h"
 #include "wx/dynarray.h"
 #include "wx/datetime.h"


@@ -28,14 +27,6 @@
 
 #include "wx/xml/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;
 class WXDLLEXPORT wxDialog;
 class WXDLLEXPORT wxMenu;
 class WXDLLEXPORT wxMenuBar;
 class WXDLLEXPORT wxDialog;


@@ -59,14 +50,14 @@ class wxXmlResourceModule;
 //     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
 //     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)
+//         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
 //       - 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 + \
 
 #define WX_XMLRES_CURRENT_VERSION \
                 (WX_XMLRES_CURRENT_VERSION_MAJOR * 256*256*256 + \


@@ -93,7 +84,8 @@ WX_DECLARE_USER_EXPORTED_OBJARRAY(wxXmlResourceDataRecord,
 enum wxXmlResourceFlags
 {
     wxXRC_USE_LOCALE     = 1,
 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
 };
 
 // This class holds XML resources from one or more .xml files


@@ -108,6 +100,9 @@ public:
     //        wxXRC_NO_SUBCLASSING
     //              subclass property of object nodes will be ignored
     //              (useful for previews in XRC editors)
     //        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.
     wxXmlResource(int flags = wxXRC_USE_LOCALE);
 
     // Constructor.


@@ -125,9 +120,12 @@ public:
     // This method understands VFS (see filesys.h).
     bool Load(const wxString& 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
     // 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
     void InitAllHandlers();
 
     // Initialize only a specific handler (or custom handler). Convention says


@@ -237,10 +235,10 @@ public:
 protected:
     // Scans the resources list for unloaded files and loads them. Also reloads
     // files that have been modified since last loading.
 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.
 
     // 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);
 
     // 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);


@@ -251,6 +249,17 @@ protected:
                                 wxObject *instance = NULL,
                                 wxXmlResourceHandler *handlerToUse = NULL);
 
                                 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:
     long m_version;
 
 private:
     long m_version;
 


@@ -274,7 +283,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
 
 // 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)
 // Example:
 //    BEGIN_EVENT_TABLE(MyFrame, wxFrame)
 //       EVT_MENU(XRCID("quit"), MyFrame::OnQuit)


@@ -295,13 +304,8 @@ private:
 //    wxXmlResource::Get()->LoadDialog(&dlg, mainFrame, "my_dialog");
 //    XRCCTRL(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 XRCCTRL(window, id, type) \
 #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.
 
 // wxXmlResourceHandler is an abstract base class for resource handlers
 // capable of creating a control from an XML node.


@@ -319,7 +323,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)
     // 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,
     // 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,


@@ -329,8 +333,8 @@ public:
     // were filled.
     virtual wxObject *DoCreateResource() = 0;
 
     // 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.
     virtual bool CanHandle(wxXmlNode *node) = 0;
 
     // Sets the parent resource.


@@ -345,7 +349,7 @@ protected:
     wxXmlNode *m_node;
     wxString m_class;
     wxObject *m_parent, *m_instance;
     wxXmlNode *m_node;
     wxString m_class;
     wxObject *m_parent, *m_instance;

-    wxWindow *m_parentAsWindow, *m_instanceAsWindow;
+    wxWindow *m_parentAsWindow;

 
     // --- Handy methods:
 
 
     // --- Handy methods:
 


@@ -378,14 +382,14 @@ protected:
     void AddWindowStyles();
 
     // Gets style flags from text in form "flag | flag2| flag3 |..."
     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)
     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();
 
     // Returns the XRCID.
     int GetID();


@@ -393,23 +397,28 @@ protected:
     // Returns the resource name.
     wxString GetName();
 
     // 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).
 
     // 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).
 
     // 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"),
 
     // Gets a bitmap.
     wxBitmap GetBitmap(const wxString& param = wxT("bitmap"),


@@ -428,7 +437,7 @@ protected:
     void SetupWindow(wxWindow *wnd);
 
     // Creates children.
     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);
 
     // Helper function.
     void CreateChildrenPrivately(wxObject *parent, wxXmlNode *rootnode = NULL);


@@ -463,9 +472,9 @@ 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
 
 // 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
 // only for language bindings developer who need a way to implement subclassing

-// in wxWindows ports that don't support wxRTTI (e.g. wxPython).
+// in wxWidgets ports that don't support wxRTTI (e.g. wxPython).

 class WXDLLIMPEXP_XRC wxXmlSubclassFactory
 {
 public:
 class WXDLLIMPEXP_XRC wxXmlSubclassFactory
 {
 public:


@@ -488,5 +497,6 @@ public:
     #define GetXMLID          GetXRCID
 #endif
 
     #define GetXMLID          GetXRCID
 #endif
 

+#endif // wxUSE_XRC

 
 #endif // _WX_XMLRES_H_
 
 #endif // _WX_XMLRES_H_