remove unused variable assignment, closes #14928

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

diff --git a/include/wx/font.h b/include/wx/font.h
index 3ef53d35807d9b785ec1ff53d2ae05cc5c5bf1ab..b14281221e0ffcb638a3a0dddb658715a3bde063 100644 (file)
--- a/include/wx/font.h
+++ b/include/wx/font.h
@@ -25,10 +25,7 @@
 // forward declarations
 // ----------------------------------------------------------------------------
 
 // forward declarations
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_FWD_CORE wxFontData;
-class WXDLLIMPEXP_FWD_CORE wxFontBase;

 class WXDLLIMPEXP_FWD_CORE wxFont;
 class WXDLLIMPEXP_FWD_CORE wxFont;

-class WXDLLIMPEXP_FWD_CORE wxSize;

 
 // ----------------------------------------------------------------------------
 // font constants
 
 // ----------------------------------------------------------------------------
 // font constants


@@ -69,8 +66,20 @@ enum wxFontWeight
     wxFONTWEIGHT_MAX
 };
 
     wxFONTWEIGHT_MAX
 };
 

+// Symbolic font sizes as defined in CSS specification.
+enum wxFontSymbolicSize
+{
+    wxFONTSIZE_XX_SMALL = -3,
+    wxFONTSIZE_X_SMALL,
+    wxFONTSIZE_SMALL,
+    wxFONTSIZE_MEDIUM,
+    wxFONTSIZE_LARGE,
+    wxFONTSIZE_X_LARGE,
+    wxFONTSIZE_XX_LARGE
+};
+

 // the font flag bits for the new font ctor accepting one combined flags word
 // the font flag bits for the new font ctor accepting one combined flags word

