Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk/font.h b/include/wx/gtk/font.h
index a15d5b5dcc0f2d51ce59fa0f3e0c01fe09e38f5e..400e37285187cd2eec96feec3e6260f26568ba86 100644 (file)
--- a/include/wx/gtk/font.h
+++ b/include/wx/gtk/font.h
@@ -1,105 +1,128 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        font.h
+// Name:        wx/gtk/font.h
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
+// Copyright:   (c) 1998 Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __GTKFONTH__
-#define __GTKFONTH__
-
-#ifdef __GNUG__
-    #pragma interface
-#endif
-
-#include "wx/hash.h"
-
-// ----------------------------------------------------------------------------
-// classes
-// ----------------------------------------------------------------------------
-
-class wxDC;
-class wxPaintDC;
-class wxWindow;
-
-class wxFont;
+#ifndef _WX_GTK_FONT_H_
+#define _WX_GTK_FONT_H_
 
 // ----------------------------------------------------------------------------
 // wxFont
 // ----------------------------------------------------------------------------
 
-class wxFont : public wxFontBase
+class WXDLLIMPEXP_CORE wxFont : public wxFontBase
 {
 public:
-    // ctors and such
-    wxFont() { Init(); }
-    wxFont(const wxFont& font) { Init(); Ref(font); }
-    wxFont(const wxString& fontname, const wxFontData& fontdata) { Create(fontname, fontdata); }
-    wxFont(const wxNativeFontInfo& info);
+    wxFont() { }
 
-    // assignment
-    wxFont& operator=(const wxFont& font);
+    wxFont(const wxFontInfo& info);
 
+    wxFont(const wxString& nativeFontInfoString)
+    {
+        Create(nativeFontInfoString);
+    }
+
+    wxFont(const wxNativeFontInfo& info);
+
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
     wxFont(int size,
            int family,
            int style,
            int weight,
-           bool underlined = FALSE,
+           bool underlined = false,
            const wxString& face = wxEmptyString,
            wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
     {
-        Init();
+        (void)Create(size, (wxFontFamily)family, (wxFontStyle)style, (wxFontWeight)weight, underlined, face, encoding);
+    }
+#endif
 
-        (void)Create(size, family, style, weight, underlined, face, encoding);
+    wxFont(int size,
+           wxFontFamily family,
+           wxFontStyle style,
+           wxFontWeight weight,
+           bool underlined = false,
+           const wxString& face = wxEmptyString,
+           wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
+    {
+        Create(size, family, style, weight, underlined, face, encoding);
+    }
+
+    wxFont(const wxSize& pixelSize,
+           wxFontFamily family,
+           wxFontStyle style,
+           wxFontWeight weight,
+           bool underlined = false,
+           const wxString& face = wxEmptyString,
+           wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
+    {
+        Create(10, family, style, weight, underlined, face, encoding);
+        SetPixelSize(pixelSize);
     }
 
     bool Create(int size,
-                int family,
-                int style,
-                int weight,
-                bool underlined = FALSE,
+                wxFontFamily family,
+                wxFontStyle style,
+                wxFontWeight weight,
+                bool underlined = false,
                 const wxString& face = wxEmptyString,
-                wxFontEncoding encoding = wxFONTENCODING_DEFAULT,
-                const wxNativeFontInfo& info = wxNullNativeFontInfo);
+                wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 
-    bool Create(const wxString& fontname, const wxFontData& fontdata);
+    // wxGTK-specific
+    bool Create(const wxString& fontname);
 
-    ~wxFont();
+    virtual ~wxFont();
 
     // implement base class pure virtuals
     virtual int GetPointSize() const;
-    virtual int GetFamily() const;
-    virtual int GetStyle() const;
-    virtual int GetWeight() const;
+    virtual wxFontStyle GetStyle() const;
+    virtual wxFontWeight GetWeight() const;
     virtual wxString GetFaceName() const;
     virtual bool GetUnderlined() const;
+    virtual bool GetStrikethrough() const;
     virtual wxFontEncoding GetEncoding() const;
-    virtual wxNativeFontInfo GetNativeFontInfo() const;
+    virtual const wxNativeFontInfo *GetNativeFontInfo() const;
+    virtual bool IsFixedWidth() const;
 
     virtual void SetPointSize( int pointSize );
-    virtual void SetFamily( int family );
-    virtual void SetStyle( int style );
-    virtual void SetWeight( int weight );
-    virtual void SetFaceName( const wxString& faceName );
+    virtual void SetFamily(wxFontFamily family);
+    virtual void SetStyle(wxFontStyle style);
+    virtual void SetWeight(wxFontWeight weight);
+    virtual bool SetFaceName( const wxString& faceName );
     virtual void SetUnderlined( bool underlined );
+    virtual void SetStrikethrough(bool strikethrough);
     virtual void SetEncoding(wxFontEncoding encoding);
-    virtual void SetNativeFontInfo( const wxNativeFontInfo& info );
+
+    wxDECLARE_COMMON_FONT_METHODS();
+
+    // Set Pango attributes in the specified layout. Currently only
+    // underlined and strike-through attributes are handled by this function.
+    //
+    // If neither of them is specified, returns false, otherwise sets up the
+    // attributes and returns true.
+    bool GTKSetPangoAttrs(PangoLayout* layout) const;
 
     // implementation from now on
     void Unshare();
 
-    GdkFont* GetInternalFont(float scale = 1.0) const;
-
     // no data :-)
 
 protected:
-    // common part of all ctors
-    void Init();
+    virtual void DoSetNativeFontInfo( const wxNativeFontInfo& info );
+
+    virtual wxGDIRefData* CreateGDIRefData() const;
+    virtual wxGDIRefData* CloneGDIRefData(const wxGDIRefData* data) const;
+
+    virtual wxFontFamily DoGetFamily() const;
 
 private:
+    void Init();
+
     DECLARE_DYNAMIC_CLASS(wxFont)
 };
 
-#endif // __GTKFONTH__
+#endif // _WX_GTK_FONT_H_