]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/overviews/font.h
the wxTip overview is in tipprovider.h; this is a page of the reference manual which...
[wxWidgets.git] / docs / doxygen / overviews / font.h
index 3a24557b654941789b187388641052f4e6f26329..71b1a3653cee860d23a2a9c9e352f16665d9cde2 100644 (file)
 /////////////////////////////////////////////////////////////////////////////
 
 /*!
+
  @page font_overview wxFont overview
+
  Class: #wxFont, #wxFontDialog
  A font is an object which determines the appearance of text, primarily
  when drawing text to a window or device context. A font is determined by
  the following parameters (not all of them have to be specified, of course):
+
+
+
+
+
+
  Point size
+
+
+
+
  This is the standard way of referring to text size.
+
+
+
+
+
  Family
+
+
+
+
  Supported families are:
   @b wxDEFAULT, wxDECORATIVE, wxROMAN, wxSCRIPT, wxSWISS, wxMODERN.
   @b wxMODERN is a fixed pitch font; the others are either fixed or variable pitch.
+
+
+
+
+
  Style
+
+
+
+
  The value can be @b wxNORMAL, wxSLANT or @b wxITALIC.
+
+
+
+
+
  Weight
+
+
+
+
  The value can be @b wxNORMAL, wxLIGHT or @b wxBOLD.
+
+
+
+
+
  Underlining
+
+
+
+
  The value can be @true or @false.
+
+
+
+
+
  Face name
+
+
+
+
  An optional string specifying the actual typeface to be used. If @NULL,
  a default typeface will chosen based on the family.
+
+
+
+
+
  Encoding
+
+
+
+
  The font encoding (see @b wxFONTENCODING_XXX
  constants and the @ref fontencoding_overview for more
  details)
+
+
+
+
+
  Specifying a family, rather than a specific typeface name, ensures a degree of
  portability across platforms because a suitable font will be chosen for the
  given font family, however it doesn't allow to choose a font precisely as the
  standard Windows fonts, or if allowing the user to specify a face name, store
  the family name with any file that might be transported to a different Windows
  machine or other platform.
+
  @b Note: There is currently a difference between the appearance
  of fonts on the two platforms, if the mapping mode is anything other than
  wxMM_TEXT. Under X, font size is always specified in points. Under MS
  Windows, the unit for text is points but the text is scaled according to the
  current mapping mode. However, user scaling on a device context will also
  scale fonts under both environments.
+
  @ref nativefontinformation_overview
+
+
  @section nativefontinformation Native font information
+
  An alternative way of choosing fonts is to use the native font description.
  This is the only acceptable solution if the user is allowed to choose the font
  using the #wxFontDialog because the selected font cannot
  be described using only the family name and so, if only family name is stored
  permanently, the user would almost surely see a different font in the program
  later.
- Instead, you should store the value returned by 
+ Instead, you should store the value returned by
  wxFont::GetNativeFontInfoDesc and pass
  it to wxFont::SetNativeFontInfo later to
  recreate exactly the same font.
  implemented for Windows and Unix (GTK+ and Motif) ports only, all the methods
  are available for all the ports and should be used to make your program work
  correctly when they are implemented later.
+
  */
+
+