Doc tweaks

[wxWidgets.git] / docs / latex / wx / font.tex

diff --git a/docs/latex/wx/font.tex b/docs/latex/wx/font.tex
index 50738f75faf7bb4601cfc5650a535fdf393067b2..143072991b1f291b0197f5b42dbd338647044bd7 100644 (file)
--- a/docs/latex/wx/font.tex
+++ b/docs/latex/wx/font.tex
@@ -19,6 +19,23 @@ You can retrieve the current system font settings with \helpref{wxSystemSettings
 
 \wxheading{Constants}
 
+The possible values for the \arg{family} parameter of \helpref{wxFont
+constructor}{wxfontctor} are (the old names are for compatibility only):
+
+\begin{verbatim}
+enum wxFontFamily
+{
+    wxFONTFAMILY_DEFAULT = wxDEFAULT,
+    wxFONTFAMILY_DECORATIVE = wxDECORATIVE,
+    wxFONTFAMILY_ROMAN = wxROMAN,
+    wxFONTFAMILY_SCRIPT = wxSCRIPT,
+    wxFONTFAMILY_SWISS = wxSWISS,
+    wxFONTFAMILY_MODERN = wxMODERN,
+    wxFONTFAMILY_TELETYPE = wxTELETYPE,
+    wxFONTFAMILY_MAX
+};
+\end{verbatim}
+
 The font flags which can be used during the font creation are:
 
 \begin{verbatim}
@@ -128,23 +145,32 @@ wxSWISS\_FONT}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxFont::wxFont}\label{wxfontconstr}
+
+\membersection{wxFont::wxFont}\label{wxfontctor}
 
 \func{}{wxFont}{\void}
 
 Default constructor.
 
-\func{}{wxFont}{\param{int}{ pointSize}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight},
+\func{}{wxFont}{\param{int}{ pointSize}, \param{wxFontFamily}{ family}, \param{int}{ style}, \param{int}{ weight},
+ \param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},
+ \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
+
+\func{}{wxFont}{\param{const wxSize\&}{ pixelSize}, \param{wxFontFamily}{ family}, \param{int}{ style}, \param{int}{ weight},
  \param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},
  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 
-Creates a font object (see \helpref{font encoding
-overview}{wxfontencodingoverview} for the meaning of the last parameter).
+Creates a font object with the specified attributes.
 
 \wxheading{Parameters}
 
 \docparam{pointSize}{Size in points.}
 
+\docparam{pixelSize}{Size in pixels: this is directly supported only under MSW
+currently where this constructor can be used directly, under other platforms a
+font with the closest size to the given one is found using binary search and
+the static \helpref{New}{wxfontnew} method must be used.}
+
 \docparam{family}{Font family, a generic way of referring to fonts without specifying actual facename. One of:
 
 \twocolwidtha{5cm}
@@ -179,7 +205,8 @@ default application encoding is the same as default system encoding.}
 \twocolitem{{\bf wxFONTENCODING\_KOI8}}{The standard Russian encoding for Internet.}
 \twocolitem{{\bf wxFONTENCODING\_CP1250...1252}}{Windows encodings similar to ISO8859 (but not identical).}
 \end{twocollist}
-If the specified encoding isn't available, no font is created.
+If the specified encoding isn't available, no font is created
+(see also \helpref{font encoding overview}{wxfontencodingoverview}).
 }
 
 \wxheading{Remarks}
@@ -190,7 +217,8 @@ Under Windows, only scalable TrueType fonts are used.
 See also \helpref{wxDC::SetFont}{wxdcsetfont}, \helpref{wxDC::DrawText}{wxdcdrawtext}
 and \helpref{wxDC::GetTextExtent}{wxdcgettextextent}.
 
-\membersection{wxFont::\destruct{wxFont}}
+
+\membersection{wxFont::\destruct{wxFont}}\label{wxfontdtor}
 
 \func{}{\destruct{wxFont}}{\void}
 
@@ -206,6 +234,7 @@ the application should try to clean up all fonts itself. This is because
 wxWidgets cannot know if a pointer to the font object is stored in an
 application data structure, and there is a risk of double deletion.
 
+
 \membersection{wxFont::IsFixedWidth}\label{wxfontisfixedwidth}
 
 \constfunc{bool}{IsFixedWidth}{\void}
