some more comments about wxSortedArrayString::Sort

[wxWidgets.git] / interface / xrc / xmlres.h

diff --git a/interface/xrc/xmlres.h b/interface/xrc/xmlres.h
index fab603bd970aa3fe6b02db3f3a80f9595b4e144b..d1d27656840b8aa77f0bc1e153c83f9e068919a4 100644 (file)
--- a/interface/xrc/xmlres.h
+++ b/interface/xrc/xmlres.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        xrc/xmlres.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        xrc/xmlres.h

-// Purpose:     documentation for wxXmlResource class
+// Purpose:     interface of wxXmlResource

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,14 +9,14 @@
 /**
     @class wxXmlResource
     @headerfile xmlres.h wx/xrc/xmlres.h
 /**
     @class wxXmlResource
     @headerfile xmlres.h wx/xrc/xmlres.h

-    
+

     This is the main class for interacting with the XML-based resource system.
     This is the main class for interacting with the XML-based resource system.

-    
+

     The class holds XML resources from one or more .xml files, binary files or zip
     archive files.
     The class holds XML resources from one or more .xml files, binary files or zip
     archive files.

-    
+

     See @ref overview_xrcoverview "XML-based resource system overview" for details.
     See @ref overview_xrcoverview "XML-based resource system overview" for details.

-    
+

     @library{wxxrc}
     @category{xrc}
 */
     @library{wxxrc}
     @category{xrc}
 */


@@ -27,24 +27,24 @@ public:
     /**
         Constructor.
         
     /**
         Constructor.
         

-        @param 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). wxXRC_NO_RELOADING will prevent the
-        XRC files from being reloaded from disk in case they have been modified there
-        since being last loaded (may slightly speed up loading them).
-        
-        @param domain 
-        The name of the gettext catalog to search for
-          translatable strings.  By default all loaded catalogs will be
-          searched.  This provides a way to allow the strings to only come
-          from a specific catalog.
+        @param 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). wxXRC_NO_RELOADING will prevent the
+            XRC files from being reloaded from disk in case they have been modified
+        there
+            since being last loaded (may slightly speed up loading them).
+        @param domain
+            The name of the gettext catalog to search for
+              translatable strings.  By default all loaded catalogs will be
+              searched.  This provides a way to allow the strings to only come
+              from a specific catalog.

     */
     wxXmlResource(const wxString& filemask,
                   int flags = wxXRC_USE_LOCALE,
                   const wxString domain = wxEmptyString);
     */
     wxXmlResource(const wxString& filemask,
                   int flags = wxXRC_USE_LOCALE,
                   const wxString domain = wxEmptyString);

-        wxXmlResource(int flags = wxXRC_USE_LOCALE,
-                      const wxString domain = wxEmptyString);
+    wxXmlResource(int flags = wxXRC_USE_LOCALE,
+                  const wxString domain = wxEmptyString);

     //@}
 
     /**
     //@}
 
     /**


@@ -59,7 +59,7 @@ public:
         wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler
         (wxxrc) can create include file that contains initialization code for
         all controls used within the resource. Note that this handler should be
         wxTextCtrlXmlHandler, wxHtmlWindowXmlHandler. The XML resource compiler
         (wxxrc) can create include file that contains initialization code for
         all controls used within the resource. Note that this handler should be

-        allocated on the heap, since it will be delete by 
+        allocated on the heap, since it will be delete by

         ClearHandlers() later.
     */
     void AddHandler(wxXmlResourceHandler* handler);
         ClearHandlers() later.
     */
     void AddHandler(wxXmlResourceHandler* handler);


@@ -70,10 +70,10 @@ public:
     */
     bool AttachUnknownControl(const wxString& name,
                               wxWindow* control,
     */
     bool AttachUnknownControl(const wxString& name,
                               wxWindow* control,

-                              wxWindow* parent = @NULL);
+                              wxWindow* parent = NULL);

 
     /**
 
     /**

-        Removes all handlers and deletes them (this means that any handlers added using 
+        Removes all handlers and deletes them (this means that any handlers added using

         AddHandler() must be allocated on the heap).
     */
     void ClearHandlers();
         AddHandler() must be allocated on the heap).
     */
     void ClearHandlers();


