X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d2d0adc7765dfe904f0f7e97d85a2638c934a7d6..d2b23b67301bd2d286366d4326a21da3132558fa:/docs/latex/wx/textattrex.tex?ds=sidebyside diff --git a/docs/latex/wx/textattrex.tex b/docs/latex/wx/textattrex.tex index 1a8d6b153c..f190f3b59b 100644 --- a/docs/latex/wx/textattrex.tex +++ b/docs/latex/wx/textattrex.tex @@ -81,10 +81,13 @@ for a text control. #define wxTEXT_ATTR_BULLET_TEXT 0x00080000 #define wxTEXT_ATTR_BULLET_NAME 0x00100000 #define wxTEXT_ATTR_URL 0x00200000 +#define wxTEXT_ATTR_PAGE_BREAK 0x00400000 +#define wxTEXT_ATTR_EFFECTS 0x00800000 +#define wxTEXT_ATTR_OUTLINE_LEVEL 0x01000000 \end{verbatim} } -The following styles can be passed to wxRichTextAttr::SetBulletStyle: +The following styles can be passed to wxTextAttrEx::SetBulletStyle: {\small \begin{verbatim} @@ -107,7 +110,9 @@ The following styles can be passed to wxRichTextAttr::SetBulletStyle: \end{verbatim} } -The following constants can be passed to wxRichTextAttr::SetLineSpacing: +Of these, wxTEXT\_ATTR\_BULLET\_STYLE\_BITMAP is unimplemented. + +The following constants can be passed to wxTextAttrEx::SetLineSpacing: {\small \begin{verbatim} @@ -117,6 +122,26 @@ The following constants can be passed to wxRichTextAttr::SetLineSpacing: \end{verbatim} } +The following styles can be passed to wxTextAttrEx::SetTextEffects: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_EFFECT_NONE 0x00000000 +#define wxTEXT_ATTR_EFFECT_CAPITALS 0x00000001 +#define wxTEXT_ATTR_EFFECT_SMALL_CAPITALS 0x00000002 +#define wxTEXT_ATTR_EFFECT_STRIKETHROUGH 0x00000004 +#define wxTEXT_ATTR_EFFECT_DOUBLE_STRIKETHROUGH 0x00000008 +#define wxTEXT_ATTR_EFFECT_SHADOW 0x00000010 +#define wxTEXT_ATTR_EFFECT_EMBOSS 0x00000020 +#define wxTEXT_ATTR_EFFECT_OUTLINE 0x00000040 +#define wxTEXT_ATTR_EFFECT_ENGRAVE 0x00000080 +#define wxTEXT_ATTR_EFFECT_SUPERSCRIPT 0x00000100 +#define wxTEXT_ATTR_EFFECT_SUBSCRIPT 0x00000200 +\end{verbatim} +} + +Of these, only wxTEXT\_ATTR\_EFFECT\_CAPITALS and wxTEXT\_ATTR\_EFFECT\_STRIKETHROUGH are implemented. + \wxheading{See also} \helpref{wxTextAttr}{wxtextattr}, \helpref{wxRichTextAttr}{wxrichtextattr}, \helpref{wxRichTextCtrl}{wxrichtextctrl} @@ -171,7 +196,7 @@ Returns the bullet number. Returns the bullet style. See \helpref{wxTextAttrEx::SetBulletStyle}{wxtextattrexsetbulletstyle} for a list of available styles. -\membersection{wxTextAttrEx::GetBulletText}\label{wxrichtextattrgetbullettext} +\membersection{wxTextAttrEx::GetBulletText}\label{wxtextattrexgetbullettext} \constfunc{const wxString\&}{GetBulletText}{\void} @@ -196,6 +221,12 @@ wxTEXT\_ATTR\_LINE\_SPACING\_HALF, and wxTEXT\_ATTR\_LINE\_SPACING\_TWICE. Returns the name of the list style. +\membersection{wxTextAttrEx::GetOutlineLevel}\label{wxtextattrexgetoutlinelevel} + +\constfunc{bool}{GetOutlineLevel}{\void} + +Returns the outline level. + \membersection{wxTextAttrEx::GetParagraphSpacingAfter}\label{wxtextattrexgetparagraphspacingafter} \constfunc{int}{GetParagraphSpacingAfter}{\void} @@ -214,6 +245,19 @@ Returns the space in tenths of a millimeter before the paragraph. Returns the name of the paragraph style. +\membersection{wxTextAttrEx::GetTextEffectFlags}\label{wxtextattrexgettexteffectflags} + +\constfunc{int}{GetTextEffectFlags}{\void} + +Returns the text effect bits of interest. See \helpref{wxTextAttr::SetFlags}{wxtextattrsetflags} for further information. + +\membersection{wxTextAttrEx::GetTextEffects}\label{wxtextattrexgettexteffects} + +\constfunc{int}{GetTextEffects}{\void} + +Returns the text effects, a bit list of styles. See \helpref{wxTextAttrEx::SetTextEffects}{wxtextattrexsettexteffects} for +details. + \membersection{wxTextAttrEx::GetURL}\label{wxtextattrexgeturl} \constfunc{const wxString\&}{GetURL}{\void} @@ -264,6 +308,18 @@ Returns \true if the attribute object specifies line spacing. Returns \true if the attribute object specifies a list style name. +\membersection{wxTextAttrEx::HasOutlineLevel}\label{wxtextattrexhasoutlinelevel} + +\constfunc{bool}{HasOutlineLevel}{\void} + +Returns \true if the attribute object specifies an outline level. + +\membersection{wxTextAttrEx::HasPageBreak}\label{wxtextattrexhaspagebreak} + +\constfunc{bool}{HasPageBreak}{\void} + +Returns \true if the attribute object specifies a page break before this paragraph. + \membersection{wxTextAttrEx::HasParagraphSpacingAfter}\label{wxtextattrexhasparagraphspacingafter} \constfunc{bool}{HasParagraphSpacingAfter}{\void} @@ -282,6 +338,18 @@ Returns \true if the attribute object specifies spacing before a paragraph. Returns \true if the attribute object specifies a paragraph style name. +\membersection{wxTextAttrEx::HasTextEffects}\label{wxtextattrexhastexteffects} + +\constfunc{bool}{HasTextEffects}{\void} + +Returns \true if the attribute object specifies text effects. + +\membersection{wxTextAttrEx::HasURL}\label{wxtextattrexhasurl} + +\constfunc{bool}{HasURL}{\void} + +Returns \true if the attribute object specifies a URL. + \membersection{wxTextAttrEx::Init}\label{wxtextattrexinit} \func{void}{Init}{\void} @@ -357,6 +425,8 @@ Sets the bullet style. The following styles can be passed: \end{verbatim} } +Currently wxTEXT\_ATTR\_BULLET\_STYLE\_BITMAP is not supported. + \membersection{wxTextAttrEx::SetBulletText}\label{wxtextattrexsetbullettext} \func{void}{SetBulletText}{\param{const wxString\& }{text}} @@ -391,6 +461,20 @@ defined for convenience: Sets the list style name. +\membersection{wxTextAttrEx::SetOutlineLevel}\label{wxtextattrexsetoutlinelevel} + +\func{void}{SetOutlineLevel}{\param{int}{ level}} + +Specifies the outline level. Zero represents normal text. At present, the outline level is +not used, but may be used in future for determining list levels and for applications +that need to store document structure information. + +\membersection{wxTextAttrEx::SetPageBreak}\label{wxtextattrexsetpagebreak} + +\func{void}{SetPageBreak}{\param{bool}{ pageBreak = true}} + +Specifies a page break before this paragraph. + \membersection{wxTextAttrEx::SetParagraphSpacingAfter}\label{wxtextattrexsetparagraphspacingafter} \func{void}{SetParagraphSpacingAfter}{\param{int }{spacing}} @@ -409,6 +493,44 @@ Sets the spacing before a paragraph, in tenths of a millimetre. Sets the name of the paragraph style. +\membersection{wxTextAttrEx::SetTextEffectFlags}\label{wxtextattrexsettexteffectflags} + +\func{void}{SetTextEffectFlags}{\param{int }{flags}} + +Sets the text effect bits of interest. You should also pass wxTEXT\_ATTR\_EFFECTS to \helpref{wxTextAttr::SetFlags}{wxtextattrsetflags}. + +\membersection{wxTextAttrEx::SetTextEffects}\label{wxtextattrexsettexteffects} + +\func{void}{SetTextEffects}{\param{int }{effects}} + +Sets the text effects, a bit list of styles. + +The following styles can be passed: + +{\small +\begin{verbatim} +#define wxTEXT_ATTR_EFFECT_NONE 0x00000000 +#define wxTEXT_ATTR_EFFECT_CAPITALS 0x00000001 +#define wxTEXT_ATTR_EFFECT_SMALL_CAPITALS 0x00000002 +#define wxTEXT_ATTR_EFFECT_STRIKETHROUGH 0x00000004 +#define wxTEXT_ATTR_EFFECT_DOUBLE_STRIKETHROUGH 0x00000008 +#define wxTEXT_ATTR_EFFECT_SHADOW 0x00000010 +#define wxTEXT_ATTR_EFFECT_EMBOSS 0x00000020 +#define wxTEXT_ATTR_EFFECT_OUTLINE 0x00000040 +#define wxTEXT_ATTR_EFFECT_ENGRAVE 0x00000080 +#define wxTEXT_ATTR_EFFECT_SUPERSCRIPT 0x00000100 +#define wxTEXT_ATTR_EFFECT_SUBSCRIPT 0x00000200 +\end{verbatim} +} + +Of these, only wxTEXT\_ATTR\_EFFECT\_CAPITALS and wxTEXT\_ATTR\_EFFECT\_STRIKETHROUGH are implemented. +wxTEXT\_ATTR\_EFFECT\_CAPITALS capitalises text when displayed (leaving the case of the actual buffer +text unchanged), and wxTEXT\_ATTR\_EFFECT\_STRIKETHROUGH draws a line through text. + +To set effects, you should also pass wxTEXT\_ATTR\_EFFECTS to \helpref{wxTextAttr::SetFlags}{wxtextattrsetflags}, and call\rtfsp +\helpref{wxTextAttrEx::SetTextEffectFlags}{wxtextattrexsettexteffectflags} with the styles (taken from the +above set) that you are interested in setting. + \membersection{wxTextAttrEx::SetURL}\label{wxtextattrexseturl} \func{void}{SetURL}{\param{const wxString\& }{url}}