-enum
+enum wxFontFlag

 {
     // no special flags: font with default weight/slant/anti-aliasing
     wxFONTFLAG_DEFAULT          = 0,
 {
     // no special flags: font with default weight/slant/anti-aliasing
     wxFONTFLAG_DEFAULT          = 0,


@@ -108,12 +117,36 @@ enum
 
 class WXDLLIMPEXP_FWD_CORE wxNativeFontInfo;
 
 
 class WXDLLIMPEXP_FWD_CORE wxNativeFontInfo;
 

-class WXDLLEXPORT wxFontBase : public wxGDIObject
+class WXDLLIMPEXP_CORE wxFontBase : public wxGDIObject

 {
 public:
 {
 public:

+    /*
+        derived classes should provide the following ctors:
+
+    wxFont();
+    wxFont(const wxString& nativeFontInfoString);
+    wxFont(const wxNativeFontInfo& info);
+    wxFont(int size,
+           wxFontFamily family,
+           wxFontStyle style,
+           wxFontWeight weight,
+           bool underlined = false,
+           const wxString& face = wxEmptyString,
+           wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
+    wxFont(const wxSize& pixelSize,
+           wxFontFamily family,
+           wxFontStyle style,
+           wxFontWeight weight,
+           bool underlined = false,
+           const wxString& face = wxEmptyString,
+           wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
+    */
+

     // creator function
     virtual ~wxFontBase();
 
     // creator function
     virtual ~wxFontBase();
 

+
+#if FUTURE_WXWIN_COMPATIBILITY_3_0

     // from the font components
     static wxFont *New(
         int pointSize,              // size of the font in points
     // from the font components
     static wxFont *New(
         int pointSize,              // size of the font in points


@@ -122,15 +155,9 @@ public:
         int weight,                 // see wxFontWeight enum
         bool underlined = false,    // not underlined by default
         const wxString& face = wxEmptyString,              // facename
         int weight,                 // see wxFontWeight enum
         bool underlined = false,    // not underlined by default
         const wxString& face = wxEmptyString,              // facename

-        wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ...
-
-    // from the font components but using the font flags instead of separate
-    // parameters for each flag
-    static wxFont *New(int pointSize,
-                       wxFontFamily family,
-                       int flags = wxFONTFLAG_DEFAULT,
-                       const wxString& face = wxEmptyString,
-                       wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
+        wxFontEncoding encoding = wxFONTENCODING_DEFAULT)  // ISO8859-X, ...
+        { return New(pointSize, (wxFontFamily)family, (wxFontStyle)style,
+                     (wxFontWeight)weight, underlined, face, encoding); }

 
     // from the font components
     static wxFont *New(
 
     // from the font components
     static wxFont *New(


@@ -140,8 +167,40 @@ public:
         int weight,                 // see wxFontWeight enum
         bool underlined = false,    // not underlined by default
         const wxString& face = wxEmptyString,              // facename
         int weight,                 // see wxFontWeight enum
         bool underlined = false,    // not underlined by default
         const wxString& face = wxEmptyString,              // facename

+        wxFontEncoding encoding = wxFONTENCODING_DEFAULT)  // ISO8859-X, ...
+        { return New(pixelSize, (wxFontFamily)family, (wxFontStyle)style,
+                     (wxFontWeight)weight, underlined, face, encoding); }
+#endif
+
+    // from the font components
+    static wxFont *New(
+        int pointSize,              // size of the font in points
+        wxFontFamily family,        // see wxFontFamily enum
+        wxFontStyle style,          // see wxFontStyle enum
+        wxFontWeight weight,        // see wxFontWeight enum
+        bool underlined = false,    // not underlined by default
+        const wxString& face = wxEmptyString,              // facename
+        wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ...
+
+    // from the font components
+    static wxFont *New(
+        const wxSize& pixelSize,    // size of the font in pixels
+        wxFontFamily family,        // see wxFontFamily enum
+        wxFontStyle style,          // see wxFontStyle enum
+        wxFontWeight weight,        // see wxFontWeight enum
+        bool underlined = false,    // not underlined by default
+        const wxString& face = wxEmptyString,              // facename

         wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ...
 
         wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ...
 

+    // from the font components but using the font flags instead of separate
+    // parameters for each flag
+    static wxFont *New(int pointSize,
+                       wxFontFamily family,
+                       int flags = wxFONTFLAG_DEFAULT,
+                       const wxString& face = wxEmptyString,
+                       wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
+
+

     // from the font components but using the font flags instead of separate
     // parameters for each flag
     static wxFont *New(const wxSize& pixelSize,
     // from the font components but using the font flags instead of separate
     // parameters for each flag
     static wxFont *New(const wxSize& pixelSize,


@@ -164,10 +223,11 @@ public:
     virtual int GetPointSize() const = 0;
     virtual wxSize GetPixelSize() const;
     virtual bool IsUsingSizeInPixels() const;
     virtual int GetPointSize() const = 0;
     virtual wxSize GetPixelSize() const;
     virtual bool IsUsingSizeInPixels() const;

-    virtual int GetFamily() const = 0;
-    virtual int GetStyle() const = 0;
-    virtual int GetWeight() const = 0;
+    wxFontFamily GetFamily() const;
+    virtual wxFontStyle GetStyle() const = 0;
+    virtual wxFontWeight GetWeight() const = 0;

     virtual bool GetUnderlined() const = 0;
     virtual bool GetUnderlined() const = 0;

+    virtual bool GetStrikethrough() const { return false; }

     virtual wxString GetFaceName() const = 0;
     virtual wxFontEncoding GetEncoding() const = 0;
     virtual const wxNativeFontInfo *GetNativeFontInfo() const = 0;
     virtual wxString GetFaceName() const = 0;
     virtual wxFontEncoding GetEncoding() const = 0;
     virtual const wxNativeFontInfo *GetNativeFontInfo() const = 0;


@@ -180,10 +240,12 @@ public:
     // change the font characteristics
     virtual void SetPointSize( int pointSize ) = 0;
     virtual void SetPixelSize( const wxSize& pixelSize );
     // change the font characteristics
     virtual void SetPointSize( int pointSize ) = 0;
     virtual void SetPixelSize( const wxSize& pixelSize );

-    virtual void SetFamily( int family ) = 0;
-    virtual void SetStyle( int style ) = 0;
-    virtual void SetWeight( int weight ) = 0;
+    virtual void SetFamily( wxFontFamily family ) = 0;
+    virtual void SetStyle( wxFontStyle style ) = 0;
+    virtual void SetWeight( wxFontWeight weight ) = 0;
+

     virtual void SetUnderlined( bool underlined ) = 0;
     virtual void SetUnderlined( bool underlined ) = 0;

+    virtual void SetStrikethrough( bool WXUNUSED(strikethrough) ) {}

     virtual void SetEncoding(wxFontEncoding encoding) = 0;
     virtual bool SetFaceName( const wxString& faceName );
     void SetNativeFontInfo(const wxNativeFontInfo& info)
     virtual void SetEncoding(wxFontEncoding encoding) = 0;
     virtual bool SetFaceName( const wxString& faceName );
     void SetNativeFontInfo(const wxNativeFontInfo& info)


@@ -192,25 +254,75 @@ public:
     bool SetNativeFontInfo(const wxString& info);
     bool SetNativeFontInfoUserDesc(const wxString& info);
 
     bool SetNativeFontInfo(const wxString& info);
     bool SetNativeFontInfoUserDesc(const wxString& info);
 

+    // Symbolic font sizes support: set the font size to "large" or "very
+    // small" either absolutely (i.e. compared to the default font size) or
+    // relatively to the given font size.
+    void SetSymbolicSize(wxFontSymbolicSize size);
+    void SetSymbolicSizeRelativeTo(wxFontSymbolicSize size, int base)
+    {
+        SetPointSize(AdjustToSymbolicSize(size, base));
+    }
+
+    // Adjust the base size in points according to symbolic size.
+    static int AdjustToSymbolicSize(wxFontSymbolicSize size, int base);
+
+

     // translate the fonts into human-readable string (i.e. GetStyleString()
     // will return "wxITALIC" for an italic font, ...)
     wxString GetFamilyString() const;
     wxString GetStyleString() const;
     wxString GetWeightString() const;
 
     // translate the fonts into human-readable string (i.e. GetStyleString()
     // will return "wxITALIC" for an italic font, ...)
     wxString GetFamilyString() const;
     wxString GetStyleString() const;
     wxString GetWeightString() const;
 

-    // Unofficial API, don't use
-    virtual void SetNoAntiAliasing( bool WXUNUSED(no) = true ) {  }
-    virtual bool GetNoAntiAliasing() const { return false; }
-

     // the default encoding is used for creating all fonts with default
     // encoding parameter
     static wxFontEncoding GetDefaultEncoding() { return ms_encodingDefault; }
     static void SetDefaultEncoding(wxFontEncoding encoding);
 
     // the default encoding is used for creating all fonts with default
     // encoding parameter
     static wxFontEncoding GetDefaultEncoding() { return ms_encodingDefault; }
     static void SetDefaultEncoding(wxFontEncoding encoding);
 

+    // this doesn't do anything and is kept for compatibility only
+#if WXWIN_COMPATIBILITY_2_8
+    wxDEPRECATED_INLINE(void SetNoAntiAliasing(bool no = true), wxUnusedVar(no););
+    wxDEPRECATED_INLINE(bool GetNoAntiAliasing() const, return false;)
+#endif // WXWIN_COMPATIBILITY_2_8
+

 protected:
     // the function called by both overloads of SetNativeFontInfo()
     virtual void DoSetNativeFontInfo(const wxNativeFontInfo& info);
 
 protected:
     // the function called by both overloads of SetNativeFontInfo()
     virtual void DoSetNativeFontInfo(const wxNativeFontInfo& info);
 

+    // The function called by public GetFamily(): it can return
+    // wxFONTFAMILY_UNKNOWN unlike the public method (see comment there).
+    virtual wxFontFamily DoGetFamily() const = 0;
+
+
+    // Helper functions to recover wxFONTSTYLE/wxFONTWEIGHT and underlined flg
+    // values from flags containing a combination of wxFONTFLAG_XXX.
+    static wxFontStyle GetStyleFromFlags(int flags)
+    {
+        return flags & wxFONTFLAG_ITALIC
+                        ? wxFONTSTYLE_ITALIC
+                        : flags & wxFONTFLAG_SLANT
+                            ? wxFONTSTYLE_SLANT
+                            : wxFONTSTYLE_NORMAL;
+    }
+
+    static wxFontWeight GetWeightFromFlags(int flags)
+    {
+        return flags & wxFONTFLAG_LIGHT
+                        ? wxFONTWEIGHT_LIGHT
+                        : flags & wxFONTFLAG_BOLD
+                            ? wxFONTWEIGHT_BOLD
+                            : wxFONTWEIGHT_NORMAL;
+    }
+
+    static bool GetUnderlinedFromFlags(int flags)
+    {
+        return (flags & wxFONTFLAG_UNDERLINED) != 0;
+    }
+
+    static bool GetStrikethroughFromFlags(int flags)
+    {
+        return (flags & wxFONTFLAG_STRIKETHROUGH) != 0;
+    }
+

 private:
     // the currently default encoding: by default, it's the default system
     // encoding, but may be changed by the application using
 private:
     // the currently default encoding: by default, it's the default system
     // encoding, but may be changed by the application using


@@ -224,11 +336,47 @@ WXDLLIMPEXP_CORE wxString wxToString(const wxFontBase& font);
 WXDLLIMPEXP_CORE bool wxFromString(const wxString& str, wxFontBase* font);
 
 
 WXDLLIMPEXP_CORE bool wxFromString(const wxString& str, wxFontBase* font);
 
 

+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+#define wxDECLARE_FONT_COMPAT_SETTER   \
+    wxDEPRECATED_FUTURE( void SetFamily(int family) ) \
+        { SetFamily((wxFontFamily)family); } \
+    wxDEPRECATED_FUTURE( void SetStyle(int style) ) \
+        { SetStyle((wxFontStyle)style); } \
+    wxDEPRECATED_FUTURE( void SetWeight(int weight) ) \
+        { SetWeight((wxFontWeight)weight); } \
+    wxDEPRECATED_FUTURE( void SetFamily(wxDeprecatedGUIConstants family) ) \
+        { SetFamily((wxFontFamily)family); } \
+    wxDEPRECATED_FUTURE( void SetStyle(wxDeprecatedGUIConstants style) ) \
+        { SetStyle((wxFontStyle)style); } \
+    wxDEPRECATED_FUTURE( void SetWeight(wxDeprecatedGUIConstants weight) ) \
+        { SetWeight((wxFontWeight)weight); }
+#else
+#define wxDECLARE_FONT_COMPAT_SETTER  /*empty*/
+#endif
+
+// this macro must be used in all derived wxFont classes declarations
+#define wxDECLARE_COMMON_FONT_METHODS() \
+    wxDECLARE_FONT_COMPAT_SETTER \
+ \
+    /* functions for modifying font in place */ \
+    wxFont& MakeBold(); \
+    wxFont& MakeItalic(); \
+    wxFont& MakeUnderlined(); \
+    wxFont& MakeStrikethrough(); \
+    wxFont& MakeLarger() { return Scale(1.2f); } \
+    wxFont& MakeSmaller() { return Scale(1/1.2f); } \
+    wxFont& Scale(float x); \
+    /* functions for creating fonts based on this one */ \
+    wxFont Bold() const; \
+    wxFont Italic() const; \
+    wxFont Underlined() const; \
+    wxFont Strikethrough() const; \
+    wxFont Larger() const { return Scaled(1.2f); } \
+    wxFont Smaller() const { return Scaled(1/1.2f); } \
+    wxFont Scaled(float x) const

 
 // include the real class declaration
 
 // include the real class declaration

-#if defined(__WXPALMOS__)
-    #include "wx/palmos/font.h"
-#elif defined(__WXMSW__)
+#if defined(__WXMSW__)

     #include "wx/msw/font.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/font.h"
     #include "wx/msw/font.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/font.h"


@@ -238,12 +386,10 @@ WXDLLIMPEXP_CORE bool wxFromString(const wxString& str, wxFontBase* font);
     #include "wx/gtk1/font.h"
 #elif defined(__WXX11__)
     #include "wx/x11/font.h"
     #include "wx/gtk1/font.h"
 #elif defined(__WXX11__)
     #include "wx/x11/font.h"

-#elif defined(__WXMGL__)
-    #include "wx/mgl/font.h"

 #elif defined(__WXDFB__)
     #include "wx/dfb/font.h"
 #elif defined(__WXMAC__)
 #elif defined(__WXDFB__)
     #include "wx/dfb/font.h"
 #elif defined(__WXMAC__)

-    #include "wx/mac/font.h"
+    #include "wx/osx/font.h"

 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/font.h"
 #elif defined(__WXPM__)
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/font.h"
 #elif defined(__WXPM__)


@@ -276,7 +422,38 @@ public:
 #endif
 };
 
 #endif
 };
 

-extern WXDLLEXPORT_DATA(wxFontList*)    wxTheFontList;
+extern WXDLLIMPEXP_DATA_CORE(wxFontList*)    wxTheFontList;
+
+
+// provide comparison operators to allow code such as
+//
+//      if ( font.GetStyle() == wxFONTSTYLE_SLANT )
+//
+// to compile without warnings which it would otherwise provoke from some
+// compilers as it compares elements of different enums
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+
+// Unfortunately some compilers have ambiguity issues when enum comparisons are
+// overloaded so we have to disable the overloads in this case, see
+// wxCOMPILER_NO_OVERLOAD_ON_ENUM definition in wx/platform.h for more details.
+#ifndef wxCOMPILER_NO_OVERLOAD_ON_ENUM
+
+inline bool operator==(wxFontFamily s, wxDeprecatedGUIConstants t)
+{ return static_cast<int>(s) == static_cast<int>(t); }
+inline bool operator!=(wxFontFamily s, wxDeprecatedGUIConstants t)
+{ return !(s == t); }
+inline bool operator==(wxFontStyle s, wxDeprecatedGUIConstants t)
+{ return static_cast<int>(s) == static_cast<int>(t); }
+inline bool operator!=(wxFontStyle s, wxDeprecatedGUIConstants t)
+{ return !(s == t); }
+inline bool operator==(wxFontWeight s, wxDeprecatedGUIConstants t)
+{ return static_cast<int>(s) == static_cast<int>(t); }
+inline bool operator!=(wxFontWeight s, wxDeprecatedGUIConstants t)
+{ return !(s == t); }
+
+#endif // // wxCOMPILER_NO_OVERLOAD_ON_ENUM
+
+#endif // FUTURE_WXWIN_COMPATIBILITY_3_0

 
 #endif
     // _WX_FONT_H_BASE_
 
 #endif
     // _WX_FONT_H_BASE_