Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix LaTeX docs for PDF manual.

Browse Source 
LaTeX fails to handle tables nested in @param sections, and we've
only used them to expand on enums that should be documented on
their own anyway, so the docs have been extracted here.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@78452 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2015-02-06 01:51:27 +00:00
parent 87f91dcbec
commit 322a55e63d
2 changed files with 28 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
interface/wx/combo.h
View File

@@ -918,6 +918,16 @@ protected:
*/ */
virtual void DoSetPopupControl(wxComboPopup* popup); virtual void DoSetPopupControl(wxComboPopup* popup);
/**
Flags for DoShowPopup() and AnimateShow().
*/
enum
{
ShowBelow = 0x0000, //!< Show popup below the control.
ShowAbove = 0x0001, //!< Show popup above the control.
CanDeferShow = 0x0002 //!< Can only return true from AnimateShow() if this is set.
};
/** /**
This member function is not normally called in application code. This member function is not normally called in application code.
Instead, it must be called in a derived class to make sure popup is Instead, it must be called in a derived class to make sure popup is
@@ -927,15 +937,8 @@ protected:
@param rect @param rect
Position to show the popup window at, in screen coordinates. Position to show the popup window at, in screen coordinates.
@param flags @param flags
Combination of any of the following: Combination of any of the following: wxComboCtrl::ShowAbove,
@beginTable and wxComboCtrl::CanDeferShow.
@row2col{wxComboCtrl::ShowAbove,
Popup is shown above the control instead of below.}
@row2col{wxComboCtrl::CanDeferShow,
Showing the popup can be deferred to happen sometime after
ShowPopup() has finished. In this case, AnimateShow() must
return false.}
@endTable
*/ */
virtual void DoShowPopup(const wxRect& rect, int flags); virtual void DoShowPopup(const wxRect& rect, int flags);
}; };

52
interface/wx/font.h
View File

@@ -138,10 +138,14 @@ enum wxFontFlag
enum wxFontEncoding enum wxFontEncoding
{ {
/// Default system encoding. /// Default system encoding.
wxFONTENCODING_SYSTEM = -1, // system default wxFONTENCODING_SYSTEM = -1, //!< Default system encoding.
/// Default application encoding. /**
wxFONTENCODING_DEFAULT, // current default encoding Default application encoding: this is the encoding set by calls to
wxFont::SetDefaultEncoding(). Initially, the default application
encoding is the same as default system encoding.
*/
wxFONTENCODING_DEFAULT,
// ISO8859 standard defines a number of single-byte charsets // ISO8859 standard defines a number of single-byte charsets
wxFONTENCODING_ISO8859_1, //!< West European (Latin1) wxFONTENCODING_ISO8859_1, //!< West European (Latin1)
@@ -472,13 +476,13 @@ public:
Creates a font object with the specified attributes and size in points. Creates a font object with the specified attributes and size in points.
Notice that the use of this constructor is often more verbose and less Notice that the use of this constructor is often more verbose and less
readable than the use of constructor from wxFontInfo, e.g. the example readable than using wxFont(const wxFontInfo& font), e.g. the example
in that constructor documentation would need to be written as in that constructor documentation would need to be written as:
@code @code
wxFont font(10, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFont font(10, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL,
wxFONTWEIGHT_BOLD, true); wxFONTWEIGHT_BOLD, true);
@endcode @endcode
which is longer and less clear.
@param pointSize @param pointSize
Size in points. See SetPointSize() for more info. Size in points. See SetPointSize() for more info.
@@ -498,21 +502,9 @@ public:
An optional string specifying the face name to be used. An optional string specifying the face name to be used.
If it is an empty string, a default face name will be chosen based on the family. If it is an empty string, a default face name will be chosen based on the family.
@param encoding @param encoding
An encoding which may be one of the enumeration values of ::wxFontEncoding. An encoding which may be one of the enumeration values of
Briefly these can be summed up as: ::wxFontEncoding. If the specified encoding isn't available, no font
<TABLE> is created (see also @ref overview_fontencoding).
<TR><TD>@c wxFONTENCODING_SYSTEM</TD><TD>Default system encoding.</TD></TR>
<TR><TD>@c 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>@c wxFONTENCODING_ISO8859_1...15</TD><TD>ISO8859 encodings.</TD></TR>
<TR><TD>@c wxFONTENCODING_KOI8</TD><TD>The standard Russian encoding for Internet.</TD></TR>
<TR><TD>@c 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 @ref overview_fontencoding).
@remarks If the desired font does not exist, the closest match will be @remarks If the desired font does not exist, the closest match will be
chosen. Under Windows, only scalable TrueType fonts are used. chosen. Under Windows, only scalable TrueType fonts are used.
@@ -548,21 +540,9 @@ public:
An optional string specifying the face name to be used. An optional string specifying the face name to be used.
If it is an empty string, a default face name will be chosen based on the family. If it is an empty string, a default face name will be chosen based on the family.
@param encoding @param encoding
An encoding which may be one of the enumeration values of ::wxFontEncoding. An encoding which may be one of the enumeration values of
Briefly these can be summed up as: ::wxFontEncoding. If the specified encoding isn't available, no font
<TABLE> is created (see also @ref overview_fontencoding).
<TR><TD>@c wxFONTENCODING_SYSTEM</TD><TD>Default system encoding.</TD></TR>
<TR><TD>@c 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>@c wxFONTENCODING_ISO8859_1...15</TD><TD>ISO8859 encodings.</TD></TR>
<TR><TD>@c wxFONTENCODING_KOI8</TD><TD>The standard Russian encoding for Internet.</TD></TR>
<TR><TD>@c 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 @ref overview_fontencoding).
@remarks If the desired font does not exist, the closest match will be @remarks If the desired font does not exist, the closest match will be
chosen. Under Windows, only scalable TrueType fonts are used. chosen. Under Windows, only scalable TrueType fonts are used.