@@ -213,6 +242,7 @@ application data structure, and there is a risk of double deletion.
 Returns {\tt true} if the font is a fixed width (or monospaced) font, 
 {\tt false} if it is a proportional one or font is invalid.
 
+
 \membersection{wxFont::GetDefaultEncoding}\label{wxfontgetdefaultencoding}
 
 \func{static wxFontEncoding}{GetDefaultEncoding}{\void}
@@ -224,6 +254,7 @@ Returns the current application's default encoding.
 \helpref{Font encoding overview}{wxfontencodingoverview}, 
 \helpref{SetDefaultEncoding}{wxfontsetdefaultencoding}
 
+
 \membersection{wxFont::GetFaceName}\label{wxfontgetfacename}
 
 \constfunc{wxString}{GetFaceName}{\void}
@@ -235,17 +266,19 @@ typeface information.
 
 \helpref{wxFont::SetFaceName}{wxfontsetfacename}
 
+
 \membersection{wxFont::GetFamily}\label{wxfontgetfamily}
 
 \constfunc{int}{GetFamily}{\void}
 
-Gets the font family. See \helpref{wxFont::wxFont}{wxfontconstr} for a list of valid
+Gets the font family. See \helpref{wxFont::wxFont}{wxfontctor} for a list of valid
 family identifiers.
 
 \wxheading{See also}
 
 \helpref{wxFont::SetFamily}{wxfontsetfamily}
 
+
 \membersection{wxFont::GetNativeFontInfoDesc}\label{wxfontgetnativefontinfodesc}
 
 \constfunc{wxString}{GetNativeFontInfoDesc}{\void}
@@ -257,6 +290,7 @@ empty string if the font wasn't constructed using the native font description.
 
 \helpref{wxFont::SetNativeFontInfo}{wxfontsetnativefontinfo}
 
+
 \membersection{wxFont::GetPointSize}\label{wxfontgetpointsize}
 
 \constfunc{int}{GetPointSize}{\void}
@@ -267,17 +301,19 @@ Gets the point size.
 
 \helpref{wxFont::SetPointSize}{wxfontsetpointsize}
 
+
 \membersection{wxFont::GetStyle}\label{wxfontgetstyle}
 
 \constfunc{int}{GetStyle}{\void}
 
-Gets the font style. See \helpref{wxFont::wxFont}{wxfontconstr} for a list of valid
+Gets the font style. See \helpref{wxFont::wxFont}{wxfontctor} for a list of valid
 styles.
 
 \wxheading{See also}
 
 \helpref{wxFont::SetStyle}{wxfontsetstyle}
 
+
 \membersection{wxFont::GetUnderlined}\label{wxfontgetunderlined}
 
 \constfunc{bool}{GetUnderlined}{\void}
@@ -288,23 +324,51 @@ Returns true if the font is underlined, false otherwise.
 
 \helpref{wxFont::SetUnderlined}{wxfontsetunderlined}
 
+
 \membersection{wxFont::GetWeight}\label{wxfontgetweight}
 
 \constfunc{int}{GetWeight}{\void}
 
-Gets the font weight. See \helpref{wxFont::wxFont}{wxfontconstr} for a list of valid
+Gets the font weight. See \helpref{wxFont::wxFont}{wxfontctor} for a list of valid
 weight identifiers.
 
 \wxheading{See also}
 
 \helpref{wxFont::SetWeight}{wxfontsetweight}
 