@@ -83,12 +83,12 @@ public:
         is less than the argument, +1 if greater, and 0 if they equal.
     */
     int CompareVersion(int major, int minor, int release,
         is less than the argument, +1 if greater, and 0 if they equal.
     */
     int CompareVersion(int major, int minor, int release,

-                       int revision);
+                       int revision) const;

 
     /**
         Gets the global resources object or creates one if none exists.
     */
 
     /**
         Gets the global resources object or creates one if none exists.
     */

-#define wxXmlResource* Get()     /* implementation is private */
+    wxXmlResource* Get();

 
     /**
         Returns the domain (message catalog) that will be used to load
 
     /**
         Returns the domain (message catalog) that will be used to load


@@ -105,14 +105,14 @@ public:
     /**
         Returns version information (a.b.c.d = d+ 256*c + 256@c 2*b + 256@c 3*a).
     */
     /**
         Returns version information (a.b.c.d = d+ 256*c + 256@c 2*b + 256@c 3*a).
     */

-    long GetVersion();
+    long GetVersion() const;

 
     /**
         Returns a numeric ID that is equivalent to the string ID used in an XML
 
     /**
         Returns a numeric ID that is equivalent to the string ID used in an XML

-        resource. If an unknown @e str_id is requested (i.e. other than wxID_XXX
+        resource. If an unknown @a str_id is requested (i.e. other than wxID_XXX

         or integer), a new record is created which associates the given string with
         or integer), a new record is created which associates the given string with

-        a number. If @e value_if_not_found is @c wxID_NONE, the number is obtained via
-        wxNewId. Otherwise @e value_if_not_found is used.
+        a number. If @a value_if_not_found is @c wxID_NONE, the number is obtained via
+        wxNewId(). Otherwise @a value_if_not_found is used.

         Macro @c XRCID(name) is provided for convenient use in event tables.
     */
 #define int GetXRCID(const wxString& str_id, int value_if_not_found = -2)     /* implementation is private */
         Macro @c XRCID(name) is provided for convenient use in event tables.
     */
 #define int GetXRCID(const wxString& str_id, int value_if_not_found = -2)     /* implementation is private */


@@ -137,17 +137,15 @@ public:
 
     //@{
     /**
 
     //@{
     /**

-        Loads a dialog. @e dlg points to parent window (if any).
-        
+        Loads a dialog. @a dlg points to parent window (if any).

         This form is used to finish creation of an already existing instance (the main
         reason
         for this is that you may want to use derived class with a new event table).
         This form is used to finish creation of an already existing instance (the main
         reason
         for this is that you may want to use derived class with a new event table).

-        

         Example:
     */
     wxDialog* LoadDialog(wxWindow* parent, const wxString& name);
         Example:
     */
     wxDialog* LoadDialog(wxWindow* parent, const wxString& name);

-        bool LoadDialog(wxDialog* dlg, wxWindow* parent,
-                        const wxString& name);
+    bool LoadDialog(wxDialog* dlg, wxWindow* parent,
+                    const wxString& name);

     //@}
 
     /**
     //@}
 
     /**


@@ -171,14 +169,13 @@ public:
         Loads a menubar from resource. Returns @NULL on failure.
     */
     wxMenuBar* LoadMenuBar(wxWindow* parent, const wxString& name);
         Loads a menubar from resource. Returns @NULL on failure.
     */
     wxMenuBar* LoadMenuBar(wxWindow* parent, const wxString& name);

