flipped accessor conforming to plain c++ impl

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

diff --git a/include/wx/fontutil.h b/include/wx/fontutil.h
index 8305e1417a1325dc154a4562e9fa48e1a18f9ae4..3efd2d1e2c9ad86f19d31558b07d036708442df9 100644 (file)
--- a/include/wx/fontutil.h
+++ b/include/wx/fontutil.h
@@ -5,21 +5,17 @@
 // Modified by:
 // Created:     05.11.99
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     05.11.99
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
-// Licence:     wxWindows license
+// Copyright:   (c) wxWidgets team
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-// General note: this header is private to wxWindows and is not supposed to be
+// General note: this header is private to wxWidgets and is not supposed to be

 // included by user code. The functions declared here are implemented in
 // msw/fontutil.cpp for Windows, unix/fontutil.cpp for GTK/Motif &c.
 
 #ifndef _WX_FONTUTIL_H_
 #define _WX_FONTUTIL_H_
 
 // included by user code. The functions declared here are implemented in
 // msw/fontutil.cpp for Windows, unix/fontutil.cpp for GTK/Motif &c.
 
 #ifndef _WX_FONTUTIL_H_
 #define _WX_FONTUTIL_H_
 

-#ifdef __GNUG__
-    #pragma interface "fontutil.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------


@@ -27,13 +23,18 @@
 #include "wx/font.h"        // for wxFont and wxFontEncoding
 
 #if defined(__WXMSW__)
 #include "wx/font.h"        // for wxFont and wxFontEncoding
 
 #if defined(__WXMSW__)

-    #include <windows.h>
-    #include "wx/msw/winundef.h"
+    #include "wx/msw/wrapwin.h"

 #endif
 
 #endif
 

+class WXDLLIMPEXP_FWD_BASE wxArrayString;
+struct WXDLLIMPEXP_FWD_CORE wxNativeEncodingInfo;
+

 #if defined(_WX_X_FONTLIKE)
 
 // the symbolic names for the XLFD fields (with examples for their value)
 #if defined(_WX_X_FONTLIKE)
 
 // the symbolic names for the XLFD fields (with examples for their value)

