Add virtual keyword where applicable.

[wxWidgets.git] / include / wx / fontmap.h

diff --git a/include/wx/fontmap.h b/include/wx/fontmap.h
index 7e3481db5b3921f1c04167716522149372f446f5..881adb6ee550133996ddd51a2b1a69366935c7e7 100644 (file)
--- a/include/wx/fontmap.h
+++ b/include/wx/fontmap.h
@@ -28,14 +28,14 @@
     class WXDLLIMPEXP_BASE wxConfigBase;
 #endif // wxUSE_CONFIG
 
-class WXDLLIMPEXP_BASE wxFontMapper;
+class WXDLLIMPEXP_CORE wxFontMapper;
 
 #if wxUSE_GUI
     class WXDLLIMPEXP_CORE wxWindow;
 #endif // wxUSE_GUI
 
 // ============================================================================
-// wxFontMapper manages user-definable correspondence between wxWindows font
+// wxFontMapper manages user-definable correspondence between wxWidgets font
 // encodings and the fonts present on the machine.
 //
 // This is a singleton class, font mapper objects can only be accessed using
@@ -49,6 +49,8 @@ class WXDLLIMPEXP_BASE wxFontMapper;
 
 class WXDLLIMPEXP_BASE wxFontMapperBase
 {
+    // For IsWxFontMapper()
+    friend class WXDLLIMPEXP_CORE wxFontMapper;
 public:
     // constructtor and such
     // ---------------------
@@ -60,7 +62,10 @@ public:
     virtual ~wxFontMapperBase();
 
     // return instance of the wxFontMapper singleton
-    static wxFontMapper *Get();
+    // wxBase code only cares that it's a wxFontMapperBase
+    // In wxBase, wxFontMapper is only forward declared
+    // so one cannot implicitly cast from it to wxFontMapperBase.
+    static wxFontMapperBase *Get();
 
     // set the singleton to 'mapper' instance and return previous one
     static wxFontMapper *Set(wxFontMapper *mapper);
@@ -85,15 +90,24 @@ public:
     // get the n-th supported encoding
     static wxFontEncoding GetEncoding(size_t n);
 
-    // return internal string identifier for the encoding (see also
-    // GetEncodingDescription())
+    // return canonical name of this encoding (this is a short string,
+    // GetEncodingDescription() returns a longer one)
     static wxString GetEncodingName(wxFontEncoding encoding);
 
+    // return a list of all names of this encoding (see GetEncodingName)
+    static const wxChar** GetAllEncodingNames(wxFontEncoding encoding);
+
     // return user-readable string describing the given encoding
     //
     // NB: hard-coded now, but might change later (read it from config?)
     static wxString GetEncodingDescription(wxFontEncoding encoding);
 
+    // find the encoding corresponding to the given name, inverse of
+    // GetEncodingName() and less general than CharsetToEncoding()
+    //
+    // returns wxFONTENCODING_MAX if the name is not a supported encoding
+    static wxFontEncoding GetEncodingFromName(const wxString& name);
+
 
     // functions which allow to configure the config object used: by default,
     // the global one (from wxConfigBase::Get() will be used) and the default
@@ -102,9 +116,6 @@ public:
     // ----------------------------------------------------------------------
 
 #if wxUSE_CONFIG && wxUSE_FILECONFIG
-    // set the config object to use (may be NULL to use default)
-    void SetConfig(wxConfigBase *config) { m_config = config; }
-
     // set the root config path to use (should be an absolute path)
     void SetConfigPath(const wxString& prefix);
 
@@ -115,8 +126,8 @@ public:
 
 protected:
 #if wxUSE_CONFIG && wxUSE_FILECONFIG
-    // get the config object we're using -- if it wasn't set explicitly, this
-    // function will use wxConfig::Get() to get the global one
+    // get the config object we're using -- either the global config object
+    // or a wxMemoryConfig object created by this class otherwise
     wxConfigBase *GetConfig();
 
     // gets the root path for our settings -- if it wasn't set explicitly, use
@@ -135,8 +146,7 @@ protected:
     void RestorePath(const wxString& pathOld);
 
     // config object and path (in it) to use
-    wxConfigBase *m_config;
-    bool m_configIsDummy;
+    wxConfigBase *m_configDummy;
 
     wxString m_configRootPath;
 #endif // wxUSE_CONFIG
@@ -149,6 +159,9 @@ protected:
     int NonInteractiveCharsetToEncoding(const wxString& charset);
 
 private:
+    // pseudo-RTTI since we aren't a wxObject.
+    virtual bool IsWxFontMapper();
+
     // the global fontmapper object or NULL
     static wxFontMapper *sm_instance;
 
@@ -206,7 +219,9 @@ public:
                            bool interactive = true);
 
     // checks whether given encoding is available in given face or not.
-    // If no facename is given, 
+    //
+    // if no facename is given (default), return true if it's available in any
+    // facename at alll.
     virtual bool IsEncodingAvailable(wxFontEncoding encoding,
                                      const wxString& facename = wxEmptyString);
 
@@ -220,6 +235,9 @@ public:
     // the title for the dialogs (note that default is quite reasonable)
     void SetDialogTitle(const wxString& title) { m_titleDialog = title; }
 
+    // GUI code needs to know it's a wxFontMapper because there
+    // are additional methods in the subclass.
+    static wxFontMapper *Get();
 
 protected:
     // GetAltForEncoding() helper: tests for the existence of the given
@@ -240,22 +258,19 @@ protected:
     wxWindow *m_windowParent;
 
 private:
-    DECLARE_NO_COPY_CLASS(wxFontMapper)
-};
-
-#else // !wxUSE_GUI
+    // pseudo-RTTI since we aren't a wxObject.
+    virtual bool IsWxFontMapper();
 
-class WXDLLIMPEXP_BASE wxFontMapper : public wxFontMapperBase
-{
+    DECLARE_NO_COPY_CLASS(wxFontMapper)
 };
 
-#endif // wxUSE_GUI/!wxUSE_GUI
+#endif // wxUSE_GUI
 
 // ----------------------------------------------------------------------------
 // global variables
 // ----------------------------------------------------------------------------
 
-// the default font mapper for wxWindows programs do NOT use! This is for
+// the default font mapper for wxWidgets programs do NOT use! This is for
 // backward compatibility, use wxFontMapper::Get() instead
 #define wxTheFontMapper (wxFontMapper::Get())