X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5f35b46aabdab414602d27bb92034c371bc09d2e..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/textattrex.tex diff --git a/docs/latex/wx/textattrex.tex b/docs/latex/wx/textattrex.tex index 80c8275045..43b7054508 100644 --- a/docs/latex/wx/textattrex.tex +++ b/docs/latex/wx/textattrex.tex @@ -26,6 +26,10 @@ the remaining functions. +\wxheading{Library} + +\helpref{wxRichtext}{librarieslist} + \wxheading{Constants} The following values can be passed to SetAlignment to determine @@ -75,30 +79,44 @@ for a text control. #define wxTEXT_ATTR_LINE_SPACING 0x00002000 #define wxTEXT_ATTR_CHARACTER_STYLE_NAME 0x00004000 #define wxTEXT_ATTR_PARAGRAPH_STYLE_NAME 0x00008000 -#define wxTEXT_ATTR_BULLET_STYLE 0x00010000 -#define wxTEXT_ATTR_BULLET_NUMBER 0x00020000 -#define wxTEXT_ATTR_BULLET_SYMBOL 0x00040000 +#define wxTEXT_ATTR_LIST_STYLE_NAME 0x00010000 +#define wxTEXT_ATTR_BULLET_STYLE 0x00020000 +#define wxTEXT_ATTR_BULLET_NUMBER 0x00040000 +#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} -#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x0000 -#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x0001 -#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x0002 -#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x0004 -#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x0008 -#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x0010 -#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x0020 -#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x0040 -#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x0080 -#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x0100 +#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x00000000 +#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x00000001 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x00000002 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x00000004 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x00000008 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x00000010 +#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x00000020 +#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x00000040 +#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x00000080 +#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x00000100 +#define wxTEXT_ATTR_BULLET_STYLE_STANDARD 0x00000200 +#define wxTEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS 0x00000400 +#define wxTEXT_ATTR_BULLET_STYLE_OUTLINE 0x00000800 +#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_LEFT 0x00000000 +#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT 0x00001000 +#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE 0x00002000 \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} @@ -108,6 +126,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} @@ -124,6 +162,31 @@ The following constants can be passed to wxRichTextAttr::SetLineSpacing: Constructors. +\membersection{wxTextAttrEx::GetBulletFont}\label{wxtextattrexgetbulletfont} + +\constfunc{const wxString\&}{GetBulletFont}{\void} + +Returns a string containing the name of the font associated with the bullet symbol. +Only valid for attributes with wxTEXT\_ATTR\_BULLET\_SYMBOL. + +\membersection{wxTextAttrEx::GetBulletName}\label{wxtextattrexgetbulletname} + +\constfunc{const wxString\&}{GetBulletName}{\void} + +Returns the standard bullet name, applicable if the bullet style is wxTEXT\_ATTR\_BULLET\_STYLE\_STANDARD. +Currently the following standard bullet names are supported: + +\begin{itemize}\itemsep=0pt +\item {\tt standard/circle} +\item {\tt standard/square} +\item {\tt standard/diamond} +\item {\tt standard/triangle} +\end{itemize} + +If you wish your application to support further bullet graphics, you can derive a +class from wxRichTextRenderer or wxRichTextStdRenderer, override {\tt DrawStandardBullet} and {\tt EnumerateStandardBulletNames}, and +set an instance of the class using \helpref{wxRichTextBuffer::SetRenderer}{wxrichtextbuffersetrenderer}. + \membersection{wxTextAttrEx::GetBulletNumber}\label{wxtextattrexgetbulletnumber} \constfunc{int}{GetBulletNumber}{\void} @@ -137,11 +200,11 @@ Returns the bullet number. Returns the bullet style. See \helpref{wxTextAttrEx::SetBulletStyle}{wxtextattrexsetbulletstyle} for a list of available styles. -\membersection{wxTextAttrEx::GetBulletSymbol}\label{wxtextattrexgetbulletsymbol} +\membersection{wxTextAttrEx::GetBulletText}\label{wxtextattrexgetbullettext} -\constfunc{wxChar}{GetBulletSymbol}{\void} +\constfunc{const wxString\&}{GetBulletText}{\void} -Returns the bullet symbol, a character. +Returns the bullet text, which could be a symbol, or (for example) cached outline text. \membersection{wxTextAttrEx::GetCharacterStyleName}\label{wxtextattrexgetcharacterstylename} @@ -156,6 +219,18 @@ Returns the name of the character style. Returns the line spacing value, one of wxTEXT\_ATTR\_LINE\_SPACING\_NORMAL, wxTEXT\_ATTR\_LINE\_SPACING\_HALF, and wxTEXT\_ATTR\_LINE\_SPACING\_TWICE. +\membersection{wxTextAttrEx::GetListStyleName}\label{wxtextattrexgetliststylename} + +\constfunc{const wxString\&}{GetListStyleName}{\void} + +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} @@ -174,6 +249,33 @@ 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} + +Returns the URL for the content. Content with wxTEXT\_ATTR\_URL style +causes wxRichTextCtrl to show a hand cursor over it, and wxRichTextCtrl generates +a wxTextUrlEvent when the content is clicked. + +\membersection{wxTextAttrEx::HasBulletName}\label{wxtextattrexhasbulletname} + +\constfunc{bool}{HasBulletName}{\void} + +Returns \true if the attribute object specifies a standard bullet name. + \membersection{wxTextAttrEx::HasBulletNumber}\label{wxtextattrexhasbulletnumber} \constfunc{bool}{HasBulletNumber}{\void} @@ -186,11 +288,11 @@ Returns \true if the attribute object specifies a bullet number. Returns \true if the attribute object specifies a bullet style. -\membersection{wxTextAttrEx::HasBulletSymbol}\label{wxtextattrexhasbulletsymbol} +\membersection{wxTextAttrEx::HasBulletText}\label{wxtextattrexhasbullettext} -\constfunc{bool}{HasBulletSymbol}{\void} +\constfunc{bool}{HasBulletText}{\void} -Returns \true if the attribute object specifies a bullet symbol. +Returns \true if the attribute object specifies bullet text (usually containing a symbol). \membersection{wxTextAttrEx::HasCharacterStyleName}\label{wxtextattrexhascharacterstylename} @@ -204,6 +306,24 @@ Returns \true if the attribute object specifies a character style name. Returns \true if the attribute object specifies line spacing. +\membersection{wxTextAttrEx::HasListStyleName}\label{wxtextattrexhasliststylename} + +\constfunc{bool}{HasListStyleName}{\void} + +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} @@ -222,6 +342,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} @@ -249,12 +381,27 @@ Returns \true if the object represents a paragraph style, that is, the flags specify alignment, indentation, tabs, paragraph spacing, or bullet style. +\membersection{wxTextAttrEx::SetBulletFont}\label{wxtextattrexsetbulletfont} + +\func{void}{SetBulletFont}{\param{const wxString\& }{font}} + +Sets the name of the font associated with the bullet symbol. +Only valid for attributes with wxTEXT\_ATTR\_BULLET\_SYMBOL. + \membersection{wxTextAttrEx::SetBulletNumber}\label{wxtextattrexsetbulletnumber} \func{void}{SetBulletNumber}{\param{int }{n}} Sets the bullet number. +\membersection{wxTextAttrEx::SetBulletName}\label{wxtextattrexsetbulletname} + +\func{void}{SetBulletName}{\param{const wxString\& }{name}} + +Sets the standard bullet name, applicable if the bullet style is wxTEXT\_ATTR\_BULLET\_STYLE\_STANDARD. +See \helpref{wxTextAttrEx::GetBulletName}{wxtextattrexgetbulletname} for a list +of supported names, and how to expand the range of supported types. + \membersection{wxTextAttrEx::SetBulletStyle}\label{wxtextattrexsetbulletstyle} \func{void}{SetBulletStyle}{\param{int }{style}} @@ -263,24 +410,32 @@ Sets the bullet style. The following styles can be passed: {\small \begin{verbatim} -#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x0000 -#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x0001 -#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x0002 -#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x0004 -#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x0008 -#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x0010 -#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x0020 -#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x0040 -#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x0080 -#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x0100 +#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x00000000 +#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x00000001 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x00000002 +#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x00000004 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x00000008 +#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x00000010 +#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x00000020 +#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x00000040 +#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x00000080 +#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x00000100 +#define wxTEXT_ATTR_BULLET_STYLE_STANDARD 0x00000200 +#define wxTEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS 0x00000400 +#define wxTEXT_ATTR_BULLET_STYLE_OUTLINE 0x00000800 +#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_LEFT 0x00000000 +#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT 0x00001000 +#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE 0x00002000 \end{verbatim} } -\membersection{wxTextAttrEx::SetBulletSymbol}\label{wxtextattrexsetbulletsymbol} +Currently wxTEXT\_ATTR\_BULLET\_STYLE\_BITMAP is not supported. -\func{void}{SetBulletSymbol}{\param{wxChar }{symbol}} +\membersection{wxTextAttrEx::SetBulletText}\label{wxtextattrexsetbullettext} -Sets the paragraph symbol. +\func{void}{SetBulletText}{\param{const wxString\& }{text}} + +Sets the bullet text, which could be a symbol, or (for example) cached outline text. \membersection{wxTextAttrEx::SetCharacterStyleName}\label{wxtextattrexsetcharacterstylename} @@ -304,6 +459,26 @@ defined for convenience: \end{verbatim} } +\membersection{wxTextAttrEx::SetListStyleName}\label{wxtextattrexsetliststylename} + +\func{void}{SetListStyleName}{\param{const wxString\& }{name}} + +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}} @@ -322,6 +497,52 @@ 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}} + +Sets the URL for the content. Sets the wxTEXT\_ATTR\_URL style; content with this style +causes wxRichTextCtrl to show a hand cursor over it, and wxRichTextCtrl generates +a wxTextUrlEvent when the content is clicked. + \membersection{wxTextAttrEx::operator=}\label{wxtextattrexoperatorassign} \func{void operator}{operator=}{\param{const wxTextAttr\& }{attr}} @@ -331,3 +552,4 @@ Assignment from a wxTextAttr object. \func{void operator}{operator=}{\param{const wxTextAttrEx\& }{attr}} Assignment from a wxTextAttrEx object. +