+
+\membersection{wxFont::New}\label{wxfontnew}
+
+\func{static wxFont *}{New}{\param{int}{ pointSize}, \param{wxFontFamily}{ family}, \param{int}{ style}, \param{int}{ weight},
+ \param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},
+ \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
+
+\func{static wxFont *}{New}{\param{int}{ pointSize}, \param{wxFontFamily}{ family}, 
+ \param{int}{ flags = \texttt{wxFONTFLAG\_DEFAULT}}, \param{const wxString\& }{faceName = ""},
+ \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
+
+\func{static wxFont *}{New}{\param{const wxSize\&}{ pixelSize}, \param{wxFontFamily}{ family}, \param{int}{ style}, \param{int}{ weight},
+ \param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},
+ \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
+
+\func{static wxFont *}{New}{\param{const wxSize\&}{ pixelSize}, \param{wxFontFamily}{ family}, 
+ \param{int}{ flags = \texttt{wxFONTFLAG\_DEFAULT}}, \param{const wxString\& }{faceName = ""},
+ \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
+
+These functions take the same parameters as \helpref{wxFont
+constructor}{wxfontctor} and return a new font object allocated on the heap.
+
+Using \texttt{New()} is currently the only way to directly create a font with
+the given size in pixels on platforms other than wxMSW.
+
+
 \membersection{wxFont::Ok}\label{wxfontok}
 
 \constfunc{bool}{Ok}{\void}
 
 Returns {\tt true} if this object is a valid font, {\tt false} otherwise.
 
+
 \membersection{wxFont::SetDefaultEncoding}\label{wxfontsetdefaultencoding}
 
 \func{static void}{SetDefaultEncoding}{\param{wxFontEncoding }{encoding}}
@@ -316,6 +380,7 @@ Sets the default font encoding.
 \helpref{Font encoding overview}{wxfontencodingoverview}, 
 \helpref{GetDefaultEncoding}{wxfontgetdefaultencoding}
 
+
 \membersection{wxFont::SetFaceName}\label{wxfontsetfacename}
 
 \func{void}{SetFaceName}{\param{const wxString\& }{faceName}}
@@ -337,6 +402,7 @@ and then for a font belonging to the same family.
 
 \helpref{wxFont::GetFaceName}{wxfontgetfacename}, \helpref{wxFont::SetFamily}{wxfontsetfamily}
 
+
 \membersection{wxFont::SetFamily}\label{wxfontsetfamily}
 
 \func{void}{SetFamily}{\param{int}{ family}}
@@ -361,6 +427,7 @@ Sets the font family.
 
 \helpref{wxFont::GetFamily}{wxfontgetfamily}, \helpref{wxFont::SetFaceName}{wxfontsetfacename}
 
+
 \membersection{wxFont::SetNativeFontInfo}\label{wxfontsetnativefontinfo}
 
 \func{void}{SetNativeFontInfo}{\param{const wxString\& }{info}}
@@ -370,6 +437,7 @@ which must have been previously returned by
 \helpref{GetNativeFontInfoDesc}{wxfontgetnativefontinfodesc}. If the string is
 invalid, font is unchanged.
 
+
 \membersection{wxFont::SetPointSize}\label{wxfontsetpointsize}
 
 \func{void}{SetPointSize}{\param{int}{ pointSize}}
@@ -384,6 +452,7 @@ Sets the point size.
 
 \helpref{wxFont::GetPointSize}{wxfontgetpointsize}
 
+
 \membersection{wxFont::SetStyle}\label{wxfontsetstyle}
 
 \func{void}{SetStyle}{\param{int}{ style}}
@@ -398,6 +467,7 @@ Sets the font style.
 
 \helpref{wxFont::GetStyle}{wxfontgetstyle}
 
+
 \membersection{wxFont::SetUnderlined}\label{wxfontsetunderlined}
 
 \func{void}{SetUnderlined}{\param{const bool}{ underlined}}
@@ -412,6 +482,7 @@ Sets underlining.
 
 \helpref{wxFont::GetUnderlined}{wxfontgetunderlined}
 
+
 \membersection{wxFont::SetWeight}\label{wxfontsetweight}
 
 \func{void}{SetWeight}{\param{int}{ weight}}
@@ -426,6 +497,7 @@ Sets the font weight.
 
 \helpref{wxFont::GetWeight}{wxfontgetweight}
 
+
 \membersection{wxFont::operator $=$}\label{wxfontassignment}
 
 \func{wxFont\&}{operator $=$}{\param{const wxFont\& }{font}}
@@ -433,15 +505,17 @@ Sets the font weight.
 Assignment operator, using reference counting. Returns a reference
 to `this'.
 
+
 \membersection{wxFont::operator $==$}\label{wxfontequals}
 
 \func{bool}{operator $==$}{\param{const wxFont\& }{font}}
 
 Equality operator. Two fonts are equal if they contain pointers
 to the same underlying font data. It does not compare each attribute,
-so two indefontdently-created fonts using the same parameters will
+so two independently-created fonts using the same parameters will
 fail the test.
 
+
 \membersection{wxFont::operator $!=$}\label{wxfontnotequals}
 
 \func{bool}{operator $!=$}{\param{const wxFont\& }{font}}