1 \section{\class{wxRichTextCtrl
}}\label{wxrichtextctrl
}
3 wxRichTextCtrl provides a generic, ground-up implementation of a text control
4 capable of showing multiple styles and images.
6 \wxheading{Derived from
}
10 \wxheading{Include files
}
12 <wx/richtext/richtextctrl.h>
14 \wxheading{Data structures
}
16 \latexignore{\rtfignore{\wxheading{Members
}}}
18 \membersection{wxRichTextCtrl::wxRichTextCtrl
}\label{wxrichtextctrlwxrichtextctrl
}
20 \func{}{wxRichTextCtrl
}{\void}
22 \func{}{wxRichTextCtrl
}{\param{wxWindow*
}{parent
},
\param{wxWindowID
}{id = wxID
\_ANY},
\param{const wxString\&
}{value = wxEmptyString
},
23 \param{const wxPoint\&
}{pos = wxDefaultPosition
},
\param{const wxSize\&
}{size = wxDefaultSize
},
\param{long
}{style = wxRE
\_MULTILINE},
24 \param{const wxValidator\&
}{validator = wxDefaultValidator
},
\param{const wxString\&
}{name = wxTextCtrlNameStr
}}
28 \membersection{wxRichTextCtrl::
\destruct{wxRichTextCtrl
}}\label{wxrichtextctrldtor
}
30 \func{}{\destruct{wxRichTextCtrl
}}{\void}
34 \membersection{wxRichTextCtrl::AddImage
}\label{wxrichtextctrladdimage
}
36 \func{wxRichTextRange
}{AddImage
}{\param{const wxImage\&
}{image
}}
38 Adds an image to the control's buffer.
40 \membersection{wxRichTextCtrl::AddParagraph
}\label{wxrichtextctrladdparagraph
}
42 \func{wxRichTextRange
}{AddParagraph
}{\param{const wxString\&
}{text
}}
44 Adds a new paragraph of text to the end of the buffer.
46 \membersection{wxRichTextCtrl::AppendText
}\label{wxrichtextctrlappendtext
}
48 \func{void
}{AppendText
}{\param{const wxString\&
}{text
}}
50 Sets the insertion point to the end of the buffer and writes the text.
52 \membersection{wxRichTextCtrl::ApplyAlignmentToSelection
}\label{wxrichtextctrlapplyalignmenttoselection
}
54 \func{bool
}{ApplyAlignmentToSelection
}{\param{wxTextAttrAlignment
}{alignment
}}
56 Applies the given alignment to the selection (undoable).
58 For alignment values, see
\helpref{wxTextAttrEx
}{wxtextattrex
}.
60 \membersection{wxRichTextCtrl::ApplyBoldToSelection
}\label{wxrichtextctrlapplyboldtoselection
}
62 \func{bool
}{ApplyBoldToSelection
}{\void}
64 Apples bold to the selection (undoable).
66 \membersection{wxRichTextCtrl::ApplyItalicToSelection
}\label{wxrichtextctrlapplyitalictoselection
}
68 \func{bool
}{ApplyItalicToSelection
}{\void}
70 Applies italic to the selection (undoable).
72 \membersection{wxRichTextCtrl::ApplyStyle
}\label{wxrichtextctrlapplystyle
}
74 \func{bool
}{ApplyStyle
}{\param{wxRichTextStyleDefinition*
}{ def
}}
76 Applies the given style to the selection.
78 \membersection{wxRichTextCtrl::ApplyStyleSheet
}\label{wxrichtextctrlapplystylesheet
}
80 \func{bool
}{ApplyStyleSheet
}{\param{wxRichTextStyleSheet*
}{ sheet $=$ NULL
}}
82 Applies the style sheet to the buffer, matching paragraph styles in the sheet against named styles
83 in the buffer. This might be useful if the styles have changed. If
{\it sheet
} is NULL, the
84 sheet set with SetStyleSheet is used.
86 Currently this applies paragraph styles only.
88 \membersection{wxRichTextCtrl::ApplyUnderlineToSelection
}\label{wxrichtextctrlapplyunderlinetoselection
}
90 \func{bool
}{ApplyUnderlineToSelection
}{\void}
92 Applies underline to the selection (undoable).
94 \membersection{wxRichTextCtrl::BatchingUndo
}\label{wxrichtextctrlbatchingundo
}
96 \constfunc{bool
}{BatchingUndo
}{\void}
98 Returns
\true if undo commands are being batched.
100 \membersection{wxRichTextCtrl::BeginAlignment
}\label{wxrichtextctrlbeginalignment
}
102 \func{bool
}{BeginAlignment
}{\param{wxTextAttrAlignment
}{alignment
}}
104 Begins using alignment
106 For alignment values, see
\helpref{wxTextAttrEx
}{wxtextattrex
}.
108 \membersection{wxRichTextCtrl::BeginBatchUndo
}\label{wxrichtextctrlbeginbatchundo
}
110 \func{bool
}{BeginBatchUndo
}{\param{const wxString\&
}{cmdName
}}
112 Starts batching undo history for commands.
114 \membersection{wxRichTextCtrl::BeginBold
}\label{wxrichtextctrlbeginbold
}
116 \func{bool
}{BeginBold
}{\void}
120 \membersection{wxRichTextCtrl::BeginCharacterStyle
}\label{wxrichtextctrlbegincharacterstyle
}
122 \func{bool
}{BeginCharacterStyle
}{\param{const wxString\&
}{characterStyle
}}
124 Begins using the named character style.
126 \membersection{wxRichTextCtrl::BeginFont
}\label{wxrichtextctrlbeginfont
}
128 \func{bool
}{BeginFont
}{\param{const wxFont\&
}{font
}}
130 Begins using this font.
132 \membersection{wxRichTextCtrl::BeginFontSize
}\label{wxrichtextctrlbeginfontsize
}
134 \func{bool
}{BeginFontSize
}{\param{int
}{pointSize
}}
136 Begins using the given point size.
138 \membersection{wxRichTextCtrl::BeginItalic
}\label{wxrichtextctrlbeginitalic
}
140 \func{bool
}{BeginItalic
}{\void}
144 \membersection{wxRichTextCtrl::BeginLeftIndent
}\label{wxrichtextctrlbeginleftindent
}
146 \func{bool
}{BeginLeftIndent
}{\param{int
}{leftIndent
},
\param{int
}{leftSubIndent =
0}}
148 Begins applying a left indent and subindent in tenths of a millimetre.
150 The sub-indent is an offset from the left of the paragraph, and is used for all but the
151 first line in a paragraph. A positive value will cause the first line to appear to the left
152 of the subsequent lines, and a negative value will cause the first line to be indented
153 relative to the subsequent lines.
155 wxRichTextBuffer uses indentation to render a bulleted item. The left indent is the distance between
156 the margin and the bullet. The content of the paragraph, including the first line, starts
157 at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the
158 left of the actual paragraph is leftSubIndent.
160 \membersection{wxRichTextCtrl::BeginLineSpacing
}\label{wxrichtextctrlbeginlinespacing
}
162 \func{bool
}{BeginLineSpacing
}{\param{int
}{lineSpacing
}}
164 Begins appling line spacing.
{\it spacing
} is a multiple, where
10 means single-spacing,
165 15 means
1.5 spacing, and
20 means double spacing. The following constants are
166 defined for convenience:
170 #define wxTEXT_ATTR_LINE_SPACING_NORMAL
10
171 #define wxTEXT_ATTR_LINE_SPACING_HALF
15
172 #define wxTEXT_ATTR_LINE_SPACING_TWICE
20
176 \membersection{wxRichTextCtrl::BeginListStyle
}\label{wxrichtextctrlbeginliststyle
}
178 \func{bool
}{BeginListStyle
}{\param{const wxString\&
}{ listStyle
},
\param{int
}{ level=
1},
\param{int
}{ number=
1}}
180 Begins using a specified list style. Optionally, you can also pass a level and a number.
182 \membersection{wxRichTextCtrl::BeginNumberedBullet
}\label{wxrichtextctrlbeginnumberedbullet
}
184 \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}}
186 Begins a numbered bullet. This call will be needed for each item in the list, and the
187 application should take care of incrementing the numbering.
189 {\it bulletNumber
} is a number, usually starting with
1.
191 {\it leftIndent
} and
{\it leftSubIndent
} are values in tenths of a millimetre.
193 {\it bulletStyle
} is a bitlist of the following values:
197 #define wxTEXT_ATTR_BULLET_STYLE_NONE
0x00000000
198 #define wxTEXT_ATTR_BULLET_STYLE_ARABIC
0x00000001
199 #define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER
0x00000002
200 #define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER
0x00000004
201 #define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER
0x00000008
202 #define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER
0x00000010
203 #define wxTEXT_ATTR_BULLET_STYLE_SYMBOL
0x00000020
204 #define wxTEXT_ATTR_BULLET_STYLE_BITMAP
0x00000040
205 #define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES
0x00000080
206 #define wxTEXT_ATTR_BULLET_STYLE_PERIOD
0x00000100
207 #define wxTEXT_ATTR_BULLET_STYLE_STANDARD
0x00000200
208 #define wxTEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS
0x00000400
209 #define wxTEXT_ATTR_BULLET_STYLE_OUTLINE
0x00000800
210 #define wxTEXT_ATTR_BULLET_STYLE_ALIGN_LEFT
0x00000000
211 #define wxTEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT
0x00001000
212 #define wxTEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE
0x00002000
216 wxRichTextBuffer uses indentation to render a bulleted item. The left indent is the distance between
217 the margin and the bullet. The content of the paragraph, including the first line, starts
218 at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the
219 left of the actual paragraph is leftSubIndent.
221 \membersection{wxRichTextCtrl::BeginParagraphSpacing
}\label{wxrichtextctrlbeginparagraphspacing
}
223 \func{bool
}{BeginParagraphSpacing
}{\param{int
}{before
},
\param{int
}{after
}}
225 Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of
228 \membersection{wxRichTextCtrl::BeginParagraphStyle
}\label{wxrichtextctrlbeginparagraphstyle
}
230 \func{bool
}{BeginParagraphStyle
}{\param{const wxString\&
}{paragraphStyle
}}
232 Begins applying the named paragraph style.
234 \membersection{wxRichTextCtrl::BeginRightIndent
}\label{wxrichtextctrlbeginrightindent
}
236 \func{bool
}{BeginRightIndent
}{\param{int
}{rightIndent
}}
238 Begins a right indent, specified in tenths of a millimetre.
240 \membersection{wxRichTextCtrl::BeginStyle
}\label{wxrichtextctrlbeginstyle
}
242 \func{bool
}{BeginStyle
}{\param{const wxTextAttrEx\&
}{style
}}
244 Begins applying a style.
246 \membersection{wxRichTextCtrl::BeginSuppressUndo
}\label{wxrichtextctrlbeginsuppressundo
}
248 \func{bool
}{BeginSuppressUndo
}{\void}
250 Starts suppressing undo history for commands.
252 \membersection{wxRichTextCtrl::BeginSymbolBullet
}\label{wxrichtextctrlbeginsymbolbullet
}
254 \func{bool
}{BeginSymbolBullet
}{\param{wxChar
}{symbol
},
\param{int
}{leftIndent
},
\param{int
}{leftSubIndent
},
\param{int
}{bulletStyle = wxTEXT
\_ATTR\_BULLET\_STYLE\_SYMBOL}}
256 Begins applying a symbol bullet, using a character from the current font. See
\helpref{BeginNumberedBullet
}{wxrichtextctrlbeginnumberedbullet
} for
257 an explanation of how indentation is used to render the bulleted paragraph.
259 \membersection{wxRichTextCtrl::BeginTextColour
}\label{wxrichtextctrlbegintextcolour
}
261 \func{bool
}{BeginTextColour
}{\param{const wxColour\&
}{colour
}}
263 Begins using this colour.
265 \membersection{wxRichTextCtrl::BeginUnderline
}\label{wxrichtextctrlbeginunderline
}
267 \func{bool
}{BeginUnderline
}{\void}
269 Begins using underlining.
271 \membersection{wxRichTextCtrl::BeginURL
}\label{wxrichtextctrlbeginurl
}
273 \func{bool
}{BeginURL
}{\param{const wxString\&
}{ url
},
\param{const wxString\&
}{ characterStyle = wxEmptyString
}}
275 Begins applying wxTEXT
\_ATTR\_URL to the content. Pass a URL and optionally, a character style to apply,
276 since it is common to mark a URL with a familiar style such as blue text with underlining.
278 \membersection{wxRichTextCtrl::CanCopy
}\label{wxrichtextctrlcancopy
}
280 \constfunc{bool
}{CanCopy
}{\void}
282 Returns
\true if selected content can be copied to the clipboard.
284 \membersection{wxRichTextCtrl::CanCut
}\label{wxrichtextctrlcancut
}
286 \constfunc{bool
}{CanCut
}{\void}
288 Returns
\true if selected content can be copied to the clipboard and deleted.
290 \membersection{wxRichTextCtrl::CanDeleteSelection
}\label{wxrichtextctrlcandeleteselection
}
292 \constfunc{bool
}{CanDeleteSelection
}{\void}
294 Returns
\true if selected content can be deleted.
296 \membersection{wxRichTextCtrl::CanPaste
}\label{wxrichtextctrlcanpaste
}
298 \constfunc{bool
}{CanPaste
}{\void}
300 Returns
\true if the clipboard content can be pasted to the buffer.
302 \membersection{wxRichTextCtrl::CanRedo
}\label{wxrichtextctrlcanredo
}
304 \constfunc{bool
}{CanRedo
}{\void}
306 Returns
\true if there is a command in the command history that can be redone.
308 \membersection{wxRichTextCtrl::CanUndo
}\label{wxrichtextctrlcanundo
}
310 \constfunc{bool
}{CanUndo
}{\void}
312 Returns
\true if there is a command in the command history that can be undone.
314 \membersection{wxRichTextCtrl::Clear
}\label{wxrichtextctrlclear
}
316 \func{void
}{Clear
}{\void}
318 Clears the buffer content, leaving a single empty paragraph. Cannot be undone.
320 \membersection{wxRichTextCtrl::ClearListStyle
}\label{wxrichtextctrlclearliststyle
}
322 \func{bool
}{ClearListStyle
}{\param{const wxRichTextRange\&
}{range
},
\param{int
}{flags $=$ wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO}}
324 \func{bool
}{ClearListStyle
}{\param{const wxRichTextRange\&
}{range
},
\param{int
}{flags $=$ wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO}}
326 Clears the list style from the given range, clearing list-related attributes and applying any named paragraph style associated with each paragraph.
328 {\it flags
} is a bit list of the following:
330 \begin{itemize
}\itemsep=
0pt
331 \item wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO: specifies that this command will be undoable.
334 See also
\helpref{wxRichTextCtrl::SetListStyle
}{wxrichtextctrlsetliststyle
},
\helpref{wxRichTextCtrl::PromoteList
}{wxrichtextctrlpromotelist
},
\helpref{wxRichTextCtrl::NumberList
}{wxrichtextctrlnumberlist
}.
336 \membersection{wxRichTextCtrl::Command
}\label{wxrichtextctrlcommand
}
338 \func{void
}{Command
}{\param{wxCommandEvent\&
}{event
}}
340 Sends the event to the control.
342 \membersection{wxRichTextCtrl::Copy
}\label{wxrichtextctrlcopy
}
344 \func{void
}{Copy
}{\void}
346 Copies the selected content (if any) to the clipboard.
348 \membersection{wxRichTextCtrl::Create
}\label{wxrichtextctrlcreate
}
350 \func{bool
}{Create
}{\param{wxWindow*
}{parent
},
\param{wxWindowID
}{id = wxID
\_ANY},
\param{const wxString\&
}{value = wxEmptyString
},
351 \param{const wxPoint\&
}{pos = wxDefaultPosition
},
\param{const wxSize\&
}{size = wxDefaultSize
},
\param{long
}{style = wxRE
\_MULTILINE},
352 \param{const wxValidator\&
}{validator = wxDefaultValidator
},
\param{const wxString\&
}{name = wxTextCtrlNameStr
}}
354 Creates the underlying window.
356 \membersection{wxRichTextCtrl::Cut
}\label{wxrichtextctrlcut
}
358 \func{void
}{Cut
}{\void}
360 Copies the selected content (if any) to the clipboard and deletes the selection.
363 \membersection{wxRichTextCtrl::Delete
}\label{wxrichtextctrldelete
}
365 \func{bool
}{Delete
}{\param{const wxRichTextRange\&
}{ range
}}
367 Deletes the content within the given range.
369 \membersection{wxRichTextCtrl::DeleteSelectedContent
}\label{wxrichtextctrldeleteselectedcontent
}
371 \func{bool
}{DeleteSelectedContent
}{\param{long*
}{newPos = NULL
}}
373 Deletes content if there is a selection, e.g. when pressing a key.
374 Returns the new caret position in
{\it newPos
}, or leaves it if there
375 was no action. This is undoable.
377 \membersection{wxRichTextCtrl::DeleteSelection
}\label{wxrichtextctrldeleteselection
}
379 \func{void
}{DeleteSelection
}{\void}
381 Deletes the content in the selection, if any. This is undoable.
383 \membersection{wxRichTextCtrl::DiscardEdits
}\label{wxrichtextctrldiscardedits
}
385 \func{void
}{DiscardEdits
}{\void}
387 Sets the buffer's modified status to
\false, and clears the buffer's command history.
389 \membersection{wxRichTextCtrl::DoGetBestSize
}\label{wxrichtextctrldogetbestsize
}
391 \constfunc{wxSize
}{DoGetBestSize
}{\void}
393 Currently this simply returns
{\tt wxSize(
10,
10)
}.
395 \membersection{wxRichTextCtrl::EndAlignment
}\label{wxrichtextctrlendalignment
}
397 \func{bool
}{EndAlignment
}{\void}
401 \membersection{wxRichTextCtrl::EndAllStyles
}\label{wxrichtextctrlendallstyles
}
403 \func{bool
}{EndAllStyles
}{\void}
405 Ends application of all styles in the current style stack.
407 \membersection{wxRichTextCtrl::EndBatchUndo
}\label{wxrichtextctrlendbatchundo
}
409 \func{bool
}{EndBatchUndo
}{\void}
411 Ends batching undo command history.
413 \membersection{wxRichTextCtrl::EndBold
}\label{wxrichtextctrlendbold
}
415 \func{bool
}{EndBold
}{\void}
419 \membersection{wxRichTextCtrl::EndCharacterStyle
}\label{wxrichtextctrlendcharacterstyle
}
421 \func{bool
}{EndCharacterStyle
}{\void}
423 Ends application of a named character style.
425 \membersection{wxRichTextCtrl::EndFont
}\label{wxrichtextctrlendfont
}
427 \func{bool
}{EndFont
}{\void}
431 \membersection{wxRichTextCtrl::EndFontSize
}\label{wxrichtextctrlendfontsize
}
433 \func{bool
}{EndFontSize
}{\void}
435 Ends using a point size.
437 \membersection{wxRichTextCtrl::EndItalic
}\label{wxrichtextctrlenditalic
}
439 \func{bool
}{EndItalic
}{\void}
443 \membersection{wxRichTextCtrl::EndLeftIndent
}\label{wxrichtextctrlendleftindent
}
445 \func{bool
}{EndLeftIndent
}{\void}
449 \membersection{wxRichTextCtrl::EndLineSpacing
}\label{wxrichtextctrlendlinespacing
}
451 \func{bool
}{EndLineSpacing
}{\void}
455 \membersection{wxRichTextCtrl::EndListStyle
}\label{wxrichtextctrlendliststyle
}
457 \func{bool
}{EndListStyle
}{\void}
459 Ends using a specified list style.
461 \membersection{wxRichTextCtrl::EndNumberedBullet
}\label{wxrichtextctrlendnumberedbullet
}
463 \func{bool
}{EndNumberedBullet
}{\void}
465 Ends application of a numbered bullet.
467 \membersection{wxRichTextCtrl::EndParagraphSpacing
}\label{wxrichtextctrlendparagraphspacing
}
469 \func{bool
}{EndParagraphSpacing
}{\void}
471 Ends paragraph spacing.
473 \membersection{wxRichTextCtrl::EndParagraphStyle
}\label{wxrichtextctrlendparagraphstyle
}
475 \func{bool
}{EndParagraphStyle
}{\void}
477 Ends application of a named character style.
479 \membersection{wxRichTextCtrl::EndRightIndent
}\label{wxrichtextctrlendrightindent
}
481 \func{bool
}{EndRightIndent
}{\void}
485 \membersection{wxRichTextCtrl::EndStyle
}\label{wxrichtextctrlendstyle
}
487 \func{bool
}{EndStyle
}{\void}
489 Ends the current style.
491 \membersection{wxRichTextCtrl::EndSuppressUndo
}\label{wxrichtextctrlendsuppressundo
}
493 \func{bool
}{EndSuppressUndo
}{\void}
495 Ends suppressing undo command history.
497 \membersection{wxRichTextCtrl::EndSymbolBullet
}\label{wxrichtextctrlendsymbolbullet
}
499 \func{bool
}{EndSymbolBullet
}{\void}
501 Ends applying a symbol bullet.
503 \membersection{wxRichTextCtrl::EndTextColour
}\label{wxrichtextctrlendtextcolour
}
505 \func{bool
}{EndTextColour
}{\void}
507 Ends applying a text colour.
509 \membersection{wxRichTextCtrl::EndUnderline
}\label{wxrichtextctrlendunderline
}
511 \func{bool
}{EndUnderline
}{\void}
513 End applying underlining.
515 \membersection{wxRichTextCtrl::EndURL
}\label{wxrichtextctrlendurl
}
517 \func{bool
}{EndURL
}{\void}
521 \membersection{wxRichTextCtrl::ExtendSelection
}\label{wxrichtextctrlextendselection
}
523 \func{bool
}{ExtendSelection
}{\param{long
}{oldPosition
},
\param{long
}{newPosition
},
\param{int
}{flags
}}
525 Helper function for extending the selection, returning
\true if the selection was
526 changed. Selections are in caret positions.
528 \membersection{wxRichTextCtrl::FindNextWordPosition
}\label{wxrichtextctrlfindnextwordposition
}
530 \constfunc{long
}{FindNextWordPosition
}{\param{int
}{direction =
1}}
532 Helper function for finding the caret position for the next word. Direction
533 is
1 (forward) or -
1 (backwards).
535 \membersection{wxRichTextCtrl::Freeze
}\label{wxrichtextctrlfreeze
}
537 \func{void
}{Freeze
}{\void}
539 Call this function to prevent refresh and allow fast updates, and then
\helpref{Thaw
}{wxrichtextctrlthaw
} to
542 \membersection{wxRichTextCtrl::GetBasicStyle
}\label{wxrichtextctrlgetbasicstyle
}
544 \constfunc{const wxTextAttrEx\&
}{GetBasicStyle
}{\void}
546 Gets the basic (overall) style. This is the style of the whole
547 buffer before further styles are applied, unlike the default style, which
548 only affects the style currently being applied (for example, setting the default
549 style to bold will cause subsequently inserted text to be bold).
551 \membersection{wxRichTextCtrl::GetBuffer
}\label{wxrichtextctrlgetbuffer
}
553 \constfunc{const wxRichTextBuffer\&
}{GetBuffer
}{\void}
555 \func{wxRichTextBuffer\&
}{GetBuffer
}{\void}
557 Returns the buffer associated with the control.
559 \membersection{wxRichTextCtrl::GetCaretPosition
}\label{wxrichtextctrlgetcaretposition
}
561 \constfunc{long
}{GetCaretPosition
}{\void}
563 Returns the current caret position.
565 \membersection{wxRichTextCtrl::GetCaretPositionForIndex
}\label{wxrichtextctrlgetcaretpositionforindex
}
567 \func{bool
}{GetCaretPositionForIndex
}{\param{long
}{position
},
\param{wxRect\&
}{rect
}}
569 Returns the caret height and position for the given character position
571 \membersection{wxRichTextCtrl::GetCommandProcessor
}\label{wxrichtextctrlgetcommandprocessor
}
573 \constfunc{wxCommandProcessor*
}{GetCommandProcessor
}{\void}
575 Gets the command processor associated with the control's buffer.
577 \membersection{wxRichTextCtrl::GetDefaultStyleEx
}\label{wxrichtextctrlgetdefaultstyleex
}
579 \constfunc{const wxTextAttrEx\&
}{GetDefaultStyleEx
}{\void}
581 Returns the current default style, which can be used to change how subsequently inserted
582 text is displayed. When wxTextAttrEx is merged with wxTextAttr, this function
583 will become GetDefaultStyle.
585 \membersection{wxRichTextCtrl::GetDelayedLayoutThreshold
}\label{wxrichtextctrlgetdelayedlayoutthreshold
}
587 \constfunc{long
}{GetDelayedLayoutThreshold
}{\void}
589 Gets the size of the buffer beyond which layout is delayed during resizing.
590 This optimizes sizing for large buffers. The default is
20000.
592 \membersection{wxRichTextCtrl::GetFilename
}\label{wxrichtextctrlgetfilename
}
594 \constfunc{wxString
}{GetFilename
}{\void}
596 Gets the current filename associated with the control.
598 \membersection{wxRichTextCtrl::GetFirstVisiblePosition
}\label{wxrichtextctrlgetfirstvisibleposition
}
600 \constfunc{long
}{GetFirstVisiblePosition
}{\void}
602 Returns the first visible position in the current view.
604 \membersection{wxRichTextCtrl::GetHandlerFlags
}\label{wxrichtextfilehandlergethandlerflags
}
606 \constfunc{int
}{GetHandlerFlags
}{\void}
608 Returns flags that change the behaviour of loading or saving. See the documentation for each
609 handler class to see what flags are relevant for each handler.
611 \membersection{wxRichTextCtrl::GetInsertionPoint
}\label{wxrichtextctrlgetinsertionpoint
}
613 \constfunc{long
}{GetInsertionPoint
}{\void}
615 Returns the current insertion point.
617 \membersection{wxRichTextCtrl::GetLastPosition
}\label{wxrichtextctrlgetlastposition
}
619 \constfunc{wxTextPos
}{GetLastPosition
}{\void}
621 Returns the last position in the buffer.
623 \membersection{wxRichTextCtrl::GetLineLength
}\label{wxrichtextctrlgetlinelength
}
625 \constfunc{int
}{GetLineLength
}{\param{long
}{lineNo
}}
627 Returns the length of the specified line in characters.
629 \membersection{wxRichTextCtrl::GetLineText
}\label{wxrichtextctrlgetlinetext
}
631 \constfunc{wxString
}{GetLineText
}{\param{long
}{lineNo
}}
633 Returns the text for the given line.
635 \membersection{wxRichTextCtrl::GetLogicalPoint
}\label{wxrichtextctrlgetlogicalpoint
}
637 \constfunc{wxPoint
}{GetLogicalPoint
}{\param{const wxPoint\&
}{ptPhysical
}}
639 Transforms physical window position to logical (unscrolled) position.
641 \membersection{wxRichTextCtrl::GetNumberOfLines
}\label{wxrichtextctrlgetnumberoflines
}
643 \constfunc{int
}{GetNumberOfLines
}{\void}
645 Returns the number of lines in the buffer.
647 \membersection{wxRichTextCtrl::GetPhysicalPoint
}\label{wxrichtextctrlgetphysicalpoint
}
649 \constfunc{wxPoint
}{GetPhysicalPoint
}{\param{const wxPoint\&
}{ptLogical
}}
651 Transforms logical (unscrolled) position to physical window position.
653 \membersection{wxRichTextCtrl::GetRange
}\label{wxrichtextctrlgetrange
}
655 \constfunc{wxString
}{GetRange
}{\param{long
}{from
},
\param{long
}{to
}}
657 Gets the text for the given range.
659 The end point of range is specified as the last character position of the span of text, plus one.
661 \membersection{wxRichTextCtrl::GetSelection
}\label{wxrichtextctrlgetselection
}
663 \constfunc{void
}{GetSelection
}{\param{long*
}{from
},
\param{long*
}{to
}}
665 Returns the range of the current selection.
667 The end point of range is specified as the last character position of the span of text, plus one.
669 If the return values
{\it from
} and
{\it to
} are the same, there is no selection.
671 \membersection{wxRichTextCtrl::GetSelectionRange
}\label{wxrichtextctrlgetselectionrange
}
673 \constfunc{const wxRichTextRange\&
}{GetSelectionRange
}{\void}
675 Returns the selection range in character positions. -
1, -
1 means no selection.
677 \membersection{wxRichTextCtrl::GetStringSelection
}\label{wxrichtextctrlgetstringselection
}
679 \constfunc{wxString
}{GetStringSelection
}{\void}
681 Returns the text within the current selection range, if any.
683 \membersection{wxRichTextCtrl::GetStyle
}\label{wxrichtextctrlgetstyle
}
685 \func{bool
}{GetStyle
}{\param{long
}{position
},
\param{wxRichTextAttr\&
}{style
}}
687 \func{bool
}{GetStyle
}{\param{long
}{position
},
\param{wxTextAttrEx\&
}{style
}}
689 \func{bool
}{GetStyle
}{\param{long
}{position
},
\param{wxTextAttr\&
}{style
}}
691 Gets the attributes at the given position. The wxRichTextAttr version is generally more efficient
692 because it does not use wxFont objects.
694 This function gets the combined style - that is, the style you see on the screen as a result
695 of combining base style, paragraph style and character style attributes. To get the character
696 or paragraph style alone, use
\helpref{GetUncombinedStyle
}{wxrichtextctrlgetuncombinedstyle
}.
698 \membersection{wxRichTextCtrl::GetStyleForRange
}\label{wxrichtextctrlgetstyleforrange
}
700 \func{bool
}{GetStyleForRange
}{\param{const wxRichTextRange\&
}{range
},
\param{wxRichTextAttr\&
}{style
}}
702 \func{bool
}{GetStyleForRange
}{\param{const wxRichTextRange\&
}{range
},
\param{wxTextAttrEx\&
}{style
}}
704 Gets the attributes common to the specified range. Attributes that differ in value within the range will
705 not be included in
{\it style
}'s flags.
707 \membersection{wxRichTextCtrl::GetStyleSheet
}\label{wxrichtextctrlgetstylesheet
}
709 \constfunc{wxRichTextStyleSheet*
}{GetStyleSheet
}{\void}
711 Returns the style sheet associated with the control, if any. A style sheet allows named
712 character and paragraph styles to be applied.
714 \membersection{wxRichTextCtrl::GetUncombinedStyle
}\label{wxrichtextctrlgetuncombinedstyle
}
716 \func{bool
}{GetUncombinedStyle
}{\param{long
}{position
},
\param{wxRichTextAttr\&
}{style
}}
718 \func{bool
}{GetUncombinedStyle
}{\param{long
}{position
},
\param{wxTextAttrEx\&
}{style
}}
720 \func{bool
}{GetUncombinedStyle
}{\param{long
}{position
},
\param{wxTextAttr\&
}{style
}}
722 Gets the attributes at the given position. The wxRichTextAttr version is generally more efficient
723 because it does not use wxFont objects.
725 This function gets the
{\it uncombined style
} - that is, the attributes associated with the
726 paragraph or character content, and not necessarily the combined attributes you see on the
727 screen. To get the combined attributes, use
\helpref{GetStyle
}{wxrichtextctrlgetstyle
}.
729 If you specify (any) paragraph attribute in
{\it style
}'s flags, this function will fetch
730 the paragraph attributes. Otherwise, it will return the character attributes.
732 \membersection{wxRichTextCtrl::GetValue
}\label{wxrichtextctrlgetvalue
}
734 \constfunc{wxString
}{GetValue
}{\void}
736 Returns the content of the entire control as a string.
738 \membersection{wxRichTextCtrl::GetVisibleLineForCaretPosition
}\label{wxrichtextctrlgetvisiblelineforcaretposition
}
740 \constfunc{wxRichTextLine*
}{GetVisibleLineForCaretPosition
}{\param{long
}{caretPosition
}}
742 Internal helper function returning the line for the visible caret position. If the caret is
743 shown at the very end of the line, it means the next character is actually
744 on the following line. So this function gets the line we're expecting to find
747 \membersection{wxRichTextCtrl::HasCharacterAttributes
}\label{wxrichtextctrlhascharacterattributes
}
749 \constfunc{bool
}{HasCharacterAttributes
}{\param{const wxRichTextRange\&
}{range
},
\param{const wxTextAttrEx\&
}{style
}}
751 \constfunc{bool
}{HasCharacterAttributes
}{\param{const wxRichTextRange\&
}{range
},
\param{const wxRichTextAttr\&
}{style
}}
753 Test if this whole range has character attributes of the specified kind. If any
754 of the attributes are different within the range, the test fails. You
755 can use this to implement, for example, bold button updating.
{\it style
} must have
756 flags indicating which attributes are of interest.
758 \membersection{wxRichTextCtrl::HasParagraphAttributes
}\label{wxrichtextctrlhasparagraphattributes
}
760 \constfunc{bool
}{HasParagraphAttributes
}{\param{const wxRichTextRange\&
}{range
},
\param{const wxTextAttrEx\&
}{style
}}
762 \constfunc{bool
}{HasParagraphAttributes
}{\param{const wxRichTextRange\&
}{range
},
\param{const wxRichTextAttr\&
}{style
}}
764 Test if this whole range has paragraph attributes of the specified kind. If any
765 of the attributes are different within the range, the test fails. You
766 can use this to implement, for example, centering button updating.
{\it style
} must have
767 flags indicating which attributes are of interest.
769 \membersection{wxRichTextCtrl::HasSelection
}\label{wxrichtextctrlhasselection
}
771 \constfunc{bool
}{HasSelection
}{\void}
773 Returns
\true if there is a selection.
775 \membersection{wxRichTextCtrl::HitTest
}\label{wxrichtextctrlhittest
}
777 \constfunc{wxTextCtrlHitTestResult
}{HitTest
}{\param{const wxPoint\&
}{pt
},
\param{long*
}{pos
}}
779 \constfunc{wxTextCtrlHitTestResult
}{HitTest
}{\param{const wxPoint\&
}{pt
},
\param{wxTextCoord*
}{col
},
\param{wxTextCoord*
}{row
}}
781 Finds the character at the given position in pixels.
783 {\it pt
} is in device coords (not adjusted for the client area origin nor for scrolling).
785 \membersection{wxRichTextCtrl::Init
}\label{wxrichtextctrlinit
}
787 \func{void
}{Init
}{\void}
789 Initialises the members of the control.
791 \membersection{wxRichTextCtrl::InitCommandEvent
}\label{wxrichtextctrlinitcommandevent
}
793 \constfunc{void
}{InitCommandEvent
}{\param{wxCommandEvent\&
}{event
}}
795 Initialises the command event.
797 \membersection{wxRichTextCtrl::IsDefaultStyleShowing
}\label{wxrichtextctrlisdefaultstyleshowing
}
799 \constfunc{bool
}{IsDefaultStyleShowing
}{\void}
801 Returns
\true if the user has recently set the default style without moving the caret,
802 and therefore the UI needs to reflect the default style and not the style at the caret.
804 Below is an example of code that uses this function to determine whether the UI
805 should show that the current style is bold.
808 /// Is all of the selection bold?
809 bool wxRichTextCtrl::IsSelectionBold()
814 wxRichTextRange range = GetInternalSelectionRange();
815 attr.SetFlags(wxTEXT_ATTR_FONT_WEIGHT);
816 attr.SetFontWeight(wxBOLD);
818 return HasCharacterAttributes(range, attr);
822 // If no selection, then we need to combine current style with default style
823 // to see what the effect would be if we started typing.
825 attr.SetFlags(wxTEXT_ATTR_FONT_WEIGHT);
827 long pos = GetAdjustedCaretPosition(GetCaretPosition());
828 if (GetStyle(pos, attr))
830 if (IsDefaultStyleShowing())
831 wxRichTextApplyStyle(attr, GetDefaultStyleEx());
832 return attr.GetFontWeight() == wxBOLD;
839 See also
\helpref{SetAndShowDefaultStyle
}{wxrichtextctrlsetandshowdefaultstyle
}.
841 \membersection{wxRichTextCtrl::IsEditable
}\label{wxrichtextctrliseditable
}
843 \constfunc{bool
}{IsEditable
}{\void}
845 Returns
\true if the control is editable.
847 \membersection{wxRichTextCtrl::IsFrozen
}\label{wxrichtextctrlisfrozen
}
849 \constfunc{bool
}{IsFrozen
}{\void}
851 Returns
\true if Freeze has been called without a Thaw.
853 \membersection{wxRichTextCtrl::IsModified
}\label{wxrichtextctrlismodified
}
855 \constfunc{bool
}{IsModified
}{\void}
857 Returns
\true if the buffer has been modified.
859 \membersection{wxRichTextCtrl::IsMultiLine
}\label{wxrichtextctrlismultiline
}
861 \constfunc{bool
}{IsMultiLine
}{\void}
863 Returns
\true if the control is multiline.
865 \membersection{wxRichTextCtrl::IsPositionVisible
}\label{wxrichtextctrlispositionvisible
}
867 \constfunc{bool
}{IsPositionVisible
}{\param{long
}{pos
}}
869 Returns
\true if the given position is visible on the screen.
871 \membersection{wxRichTextCtrl::IsSelectionAligned
}\label{wxrichtextctrlisselectionaligned
}
873 \constfunc{bool
}{IsSelectionAligned
}{\param{wxTextAttrAlignment
}{alignment
}}
875 Returns
\true if all of the selection is aligned according to the specified flag.
877 \membersection{wxRichTextCtrl::IsSelectionBold
}\label{wxrichtextctrlisselectionbold
}
879 \constfunc{bool
}{IsSelectionBold
}{\void}
881 Returns
\true if all of the selection is bold.
883 \membersection{wxRichTextCtrl::IsSelectionItalics
}\label{wxrichtextctrlisselectionitalics
}
885 \constfunc{bool
}{IsSelectionItalics
}{\void}
887 Returns
\true if all of the selection is italic.
889 \membersection{wxRichTextCtrl::IsSelectionUnderlined
}\label{wxrichtextctrlisselectionunderlined
}
891 \constfunc{bool
}{IsSelectionUnderlined
}{\void}
893 Returns
\true if all of the selection is underlined.
895 \membersection{wxRichTextCtrl::IsSingleLine
}\label{wxrichtextctrlissingleline
}
897 \constfunc{bool
}{IsSingleLine
}{\void}
899 Returns
\true if the control is single-line. Currently wxRichTextCtrl does not
900 support single-line editing.
902 \membersection{wxRichTextCtrl::KeyboardNavigate
}\label{wxrichtextctrlkeyboardnavigate
}
904 \func{bool
}{KeyboardNavigate
}{\param{int
}{keyCode
},
\param{int
}{flags
}}
906 Helper function implementing keyboard navigation.
908 \membersection{wxRichTextCtrl::LayoutContent
}\label{wxrichtextctrllayoutcontent
}
910 \func{bool
}{LayoutContent
}{\param{bool
}{onlyVisibleRect = false
}}
912 Lays out the buffer, which must be done before certain operations, such as
913 setting the caret position. This function should not normally be required by the
916 \membersection{wxRichTextCtrl::LineBreak
}\label{wxrichtextctrllinebreak
}
918 \func{bool
}{LineBreak
}{\void}
920 Inserts a line break at the current insertion point. A line break forces wrapping within a paragraph, and
921 can be introduced by using this function, by appending the wxChar value
{\bf wxRichTextLineBreakChar
} to text content,
922 or by typing Shift-Return.
924 \membersection{wxRichTextCtrl::LoadFile
}\label{wxrichtextctrlloadfile
}
926 \func{bool
}{LoadFile
}{\param{const wxString\&
}{file
},
\param{int
}{type = wxRICHTEXT
\_TYPE\_ANY}}
928 Loads content into the control's buffer using the given type. If the specified type
929 is wxRICHTEXT
\_TYPE\_ANY, the type is deduced from the filename extension.
931 This function looks for a suitable
\helpref{wxRichTextFileHandler
}{wxrichtextfilehandler
} object.
933 \membersection{wxRichTextCtrl::MarkDirty
}\label{wxrichtextctrlmarkdirty
}
935 \func{void
}{MarkDirty
}{\void}
937 Marks the buffer as modified.
939 \membersection{wxRichTextCtrl::MoveCaret
}\label{wxrichtextctrlmovecaret
}
941 \func{bool
}{MoveCaret
}{\param{long
}{pos
},
\param{bool
}{showAtLineStart = false
}}
943 Move the caret to the given character position.
945 \membersection{wxRichTextCtrl::MoveCaretBack
}\label{wxrichtextctrlmovecaretback
}
947 \func{void
}{MoveCaretBack
}{\param{long
}{oldPosition
}}
949 Move the caret one visual step forward: this may mean setting a flag
950 and keeping the same position if we're going from the end of one line
951 to the start of the next, which may be the exact same caret position.
953 \membersection{wxRichTextCtrl::MoveCaretForward
}\label{wxrichtextctrlmovecaretforward
}
955 \func{void
}{MoveCaretForward
}{\param{long
}{oldPosition
}}
957 Move the caret one visual step forward: this may mean setting a flag
958 and keeping the same position if we're going from the end of one line
959 to the start of the next, which may be the exact same caret position.
961 \membersection{wxRichTextCtrl::MoveDown
}\label{wxrichtextctrlmovedown
}
963 \func{bool
}{MoveDown
}{\param{int
}{noLines =
1},
\param{int
}{flags =
0}}
965 Moves the caret down.
967 \membersection{wxRichTextCtrl::MoveEnd
}\label{wxrichtextctrlmoveend
}
969 \func{bool
}{MoveEnd
}{\param{int
}{flags =
0}}
971 Moves to the end of the buffer.
973 \membersection{wxRichTextCtrl::MoveHome
}\label{wxrichtextctrlmovehome
}
975 \func{bool
}{MoveHome
}{\param{int
}{flags =
0}}
977 Moves to the start of the buffer.
979 \membersection{wxRichTextCtrl::MoveLeft
}\label{wxrichtextctrlmoveleft
}
981 \func{bool
}{MoveLeft
}{\param{int
}{noPositions =
1},
\param{int
}{flags =
0}}
985 \membersection{wxRichTextCtrl::MoveRight
}\label{wxrichtextctrlmoveright
}
987 \func{bool
}{MoveRight
}{\param{int
}{noPositions =
1},
\param{int
}{flags =
0}}
991 \membersection{wxRichTextCtrl::MoveToLineEnd
}\label{wxrichtextctrlmovetolineend
}
993 \func{bool
}{MoveToLineEnd
}{\param{int
}{flags =
0}}
995 Moves to the end of the line.
997 \membersection{wxRichTextCtrl::MoveToLineStart
}\label{wxrichtextctrlmovetolinestart
}
999 \func{bool
}{MoveToLineStart
}{\param{int
}{flags =
0}}
1001 Moves to the start of the line.
1003 \membersection{wxRichTextCtrl::MoveToParagraphEnd
}\label{wxrichtextctrlmovetoparagraphend
}
1005 \func{bool
}{MoveToParagraphEnd
}{\param{int
}{flags =
0}}
1007 Moves to the end of the paragraph.
1009 \membersection{wxRichTextCtrl::MoveToParagraphStart
}\label{wxrichtextctrlmovetoparagraphstart
}
1011 \func{bool
}{MoveToParagraphStart
}{\param{int
}{flags =
0}}
1013 Moves to the start of the paragraph.
1015 \membersection{wxRichTextCtrl::MoveUp
}\label{wxrichtextctrlmoveup
}
1017 \func{bool
}{MoveUp
}{\param{int
}{noLines =
1},
\param{int
}{flags =
0}}
1021 \membersection{wxRichTextCtrl::Newline
}\label{wxrichtextctrlnewline
}
1023 \func{bool
}{Newline
}{\void}
1025 Inserts a new paragraph at the current insertion point. See also
\helpref{wxRichTextCtrl::LineBreak
}{wxrichtextctrllinebreak
}.
1027 \membersection{wxRichTextCtrl::NumberList
}\label{wxrichtextctrlnumberlist
}
1029 \func{bool
}{NumberList
}{\param{const wxRichTextRange\&
}{range
},
\param{const wxRichTextListStyleDefinition*
}{style
},
\param{int
}{flags $=$ wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO},
\param{int
}{ startFrom = -
1},
\param{int
}{ listLevel = -
1}}
1031 \func{bool
}{Number
}{\param{const wxRichTextRange\&
}{range
},
\param{const wxString\&
}{styleName
},
\param{int
}{flags $=$ wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO},
\param{int
}{ startFrom = -
1},
\param{int
}{ listLevel = -
1}}
1033 Numbers the paragraphs in the given range. Pass flags to determine how the attributes are set.
1034 Either the style definition or the name of the style definition (in the current sheet) can be passed.
1036 {\it flags
} is a bit list of the following:
1038 \begin{itemize
}\itemsep=
0pt
1039 \item wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO: specifies that this command will be undoable.
1040 \item wxRICHTEXT
\_SETSTYLE\_RENUMBER: specifies that numbering should start from
{\it startFrom
}, otherwise existing attributes are used.
1041 \item wxRICHTEXT
\_SETSTYLE\_SPECIFY\_LEVEL: specifies that
{\it listLevel
} should be used as the level for all paragraphs, otherwise the current indentation will be used.
1044 See also
\helpref{wxRichTextCtrl::SetListStyle
}{wxrichtextctrlsetliststyle
},
\helpref{wxRichTextCtrl::PromoteList
}{wxrichtextctrlpromotelist
},
\helpref{wxRichTextCtrl::ClearListStyle
}{wxrichtextctrlclearliststyle
}.
1046 \membersection{wxRichTextCtrl::OnClear
}\label{wxrichtextctrlonclear
}
1048 \func{void
}{OnClear
}{\param{wxCommandEvent\&
}{event
}}
1050 Standard handler for the wxID
\_CLEAR command.
1052 \membersection{wxRichTextCtrl::OnContextMenu
}\label{wxrichtextctrloncontextmenu
}
1054 \func{void
}{OnContextMenu
}{\param{wxContextMenuEvent\&
}{event
}}
1056 Shows a standard context menu with undo, redo, cut, copy, paste, clear, and select all commands.
1058 \membersection{wxRichTextCtrl::OnCopy
}\label{wxrichtextctrloncopy
}
1060 \func{void
}{OnCopy
}{\param{wxCommandEvent\&
}{event
}}
1062 Standard handler for the wxID
\_COPY command.
1064 \membersection{wxRichTextCtrl::OnCut
}\label{wxrichtextctrloncut
}
1066 \func{void
}{OnCut
}{\param{wxCommandEvent\&
}{event
}}
1068 Standard handler for the wxID
\_CUT command.
1070 \membersection{wxRichTextCtrl::OnDropFiles
}\label{wxrichtextctrlondropfiles
}
1072 \func{void
}{OnDropFiles
}{\param{wxDropFilesEvent\&
}{event
}}
1074 Loads the first dropped file.
1076 \membersection{wxRichTextCtrl::OnPaste
}\label{wxrichtextctrlonpaste
}
1078 \func{void
}{OnPaste
}{\param{wxCommandEvent\&
}{event
}}
1080 Standard handler for the wxID
\_PASTE command.
1082 \membersection{wxRichTextCtrl::OnRedo
}\label{wxrichtextctrlonredo
}
1084 \func{void
}{OnRedo
}{\param{wxCommandEvent\&
}{event
}}
1086 Standard handler for the wxID
\_REDO command.
1088 \membersection{wxRichTextCtrl::OnSelectAll
}\label{wxrichtextctrlonselectall
}
1090 \func{void
}{OnSelectAll
}{\param{wxCommandEvent\&
}{event
}}
1092 Standard handler for the wxID
\_SELECTALL command.
1094 \membersection{wxRichTextCtrl::OnUndo
}\label{wxrichtextctrlonundo
}
1096 \func{void
}{OnUndo
}{\param{wxCommandEvent\&
}{event
}}
1098 Standard handler for the wxID
\_PASTE command.
1100 \membersection{wxRichTextCtrl::OnUpdateClear
}\label{wxrichtextctrlonupdateclear
}
1102 \func{void
}{OnUpdateClear
}{\param{wxUpdateUIEvent\&
}{event
}}
1104 Standard update handler for the wxID
\_CLEAR command.
1106 \membersection{wxRichTextCtrl::OnUpdateCopy
}\label{wxrichtextctrlonupdatecopy
}
1108 \func{void
}{OnUpdateCopy
}{\param{wxUpdateUIEvent\&
}{event
}}
1110 Standard update handler for the wxID
\_COPY command.
1112 \membersection{wxRichTextCtrl::OnUpdateCut
}\label{wxrichtextctrlonupdatecut
}
1114 \func{void
}{OnUpdateCut
}{\param{wxUpdateUIEvent\&
}{event
}}
1116 Standard update handler for the wxID
\_CUT command.
1118 \membersection{wxRichTextCtrl::OnUpdatePaste
}\label{wxrichtextctrlonupdatepaste
}
1120 \func{void
}{OnUpdatePaste
}{\param{wxUpdateUIEvent\&
}{event
}}
1122 Standard update handler for the wxID
\_PASTE command.
1124 \membersection{wxRichTextCtrl::OnUpdateRedo
}\label{wxrichtextctrlonupdateredo
}
1126 \func{void
}{OnUpdateRedo
}{\param{wxUpdateUIEvent\&
}{event
}}
1128 Standard update handler for the wxID
\_REDO command.
1130 \membersection{wxRichTextCtrl::OnUpdateSelectAll
}\label{wxrichtextctrlonupdateselectall
}
1132 \func{void
}{OnUpdateSelectAll
}{\param{wxUpdateUIEvent\&
}{event
}}
1134 Standard update handler for the wxID
\_SELECTALL command.
1136 \membersection{wxRichTextCtrl::OnUpdateUndo
}\label{wxrichtextctrlonupdateundo
}
1138 \func{void
}{OnUpdateUndo
}{\param{wxUpdateUIEvent\&
}{event
}}
1140 Standard update handler for the wxID
\_UNDO command.
1142 \membersection{wxRichTextCtrl::PageDown
}\label{wxrichtextctrlpagedown
}
1144 \func{bool
}{PageDown
}{\param{int
}{noPages =
1},
\param{int
}{flags =
0}}
1146 Moves one or more pages down.
1148 \membersection{wxRichTextCtrl::PageUp
}\label{wxrichtextctrlpageup
}
1150 \func{bool
}{PageUp
}{\param{int
}{noPages =
1},
\param{int
}{flags =
0}}
1152 Moves one or more pages up.
1154 \membersection{wxRichTextCtrl::PaintBackground
}\label{wxrichtextctrlpaintbackground
}
1156 \func{void
}{PaintBackground
}{\param{wxDC\&
}{dc
}}
1158 Paints the background.
1160 \membersection{wxRichTextCtrl::Paste
}\label{wxrichtextctrlpaste
}
1162 \func{void
}{Paste
}{\void}
1164 Pastes content from the clipboard to the buffer.
1166 \membersection{wxRichTextCtrl::PositionCaret
}\label{wxrichtextctrlpositioncaret
}
1168 \func{void
}{PositionCaret
}{\void}
1170 Internal function to position the visible caret according to the current caret position.
1172 \membersection{wxRichTextCtrl::PositionToXY
}\label{wxrichtextctrlpositiontoxy
}
1174 \constfunc{bool
}{PositionToXY
}{\param{long
}{pos
},
\param{long*
}{x
},
\param{long*
}{y
}}
1176 Converts a text position to zero-based column and line numbers.
1178 \membersection{wxRichTextCtrl::PromoteList
}\label{wxrichtextctrlpromotelist
}
1180 \func{bool
}{PromoteList
}{\param{int
}{ promoteBy
},
\param{const wxRichTextRange\&
}{range
},
\param{const wxRichTextListStyleDefinition*
}{style
},
\param{int
}{flags $=$ wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO},
\param{int
}{ listLevel = -
1}}
1182 \func{bool
}{PromoteList
}{\param{int
}{ promoteBy
},
\param{const wxRichTextRange\&
}{range
},
\param{const wxString\&
}{styleName
},
\param{int
}{flags $=$ wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO},
\param{int
}{ listLevel = -
1}}
1184 Promotes or demotes the paragraphs in the given range. A positive
{\it promoteBy
} produces a smaller indent, and a negative number
1185 produces a larger indent. Pass flags to determine how the attributes are set.
1186 Either the style definition or the name of the style definition (in the current sheet) can be passed.
1188 {\it flags
} is a bit list of the following:
1190 \begin{itemize
}\itemsep=
0pt
1191 \item wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO: specifies that this command will be undoable.
1192 \item wxRICHTEXT
\_SETSTYLE\_RENUMBER: specifies that numbering should start from
{\it startFrom
}, otherwise existing attributes are used.
1193 \item wxRICHTEXT
\_SETSTYLE\_SPECIFY\_LEVEL: specifies that
{\it listLevel
} should be used as the level for all paragraphs, otherwise the current indentation will be used.
1196 See also
\helpref{wxRichTextCtrl::SetListStyle
}{wxrichtextctrlsetliststyle
}, See also
\helpref{wxRichTextCtrl::SetListStyle
}{wxrichtextctrlnumberlist
},
\helpref{wxRichTextCtrl::ClearListStyle
}{wxrichtextctrlclearliststyle
}.
1198 \membersection{wxRichTextCtrl::Redo
}\label{wxrichtextctrlredo
}
1200 \func{void
}{Redo
}{\void}
1202 Redoes the current command.
1204 \membersection{wxRichTextCtrl::Remove
}\label{wxrichtextctrlremove
}
1206 \func{void
}{Remove
}{\param{long
}{from
},
\param{long
}{to
}}
1208 Removes the content in the specified range.
1210 \membersection{wxRichTextCtrl::Replace
}\label{wxrichtextctrlreplace
}
1212 \func{void
}{Replace
}{\param{long
}{from
},
\param{long
}{to
},
\param{const wxString\&
}{value
}}
1214 Replaces the content in the specified range with the string specified by
{\it value
}.
1216 \membersection{wxRichTextCtrl::SaveFile
}\label{wxrichtextctrlsavefile
}
1218 \func{bool
}{SaveFile
}{\param{const wxString\&
}{file = wxEmptyString
},
\param{int
}{type = wxRICHTEXT
\_TYPE\_ANY}}
1220 Saves the buffer content using the given type. If the specified type
1221 is wxRICHTEXT
\_TYPE\_ANY, the type is deduced from the filename extension.
1223 This function looks for a suitable
\helpref{wxRichTextFileHandler
}{wxrichtextfilehandler
} object.
1225 \membersection{wxRichTextCtrl::ScrollIntoView
}\label{wxrichtextctrlscrollintoview
}
1227 \func{bool
}{ScrollIntoView
}{\param{long
}{position
},
\param{int
}{keyCode
}}
1229 Scrolls
{\it position
} into view. This function takes a caret position.
1231 \membersection{wxRichTextCtrl::SelectAll
}\label{wxrichtextctrlselectall
}
1233 \func{void
}{SelectAll
}{\void}
1235 Selects all the text in the buffer.
1237 \membersection{wxRichTextCtrl::SelectNone
}\label{wxrichtextctrlselectnone
}
1239 \func{void
}{SelectNone
}{\void}
1241 Cancels any selection.
1243 \membersection{wxRichTextCtrl::SetAndShowDefaultStyle
}\label{wxrichtextctrlsetandshowdefaultstyle
}
1245 \func{void
}{SetAndShowDefaultStyle
}{\param{const wxRichTextAttr\&
}{attr
}}
1247 Sets
{\it attr
} as the default style and tells the control that the UI should reflect
1248 this attribute until the user moves the caret.
1250 See also
\helpref{IsDefaultStyleShowing
}{wxrichtextctrlisdefaultstyleshowing
}.
1252 \membersection{wxRichTextCtrl::SetBasicStyle
}\label{wxrichtextctrlsetbasicstyle
}
1254 \func{void
}{SetBasicStyle
}{\param{const wxRichTextAttr\&
}{style
}}
1256 \func{void
}{SetBasicStyle
}{\param{const wxTextAttrEx\&
}{style
}}
1258 Sets the basic (overall) style. This is the style of the whole
1259 buffer before further styles are applied, unlike the default style, which
1260 only affects the style currently being applied (for example, setting the default
1261 style to bold will cause subsequently inserted text to be bold).
1263 \membersection{wxRichTextCtrl::SetCaretPosition
}\label{wxrichtextctrlsetcaretposition
}
1265 \func{void
}{SetCaretPosition
}{\param{long
}{position
},
\param{bool
}{showAtLineStart = false
}}
1267 The caret position is the character position just before the caret.
1268 A value of -
1 means the caret is at the start of the buffer.
1270 \membersection{wxRichTextCtrl::SetDefaultStyle
}\label{wxrichtextctrlsetdefaultstyle
}
1272 \func{bool
}{SetDefaultStyle
}{\param{const wxTextAttrEx\&
}{style
}}
1274 Sets the current default style, which can be used to change how subsequently inserted
1277 \membersection{wxRichTextCtrl::SetDefaultStyleToCursorStyle
}\label{wxrichtextctrlsetdefaultstyletocursorstyle
}
1279 \func{bool
}{SetDefaultStyleToCursorStyle
}{\void}
1281 Sets the default style to the style under the cursor.
1283 \membersection{wxRichTextCtrl::SetDelayedLayoutThreshold
}\label{wxrichtextctrlsetdelayedlayoutthreshold
}
1285 \func{void
}{SetDelayedLayoutThreshold
}{\param{long
}{threshold
}}
1287 Sets the size of the buffer beyond which layout is delayed during resizing.
1288 This optimizes sizing for large buffers. The default is
20000.
1290 \membersection{wxRichTextCtrl::SetEditable
}\label{wxrichtextctrlseteditable
}
1292 \func{void
}{SetEditable
}{\param{bool
}{editable
}}
1294 Makes the control editable, or not.
1296 \membersection{wxRichTextCtrl::SetFilename
}\label{wxrichtextctrlsetfilename
}
1298 \func{void
}{SetFilename
}{\param{const wxString\&
}{filename
}}
1300 Sets the current filename.
1302 \membersection{wxRichTextCtrl::SetFont
}\label{wxrichtextctrlsetfont
}
1304 \func{bool
}{SetFont
}{\param{const wxFont\&
}{font
}}
1306 Sets the font, and also the basic and default attributes (see
\helpref{SetDefaultStyle
}{wxrichtextctrlsetdefaultstyle
}).
1308 \membersection{wxRichTextCtrl::SetHandlerFlags
}\label{wxrichtextctrlsethandlerflags
}
1310 \func{void
}{SetHandlerFlags
}{\param{int
}{flags
}}
1312 Sets flags that change the behaviour of loading or saving. See the documentation for each
1313 handler class to see what flags are relevant for each handler.
1315 \membersection{wxRichTextCtrl::SetInsertionPoint
}\label{wxrichtextctrlsetinsertionpoint
}
1317 \func{void
}{SetInsertionPoint
}{\param{long
}{pos
}}
1319 Sets the insertion point.
1321 \membersection{wxRichTextCtrl::SetInsertionPointEnd
}\label{wxrichtextctrlsetinsertionpointend
}
1323 \func{void
}{SetInsertionPointEnd
}{\void}
1325 Sets the insertion point to the end of the text control.
1327 \membersection{wxRichTextCtrl::SetListStyle
}\label{wxrichtextctrlsetliststyle
}
1329 \func{bool
}{SetListStyle
}{\param{const wxRichTextRange\&
}{range
},
\param{const wxRichTextListStyleDefinition*
}{style
},
\param{int
}{flags $=$ wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO},
\param{int
}{ startFrom = -
1},
\param{int
}{ listLevel = -
1}}
1331 \func{bool
}{SetListStyle
}{\param{const wxRichTextRange\&
}{range
},
\param{const wxString\&
}{styleName
},
\param{int
}{flags $=$ wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO},
\param{int
}{ startFrom = -
1},
\param{int
}{ listLevel = -
1}}
1333 Sets the list attributes for the given range, passing flags to determine how the attributes are set.
1334 Either the style definition or the name of the style definition (in the current sheet) can be passed.
1336 {\it flags
} is a bit list of the following:
1338 \begin{itemize
}\itemsep=
0pt
1339 \item wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO: specifies that this command will be undoable.
1340 \item wxRICHTEXT
\_SETSTYLE\_RENUMBER: specifies that numbering should start from
{\it startFrom
}, otherwise existing attributes are used.
1341 \item wxRICHTEXT
\_SETSTYLE\_SPECIFY\_LEVEL: specifies that
{\it listLevel
} should be used as the level for all paragraphs, otherwise the current indentation will be used.
1344 See also
\helpref{wxRichTextCtrl::NumberList
}{wxrichtextctrlnumberlist
},
\helpref{wxRichTextCtrl::PromoteList
}{wxrichtextctrlpromotelist
},
\helpref{wxRichTextCtrl::ClearListStyle
}{wxrichtextctrlclearliststyle
}.
1346 \membersection{wxRichTextCtrl::SetSelection
}\label{wxrichtextctrlsetselection
}
1348 \func{void
}{SetSelection
}{\param{long
}{from
},
\param{long
}{to
}}
1350 Sets the selection to the given range.
1352 The end point of range is specified as the last character position of the span of text, plus one.
1353 So, for example, to set the style for a character at position
5, use the range (
5,
6).
1355 \membersection{wxRichTextCtrl::SetSelectionRange
}\label{wxrichtextctrlsetselectionrange
}
1357 \func{void
}{SetSelectionRange
}{\param{const wxRichTextRange\&
}{range
}}
1359 Sets the selection to the given range.
1361 The end point of range is specified as the last character position of the span of text, plus one.
1362 So, for example, to set the style for a character at position
5, use the range (
5,
6).
1364 \membersection{wxRichTextCtrl::SetStyle
}\label{wxrichtextctrlsetstyle
}
1366 \func{bool
}{SetStyle
}{\param{const wxRichTextRange\&
}{range
},
\param{const wxRichTextAttr\&
}{style
}}
1368 \func{bool
}{SetStyle
}{\param{long
}{start
},
\param{long
}{end
},
\param{const wxTextAttrEx\&
}{style
}}
1370 \func{bool
}{SetStyle
}{\param{long
}{start
},
\param{long
}{end
},
\param{const wxTextAttr\&
}{style
}}
1372 Sets the attributes for the given range. The wxRichTextAttr version is more efficient
1373 because it does not use wxFont objects.
1375 The end point of range is specified as the last character position of the span of text, plus one.
1376 So, for example, to set the style for a character at position
5, use the range (
5,
6).
1378 \membersection{wxRichTextCtrl::SetStyleEx
}\label{wxrichtextctrlsetstyleex
}
1380 \func{bool
}{SetStyleEx
}{\param{const wxRichTextRange\&
}{range
},
\param{const wxRichTextAttr\&
}{style
},
\param{int
}{flags $=$ wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO}}
1382 \func{bool
}{SetStyleEx
}{\param{const wxRichTextRange\&
}{range
},
\param{const wxTextAttrEx\&
}{style
},
\param{int
}{flags $=$ wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO}}
1384 \func{bool
}{SetStyleEx
}{\param{long
}{start
},
\param{long
}{end
},
\param{const wxTextAttrEx\&
}{style
},
\param{int
}{flags $=$ wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO}}
1386 Sets the attributes for the given range, passing flags to determine how the attributes are set. The wxRichTextAttr version is more efficient
1387 because it does not use wxFont objects.
1389 The end point of range is specified as the last character position of the span of text, plus one.
1390 So, for example, to set the style for a character at position
5, use the range (
5,
6).
1392 {\it flags
} may contain a bit list of the following values:
1394 \begin{itemize
}\itemsep=
0pt
1395 \item wxRICHTEXT
\_SETSTYLE\_NONE: no style flag.
1396 \item wxRICHTEXT
\_SETSTYLE\_WITH\_UNDO: specifies that this operation should be undoable.
1397 \item wxRICHTEXT
\_SETSTYLE\_OPTIMIZE: specifies that the style should not be applied if the
1398 combined style at this point is already the style in question.
1399 \item wxRICHTEXT
\_SETSTYLE\_PARAGRAPHS\_ONLY: specifies that the style should only be applied to paragraphs,
1400 and not the content. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
1401 \item wxRICHTEXT
\_SETSTYLE\_CHARACTERS\_ONLY: specifies that the style should only be applied to characters,
1402 and not the paragraph. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
1403 \item wxRICHTEXT
\_SETSTYLE\_RESET: resets (clears) the existing style before applying the new style.
1406 \membersection{wxRichTextCtrl::SetStyleSheet
}\label{wxrichtextctrlsetstylesheet
}
1408 \func{void
}{SetStyleSheet
}{\param{wxRichTextStyleSheet*
}{styleSheet
}}
1410 Sets the style sheet associated with the control. A style sheet allows named
1411 character and paragraph styles to be applied.
1413 \membersection{wxRichTextCtrl::SetValue
}\label{wxrichtextctrlsetvalue
}
1415 \func{void
}{SetValue
}{\param{const wxString\&
}{value
}}
1417 Replaces existing content with the given text.
1419 \membersection{wxRichTextCtrl::SetupScrollbars
}\label{wxrichtextctrlsetupscrollbars
}
1421 \func{void
}{SetupScrollbars
}{\param{bool
}{atTop = false
}}
1423 A helper function setting up scrollbars, for example after a resize.
1425 \membersection{wxRichTextCtrl::ShowPosition
}\label{wxrichtextctrlshowposition
}
1427 \func{void
}{ShowPosition
}{\param{long
}{pos
}}
1429 Scrolls the buffer so that the given position is in view.
1431 \membersection{wxRichTextCtrl::SuppressingUndo
}\label{wxrichtextctrlsuppressingundo
}
1433 \constfunc{bool
}{SuppressingUndo
}{\void}
1435 Returns
\true if undo history suppression is on.
1437 \membersection{wxRichTextCtrl::Thaw
}\label{wxrichtextctrlthaw
}
1439 \func{void
}{Thaw
}{\void}
1441 Call this function to end a Freeze and refresh the display.
1443 \membersection{wxRichTextCtrl::Undo
}\label{wxrichtextctrlundo
}
1445 \func{void
}{Undo
}{\void}
1447 Undoes the command at the top of the command history, if there is one.
1449 \membersection{wxRichTextCtrl::WordLeft
}\label{wxrichtextctrlwordleft
}
1451 \func{bool
}{WordLeft
}{\param{int
}{noWords =
1},
\param{int
}{flags =
0}}
1453 Moves a number of words to the left.
1455 \membersection{wxRichTextCtrl::WordRight
}\label{wxrichtextctrlwordright
}
1457 \func{bool
}{WordRight
}{\param{int
}{noWords =
1},
\param{int
}{flags =
0}}
1459 Move a nuber of words to the right.
1461 \membersection{wxRichTextCtrl::WriteImage
}\label{wxrichtextctrlwriteimage
}
1463 \func{bool
}{WriteImage
}{\param{const wxString\&
}{filename
},
\param{int
}{bitmapType
}}
1465 Loads an image from a file and writes it at the current insertion point.
1467 \func{bool
}{WriteImage
}{\param{const wxRichTextImageBlock\&
}{imageBlock
}}
1469 Writes an image block at the current insertion point.
1471 \func{bool
}{WriteImage
}{\param{const wxBitmap\&
}{bitmap
},
\param{int
}{bitmapType = wxBITMAP
\_TYPE\_PNG}}
1473 \func{bool
}{WriteImage
}{\param{const wxImage\&
}{image
},
\param{int
}{bitmapType = wxBITMAP
\_TYPE\_PNG}}
1475 Write a bitmap or image at the current insertion point. Supply an optional type to use
1476 for internal and file storage of the raw data.
1478 \membersection{wxRichTextCtrl::WriteText
}\label{wxrichtextctrlwritetext
}
1480 \func{void
}{WriteText
}{\param{const wxString\&
}{text
}}
1482 Writes text at the current position.
1484 \membersection{wxRichTextCtrl::XYToPosition
}\label{wxrichtextctrlxytoposition
}
1486 \constfunc{long
}{XYToPosition
}{\param{long
}{x
},
\param{long
}{y
}}
1488 Translates from column and line number to position.