Added URL support to attribute objects and to wxRichTextCtrl,
generating a wxTextUrlEvent as appropriate. Added outline list support and updated previews. Added alignment support for bullets. Added single right parenthesis support. Added XML stylesheet reading/writing. Changed SetBulletSymbol to SetBulletText so it can support bullet text more generally (e.g. for cached outline list numbering) Added wxRichTextRenderer to isolate e.g. bullet drawing and make it customisable. Added event handler support to wxRichTextBuffer. Updated documentation. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42431 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -310,6 +310,7 @@
|
||||
\input richtextfilehandler.tex
|
||||
\input richtextformattingdialog.tex
|
||||
\input richtexthtmlhandler.tex
|
||||
\input richtextliststyledefinition.tex
|
||||
\input richtextparagraphstyledefinition.tex
|
||||
\input richtextrange.tex
|
||||
\input richtextstyledefinition.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}}
|
||||
|
@@ -34,6 +34,18 @@ Default constructors.
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxRichTextBuffer::AddEventHandler}\label{wxrichtextbufferaddeventhandler}
|
||||
|
||||
\func{bool}{AddEventHandler}{\param{wxEvtHandler* }{handler}}
|
||||
|
||||
Adds an event handler to the buffer's list of handlers. A buffer associated with
|
||||
a contol has the control as the only event handler, but the application is free
|
||||
to add more if further notification is required. All handlers are notified
|
||||
of an event originating from the buffer, such as the replacement of a style sheet
|
||||
during loading. The buffer never deletes any of the event handlers, unless
|
||||
\helpref{wxRichTextBuffer::RemoveEventHandler}{wxrichtextbufferremoveeventhandler} is
|
||||
called with \true as the second argument.
|
||||
|
||||
\membersection{wxRichTextBuffer::AddHandler}\label{wxrichtextbufferaddhandler}
|
||||
|
||||
\func{void}{AddHandler}{\param{wxRichTextFileHandler* }{handler}}
|
||||
@@ -127,6 +139,12 @@ defined for convenience:
|
||||
\end{verbatim}
|
||||
}
|
||||
|
||||
\membersection{wxRichTextBuffer::BeginListStyle}\label{wxrichtextbufferbeginliststyle}
|
||||
|
||||
\func{bool}{BeginListStyle}{\param{const wxString\&}{ listStyle}, \param{int}{ level=1}, \param{int}{ number=1}}
|
||||
|
||||
Begins using a specified list style. Optionally, you can also pass a level and a number.
|
||||
|
||||
\membersection{wxRichTextBuffer::BeginNumberedBullet}\label{wxrichtextbufferbeginnumberedbullet}
|
||||
|
||||
\func{bool}{BeginNumberedBullet}{\param{int }{bulletNumber}, \param{int }{leftIndent}, \param{int }{leftSubIndent}, \param{int }{bulletStyle = wxTEXT\_ATTR\_BULLET\_STYLE\_ARABIC|wxTEXT\_ATTR\_BULLET\_STYLE\_PERIOD}}
|
||||
@@ -194,6 +212,13 @@ differently by each command. If not dealt with by a command implementation, then
|
||||
it will be implemented automatically by not storing the command in the undo history
|
||||
when the action is submitted to the command processor.
|
||||
|
||||
\membersection{wxRichTextBuffer::BeginStandardBullet}\label{wxrichtextbufferbeginstandardbullet}
|
||||
|
||||
\func{bool}{BeginStandardBullet}{\param{const wxString\&}{ bulletName}, \param{int }{leftIndent}, \param{int }{leftSubIndent}, \param{int }{bulletStyle = wxTEXT\_ATTR\_BULLET\_STYLE\_STANDARD}}
|
||||
|
||||
Begins applying a standard bullet, using one of the standard bullet names (currently {\tt standard/circle} or {\tt standard/square}.
|
||||
See \helpref{BeginNumberedBullet}{wxrichtextbufferbeginnumberedbullet} for an explanation of how indentation is used to render the bulleted paragraph.
|
||||
|
||||
\membersection{wxRichTextBuffer::BeginSymbolBullet}\label{wxrichtextbufferbeginsymbolbullet}
|
||||
|
||||
\func{bool}{BeginSymbolBullet}{\param{wxChar }{symbol}, \param{int }{leftIndent}, \param{int }{leftSubIndent}, \param{int }{bulletStyle = wxTEXT\_ATTR\_BULLET\_STYLE\_SYMBOL}}
|
||||
@@ -213,6 +238,13 @@ Begins using the specified text foreground colour.
|
||||
|
||||
Begins using underline.
|
||||
|
||||
\membersection{wxRichTextBuffer::BeginURL}\label{wxrichtextbufferbeginurl}
|
||||
|
||||
\func{bool}{BeginURL}{\param{const wxString\&}{ url}, \param{const wxString\&}{ characterStyle = wxEmptyString}}
|
||||
|
||||
Begins applying wxTEXT\_ATTR\_URL to the content. Pass a URL and optionally, a character style to apply,
|
||||
since it is common to mark a URL with a familiar style such as blue text with underlining.
|
||||
|
||||
\membersection{wxRichTextBuffer::CanPasteFromClipboard}\label{wxrichtextbuffercanpastefromclipboard}
|
||||
|
||||
\constfunc{bool}{CanPasteFromClipboard}{\void}
|
||||
@@ -329,6 +361,12 @@ Ends using a left indent.
|
||||
|
||||
Ends using a line spacing.
|
||||
|
||||
\membersection{wxRichTextBuffer::EndListStyle}\label{wxrichtextbufferendliststyle}
|
||||
|
||||
\func{bool}{EndListStyle}{\void}
|
||||
|
||||
Ends using a specified list style.
|
||||
|
||||
\membersection{wxRichTextBuffer::EndNumberedBullet}\label{wxrichtextbufferendnumberedbullet}
|
||||
|
||||
\func{bool}{EndNumberedBullet}{\void}
|
||||
@@ -371,6 +409,12 @@ Ends suppressing undo/redo commands.
|
||||
|
||||
Ends using a symbol bullet.
|
||||
|
||||
\membersection{wxRichTextBuffer::EndStandardBullet}\label{wxrichtextbufferendstandardbullet}
|
||||
|
||||
\func{bool}{EndStandardBullet}{\void}
|
||||
|
||||
Ends using a standard bullet.
|
||||
|
||||
\membersection{wxRichTextBuffer::EndTextColour}\label{wxrichtextbufferendtextcolour}
|
||||
|
||||
\func{bool}{EndTextColour}{\void}
|
||||
@@ -383,6 +427,12 @@ Ends using a text foreground colour.
|
||||
|
||||
Ends using underline.
|
||||
|
||||
\membersection{wxRichTextBuffer::EndURL}\label{wxrichtextbufferendurl}
|
||||
|
||||
\func{bool}{EndURL}{\void}
|
||||
|
||||
Ends applying a URL.
|
||||
|
||||
\membersection{wxRichTextBuffer::FindHandler}\label{wxrichtextbufferfindhandler}
|
||||
|
||||
\func{wxRichTextFileHandler*}{FindHandler}{\param{int }{imageType}}
|
||||
@@ -446,6 +496,12 @@ used to determine the type to pass to \helpref{LoadFile}{wxrichtextbuffergetextw
|
||||
|
||||
Returns the list of file handlers.
|
||||
|
||||
\membersection{wxRichTextBuffer::GetRenderer}\label{wxrichtextbuffergetrenderer}
|
||||
|
||||
\func{static wxRichTextRenderer*}{GetRenderer}{\void}
|
||||
|
||||
Returns the object to be used to render certain aspects of the content, such as bullets.
|
||||
|
||||
\membersection{wxRichTextBuffer::GetStyle}\label{wxrichtextbuffergetstyle}
|
||||
|
||||
\func{bool}{GetStyle}{\param{long }{position}, \param{wxRichTextAttr\& }{style}}
|
||||
@@ -596,6 +652,12 @@ Marks the buffer as modified or unmodified.
|
||||
|
||||
Pastes the clipboard content to the buffer at the given position.
|
||||
|
||||
\membersection{wxRichTextBuffer::RemoveEventHandler}\label{wxrichtextbufferremoveeventhandler}
|
||||
|
||||
\func{bool}{RemoveEventHandler}{\param{wxEvtHandler* }{handler}, \param{bool}{ deleteHandler = false}}
|
||||
|
||||
Removes an event handler from the buffer's list of handlers, deleting the object if {\it deleteHandler} is \true.
|
||||
|
||||
\membersection{wxRichTextBuffer::RemoveHandler}\label{wxrichtextbufferremovehandler}
|
||||
|
||||
\func{bool}{RemoveHandler}{\param{const wxString\& }{name}}
|
||||
@@ -638,6 +700,14 @@ style to bold will cause subsequently inserted text to be bold).
|
||||
|
||||
This is not cumulative - setting the default style will replace the previous default style.
|
||||
|
||||
\membersection{wxRichTextBuffer::SetRenderer}\label{wxrichtextbuffersetrenderer}
|
||||
|
||||
\func{static void}{SetRenderer}{\param{wxRichTextRenderer* }{renderer}}
|
||||
|
||||
Sets {\it renderer} as the object to be used to render certain aspects of the content, such as bullets.
|
||||
You can override default rendering by deriving a new class from wxRichTextRenderer or wxRichTextStdRenderer,
|
||||
overriding one or more virtual functions, and setting an instance of the class using this function.
|
||||
|
||||
\membersection{wxRichTextBuffer::SetStyle}\label{wxrichtextbuffersetstyle}
|
||||
|
||||
\func{bool}{SetStyle}{\param{const wxRichTextRange\& }{range}, \param{const wxRichTextAttr\& }{style}, \param{int }{flags $=$ wxRICHTEXT\_SETSTYLE\_WITH\_UNDO}}
|
||||
|
@@ -171,6 +171,12 @@ defined for convenience:
|
||||
\end{verbatim}
|
||||
}
|
||||
|
||||
\membersection{wxRichTextCtrl::BeginListStyle}\label{wxrichtextctrlbeginliststyle}
|
||||
|
||||
\func{bool}{BeginListStyle}{\param{const wxString\&}{ listStyle}, \param{int}{ level=1}, \param{int}{ number=1}}
|
||||
|
||||
Begins using a specified list style. Optionally, you can also pass a level and a number.
|
||||
|
||||
\membersection{wxRichTextCtrl::BeginNumberedBullet}\label{wxrichtextctrlbeginnumberedbullet}
|
||||
|
||||
\func{bool}{BeginNumberedBullet}{\param{int }{bulletNumber}, \param{int }{leftIndent}, \param{int }{leftSubIndent}, \param{int }{bulletStyle = wxTEXT\_ATTR\_BULLET\_STYLE\_ARABIC|wxTEXT\_ATTR\_BULLET\_STYLE\_PERIOD}}
|
||||
@@ -254,6 +260,13 @@ Begins using this colour.
|
||||
|
||||
Begins using underlining.
|
||||
|
||||
\membersection{wxRichTextCtrl::BeginURL}\label{wxrichtextctrlbeginurl}
|
||||
|
||||
\func{bool}{BeginURL}{\param{const wxString\&}{ url}, \param{const wxString\&}{ characterStyle = wxEmptyString}}
|
||||
|
||||
Begins applying wxTEXT\_ATTR\_URL to the content. Pass a URL and optionally, a character style to apply,
|
||||
since it is common to mark a URL with a familiar style such as blue text with underlining.
|
||||
|
||||
\membersection{wxRichTextCtrl::CanCopy}\label{wxrichtextctrlcancopy}
|
||||
|
||||
\constfunc{bool}{CanCopy}{\void}
|
||||
@@ -407,6 +420,12 @@ Ends left indent.
|
||||
|
||||
Ends line spacing.
|
||||
|
||||
\membersection{wxRichTextCtrl::EndListStyle}\label{wxrichtextctrlendliststyle}
|
||||
|
||||
\func{bool}{EndListStyle}{\void}
|
||||
|
||||
Ends using a specified list style.
|
||||
|
||||
\membersection{wxRichTextCtrl::EndNumberedBullet}\label{wxrichtextctrlendnumberedbullet}
|
||||
|
||||
\func{bool}{EndNumberedBullet}{\void}
|
||||
@@ -461,6 +480,12 @@ Ends applying a text colour.
|
||||
|
||||
End applying underlining.
|
||||
|
||||
\membersection{wxRichTextCtrl::EndURL}\label{wxrichtextctrlendurl}
|
||||
|
||||
\func{bool}{EndURL}{\void}
|
||||
|
||||
Ends applying a URL.
|
||||
|
||||
\membersection{wxRichTextCtrl::ExtendSelection}\label{wxrichtextctrlextendselection}
|
||||
|
||||
\func{bool}{ExtendSelection}{\param{long }{oldPosition}, \param{long }{newPosition}, \param{int }{flags}}
|
||||
|
85
docs/latex/wx/richtextliststyledefinition.tex
Normal file
85
docs/latex/wx/richtextliststyledefinition.tex
Normal file
@@ -0,0 +1,85 @@
|
||||
\section{\class{wxRichTextListStyleDefinition}}\label{wxrichtextliststyledefinition}
|
||||
|
||||
This class represents a list style definition, usually added to a \helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}.
|
||||
|
||||
The class inherits paragraph attributes from wxRichTextStyleParagraphDefinition, and adds 10 further attribute objects, one for each level of a list.
|
||||
When applying a list style to a paragraph, the list style's base and appropriate level attributes are merged with the
|
||||
paragraph's existing attributes.
|
||||
|
||||
You can apply a list style to one or more paragraphs using \helpref{wxRichTextCtrl::SetListStyle}{wxrichtextctrlsetliststyle}. You
|
||||
can also use the functions \helpref{wxRichTextCtrl::NumberList}{wxrichtextctrlnumberlist}, \helpref{wxRichTextCtrl::PromoteList}{wxrichtextctrlpromotelist} and
|
||||
\helpref{wxRichTextCtrl::ClearListStyle}{wxrichtextctrlclearliststyle}. As usual, there are wxRichTextBuffer versions of these functions
|
||||
so that you can apply them directly to a buffer without requiring a control.
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxRichTextStyleParagraphDefinition}{wxrichtextstyleparagraphdefinition}
|
||||
|
||||
\wxheading{Include files}
|
||||
|
||||
<wx/richtext/richtextstyles.h>
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxRichTextListStyleDefinition::wxRichTextListStyleDefinition}\label{wxrichtextliststyledefinitionwxrichtextliststyledefinition}
|
||||
|
||||
\func{}{wxRichTextListStyleDefinition}{\param{const wxString\& }{name = wxEmptyString}}
|
||||
|
||||
Constructor.
|
||||
|
||||
\membersection{wxRichTextListStyleDefinition::\destruct{wxRichTextListStyleDefinition}}\label{wxrichtextliststyledefinitiondtor}
|
||||
|
||||
\func{}{\destruct{wxRichTextListStyleDefinition}}{\void}
|
||||
|
||||
Destructor.
|
||||
|
||||
\membersection{wxRichTextListStyleDefinition::CombineWithParagraphStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}
|
||||
|
||||
\func{wxRichTextAttr}{CombineWithParagraphStyle}{\param{int }{indent}, \param{const wxRichTextAttr\&}{ paraStyle}}
|
||||
|
||||
This function combines the given paragraph style with the list style's base attributes and level style matching the given indent, returning the combined attributes.
|
||||
|
||||
\membersection{wxRichTextListStyleDefinition::FindLevelForIndent}\label{wxrichtextliststyledefinitionfindlevelforindent}
|
||||
|
||||
\constfunc{int}{FindLevelForIndent}{\param{int }{indent}}
|
||||
|
||||
This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches {\it indent} (expressed in tenths of a millimetre).
|
||||
|
||||
\membersection{wxRichTextListStyleDefinition::GetCombinedStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}
|
||||
|
||||
\constfunc{wxRichTextAttr}{GetCombinedStyle}{\param{int }{indent}}
|
||||
|
||||
This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.
|
||||
|
||||
\membersection{wxRichTextListStyleDefinition::GetLevelAttributes}\label{wxrichtextliststyledefinitiongetlevelattributes}
|
||||
|
||||
\constfunc{const wxRichTextAttr*}{GetLevelAttributes}{\param{int }{level}}
|
||||
|
||||
Returns the style for the given level. {\it level} is a number between 0 and 9.
|
||||
|
||||
\membersection{wxRichTextListStyleDefinition::GetLevelCount}\label{wxrichtextliststyledefinitiongetlevelcount}
|
||||
|
||||
\constfunc{int}{GetLevelCount}{\void}
|
||||
|
||||
Returns the number of levels. This is hard-wired to 10.
|
||||
|
||||
Returns the style for the given level. {\it level} is a number between 0 and 9.
|
||||
|
||||
\membersection{wxRichTextListStyleDefinition::IsNumbered}\label{wxrichtextliststyledefinitionisnumbered}
|
||||
|
||||
\constfunc{int}{IsNumbered}{\param{int}{ level}}
|
||||
|
||||
Returns \true if the given level has numbered list attributes.
|
||||
|
||||
\membersection{wxRichTextListStyleDefinition::SetLevelAttributes}\label{wxrichtextliststyledefinitionsetlevelattributes}
|
||||
|
||||
\func{void}{SetLevelAttributes}{\param{int }{level}, \param{const wxRichTextAttr\&}{ attr}}
|
||||
|
||||
\func{void}{SetLevelAttributes}{\param{int }{level}, \param{int}{ leftIndent}, \param{int}{ leftSubIndent}, \param{int}{ bulletStyle}, \param{const wxString\&}{ bulletSymbol = wxEmptyString}}
|
||||
|
||||
Sets the style for the given level. {\it level} is a number between 0 and 9.
|
||||
|
||||
The first and most flexible form uses a wxRichTextAttr object, while the second form is for convenient setting of the most commonly-used attributes.
|
||||
|
@@ -4,6 +4,7 @@ Classes: \helpref{wxRichTextCtrl}{wxrichtextctrl}, \helpref{wxRichTextBuffer}{wx
|
||||
\helpref{wxRichTextAttr}{wxrichtextattr}, \helpref{wxTextAttrEx}{wxtextattrex},
|
||||
\helpref{wxRichTextCharacterStyleDefinition}{wxrichtextcharacterstyledefinition},
|
||||
\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition},
|
||||
\helpref{wxRichTextListStyleDefinition}{wxrichtextliststyledefinition},
|
||||
\helpref{wxRichTextStyleSheet}{wxrichtextstylesheet},
|
||||
\helpref{wxRichTextStyleComboCtrl}{wxrichtextstylecomboctrl},
|
||||
\helpref{wxRichTextStyleListBox}{wxrichtextstylelistbox},
|
||||
@@ -285,7 +286,7 @@ of styles that you can tailor or use as-is, and this means that you can set a he
|
||||
instead of marking text in bold, specifying a large font size, and applying a certain
|
||||
paragraph spacing and alignment for every such heading. Similarly,
|
||||
wxWidgets provides a class called \helpref{wxRichTextStyleSheet}{wxrichtextstylesheet} which manages style definitions
|
||||
(\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition} and \helpref{wxRichTextCharacterStyleDefinition}{wxrichtextcharacterstyledefinition}).
|
||||
(\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}, \helpref{wxRichTextListStyleDefinition}{wxrichtextliststyledefinition} and \helpref{wxRichTextCharacterStyleDefinition}{wxrichtextcharacterstyledefinition}).
|
||||
Once you have added definitions to a style sheet and associated it with a wxRichTextCtrl,
|
||||
you can apply a named definition to a range of text. The classes \helpref{wxRichTextStyleComboCtrl}{wxrichtextstylecomboctrl}\rtfsp
|
||||
and \helpref{wxRichTextStyleListBox}{wxrichtextstylelistbox} can be used to present the user with a list
|
||||
@@ -295,7 +296,7 @@ You can reapply a style sheet to the contents of the control, by calling \helpre
|
||||
This is useful if the style definitions have changed, and you want the content to reflect this.
|
||||
It relies on the fact that when you apply a named style, the style definition name is recorded in the
|
||||
content. So ApplyStyleSheet works by finding the paragraph attributes with style names and re-applying the definition's
|
||||
attributes to the paragraph. Currently, this works with paragraph style definitions only.
|
||||
attributes to the paragraph. Currently, this works with paragraph and list style definitions only.
|
||||
|
||||
\subsection{wxRichTextCtrl dialogs}\label{wxrichtextctrldialogs}
|
||||
|
||||
@@ -386,12 +387,8 @@ This is a list of some of the features that have yet to be implemented. Help wit
|
||||
\item Floating images, with content wrapping around them
|
||||
\item A ruler control
|
||||
\item Standard editing toolbars
|
||||
\item Automatic list numbering
|
||||
\item Tables
|
||||
\item Text frames
|
||||
\item Add ability to show images in wxHTML output (currently uses embedded data suitable only for real browsers)
|
||||
\item More complete stylesheet viewer, plus style sheet editing dialogs
|
||||
\item Ability to read and write style sheets
|
||||
\end{itemize}
|
||||
|
||||
There are also things that could be done to take advantage of the underlying text capabilities of the platform;
|
||||
|
@@ -37,6 +37,12 @@ Destructor.
|
||||
|
||||
Adds a definition to the character style list.
|
||||
|
||||
\membersection{wxRichTextStyleSheet::AddListStyle}\label{wxrichtextstylesheetaddliststyle}
|
||||
|
||||
\func{bool}{AddListStyle}{\param{wxRichTextListStyleDefinition* }{def}}
|
||||
|
||||
Adds a definition to the list style list.
|
||||
|
||||
\membersection{wxRichTextStyleSheet::AddParagraphStyle}\label{wxrichtextstylesheetaddparagraphstyle}
|
||||
|
||||
\func{bool}{AddParagraphStyle}{\param{wxRichTextParagraphStyleDefinition* }{def}}
|
||||
@@ -55,6 +61,12 @@ Deletes all styles.
|
||||
|
||||
Finds a character definition by name.
|
||||
|
||||
\membersection{wxRichTextStyleSheet::FindListStyle}\label{wxrichtextstylesheetfindliststyle}
|
||||
|
||||
\constfunc{wxRichTextListStyleDefinition*}{FindListStyle}{\param{const wxString\& }{name}}
|
||||
|
||||
Finds a list definition by name.
|
||||
|
||||
\membersection{wxRichTextStyleSheet::FindParagraphStyle}\label{wxrichtextstylesheetfindparagraphstyle}
|
||||
|
||||
\constfunc{wxRichTextParagraphStyleDefinition*}{FindParagraphStyle}{\param{const wxString\& }{name}}
|
||||
@@ -73,6 +85,18 @@ Returns the {\it n}th character style.
|
||||
|
||||
Returns the number of character styles.
|
||||
|
||||
\membersection{wxRichTextStyleSheet::GetListStyle}\label{wxrichtextstylesheetgetliststyle}
|
||||
|
||||
\constfunc{wxRichTextListStyleDefinition*}{GetListStyle}{\param{size\_t }{n}}
|
||||
|
||||
Returns the {\it n}th list style.
|
||||
|
||||
\membersection{wxRichTextStyleSheet::GetListStyleCount}\label{wxrichtextstylesheetgetliststylecount}
|
||||
|
||||
\constfunc{size\_t}{GetListStyleCount}{\void}
|
||||
|
||||
Returns the number of list styles.
|
||||
|
||||
\membersection{wxRichTextStyleSheet::GetParagraphStyle}\label{wxrichtextstylesheetgetparagraphstyle}
|
||||
|
||||
\constfunc{wxRichTextParagraphStyleDefinition*}{GetParagraphStyle}{\param{size\_t }{n}}
|
||||
@@ -97,6 +121,12 @@ Initialises the style sheet.
|
||||
|
||||
Removes a character style.
|
||||
|
||||
\membersection{wxRichTextStyleSheet::RemoveListStyle}\label{wxrichtextstylesheetremoveliststyle}
|
||||
|
||||
\func{bool}{RemoveListStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}
|
||||
|
||||
Removes a list style.
|
||||
|
||||
\membersection{wxRichTextStyleSheet::RemoveParagraphStyle}\label{wxrichtextstylesheetremoveparagraphstyle}
|
||||
|
||||
\func{bool}{RemoveParagraphStyle}{\param{wxRichTextStyleDefinition* }{def}, \param{bool }{deleteStyle = false}}
|
||||
|
@@ -75,9 +75,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}
|
||||
}
|
||||
|
||||
@@ -85,16 +88,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}
|
||||
}
|
||||
|
||||
@@ -131,6 +140,24 @@ Constructors.
|
||||
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}
|
||||
@@ -144,11 +171,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{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{wxTextAttrEx::GetCharacterStyleName}\label{wxtextattrexgetcharacterstylename}
|
||||
|
||||
@@ -163,6 +190,12 @@ 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::GetParagraphSpacingAfter}\label{wxtextattrexgetparagraphspacingafter}
|
||||
|
||||
\constfunc{int}{GetParagraphSpacingAfter}{\void}
|
||||
@@ -181,6 +214,20 @@ Returns the space in tenths of a millimeter before the paragraph.
|
||||
|
||||
Returns the name of the paragraph style.
|
||||
|
||||
\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}
|
||||
@@ -193,11 +240,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}
|
||||
|
||||
@@ -211,6 +258,12 @@ 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::HasParagraphSpacingAfter}\label{wxtextattrexhasparagraphspacingafter}
|
||||
|
||||
\constfunc{bool}{HasParagraphSpacingAfter}{\void}
|
||||
@@ -269,6 +322,14 @@ Only valid for attributes with wxTEXT\_ATTR\_BULLET\_SYMBOL.
|
||||
|
||||
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}}
|
||||
@@ -277,24 +338,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{wxTextAttrEx::SetBulletSymbol}\label{wxtextattrexsetbulletsymbol}
|
||||
\membersection{wxTextAttrEx::SetBulletText}\label{wxtextattrexsetbullettext}
|
||||
|
||||
\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{wxTextAttrEx::SetCharacterStyleName}\label{wxtextattrexsetcharacterstylename}
|
||||
|
||||
@@ -318,6 +385,12 @@ defined for convenience:
|
||||
\end{verbatim}
|
||||
}
|
||||
|
||||
\membersection{wxTextAttrEx::SetListStyleName}\label{wxtextattrexsetliststylename}
|
||||
|
||||
\func{void}{SetListStyleName}{\param{const wxString\& }{name}}
|
||||
|
||||
Sets the list style name.
|
||||
|
||||
\membersection{wxTextAttrEx::SetParagraphSpacingAfter}\label{wxtextattrexsetparagraphspacingafter}
|
||||
|
||||
\func{void}{SetParagraphSpacingAfter}{\param{int }{spacing}}
|
||||
@@ -336,6 +409,14 @@ Sets the spacing before a paragraph, in tenths of a millimetre.
|
||||
|
||||
Sets the name of the paragraph style.
|
||||
|
||||
\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}}
|
||||
|
Reference in New Issue
Block a user