From 322a55e63d6659d6583377abaf778e2fdb05ca64 Mon Sep 17 00:00:00 2001 From: Bryan Petty Date: Fri, 6 Feb 2015 01:51:27 +0000 Subject: [PATCH] Fix LaTeX docs for PDF manual. 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 --- interface/wx/combo.h | 21 ++++++++++-------- interface/wx/font.h | 52 ++++++++++++++------------------------------ 2 files changed, 28 insertions(+), 45 deletions(-) diff --git a/interface/wx/combo.h b/interface/wx/combo.h index c26410186b..443d9de1c4 100644 --- a/interface/wx/combo.h +++ b/interface/wx/combo.h @@ -918,6 +918,16 @@ protected: */ 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. Instead, it must be called in a derived class to make sure popup is @@ -927,15 +937,8 @@ protected: @param rect Position to show the popup window at, in screen coordinates. @param flags - Combination of any of the following: - @beginTable - @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 + Combination of any of the following: wxComboCtrl::ShowAbove, + and wxComboCtrl::CanDeferShow. */ virtual void DoShowPopup(const wxRect& rect, int flags); }; diff --git a/interface/wx/font.h b/interface/wx/font.h index 4bd8687d42..1bc18f6b9a 100644 --- a/interface/wx/font.h +++ b/interface/wx/font.h @@ -138,10 +138,14 @@ enum wxFontFlag enum wxFontEncoding { /// 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 wxFONTENCODING_ISO8859_1, //!< West European (Latin1) @@ -472,13 +476,13 @@ public: 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 - readable than the use of constructor from wxFontInfo, e.g. the example - in that constructor documentation would need to be written as + readable than using wxFont(const wxFontInfo& font), e.g. the example + in that constructor documentation would need to be written as: + @code wxFont font(10, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_BOLD, true); @endcode - which is longer and less clear. @param pointSize Size in points. See SetPointSize() for more info. @@ -498,21 +502,9 @@ public: 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. @param encoding - An encoding which may be one of the enumeration values of ::wxFontEncoding. - Briefly these can be summed up as: - - - - - - -
@c wxFONTENCODING_SYSTEMDefault system encoding.
@c 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.
@c wxFONTENCODING_ISO8859_1...15ISO8859 encodings.
@c wxFONTENCODING_KOI8The standard Russian encoding for Internet.
@c wxFONTENCODING_CP1250...1252Windows encodings similar to ISO8859 (but not identical).
- If the specified encoding isn't available, no font is created - (see also @ref overview_fontencoding). + An encoding which may be one of the enumeration values of + ::wxFontEncoding. 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 chosen. Under Windows, only scalable TrueType fonts are used. @@ -548,21 +540,9 @@ public: 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. @param encoding - An encoding which may be one of the enumeration values of ::wxFontEncoding. - Briefly these can be summed up as: - - - - - - -
@c wxFONTENCODING_SYSTEMDefault system encoding.
@c 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.
@c wxFONTENCODING_ISO8859_1...15ISO8859 encodings.
@c wxFONTENCODING_KOI8The standard Russian encoding for Internet.
@c wxFONTENCODING_CP1250...1252Windows encodings similar to ISO8859 (but not identical).
- If the specified encoding isn't available, no font is created - (see also @ref overview_fontencoding). + An encoding which may be one of the enumeration values of + ::wxFontEncoding. 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 chosen. Under Windows, only scalable TrueType fonts are used.