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

Another doc patch from Tim

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55343 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling
2008-08-29 12:15:59 +00:00
parent e85eaef3fa
commit 3f5506cfd3
5 changed files with 75 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
interface/wx/html/htmltag.h
View File

@@ -101,7 +101,7 @@ public:
/** /**
Returns @true if the tag has a parameter of the given name. Returns @true if the tag has a parameter of the given name.
Example : @c FONT SIZE=+2 COLOR="#FF00FF" has two parameters named Example : @c FONT SIZE=+2 COLOR="\#FF00FF" has two parameters named
"SIZE" and "COLOR". "SIZE" and "COLOR".
@param par @param par

134
interface/wx/stattext.h
View File

@@ -117,77 +117,81 @@ public:
support it (currently only GTK+ 2). For the other platforms, the markup is support it (currently only GTK+ 2). For the other platforms, the markup is
ignored. ignored.
The supported tags are: The supported tags are:
<TABLE>
b <TR>
<TD>&lt;b&gt;</TD>
bold text <TD>bold text</TD>
</TR>
big <TR>
<TD>&lt;big&gt;</TD>
bigger text <TD>bigger text</TD>
</TR>
i <TR>
<TD>&lt;i&gt;</TD>
italic text <TD>italic text</TD>
</TR>
s <TR>
<TD>&lt;s&gt;</TD>
strike-through text <TD>strike-through text</TD>
</TR>
sub <TR>
<TD>&lt;sub&gt;</TD>
subscript text <TD>subscript text</TD>
</TR>
sup <TR>
<TD>&lt;sup&gt;</TD>
superscript text <TD>superscript text</TD>
</TR>
small <TR>
<TD>&lt;small&gt;</TD>
smaller text <TD>smaller text</TD>
</TR>
tt <TR>
<TD>&lt;tt&gt;</TD>
monospaced text <TD>monospaced text</TD>
</TR>
u <TR>
<TD>&lt;u&gt;</TD>
underlined text <TD>underlined text</TD>
</TR>
span <TR>
<TD>&lt;span&gt;</TD>
generic formatter tag; see Pango Markup for more information. <TD>generic formatter tag; see Pango Markup for more information.</TD>
</TR>
</TABLE>
Note that the string must be well-formed (e.g. all tags must be correctly Note that the string must be well-formed (e.g. all tags must be correctly
closed) closed)
otherwise it can be not shown correctly or at all. otherwise it can be not shown correctly or at all.
Also note that you need to escape the following special characters: Also note that you need to escape the following special characters:
<TABLE>
<TR>
<TD>@b Special character</TD>
<TD>@b Escape as</TD>
</TR>
<TR>
<TD>@c &amp;</TD>
<TD>@c &amp;amp; or as &amp;&amp;</TD>
</TR>
<TR>
<TD>@c &apos;</TD>
<TD>@c &amp;apos;</TD>
</TR>
<TR>
<TD>@c &quot;</TD>
<TD>@c &amp;quot;</TD>
</TR>
<TR>
<TD>@c &lt;</TD>
<TD>@c &amp;lt;</TD>
</TR>
<TR>
<TD>@c &gt;</TD>
<TD>@c &amp;gt;</TD>
</TR>
</TABLE>
@b Special character The non-escaped ampersand @c &amp; characters are interpreted as
@b Escape as
@c
@c amp; or as @c
@c '
@c apos;
@c "
@c quot;
@c
@c lt;
@c
@c gt;
The non-escaped ampersand @c characters are interpreted as
mnemonics; see wxControl::SetLabel. mnemonics; see wxControl::SetLabel.
Example: Example:

4
interface/wx/stc/stc.h
View File

@@ -2544,8 +2544,8 @@ public:
more of the following comma separated elements: more of the following comma separated elements:
bold turns on bold bold turns on bold
italic turns on italics italic turns on italics
fore:[name or #RRGGBB] sets the foreground colour fore:[name or \#RRGGBB] sets the foreground colour
back:[name or #RRGGBB] sets the background colour back:[name or \#RRGGBB] sets the background colour
face:[facename] sets the font face name to use face:[facename] sets the font face name to use
size:[num] sets the font size in points size:[num] sets the font size in points
eol turns on eol filling eol turns on eol filling

2
interface/wx/stdpaths.h
View File

@@ -180,7 +180,7 @@ public:
/** /**
Return the directory for the user-dependent application data files: Return the directory for the user-dependent application data files:
- Unix: @c ~/.appname - Unix: @c ~/.appname
- Windows: @c C:\\Documents @c and @c Settings\\username\Application @c Data\\appname - Windows: @c C:\\Documents @c and @c Settings\\username\\Application @c Data\\appname
- Mac: @c ~/Library/Application @c Support/appname - Mac: @c ~/Library/Application @c Support/appname
*/ */
wxString GetUserDataDir() const; wxString GetUserDataDir() const;

2
interface/wx/xrc/xmlres.h
View File

@@ -324,7 +324,7 @@ public:
bool GetBool(const wxString& param, bool defaultv = false); bool GetBool(const wxString& param, bool defaultv = false);
/** /**
Gets colour in HTML syntax (#RRGGBB). Gets colour in HTML syntax (\#RRGGBB).
*/ */
wxColour GetColour(const wxString& param, wxColour GetColour(const wxString& param,
const wxColour& default = wxNullColour); const wxColour& default = wxNullColour);