-        wxMenuBar* LoadMenuBar(const wxString& name);
+    wxMenuBar* LoadMenuBar(const wxString& name);

     //@}
 
     //@{
     /**
         Load an object from the resource specifying both the resource name and the
         class name.
     //@}
 
     //@{
     /**
         Load an object from the resource specifying both the resource name and the
         class name.

-        

         The first overload lets you load nonstandard container windows and returns @c
         @NULL
         on failure. The second one lets you finish the creation of an existing
         The first overload lets you load nonstandard container windows and returns @c
         @NULL
         on failure. The second one lets you finish the creation of an existing


@@ -186,19 +183,19 @@ public:
     */
     wxObject* LoadObject(wxWindow* parent, const wxString& name,
                          const wxString& classname);
     */
     wxObject* LoadObject(wxWindow* parent, const wxString& name,
                          const wxString& classname);

-        bool LoadObject(wxObject* instance, wxWindow* parent,
-                        const wxString& name,
-                        const wxString& classname);
+    bool LoadObject(wxObject* instance, wxWindow* parent,
+                    const wxString& name,
+                    const wxString& classname);

     //@}
 
     //@{
     /**
     //@}
 
     //@{
     /**

-        Loads a panel. @e panel points to parent window (if any). This form
+        Loads a panel. @a panel points to parent window (if any). This form

         is used to finish creation of an already existing instance.
     */
     wxPanel* LoadPanel(wxWindow* parent, const wxString& name);
         is used to finish creation of an already existing instance.
     */
     wxPanel* LoadPanel(wxWindow* parent, const wxString& name);

-        bool LoadPanel(wxPanel* panel, wxWindow* parent,
-                       const wxString& name);
+    bool LoadPanel(wxPanel* panel, wxWindow* parent,
+                   const wxString& name);

     //@}
 
     /**
     //@}
 
     /**


@@ -210,7 +207,7 @@ public:
         Sets the global resources object and returns a pointer to the previous one (may
         be @NULL).
     */
         Sets the global resources object and returns a pointer to the previous one (may
         be @NULL).
     */

-#define wxXmlResource* Set(wxXmlResource* res)     /* implementation is private */
+    wxXmlResource* Set(wxXmlResource* res);

 
     /**
         Sets the domain (message catalog) that will be used to load
 
     /**
         Sets the domain (message catalog) that will be used to load


@@ -224,9 +221,8 @@ public:
     void SetFlags(int flags);
 
     /**
     void SetFlags(int flags);
 
     /**

-        This function unloads a resource previously loaded by 
+        This function unloads a resource previously loaded by

         Load().
         Load().

-        

         Returns @true if the resource was successfully unloaded and @false if it
         hasn't
         been found in the list of loaded resources.
         Returns @true if the resource was successfully unloaded and @false if it
         hasn't
         been found in the list of loaded resources.


@@ -235,15 +231,16 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxXmlResourceHandler
     @headerfile xmlres.h wx/xrc/xmlres.h
 /**
     @class wxXmlResourceHandler
     @headerfile xmlres.h wx/xrc/xmlres.h

-    
+

     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.

-    
+

     See @ref overview_xrcoverview "XML-based resource system overview" for details.
     See @ref overview_xrcoverview "XML-based resource system overview" for details.

-    
+

     @library{wxxrc}
     @category{xrc}
 */
     @library{wxxrc}
     @category{xrc}
 */