+//
+// NB: we suppose that the font always starts with the empty token (font name
+//     registry field) as we never use nor generate it anyhow

 enum wxXLFDField
 {
     wxXLFD_FOUNDRY,     // adobe
 enum wxXLFDField
 {
     wxXLFD_FOUNDRY,     // adobe


@@ -64,31 +65,48 @@ enum wxXLFDField
 // functions, the user code can only get the objects of this type from
 // somewhere and pass it somewhere else (possibly save them somewhere using
 // ToString() and restore them using FromString())
 // functions, the user code can only get the objects of this type from
 // somewhere and pass it somewhere else (possibly save them somewhere using
 // ToString() and restore them using FromString())

-//
-// NB: it is a POD currently for max efficiency but if it continues to grow
-//     further it might make sense to make it a real class with virtual methods
-struct WXDLLEXPORT wxNativeFontInfo
+class WXDLLIMPEXP_CORE wxNativeFontInfo

 {
 {

-#if defined(_WX_X_FONTLIKE)
-    // the fonts array can't be accessed directly as we only parse the
-    // xFontName when needed
+public:
+#if wxUSE_PANGO
+    PangoFontDescription *description;
+#elif defined(_WX_X_FONTLIKE)
+    // the members can't be accessed directly as we only parse the
+    // xFontName on demand

 private:
     // the components of the XLFD
     wxString     fontElements[wxXLFD_MAX];
 
 private:
     // the components of the XLFD
     wxString     fontElements[wxXLFD_MAX];
 

-public:

     // the full XLFD
     wxString     xFontName;
 
     // the full XLFD
     wxString     xFontName;
 

-    // init the elements from an XLFD, return TRUE if ok
+    // true until SetXFontName() is called
+    bool         m_isDefault;
+
+    // return true if we have already initialized fontElements
+    inline bool HasElements() const;
+
+public:
+    // init the elements from an XLFD, return true if ok

     bool FromXFontName(const wxString& xFontName);
 
     bool FromXFontName(const wxString& xFontName);
 

-    // generate an XLFD using the fontElements
+    // return false if we were never initialized with a valid XLFD
+    bool IsDefault() const { return m_isDefault; }
+
+    // return the XLFD (using the fontElements if necessary)

     wxString GetXFontName() const;
 
     // get the given XFLD component
     wxString GetXFontComponent(wxXLFDField field) const;
     wxString GetXFontName() const;
 
     // get the given XFLD component
     wxString GetXFontComponent(wxXLFDField field) const;

+
+    // change the font component
+    void SetXFontComponent(wxXLFDField field, const wxString& value);
+
+    // set the XFLD
+    void SetXFontName(const wxString& xFontName);

 #elif defined(__WXMSW__)
 #elif defined(__WXMSW__)

+    wxNativeFontInfo(const LOGFONT& lf_) : lf(lf_) { }
+

     LOGFONT      lf;
 #elif defined(__WXPM__)
     // OS/2 native structures that define a font
     LOGFONT      lf;
 #elif defined(__WXPM__)
     // OS/2 native structures that define a font


@@ -114,11 +132,58 @@ public:
     // default ctor (default copy ctor is ok)
     wxNativeFontInfo() { Init(); }
 
     // default ctor (default copy ctor is ok)
     wxNativeFontInfo() { Init(); }
 

+#if wxUSE_PANGO
+private:
+    void Init(const wxNativeFontInfo& info);
+    void Free();
+
+public:
+    wxNativeFontInfo(const wxNativeFontInfo& info) { Init(info); }
+    ~wxNativeFontInfo() { Free(); }
+
+    wxNativeFontInfo& operator=(const wxNativeFontInfo& info)
+    {
+        Free();
+        Init(info);
+        return *this;
+    }
+#endif // wxUSE_PANGO
+

     // reset to the default state
     void Init();
 
     // reset to the default state
     void Init();
 

+    // init with the parameters of the given font
+    void InitFromFont(const wxFont& font)
+    {
+        // translate all font parameters
+        SetStyle((wxFontStyle)font.GetStyle());
+        SetWeight((wxFontWeight)font.GetWeight());
+        SetUnderlined(font.GetUnderlined());
+#if defined(__WXMSW__)
+        if ( font.IsUsingSizeInPixels() )
+            SetPixelSize(font.GetPixelSize());
+        else
+            SetPointSize(font.GetPointSize());
+#else
+        SetPointSize(font.GetPointSize());
+#endif
+
+        // set the family/facename
+        SetFamily((wxFontFamily)font.GetFamily());
+        const wxString& facename = font.GetFaceName();
+        if ( !facename.empty() )
+        {
+            SetFaceName(facename);
+        }
+
+        // deal with encoding now (it may override the font family and facename
+        // so do it after setting them)
+        SetEncoding(font.GetEncoding());
+    }
+

     // accessors and modifiers for the font elements
     int GetPointSize() const;
     // accessors and modifiers for the font elements
     int GetPointSize() const;

+    wxSize GetPixelSize() const;

     wxFontStyle GetStyle() const;
     wxFontWeight GetWeight() const;
     bool GetUnderlined() const;
     wxFontStyle GetStyle() const;
     wxFontWeight GetWeight() const;
     bool GetUnderlined() const;


@@ -127,13 +192,21 @@ public:
     wxFontEncoding GetEncoding() const;
 
     void SetPointSize(int pointsize);
     wxFontEncoding GetEncoding() const;
 
     void SetPointSize(int pointsize);

+    void SetPixelSize(const wxSize& pixelSize);

     void SetStyle(wxFontStyle style);
     void SetWeight(wxFontWeight weight);
     void SetUnderlined(bool underlined);
     void SetStyle(wxFontStyle style);
     void SetWeight(wxFontWeight weight);
     void SetUnderlined(bool underlined);

-    void SetFaceName(wxString facename);
+    bool SetFaceName(const wxString& facename);

     void SetFamily(wxFontFamily family);
     void SetEncoding(wxFontEncoding encoding);
 
     void SetFamily(wxFontFamily family);
     void SetEncoding(wxFontEncoding encoding);
 

+    // sets the first facename in the given array which is found
+    // to be valid. If no valid facename is given, sets the
+    // first valid facename returned by wxFontEnumerator::GetFacenames().
+    // Does not return a bool since it cannot fail.
+    void SetFaceName(const wxArrayString &facenames);
+
+

     // it is important to be able to serialize wxNativeFontInfo objects to be
     // able to store them (in config file, for example)
     bool FromString(const wxString& s);
     // it is important to be able to serialize wxNativeFontInfo objects to be
     // able to store them (in config file, for example)
     bool FromString(const wxString& s);


@@ -151,14 +224,14 @@ public:
 // ----------------------------------------------------------------------------
 
 // translate a wxFontEncoding into native encoding parameter (defined above),
 // ----------------------------------------------------------------------------
 
 // translate a wxFontEncoding into native encoding parameter (defined above),

-// returning TRUE if an (exact) macth could be found, FALSE otherwise (without
+// returning true if an (exact) macth could be found, false otherwise (without

 // attempting any substitutions)
 // attempting any substitutions)

-extern bool wxGetNativeFontEncoding(wxFontEncoding encoding,
-                                    wxNativeEncodingInfo *info);
+WXDLLIMPEXP_CORE bool wxGetNativeFontEncoding(wxFontEncoding encoding,
+                                              wxNativeEncodingInfo *info);

 
 // test for the existence of the font described by this facename/encoding,
 
 // test for the existence of the font described by this facename/encoding,

-// return TRUE if such font(s) exist, FALSE otherwise
-extern bool wxTestFontEncoding(const wxNativeEncodingInfo& info);
+// return true if such font(s) exist, false otherwise
+WXDLLIMPEXP_CORE bool wxTestFontEncoding(const wxNativeEncodingInfo& info);

 
 // ----------------------------------------------------------------------------
 // font-related functions (X and GTK)
 
 // ----------------------------------------------------------------------------
 // font-related functions (X and GTK)


@@ -168,12 +241,4 @@ extern bool wxTestFontEncoding(const wxNativeEncodingInfo& info);
     #include "wx/unix/fontutil.h"
 #endif // X || GDK
 
     #include "wx/unix/fontutil.h"
 #endif // X || GDK
 

-// ----------------------------------------------------------------------------
-// font-related functions (MGL)
-// ----------------------------------------------------------------------------
-
-#ifdef __WXMGL__
-    #include "wx/mgl/fontutil.h"
-#endif // __WXMGL__
-

 #endif // _WX_FONTUTIL_H_
 #endif // _WX_FONTUTIL_H_