X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/62a268cc71a93c9fd2d696bc85b323e232f44a20..a1c3cdc4a2c4cc2b15d7fdf60c1be228f9fbc520:/docs/latex/wx/richtextattr.tex diff --git a/docs/latex/wx/richtextattr.tex b/docs/latex/wx/richtextattr.tex index 375451cf14..5a97fad846 100644 --- a/docs/latex/wx/richtextattr.tex +++ b/docs/latex/wx/richtextattr.tex @@ -69,9 +69,12 @@ 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 \end{verbatim} } @@ -79,16 +82,22 @@ The following styles can be passed to wxRichTextAttr::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} } @@ -150,6 +159,24 @@ Returns the background colour. Returns a string containing the name of the font associated with the bullet symbol. Only valid for attributes with wxTEXT\_ATTR\_BULLET\_SYMBOL. +\membersection{wxRichTextAttr::GetBulletName}\label{wxrichtextattrgetbulletname} + +\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{wxRichTextAttr::GetBulletNumber}\label{wxrichtextattrgetbulletnumber} \constfunc{int}{GetBulletNumber}{\void} @@ -163,11 +190,11 @@ Returns the bullet number. Returns the bullet style. See \helpref{wxRichTextAttr::SetBulletStyle}{wxrichtextattrsetbulletstyle} for a list of available styles. -\membersection{wxRichTextAttr::GetBulletSymbol}\label{wxrichtextattrgetbulletsymbol} +\membersection{wxRichTextAttr::GetBulletText}\label{wxrichtextattrgetbullettext} -\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{wxRichTextAttr::GetCharacterStyleName}\label{wxrichtextattrgetcharacterstylename} @@ -237,6 +264,12 @@ Returns the left sub-indent in tenths of a millimetre. Returns the line spacing value, one of wxTEXT\_ATTR\_LINE\_SPACING\_NORMAL, wxTEXT\_ATTR\_LINE\_SPACING\_HALF, and wxTEXT\_ATTR\_LINE\_SPACING\_TWICE. +\membersection{wxRichTextAttr::GetListStyleName}\label{wxrichtextattrgetliststylename} + +\constfunc{const wxString\&}{GetListStyleName}{\void} + +Returns the name of the list style. + \membersection{wxRichTextAttr::GetParagraphSpacingAfter}\label{wxrichtextattrgetparagraphspacingafter} \constfunc{int}{GetParagraphSpacingAfter}{\void} @@ -274,6 +307,14 @@ is measured from the left margin and therefore each value must be larger than th Returns the text foreground colour. +\membersection{wxRichTextAttr::GetURL}\label{wxrichtextattrgeturl} + +\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{wxRichTextAttr::HasAlignment}\label{wxrichtextattrhasalignment} \constfunc{bool}{HasAlignment}{\void} @@ -286,6 +327,12 @@ Returns \true if the attribute object specifies alignment. Returns \true if the attribute object specifies a background colour. +\membersection{wxRichTextAttr::HasBulletName}\label{wxrichtextattrhasbulletname} + +\constfunc{bool}{HasBulletName}{\void} + +Returns \true if the attribute object specifies a standard bullet name. + \membersection{wxRichTextAttr::HasBulletNumber}\label{wxrichtextattrhasbulletnumber} \constfunc{bool}{HasBulletNumber}{\void} @@ -298,11 +345,11 @@ Returns \true if the attribute object specifies a bullet number. Returns \true if the attribute object specifies a bullet style. -\membersection{wxRichTextAttr::HasBulletSymbol}\label{wxrichtextattrhasbulletsymbol} +\membersection{wxRichTextAttr::HasBulletText}\label{wxrichtextattrhasbullettext} -\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 specifying a symbol). \membersection{wxRichTextAttr::HasCharacterStyleName}\label{wxrichtextattrhascharacterstylename} @@ -346,6 +393,12 @@ Returns \true if the attribute object specifies a left indent. Returns \true if the attribute object specifies line spacing. +\membersection{wxRichTextAttr::HasListStyleName}\label{wxrichtextattrhasliststylename} + +\constfunc{bool}{HasListStyleName}{\void} + +Returns \true if the attribute object specifies a list style name. + \membersection{wxRichTextAttr::HasParagraphSpacingAfter}\label{wxrichtextattrhasparagraphspacingafter} \constfunc{bool}{HasParagraphSpacingAfter}{\void} @@ -460,6 +513,14 @@ Sets the background colour. Sets the name of the font associated with the bullet symbol. Only valid for attributes with wxTEXT\_ATTR\_BULLET\_SYMBOL. +\membersection{wxRichTextAttr::SetBulletName}\label{wxrichtextattrsetbulletname} + +\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{wxRichTextAttr::GetBulletName}{wxrichtextattrgetbulletname} for a list +of supported names, and how to expand the range of supported types. + \membersection{wxRichTextAttr::SetBulletNumber}\label{wxrichtextattrsetbulletnumber} \func{void}{SetBulletNumber}{\param{int }{n}} @@ -474,24 +535,30 @@ 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{wxRichTextAttr::SetBulletSymbol}\label{wxrichtextattrsetbulletsymbol} +\membersection{wxRichTextAttr::SetBulletText}\label{wxrichtextattrsetbullettext} -\func{void}{SetBulletSymbol}{\param{wxChar }{symbol}} +\func{void}{SetBulletText}{\param{const wxString& }{text}} -Sets the paragraph symbol. +Sets the bullet text, which could be a symbol, or (for example) cached outline text. \membersection{wxRichTextAttr::SetCharacterStyleName}\label{wxrichtextattrsetcharacterstylename} @@ -532,9 +599,12 @@ flags can be passed in a bitlist: #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 \end{verbatim} } @@ -600,6 +670,12 @@ defined for convenience: \end{verbatim} } +\membersection{wxRichTextAttr::SetListStyleName}\label{wxrichtextattrsetliststylename} + +\func{void}{SetListStyleName}{\param{const wxString\& }{name}} + +Sets the list style name. + \membersection{wxRichTextAttr::SetParagraphSpacingAfter}\label{wxrichtextattrsetparagraphspacingafter} \func{void}{SetParagraphSpacingAfter}{\param{int }{spacing}} @@ -637,6 +713,14 @@ Each stop is measured from the left margin and therefore each value must be larg Sets the text foreground colout. +\membersection{wxRichTextAttr::SetURL}\label{wxrichtextattrseturl} + +\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{wxRichTextAttr::operator=}\label{wxrichtextattroperatorassign} \func{void operator}{operator=}{\param{const wxTextAttrEx\& }{attr}}