@@ -280,23 +277,23 @@ public:
     /**
         Creates children.
     */
     /**
         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,
 
     /**
         Helper function.
     */
     void CreateChildrenPrivately(wxObject* parent,

-                                 wxXmlNode* rootnode = @NULL);
+                                 wxXmlNode* rootnode = NULL);

 
     /**
         Creates a resource from a node.
     */
     wxObject* CreateResFromNode(wxXmlNode* node, wxObject* parent,
 
     /**
         Creates a resource from a node.
     */
     wxObject* CreateResFromNode(wxXmlNode* node, wxObject* parent,

-                                wxObject* instance = @NULL);
+                                wxObject* instance = NULL);

 
     /**
         Creates an object (menu, dialog, control, ...) from an XML node.
 
     /**
         Creates an object (menu, dialog, control, ...) from an XML node.

-        Should check for validity. @e parent is a higher-level object (usually window,
+        Should check for validity. @a parent is a higher-level object (usually window,

         dialog or panel)
         that is often necessary to create the resource.
         If @b instance is non-@NULL it should not create a new instance via 'new' but
         dialog or panel)
         that is often necessary to create the resource.
         If @b instance is non-@NULL it should not create a new instance via 'new' but


@@ -313,14 +310,12 @@ public:
 
     /**
         )
 
     /**
         )

-        
-        Creates a animation from the filename specified in @e param.
+        Creates a animation() from the filename specified in @e param.

     */
     wxAnimation GetAnimation();
 
     /**
         , @b wxSize@e size = wxDefaultSize)
     */
     wxAnimation GetAnimation();
 
     /**
         , @b wxSize@e size = wxDefaultSize)

-        

         Gets a bitmap.
     */
     wxBitmap GetBitmap();
         Gets a bitmap.
     */
     wxBitmap GetBitmap();


@@ -328,13 +323,13 @@ public:
     /**
         Gets a bool flag (1, t, yes, on, @true are @true, everything else is @false).
     */
     /**
         Gets a bool flag (1, t, yes, on, @true are @true, everything else is @false).
     */

-    bool GetBool(const wxString& param, bool defaultv = @false);
+    bool GetBool(const wxString& param, bool defaultv = false);

 
     /**
         Gets colour in HTML syntax (#RRGGBB).
     */
     wxColour GetColour(const wxString& param,
 
     /**
         Gets colour in HTML syntax (#RRGGBB).
     */
     wxColour GetColour(const wxString& param,

-                       const wxColour& default = wxNullColour);
+                   const wxColour& default = wxNullColour);

 
     /**
         Returns the current file system.
 
     /**
         Returns the current file system.


@@ -348,7 +343,6 @@ public:
 
     /**
         )
 
     /**
         )

-        

         Gets a font.
     */
     wxFont GetFont();
         Gets a font.
     */
     wxFont GetFont();


@@ -356,11 +350,10 @@ public:
     /**
         Returns the XRCID.
     */
     /**
         Returns the XRCID.
     */

-#define int GetID()     /* implementation is private */
+    int GetID();

 
     /**
         , @b wxSize@e size = wxDefaultSize)
 
     /**
         , @b wxSize@e size = wxDefaultSize)

-        

         Returns an icon.
     */
     wxIcon GetIcon();
         Returns an icon.
     */
     wxIcon GetIcon();


@@ -392,21 +385,18 @@ public:
 
     /**
         )
 
     /**
         )

-        

         Gets the position (may be in dialog units).
     */
     wxPoint GetPosition();
 
     /**
         )
         Gets the position (may be in dialog units).
     */
     wxPoint GetPosition();
 
     /**
         )

-        

         Gets the size (may be in dialog units).
     */
     wxSize GetSize();
 
     /**
         , @b int@e defaults = 0)
         Gets the size (may be in dialog units).
     */
     wxSize GetSize();
 
     /**
         , @b int@e defaults = 0)

-        

         Gets style flags from text in form "flag | flag2| flag3 |..."
         Only understands flags added with AddStyle.
     */
         Gets style flags from text in form "flag | flag2| flag3 |..."
         Only understands flags added with AddStyle.
     */


@@ -414,7 +404,6 @@ public:
 
     /**
         Gets text from param and does some conversions:
 
     /**
         Gets text from param and does some conversions:

-        

          replaces \n, \r, \t by respective characters (according to C syntax)
          replaces @c $ by @c  and @c $$ by @c $ (needed for @c _File to @c File
         translation because of XML syntax)
          replaces \n, \r, \t by respective characters (according to C syntax)
          replaces @c $ by @c  and @c $$ by @c $ (needed for @c _File to @c File
         translation because of XML syntax)


@@ -444,3 +433,4 @@ public:
     */
     void SetupWindow(wxWindow* wnd);
 };
     */
     void SetupWindow(wxWindow* wnd);
 };

+