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

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

 // Purpose:
 // Author:      Robert Roebling
 // Purpose:
 // Author:      Robert Roebling

-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence

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

+#ifndef _WX_GTK_FONT_H_
+#define _WX_GTK_FONT_H_

 
 

-#ifndef __GTKFONTH__
-#define __GTKFONTH__
+// ----------------------------------------------------------------------------
+// wxFont
+// ----------------------------------------------------------------------------

 
 

-#ifdef __GNUG__
-#pragma interface
+class WXDLLIMPEXP_CORE wxFont : public wxFontBase
+{
+public:
+    wxFont() { }
+
+    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,
+           const wxString& face = wxEmptyString,
+           wxFontEncoding encoding = wxFONTENCODING_DEFAULT)
+    {
+        (void)Create(size, (wxFontFamily)family, (wxFontStyle)style, (wxFontWeight)weight, underlined, face, encoding);
+    }

 #endif
 
 #endif
 

-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/hash.h"
-#include "wx/gdiobj.h"
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxDC;
-class wxPaintDC;
-class wxWindow;
+    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,
+                wxFontFamily family,
+                wxFontStyle style,
+                wxFontWeight weight,
+                bool underlined = false,
+                const wxString& face = wxEmptyString,
+                wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
+
+    // wxGTK-specific
+    bool Create(const wxString& fontname);
+
+    virtual ~wxFont();
+
+    // implement base class pure virtuals
+    virtual int GetPointSize() 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 const wxNativeFontInfo *GetNativeFontInfo() const;
+    virtual bool IsFixedWidth() const;
+
+    virtual void SetPointSize( int pointSize );
+    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);
+
+    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();

 
 

-class wxFont;
-class wxFontNameDirectory;
+    // no data :-)

 
 

-//-----------------------------------------------------------------------------
-// global variables
-//-----------------------------------------------------------------------------
+protected:
+    virtual void DoSetNativeFontInfo( const wxNativeFontInfo& info );

 
 

-//extern wxFontNameDirectory *wxTheFontNameDirectory;  // defined below
+    virtual wxGDIRefData* CreateGDIRefData() const;
+    virtual wxGDIRefData* CloneGDIRefData(const wxGDIRefData* data) const;

 
 

-//-----------------------------------------------------------------------------
-// wxFont
-//-----------------------------------------------------------------------------
+    virtual wxFontFamily DoGetFamily() const;

 
 

-class wxFont: public wxGDIObject 
-{
-  DECLARE_DYNAMIC_CLASS(wxFont)
-  
-  public:
-    wxFont(void);
-    wxFont( int PointSize, int FontIdOrFamily, int Style, int Weight,
-          bool underlined = FALSE, const char *Face=NULL );
-    wxFont( int PointSize, const char *Face, int Family, int Style, int Weight, 
-          bool underlined = FALSE );
-    wxFont( const wxFont& font );
-    wxFont( const wxFont* font );
-    ~wxFont(void);
-    wxFont& operator = ( const wxFont& font );
-    bool operator == ( const wxFont& font );
-    bool operator != ( const wxFont& font );
-    bool Ok();
-
-    int GetPointSize(void) const;
-    wxString GetFaceName(void) const;
-    int GetFamily(void) const;
-    wxString GetFamilyString(void) const;
-    int GetFontId(void) const;
-    wxString GetFaceString(void) const;
-    int GetStyle(void) const;
-    wxString GetStyleString(void) const;
-    int GetWeight(void) const;
-    wxString GetWeightString(void) const;
-    bool GetUnderlined(void) const;
-
-    wxFont( char *xFontName );
-    
-  private:
-  
-    friend wxDC;
-    friend wxPaintDC;
-    friend wxWindow;
-    
-    GdkFont* GetInternalFont(float scale = 1.0);
+private:
+    void Init();

 
 

-    // no data :-)
-};
-
-//-----------------------------------------------------------------------------
-// wxFontDirectory
-//-----------------------------------------------------------------------------
-
-class wxFontNameDirectory: public wxObject 
-{
-  DECLARE_DYNAMIC_CLASS(wxFontNameDirectory)
-  
-  public:
-    wxFontNameDirectory(void);
-    ~wxFontNameDirectory();
-
-    void  Initialize(void);
-    void  Initialize(int fontid, int family, const char *name);
-
-    int   FindOrCreateFontId(const char *name, int family);
-    char* GetAFMName(int fontid, int weight, int style);
-    int   GetFamily(int fontid);
-    int   GetFontId(const char *name);
-    char* GetFontName(int fontid);
-    int   GetNewFontId(void);
-    char* GetPostScriptName(int fontid, int weight, int style);
-    char* GetScreenName(int fontid, int weight, int style);
-    
-    
-    class wxHashTable *table;
-    int   nextFontId;
+    DECLARE_DYNAMIC_CLASS(wxFont)

 };
 
 };
 

-extern wxFontNameDirectory *wxTheFontNameDirectory;
-
-#endif // __GTKFONTH__
+#endif // _WX_GTK_FONT_H_