extend GetAsBitmap with an optional subrect

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

diff --git a/include/wx/font.h b/include/wx/font.h
index 83a00873cca750f307b3691515d4f08fd0e87d78..5d890e61765de4dcc791102ae8e9154cf150f029 100644 (file)
--- a/include/wx/font.h
+++ b/include/wx/font.h
@@ -5,17 +5,13 @@
 // Modified by:
 // Created:     20.09.99
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     20.09.99
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_FONT_H_BASE_
 #define _WX_FONT_H_BASE_
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_FONT_H_BASE_
 #define _WX_FONT_H_BASE_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "fontbase.h"
-#endif
-

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


@@ -31,6 +27,7 @@
 class WXDLLEXPORT wxFontData;
 class WXDLLEXPORT wxFontBase;
 class WXDLLEXPORT wxFont;
 class WXDLLEXPORT wxFontData;
 class WXDLLEXPORT wxFontBase;
 class WXDLLEXPORT wxFont;

+class WXDLLEXPORT wxSize;

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


@@ -109,7 +106,7 @@ enum
 // ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxFontRefData;
 // ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxFontRefData;

-struct WXDLLEXPORT wxNativeFontInfo;
+class WXDLLEXPORT wxNativeFontInfo;

 
 class WXDLLEXPORT wxFontBase : public wxGDIObject
 {
 
 class WXDLLEXPORT wxFontBase : public wxGDIObject
 {


@@ -123,7 +120,7 @@ public:
         int family,                 // see wxFontFamily enum
         int style,                  // see wxFontStyle enum
         int weight,                 // see wxFontWeight enum
         int family,                 // see wxFontFamily enum
         int style,                  // see wxFontStyle enum
         int weight,                 // see wxFontWeight enum

-        bool underlined = FALSE,    // not underlined by default
+        bool underlined = false,    // not underlined by default

         const wxString& face = wxEmptyString,              // facename
         wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ...
 
         const wxString& face = wxEmptyString,              // facename
         wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ...
 


@@ -135,6 +132,24 @@ public:
                        const wxString& face = wxEmptyString,
                        wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 
                        const wxString& face = wxEmptyString,
                        wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 

+    // from the font components
+    static wxFont *New(
+        const wxSize& pixelSize,    // size of the font in pixels
+        int family,                 // see wxFontFamily enum
+        int style,                  // see wxFontStyle enum
+        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(const wxSize& pixelSize,
+                       wxFontFamily family,
+                       int flags = wxFONTFLAG_DEFAULT,
+                       const wxString& face = wxEmptyString,
+                       wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
+

     // from the (opaque) native font description object
     static wxFont *New(const wxNativeFontInfo& nativeFontDesc);
 
     // from the (opaque) native font description object
     static wxFont *New(const wxNativeFontInfo& nativeFontDesc);
 


@@ -142,7 +157,8 @@ public:
     static wxFont *New(const wxString& strNativeFontDesc);
 
     // was the font successfully created?
     static wxFont *New(const wxString& strNativeFontDesc);
 
     // was the font successfully created?

-    bool Ok() const { return m_refData != NULL; }
+    bool Ok() const { return IsOk(); }
+    bool IsOk() const { return m_refData != NULL; }

 
     // comparison
     bool operator == (const wxFont& font) const;
 
     // comparison
     bool operator == (const wxFont& font) const;


@@ -150,13 +166,15 @@ public:
 
     // accessors: get the font characteristics
     virtual int GetPointSize() const = 0;
 
     // accessors: get the font characteristics
     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;
     virtual bool GetUnderlined() const = 0;
     virtual wxString GetFaceName() const = 0;
     virtual wxFontEncoding GetEncoding() const = 0;
     virtual int GetFamily() const = 0;
     virtual int GetStyle() const = 0;
     virtual int GetWeight() const = 0;
     virtual bool GetUnderlined() const = 0;
     virtual wxString GetFaceName() const = 0;
     virtual wxFontEncoding GetEncoding() const = 0;

-    virtual wxNativeFontInfo *GetNativeFontInfo() const;
+    virtual const wxNativeFontInfo *GetNativeFontInfo() const = 0;

 
     virtual bool IsFixedWidth() const;
 
 
     virtual bool IsFixedWidth() const;
 


@@ -165,17 +183,18 @@ public:
 
     // change the font characteristics
     virtual void SetPointSize( int pointSize ) = 0;
 
     // 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( int family ) = 0;
     virtual void SetStyle( int style ) = 0;
     virtual void SetWeight( int weight ) = 0;

-    virtual void SetFaceName( const wxString& faceName ) = 0;

     virtual void SetUnderlined( bool underlined ) = 0;
     virtual void SetEncoding(wxFontEncoding encoding) = 0;
     virtual void SetUnderlined( bool underlined ) = 0;
     virtual void SetEncoding(wxFontEncoding encoding) = 0;

+    virtual bool SetFaceName( const wxString& faceName );

     void SetNativeFontInfo(const wxNativeFontInfo& info)
         { DoSetNativeFontInfo(info); }
 
     void SetNativeFontInfo(const wxNativeFontInfo& info)
         { DoSetNativeFontInfo(info); }
 

-    void SetNativeFontInfo(const wxString& info);
-    void SetNativeFontInfoUserDesc(const wxString& info);
+    bool SetNativeFontInfo(const wxString& info);
+    bool SetNativeFontInfoUserDesc(const wxString& info);

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


@@ -184,8 +203,8 @@ public:
     wxString GetWeightString() const;
 
     // Unofficial API, don't use
     wxString GetWeightString() const;
 
     // Unofficial API, don't use

-    virtual void SetNoAntiAliasing( bool WXUNUSED(no) = TRUE ) {  }
-    virtual bool GetNoAntiAliasing() { return FALSE; }
+    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
 
     // the default encoding is used for creating all fonts with default
     // encoding parameter


@@ -204,21 +223,27 @@ private:
     // the currently default encoding: by default, it's the default system
     // encoding, but may be changed by the application using
     // SetDefaultEncoding() to make all subsequent fonts created without
     // the currently default encoding: by default, it's the default system
     // encoding, but may be changed by the application using
     // SetDefaultEncoding() to make all subsequent fonts created without

-    // specifing encoding parameter using this encoding
+    // specifying encoding parameter using this encoding

     static wxFontEncoding ms_encodingDefault;
 };
 
 // include the real class declaration
     static wxFontEncoding ms_encodingDefault;
 };
 
 // include the real class declaration

-#if defined(__WXMSW__)
+#if defined(__WXPALMOS__)
+    #include "wx/palmos/font.h"
+#elif 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"

-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)

     #include "wx/gtk/font.h"
     #include "wx/gtk/font.h"

+#elif defined(__WXGTK__)
+    #include "wx/gtk1/font.h"

 #elif defined(__WXX11__)
     #include "wx/x11/font.h"
 #elif defined(__WXMGL__)
     #include "wx/mgl/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__)
     #include "wx/mac/font.h"
 #elif defined(__WXCOCOA__)
 #elif defined(__WXMAC__)
     #include "wx/mac/font.h"
 #elif defined(__WXCOCOA__)