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 6bc37e9eff2c2100e57e87ef895ee0cba1772914..400e37285187cd2eec96feec3e6260f26568ba86 100644 (file)
--- a/include/wx/gtk/font.h
+++ b/include/wx/gtk/font.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        font.h
+// Name:        wx/gtk/font.h

 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$


@@ -19,7 +19,8 @@ class WXDLLIMPEXP_CORE wxFont : public wxFontBase
 public:
     wxFont() { }
 
 public:
     wxFont() { }
 

-    // wxGTK-specific
+    wxFont(const wxFontInfo& info);
+

     wxFont(const wxString& nativeFontInfoString)
     {
         Create(nativeFontInfoString);
     wxFont(const wxString& nativeFontInfoString)
     {
         Create(nativeFontInfoString);


@@ -82,6 +83,7 @@ public:
     virtual wxFontWeight GetWeight() const;
     virtual wxString GetFaceName() const;
     virtual bool GetUnderlined() const;
     virtual wxFontWeight GetWeight() const;
     virtual wxString GetFaceName() const;
     virtual bool GetUnderlined() const;

+    virtual bool GetStrikethrough() const;

     virtual wxFontEncoding GetEncoding() const;
     virtual const wxNativeFontInfo *GetNativeFontInfo() const;
     virtual bool IsFixedWidth() const;
     virtual wxFontEncoding GetEncoding() const;
     virtual const wxNativeFontInfo *GetNativeFontInfo() const;
     virtual bool IsFixedWidth() const;


@@ -92,10 +94,18 @@ public:
     virtual void SetWeight(wxFontWeight weight);
     virtual bool SetFaceName( const wxString& faceName );
     virtual void SetUnderlined( bool underlined );
     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);
 
     wxDECLARE_COMMON_FONT_METHODS();
 
     virtual void SetEncoding(wxFontEncoding encoding);
 
     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();
 
     // implementation from now on
     void Unshare();
 


@@ -104,15 +114,14 @@ public:
 protected:
     virtual void DoSetNativeFontInfo( const wxNativeFontInfo& info );
 
 protected:
     virtual void DoSetNativeFontInfo( const wxNativeFontInfo& info );
 

-    // common part of all ctors
-    void Init();
-

     virtual wxGDIRefData* CreateGDIRefData() const;
     virtual wxGDIRefData* CloneGDIRefData(const wxGDIRefData* data) const;
 
     virtual wxFontFamily DoGetFamily() const;
 
 private:
     virtual wxGDIRefData* CreateGDIRefData() const;
     virtual wxGDIRefData* CloneGDIRefData(const wxGDIRefData* data) const;
 
     virtual wxFontFamily DoGetFamily() const;
 
 private:

+    void Init();
+

     DECLARE_DYNAMIC_CLASS(wxFont)
 };
 
     DECLARE_DYNAMIC_CLASS(wxFont)
 };