From 336aecf1c2f69fa10e3271ea94dac7c545bf6300 Mon Sep 17 00:00:00 2001
From: Francesco Montorsi <f18m_cpp217828@yahoo.it>
Date: Sat, 10 Jan 2009 18:59:37 +0000
Subject: [PATCH] miscellaneous small enhancements

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57984 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 interface/wx/filesys.h    |  9 +++++++--
 interface/wx/help.h       |  2 +-
 interface/wx/image.h      |  6 ++++++
 interface/wx/intl.h       |  2 +-
 interface/wx/mediactrl.h  |  2 +-
 interface/wx/xrc/xmlres.h | 14 ++++++++++++--
 6 files changed, 28 insertions(+), 7 deletions(-)

diff --git a/interface/wx/filesys.h b/interface/wx/filesys.h
index 80accecb76..22246cacbc 100644
--- a/interface/wx/filesys.h
+++ b/interface/wx/filesys.h
@@ -36,6 +36,11 @@ class wxFileSystem : public wxObject
 public:
     /**
         Constructor.
+
+        The initial current path of this object will be empty
+        (i.e. GetPath() == wxEmptyString) which means that e.g. OpenFile()
+        or FindFirst() functions will use current working directory as
+        current path (see also wxGetCwd).
     */
     wxFileSystem();
 
@@ -172,7 +177,7 @@ public:
     @class wxFSFile
 
     This class represents a single file opened by wxFileSystem.
-    It provides more information than wxWindow's input stream
+    It provides more informations than wxWidgets' input streams
     (stream, filename, mime type, anchor).
 
     @note Any pointer returned by a method of wxFSFile is valid only as long as
@@ -182,7 +187,7 @@ public:
           ten identical pointers.
 
     @library{wxbase}
-    @category{vfs}
+    @category{vfs,file}
 
     @see wxFileSystemHandler, wxFileSystem, @ref overview_fs
 */
diff --git a/interface/wx/help.h b/interface/wx/help.h
index 09475c75e9..e32617b320 100644
--- a/interface/wx/help.h
+++ b/interface/wx/help.h
@@ -205,7 +205,7 @@ public:
 
         wxHtmlHelpController ignores this call.
     */
-    virtual bool LoadFile(const wxString& file = "");
+    virtual bool LoadFile(const wxString& file = wxEmptyString);
 
     /**
         Overrideable member called when this application's viewer is quit by the user.
diff --git a/interface/wx/image.h b/interface/wx/image.h
index 8c9208bf35..0c6af9ef93 100644
--- a/interface/wx/image.h
+++ b/interface/wx/image.h
@@ -1446,6 +1446,12 @@ public:
     wxImage& operator=(const wxImage& image);
 };
 
+/**
+    An instance of an empty image without an alpha channel.
+*/
+wxImage wxNullImage;
+
+
 // ============================================================================
 // Global functions/macros
 // ============================================================================
diff --git a/interface/wx/intl.h b/interface/wx/intl.h
index 390970029c..0548bff2b4 100644
--- a/interface/wx/intl.h
+++ b/interface/wx/intl.h
@@ -17,7 +17,7 @@
 */
 enum wxLanguage
 {
-    /// User's default/preffered language as got from OS.
+    /// User's default/preferred language as got from OS.
     wxLANGUAGE_DEFAULT,
 
     /// Unknown language, returned if wxLocale::GetSystemLanguage fails.
diff --git a/interface/wx/mediactrl.h b/interface/wx/mediactrl.h
index 6109e65272..d4442827f4 100644
--- a/interface/wx/mediactrl.h
+++ b/interface/wx/mediactrl.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        mediactrl.h
-// Purpose:     interface of wxMediaEvent
+// Purpose:     interface of wxMediaEvent, wxMediaCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
diff --git a/interface/wx/xrc/xmlres.h b/interface/wx/xrc/xmlres.h
index 14d9df782e..75b8820a00 100644
--- a/interface/wx/xrc/xmlres.h
+++ b/interface/wx/xrc/xmlres.h
@@ -31,6 +31,9 @@ enum wxXmlResourceFlags
     The class holds XML resources from one or more .xml files, binary files or zip
     archive files.
 
+    Note that this is a singleton class and you'll never allocate/deallocate it.
+    Just use the static wxXmlResource::Get() getter.
+
     @see @ref overview_xrc, @ref overview_xrcformat
 
     @library{wxxrc}
@@ -166,7 +169,14 @@ public:
 
     /**
         Loads resources from XML files that match given filemask.
-        This method understands VFS (see filesys.h).
+
+        Example:
+        @code
+            if (!wxXmlResource::Get()->Load("rc/*.xrc"))
+                wxLogError("Couldn't load resources!");
+        @endcode
+
+        This method understands VFS (see wxFileSystem::FindFirst).
     */
     bool Load(const wxString& filemask);
 
@@ -189,7 +199,7 @@ public:
 
         @code
           MyDialog dlg;
-          wxTheXmlResource->LoadDialog(&dlg, mainFrame, "my_dialog");
+          wxXmlResource::Get()->LoadDialog(&dlg, mainFrame, "my_dialog");
           dlg.ShowModal();
         @endcode
     */
-- 
2.47.2