more Doxygen warnings corrections and fixes from Tim S
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55386 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
@@ -49,7 +49,7 @@ public:
|
|||||||
Preferred minimum width.
|
Preferred minimum width.
|
||||||
@param prefHeight
|
@param prefHeight
|
||||||
Preferred height. May be -1 to indicate no preference.
|
Preferred height. May be -1 to indicate no preference.
|
||||||
@param maxWidth
|
@param maxHeight
|
||||||
Max height for window, as limited by screen size.
|
Max height for window, as limited by screen size.
|
||||||
|
|
||||||
@remarks This function is called each time popup is about to be shown.
|
@remarks This function is called each time popup is about to be shown.
|
||||||
@@ -584,7 +584,7 @@ public:
|
|||||||
@param text
|
@param text
|
||||||
The text to insert.
|
The text to insert.
|
||||||
*/
|
*/
|
||||||
virtual void Replace(long from, long to, const wxString& value);
|
virtual void Replace(long from, long to, const wxString& text);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Sets custom dropdown button graphics.
|
Sets custom dropdown button graphics.
|
||||||
|
|||||||
@@ -37,138 +37,45 @@ class wxFont : public wxGDIObject
|
|||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
//@{
|
//@{
|
||||||
|
/**
|
||||||
|
Creates a font object.
|
||||||
|
*/
|
||||||
|
wxFont();
|
||||||
|
|
||||||
|
/**
|
||||||
|
Creates a font object with the specified font.
|
||||||
|
|
||||||
|
@param font
|
||||||
|
font object.
|
||||||
|
*/
|
||||||
|
wxFont(const wxFont& font);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Creates a font object with the specified attributes.
|
Creates a font object with the specified attributes.
|
||||||
|
|
||||||
@param pointSize
|
@param pointSize
|
||||||
Size in points.
|
Size in points.
|
||||||
@param 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 New method must be used.
|
|
||||||
@param family
|
@param family
|
||||||
Font family, a generic way of referring to fonts without specifying actual
|
Font family, a generic way of referring to fonts without specifying actual
|
||||||
facename. One of:
|
facename. One of:
|
||||||
|
<TABLE>
|
||||||
|
<TR><TD>wxFONTFAMILY_DEFAULT</TD><TD>Chooses a default font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_DECORATIVE</TD><TD>A decorative font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_ROMAN</TD><TD>A formal, serif font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_SCRIPT</TD><TD>A handwriting font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_SWISS</TD><TD>A sans-serif font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_MODERN</TD><TD>A fixed pitch font.</TD></TR>
|
||||||
wxFONTFAMILY_DEFAULT
|
<TR><TD>wxFONTFAMILY_TELETYPE</TD><TD>A teletype font.</TD></TR>
|
||||||
|
</TABLE>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Chooses a default font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_DECORATIVE
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A decorative font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_ROMAN
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A formal, serif font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_SCRIPT
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A handwriting font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_SWISS
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A sans-serif font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_MODERN
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A fixed pitch font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_TELETYPE
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A teletype font.
|
|
||||||
@param style
|
@param style
|
||||||
One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
|
One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
|
||||||
@param weight
|
@param weight
|
||||||
Font weight, sometimes also referred to as font boldness. One of:
|
Font weight, sometimes also referred to as font boldness. One of:
|
||||||
|
<TABLE>
|
||||||
|
<TR><TD>wxFONTWEIGHT_NORMAL</TD><TD>Normal font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTWEIGHT_LIGHT</TD><TD>Light font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTWEIGHT_BOLD</TD><TD>Bold font.</TD></TR>
|
||||||
|
</TABLE>
|
||||||
|
|
||||||
|
|
||||||
wxFONTWEIGHT_NORMAL
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Normal font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTWEIGHT_LIGHT
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Light font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTWEIGHT_BOLD
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Bold font.
|
|
||||||
@param underline
|
@param underline
|
||||||
The value can be @true or @false. At present this has an effect on Windows
|
The value can be @true or @false. At present this has an effect on Windows
|
||||||
and Motif 2.x only.
|
and Motif 2.x only.
|
||||||
@@ -178,71 +85,18 @@ public:
|
|||||||
a default typeface will be chosen based on the family.
|
a default typeface will be chosen based on the family.
|
||||||
@param encoding
|
@param encoding
|
||||||
An encoding which may be one of
|
An encoding which may be one of
|
||||||
|
<TABLE>
|
||||||
|
<TR><TD>wxFONTENCODING_SYSTEM</TD><TD>Default system encoding.</TD></TR>
|
||||||
|
<TR><TD>wxFONTENCODING_DEFAULT</TD><TD>
|
||||||
|
Default application encoding: this
|
||||||
|
is the encoding set by calls to
|
||||||
|
SetDefaultEncoding and which may be set to,
|
||||||
|
say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
|
||||||
wxFONTENCODING_SYSTEM
|
default application encoding is the same as default system encoding.</TD></TR>
|
||||||
|
<TR><TD>wxFONTENCODING_ISO8859_1...15</TD><TD>ISO8859 encodings.</TD></TR>
|
||||||
|
<TR><TD>wxFONTENCODING_KOI8</TD><TD>The standard Russian encoding for Internet.</TD></TR>
|
||||||
|
<TR><TD>wxFONTENCODING_CP1250...1252</TD><TD>Windows encodings similar to ISO8859 (but not identical).</TD></TR>
|
||||||
|
</TABLE>
|
||||||
Default system encoding.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTENCODING_DEFAULT
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Default application encoding: this
|
|
||||||
is the encoding set by calls to
|
|
||||||
SetDefaultEncoding and which may be set to,
|
|
||||||
say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
|
|
||||||
default application encoding is the same as default system encoding.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTENCODING_ISO8859_1...15
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
ISO8859 encodings.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTENCODING_KOI8
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
The standard Russian encoding for Internet.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTENCODING_CP1250...1252
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Windows encodings similar to ISO8859 (but not identical).
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
If the specified encoding isn't available, no font is created
|
If the specified encoding isn't available, no font is created
|
||||||
(see also font encoding overview).
|
(see also font encoding overview).
|
||||||
@@ -251,13 +105,70 @@ public:
|
|||||||
chosen. Under Windows, only scalable TrueType fonts are
|
chosen. Under Windows, only scalable TrueType fonts are
|
||||||
used.
|
used.
|
||||||
*/
|
*/
|
||||||
wxFont();
|
|
||||||
wxFont(const wxFont& font);
|
|
||||||
wxFont(int pointSize, wxFontFamily family, int style,
|
wxFont(int pointSize, wxFontFamily family, int style,
|
||||||
wxFontWeight weight,
|
wxFontWeight weight,
|
||||||
const bool underline = false,
|
const bool underline = false,
|
||||||
const wxString& faceName = "",
|
const wxString& faceName = "",
|
||||||
wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
|
wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
|
||||||
|
/**
|
||||||
|
Creates a font object with the specified attributes.
|
||||||
|
|
||||||
|
@param 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 New method must be used.
|
||||||
|
@param family
|
||||||
|
Font family, a generic way of referring to fonts without specifying actual
|
||||||
|
facename. One of:
|
||||||
|
<TABLE>
|
||||||
|
<TR><TD>wxFONTFAMILY_DEFAULT</TD><TD>Chooses a default font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_DECORATIVE</TD><TD>A decorative font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_ROMAN</TD><TD>A formal, serif font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_SCRIPT</TD><TD>A handwriting font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_SWISS</TD><TD>A sans-serif font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_MODERN</TD><TD>A fixed pitch font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_TELETYPE</TD><TD>A teletype font.</TD></TR>
|
||||||
|
</TABLE>
|
||||||
|
@param style
|
||||||
|
One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
|
||||||
|
@param weight
|
||||||
|
Font weight, sometimes also referred to as font boldness. One of:
|
||||||
|
<TABLE>
|
||||||
|
<TR><TD>wxFONTWEIGHT_NORMAL</TD><TD>Normal font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTWEIGHT_LIGHT</TD><TD>Light font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTWEIGHT_BOLD</TD><TD>Bold font.</TD></TR>
|
||||||
|
</TABLE>
|
||||||
|
@param underline
|
||||||
|
The value can be @true or @false. At present this has an effect on Windows
|
||||||
|
and Motif 2.x only.
|
||||||
|
@param faceName
|
||||||
|
An optional string specifying the actual typeface to be used. If it is an
|
||||||
|
empty string,
|
||||||
|
a default typeface will be chosen based on the family.
|
||||||
|
@param encoding
|
||||||
|
An encoding which may be one of
|
||||||
|
<TABLE>
|
||||||
|
<TR><TD>wxFONTENCODING_SYSTEM</TD><TD>Default system encoding.</TD></TR>
|
||||||
|
<TR><TD>wxFONTENCODING_DEFAULT</TD><TD>
|
||||||
|
Default application encoding: this
|
||||||
|
is the encoding set by calls to
|
||||||
|
SetDefaultEncoding and which may be set to,
|
||||||
|
say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
|
||||||
|
default application encoding is the same as default system encoding.</TD></TR>
|
||||||
|
<TR><TD>wxFONTENCODING_ISO8859_1...15</TD><TD>ISO8859 encodings.</TD></TR>
|
||||||
|
<TR><TD>wxFONTENCODING_KOI8</TD><TD>The standard Russian encoding for Internet.</TD></TR>
|
||||||
|
<TR><TD>wxFONTENCODING_CP1250...1252</TD><TD>Windows encodings similar to ISO8859 (but not identical).</TD></TR>
|
||||||
|
</TABLE>
|
||||||
|
|
||||||
|
If the specified encoding isn't available, no font is created
|
||||||
|
(see also font encoding overview).
|
||||||
|
|
||||||
|
@remarks If the desired font does not exist, the closest match will be
|
||||||
|
chosen. Under Windows, only scalable TrueType fonts are
|
||||||
|
used.
|
||||||
|
*/
|
||||||
wxFont(const wxSize& pixelSize, wxFontFamily family,
|
wxFont(const wxSize& pixelSize, wxFontFamily family,
|
||||||
int style, wxFontWeight weight,
|
int style, wxFontWeight weight,
|
||||||
const bool underline = false,
|
const bool underline = false,
|
||||||
@@ -424,85 +335,14 @@ public:
|
|||||||
|
|
||||||
@param family
|
@param family
|
||||||
One of:
|
One of:
|
||||||
|
<TABLE>
|
||||||
|
<TR><TD>wxFONTFAMILY_DEFAULT</TD><TD>Chooses a default font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_DECORATIVE</TD><TD>A decorative font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_ROMAN</TD><TD>A formal, serif font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_SCRIPT</TD><TD>A handwriting font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_SWISS</TD><TD>A sans-serif font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTFAMILY_MODERN</TD><TD>A fixed pitch font.</TD></TR>
|
||||||
wxFONTFAMILY_DEFAULT
|
<TR><TD>wxFONTFAMILY_TELETYPE</TD><TD>A teletype font.</TD></TR>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Chooses a default font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_DECORATIVE
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A decorative font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_ROMAN
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A formal, serif font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_SCRIPT
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A handwriting font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_SWISS
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A sans-serif font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_MODERN
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A fixed pitch font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTFAMILY_TELETYPE
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
A teletype font.
|
|
||||||
|
|
||||||
@see GetFamily(), SetFaceName()
|
@see GetFamily(), SetFaceName()
|
||||||
*/
|
*/
|
||||||
@@ -576,7 +416,7 @@ public:
|
|||||||
/**
|
/**
|
||||||
Sets underlining.
|
Sets underlining.
|
||||||
|
|
||||||
@param underlining
|
@param underlined
|
||||||
@true to underline, @false otherwise.
|
@true to underline, @false otherwise.
|
||||||
|
|
||||||
@see GetUnderlined()
|
@see GetUnderlined()
|
||||||
@@ -588,41 +428,11 @@ public:
|
|||||||
|
|
||||||
@param weight
|
@param weight
|
||||||
One of:
|
One of:
|
||||||
|
<TABLE>
|
||||||
|
<TR><TD>wxFONTWEIGHT_NORMAL</TD><TD>Normal font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTWEIGHT_LIGHT</TD><TD>Light font.</TD></TR>
|
||||||
|
<TR><TD>wxFONTWEIGHT_BOLD</TD><TD>Bold font.</TD></TR>
|
||||||
|
</TABLE>
|
||||||
|
|
||||||
|
|
||||||
wxFONTWEIGHT_NORMAL
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Normal font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTWEIGHT_LIGHT
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Light font.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
wxFONTWEIGHT_BOLD
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Bold font.
|
|
||||||
|
|
||||||
@see GetWeight()
|
@see GetWeight()
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -52,22 +52,6 @@ public:
|
|||||||
virtual void SetViewer(const wxString& viewer = wxEmptyString,
|
virtual void SetViewer(const wxString& viewer = wxEmptyString,
|
||||||
long flags = wxHELP_NETSCAPE);
|
long flags = wxHELP_NETSCAPE);
|
||||||
|
|
||||||
/**
|
|
||||||
This must be called to tell the controller where to find the
|
|
||||||
documentation.
|
|
||||||
If a locale is set, look in file/localename, i.e.
|
|
||||||
If passed "/usr/local/myapp/help" and the current wxLocale is
|
|
||||||
set to be "de", then look in "/usr/local/myapp/help/de/"
|
|
||||||
first and fall back to "/usr/local/myapp/help" if that
|
|
||||||
doesn't exist.
|
|
||||||
|
|
||||||
@param file
|
|
||||||
NOT a filename, but a directory name.
|
|
||||||
|
|
||||||
@return @true on success
|
|
||||||
*/
|
|
||||||
virtual bool Initialize(const wxString& dir, int server);
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
This must be called to tell the controller where to find the
|
This must be called to tell the controller where to find the
|
||||||
documentation.
|
documentation.
|
||||||
@@ -128,6 +112,10 @@ public:
|
|||||||
|
|
||||||
@param k
|
@param k
|
||||||
string to search for, empty string will list all entries
|
string to search for, empty string will list all entries
|
||||||
|
|
||||||
|
@param mode
|
||||||
|
optional parameter allows the search the index (wxHELP_SEARCH_INDEX)
|
||||||
|
but this currently only supported by the wxHtmlHelpController.
|
||||||
|
|
||||||
@return @true on success
|
@return @true on success
|
||||||
*/
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user