************************
wx.richtext.RichTextCtrl
************************

Inheritance diagram for `wx.richtext.RichTextCtrl`:

|

.. inheritance-diagram:: wx.richtext.RichTextCtrl

|

Description
===========

`wx.richtext.RichTextCtrl` provides a generic, ground-up implementation of a text control capable of showing multiple styles and images.

`wx.richtext.RichTextCtrl` sends notification events: see `wx.richtext.RichTextEvent <../Events/wx.richtext.RichTextEvent.html>`_. It also sends the standard 
`wx.TextCtrl <../Widgets/wx.TextCtrl.html>`_ events ``wx.wxEVT_COMMAND_TEXT_ENTER`` and ``wx.wxEVT_COMMAND_TEXT_UPDATED``, and `wx.TextUrlEvent` when 
URL content is clicked.

|

Control Appearance
^^^^^^^^^^^^^^^^^^

|

.. figure:: ../images/wxWidgets/wxmsw/richtextctrl.png 
   :alt: wxMSW
   :figclass: floatleft
   
   **wxMSW**


.. figure:: ../images/wxWidgets/wxmac/richtextctrl.png 
   :alt: wxMAC
   :figclass: floatright

   **wxMAC**


.. figure:: ../images/wxWidgets/wxgtk/richtextctrl.png
   :alt: wxGTK
   :figclass: floatcenter

   **wxGTK**


|

Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `AddImage <#AddImage>`_ 
* `AddParagraph <#AddParagraph>`_ 
* `AppendText <#AppendText>`_ 
* `ApplyAlignmentToSelection <#ApplyAlignmentToSelection>`_ 
* `ApplyBoldToSelection <#ApplyBoldToSelection>`_ 
* `ApplyItalicToSelection <#ApplyItalicToSelection>`_ 
* `ApplyStyle <#ApplyStyle>`_ 
* `ApplyStyleSheet <#ApplyStyleSheet>`_ 
* `ApplyUnderlineToSelection <#ApplyUnderlineToSelection>`_ 
* `BatchingUndo <#BatchingUndo>`_ 
* `BeginAlignment <#BeginAlignment>`_ 
* `BeginBatchUndo <#BeginBatchUndo>`_ 
* `BeginBold <#BeginBold>`_ 
* `BeginCharacterStyle <#BeginCharacterStyle>`_ 
* `BeginFont <#BeginFont>`_ 
* `BeginFontSize <#BeginFontSize>`_ 
* `BeginItalic <#BeginItalic>`_ 
* `BeginLeftIndent <#BeginLeftIndent>`_ 
* `BeginLineSpacing <#BeginLineSpacing>`_ 
* `BeginListStyle <#BeginListStyle>`_ 
* `BeginNumberedBullet <#BeginNumberedBullet>`_ 
* `BeginParagraphSpacing <#BeginParagraphSpacing>`_ 
* `BeginParagraphStyle <#BeginParagraphStyle>`_ 
* `BeginRightIndent <#BeginRightIndent>`_ 
* `BeginStandardBullet <#BeginStandardBullet>`_ 
* `BeginStyle <#BeginStyle>`_ 
* `BeginSuppressUndo <#BeginSuppressUndo>`_ 
* `BeginSymbolBullet <#BeginSymbolBullet>`_ 
* `BeginTextColour <#BeginTextColour>`_ 
* `BeginURL <#BeginURL>`_ 
* `BeginUnderline <#BeginUnderline>`_ 
* `CanCopy <#CanCopy>`_ 
* `CanCut <#CanCut>`_ 
* `CanDeleteSelection <#CanDeleteSelection>`_ 
* `CanPaste <#CanPaste>`_ 
* `CanRedo <#CanRedo>`_ 
* `CanUndo <#CanUndo>`_ 
* `ChangeValue <#ChangeValue>`_ 
* `Clear <#Clear>`_ 
* `ClearListStyle <#ClearListStyle>`_ 
* `Copy <#Copy>`_ 
* `Create <#Create>`_ 
* `Cut <#Cut>`_ 
* `Delete <#Delete>`_ 
* `DeleteSelection <#DeleteSelection>`_ 
* `DiscardEdits <#DiscardEdits>`_ 
* `EmulateKeyPress <#EmulateKeyPress>`_ 
* `EndAlignment <#EndAlignment>`_ 
* `EndAllStyles <#EndAllStyles>`_ 
* `EndBatchUndo <#EndBatchUndo>`_ 
* `EndBold <#EndBold>`_ 
* `EndCharacterStyle <#EndCharacterStyle>`_ 
* `EndFont <#EndFont>`_ 
* `EndFontSize <#EndFontSize>`_ 
* `EndItalic <#EndItalic>`_ 
* `EndLeftIndent <#EndLeftIndent>`_ 
* `EndLineSpacing <#EndLineSpacing>`_ 
* `EndListStyle <#EndListStyle>`_ 
* `EndNumberedBullet <#EndNumberedBullet>`_ 
* `EndParagraphSpacing <#EndParagraphSpacing>`_ 
* `EndParagraphStyle <#EndParagraphStyle>`_ 
* `EndRightIndent <#EndRightIndent>`_ 
* `EndStandardBullet <#EndStandardBullet>`_ 
* `EndStyle <#EndStyle>`_ 
* `EndSuppressUndo <#EndSuppressUndo>`_ 
* `EndSymbolBullet <#EndSymbolBullet>`_ 
* `EndTextColour <#EndTextColour>`_ 
* `EndURL <#EndURL>`_ 
* `EndUnderline <#EndUnderline>`_ 
* `GetBasicStyle <#GetBasicStyle>`_ 
* `GetBuffer <#GetBuffer>`_ 
* `GetDefaultStyle <#GetDefaultStyle>`_ 
* `GetDelayedLayoutThreshold <#GetDelayedLayoutThreshold>`_ 
* `GetFilename <#GetFilename>`_ 
* `GetHandlerFlags <#GetHandlerFlags>`_ 
* `GetInsertionPoint <#GetInsertionPoint>`_ 
* `GetInternalSelectionRange <#GetInternalSelectionRange>`_ 
* `GetLastPosition <#GetLastPosition>`_ 
* `GetLineLength <#GetLineLength>`_ 
* `GetLineText <#GetLineText>`_ 
* `GetNumberOfLines <#GetNumberOfLines>`_ 
* `GetRange <#GetRange>`_ 
* `GetSelection <#GetSelection>`_ 
* `GetSelectionRange <#GetSelectionRange>`_ 
* `GetStringSelection <#GetStringSelection>`_ 
* `GetStyle <#GetStyle>`_ 
* `GetStyleForRange <#GetStyleForRange>`_ 
* `GetStyleSheet <#GetStyleSheet>`_ 
* `GetTextCursor <#GetTextCursor>`_ 
* `GetURLCursor <#GetURLCursor>`_ 
* `GetUncombinedStyle <#GetUncombinedStyle>`_ 
* `GetValue <#GetValue>`_ 
* `HasCharacterAttributes <#HasCharacterAttributes>`_ 
* `HasParagraphAttributes <#HasParagraphAttributes>`_ 
* `HasSelection <#HasSelection>`_ 
* `IsEditable <#IsEditable>`_ 
* `IsEmpty <#IsEmpty>`_ 
* `IsModified <#IsModified>`_ 
* `IsMultiLine <#IsMultiLine>`_ 
* `IsSelectionAligned <#IsSelectionAligned>`_ 
* `IsSelectionBold <#IsSelectionBold>`_ 
* `IsSelectionItalics <#IsSelectionItalics>`_ 
* `IsSelectionUnderlined <#IsSelectionUnderlined>`_ 
* `IsSingleLine <#IsSingleLine>`_ 
* `LayoutContent <#LayoutContent>`_ 
* `LineBreak <#LineBreak>`_ 
* `LoadFile <#LoadFile>`_ 
* `MarkDirty <#MarkDirty>`_ 
* `MoveCaret <#MoveCaret>`_ 
* `MoveDown <#MoveDown>`_ 
* `MoveEnd <#MoveEnd>`_ 
* `MoveHome <#MoveHome>`_ 
* `MoveLeft <#MoveLeft>`_ 
* `MoveRight <#MoveRight>`_ 
* `MoveToLineEnd <#MoveToLineEnd>`_ 
* `MoveToLineStart <#MoveToLineStart>`_ 
* `MoveToParagraphEnd <#MoveToParagraphEnd>`_ 
* `MoveToParagraphStart <#MoveToParagraphStart>`_ 
* `MoveUp <#MoveUp>`_ 
* `Newline <#Newline>`_ 
* `NumberList <#NumberList>`_ 
* `Paste <#Paste>`_ 
* `PopStyleSheet <#PopStyleSheet>`_ 
* `PositionToXY <#PositionToXY>`_ 
* `PromoteList <#PromoteList>`_ 
* `PushStyleSheet <#PushStyleSheet>`_ 
* `Redo <#Redo>`_ 
* `Remove <#Remove>`_ 
* `Replace <#Replace>`_ 
* `SaveFile <#SaveFile>`_ 
* `SelectAll <#SelectAll>`_ 
* `SelectNone <#SelectNone>`_ 
* `SelectWord <#SelectWord>`_ 
* `SetBasicStyle <#SetBasicStyle>`_ 
* `SetDefaultStyle <#SetDefaultStyle>`_ 
* `SetDefaultStyleToCursorStyle <#SetDefaultStyleToCursorStyle>`_ 
* `SetDelayedLayoutThreshold <#SetDelayedLayoutThreshold>`_ 
* `SetEditable <#SetEditable>`_ 
* `SetFilename <#SetFilename>`_ 
* `SetHandlerFlags <#SetHandlerFlags>`_ 
* `SetInsertionPoint <#SetInsertionPoint>`_ 
* `SetInsertionPointEnd <#SetInsertionPointEnd>`_ 
* `SetInternalSelectionRange <#SetInternalSelectionRange>`_ 
* `SetListStyle <#SetListStyle>`_ 
* `SetMaxLength <#SetMaxLength>`_ 
* `SetModified <#SetModified>`_ 
* `SetSelection <#SetSelection>`_ 
* `SetSelectionRange <#SetSelectionRange>`_ 
* `SetStyle <#SetStyle>`_ 
* `SetStyleEx <#SetStyleEx>`_ 
* `SetStyleSheet <#SetStyleSheet>`_ 
* `SetTextCursor <#SetTextCursor>`_ 
* `SetURLCursor <#SetURLCursor>`_ 
* `SetValue <#SetValue>`_ 
* `ShowPosition <#ShowPosition>`_ 
* `SuppressingUndo <#SuppressingUndo>`_ 
* `Undo <#Undo>`_ 
* `WordLeft <#WordLeft>`_ 
* `WordRight <#WordRight>`_ 
* `WriteBitmap <#WriteBitmap>`_ 
* `WriteImage <#WriteImage>`_ 
* `WriteImageBlock <#WriteImageBlock>`_ 
* `WriteImageFile <#WriteImageFile>`_ 
* `WriteText <#WriteText>`_ 
* `XYToPosition <#XYToPosition>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Buffer <#Buffer>`_ 
* `DefaultStyle <#DefaultStyle>`_ 
* `DelayedLayoutThreshold <#DelayedLayoutThreshold>`_ 
* `Filename <#Filename>`_ 
* `InsertionPoint <#InsertionPoint>`_ 
* `InternalSelectionRange <#InternalSelectionRange>`_ 
* `LastPosition <#LastPosition>`_ 
* `NumberOfLines <#NumberOfLines>`_ 
* `Selection <#Selection>`_ 
* `SelectionRange <#SelectionRange>`_ 
* `StringSelection <#StringSelection>`_ 
* `StyleSheet <#StyleSheet>`_ 
* `Value <#Value>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(parent, id=-1, value="", pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.richtext.RE_MULTILINE, validator=wx.DefaultValidator, name=wx.TextCtrlNameStr)

   Constructor.

   **Parameters:**

   * `parent` (`wx.Window <../Widgets/wx.Window.html>`_)
   * `id` (int)
   * `value` (string)
   * `pos` (`wx.Point <../Widgets/wx.Point.html>`_)
   * `size` (`wx.Size <../Widgets/wx.Size.html>`_)
   * `style` (long)
   * `validator` (`wx.Validator <../Widgets/wx.Validator.html>`_)
   * `name` (string)

   |

   **Returns:**

   `wx.richtext.RichTextCtrl <wx.richtext.RichTextCtrl.html>`_ 

--------

.. method:: AddImage(image)

   Adds an image to the control's buffer.

   **Parameters:**

   * `image` (`wx.Image <../Widgets/wx.Image.html>`_) 

   |  

   **Returns:**

   `wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_
 

--------

.. method:: AddParagraph(text)

   Adds a new paragraph of text to the end of the buffer.

   **Parameters:**

   * `text` (string) 

   |  

   **Returns:**

   `wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_
 

--------


.. method:: AppendText(text)

   Sets the insertion point to the end of the buffer and writes the text.

   **Parameters:**

   * `text` (string) 

--------

.. method:: ApplyAlignmentToSelection(alignment)

   Applies the given alignment to the selection (undoable).

   For alignment values, see `wx.richtext.RichTextAttr <wx.richtext.RichTextAttr.html>`_.

   **Parameters:**

   * `alignment` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: ApplyBoldToSelection()

   Apples bold to the selection (undoable).

   |  

   **Returns:**

   `bool` 

--------

.. method:: ApplyItalicToSelection()

   Applies italic to the selection (undoable).

   |  

   **Returns:**

   `bool` 

--------

.. method:: ApplyStyle(def)

   Applies the given style to the selection.

   **Parameters:**

   * `def` (`wx.richtext.RichTextStyleDefinition`) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: ApplyStyleSheet(sheet=None)

   Applies the style sheet to the buffer, matching paragraph styles in the sheet against named styles in the buffer. 

   This might be useful if the styles have changed. If `sheet` is ``None``, the sheet set with `SetStyleSheet <#SetStyleSheet>`_ is used.

   Currently this applies paragraph styles only.

   **Parameters:**

   * `sheet` (`wx.richtext.RichTextStyleSheet`) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: ApplyUnderlineToSelection()

   Applies underline to the selection (undoable).

   |  

   **Returns:**

   `bool` 

--------

.. method:: BatchingUndo()

   Returns ``True`` if undo commands are being batched.

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginAlignment(alignment)

   Begins using alignment.

   For alignment values, `wx.richtext.RichTextAttr <wx.richtext.RichTextAttr.html>`_.

   **Parameters:**

   * `alignment` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginBatchUndo(cmdName)

   Starts batching undo history for commands.

   **Parameters:**

   * `cmdName` (string) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginBold()

   Begins using bold.

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginCharacterStyle(characterStyle)

   Begins using the named character style.

   **Parameters:**

   * `characterStyle` (string) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginFont(font)

   Begins using this font.

   **Parameters:**

   * `font` (`wx.Font <../Widgets/wx.Font.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginFontSize(pointSize)

   Begins using the given point size.

   **Parameters:**

   * `pointSize` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginItalic()

   Begins using italic.

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginLeftIndent(leftIndent, leftSubIndent=0)

   Begins applying a left indent and subindent in tenths of a millimetre.

   The sub-indent is an offset from the left of the paragraph, and is used for all but the first line in a paragraph. A positive value will cause the first 
   line to appear to the left of the subsequent lines, and a negative value will cause the first line to be indented relative to the subsequent lines.

   `wx.richtext.RichTextBuffer <wx.richtext.RichTextBuffer.html>`_ uses indentation to render a bulleted item. The left indent is the distance between 
   the margin and the bullet. The content of the paragraph, including the first line, starts at `leftMargin` + `leftSubIndent`. So the distance between 
   the left edge of the bullet and the left of the actual paragraph is `leftSubIndent`.

   **Parameters:**

   * `leftIndent` (int) 
   * `leftSubIndent` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginLineSpacing(lineSpacing)

   Begins appling line spacing. 

   `spacing` is a multiple, where 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing. The following constants are defined for convenience:

   =============================================================  =======================
   Line Spacing Flags                                             Value
   =============================================================  =======================
   ``wx.richtext.TEXT_ATTR_LINE_SPACING_NORMAL``                  10
   ``wx.richtext.TEXT_ATTR_LINE_SPACING_HALF``                    15
   ``wx.richtext.TEXT_ATTR_LINE_SPACING_TWICE``                   20
   =============================================================  =======================

   |

   **Parameters:**

   * `lineSpacing` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginListStyle(listStyle, level=1, number=1)

   Begins using a specified list style. Optionally, you can also pass a level and a number.

   **Parameters:**

   * `listStyle` (string) 
   * `level` (int) 
   * `number` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginNumberedBullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle=wx.richtext.TEXT_ATTR_BULLET_STYLE_ARABIC | wx.richtext.TEXT_ATTR_BULLET_STYLE_PERIOD)

   Begins a numbered bullet. 

   This call will be needed for each item in the list, and the application should take care of incrementing the numbering.
   
   **Parameters:**

   * `bulletNumber` (int): Is a number, usually starting with 1.
   * `leftIndent` (int): Value in tenths of a millimetre.
   * `leftSubIndent` (int): Value in tenths of a millimetre.
   * `bulletStyle` (int): A bitlist of the following values:

     =============================================================  =======================
     Bullet Style Flags                                             Value
     =============================================================  =======================
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_NONE``                    0x00000000
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_ARABIC``                  0x00000001
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_LETTERS_UPPER``           0x00000002
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_LETTERS_LOWER``           0x00000004
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_ROMAN_UPPER``             0x00000008
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_ROMAN_LOWER``             0x00000010
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_SYMBOL``                  0x00000020
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_BITMAP``                  0x00000040
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_PARENTHESES``             0x00000080
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_PERIOD``                  0x00000100
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_STANDARD``                0x00000200
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS``       0x00000400
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_OUTLINE``                 0x00000800
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_ALIGN_LEFT``              0x00000000
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT``             0x00001000
     ``wx.richtext.TEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE``            0x00002000
     =============================================================  =======================

     Of these, ``wx.richtext.TEXT_ATTR_BULLET_STYLE_BITMAP`` is unimplemented.

   `wx.richtext.RichTextCtrl` uses indentation to render a bulleted item. The left indent is the distance between the margin and the bullet. 
   The content of the paragraph, including the first line, starts at `leftMargin` + `leftSubIndent`. So the distance between the left edge of the bullet 
   and the left of the actual paragraph is `leftSubIndent`.

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginParagraphSpacing(before, after)

   Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of a millimetre.

   **Parameters:**

   * `before` (int) 
   * `after` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginParagraphStyle(paragraphStyle)

   Begins applying the named paragraph style.

   **Parameters:**

   * `paragraphStyle` (string) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginRightIndent(rightIndent)

   Begins a right indent, specified in tenths of a millimetre.

   **Parameters:**

   * `rightIndent` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginStandardBullet(bulletName, leftIndent, leftSubIndent, bulletStyle=wx.richtext.TEXT_ATTR_BULLET_STYLE_STANDARD)

   Begins applying a standard bullet, using one of the standard bullet names (currently ``standard/circle`` or ``standard/square``). 

   See `BeginNumberedBullet <#BeginNumberedBullet>`_ for an explanation of how indentation is used to render the bulleted paragraph.

   **Parameters:**

   * `bulletName` (string) 
   * `leftIndent` (int) 
   * `leftSubIndent` (int) 
   * `bulletStyle` (int) 

   |

   **Returns:**

   `bool` 

--------

.. method:: BeginStyle(style)

   Begins applying a style.

   **Parameters:**

   * `style` (`wx.richtext.TextAttrEx <wx.richtext.TextAttrEx.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginSuppressUndo()

   Starts suppressing undo history for commands.

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginSymbolBullet(symbol, leftIndent, leftSubIndent, bulletStyle=wx.richtext.TEXT_ATTR_BULLET_STYLE_SYMBOL)

   Begins applying a symbol bullet, using a character from the current font. 

   See `BeginNumberedBullet <#BeginNumberedBullet>`_ for an explanation of how indentation is used to render the bulleted paragraph.

   **Parameters:**

   * `symbol` (string) 
   * `leftIndent` (int) 
   * `leftSubIndent` (int) 
   * `bulletStyle` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginTextColour(colour)

   Begins using this colour.

   **Parameters:**

   * `colour` (`wx.Colour <../Widgets/wx.Colour.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginURL(url, characterStyle="")

   Begins applying ``wx.TEXT_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.

   **Parameters:**

   * `url` (string) 
   * `characterStyle` (string) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: BeginUnderline()

   Begins using underlining.

   |  

   **Returns:**

   `bool` 

--------

.. method:: CanCopy()

   Returns ``True`` if selected content can be copied to the clipboard.

   |  

   **Returns:**

   `bool` 

--------

.. method:: CanCut()

   Returns ``True`` if selected content can be copied to the clipboard and deleted.

   |  

   **Returns:**

   `bool` 

--------

.. method:: CanDeleteSelection()

   Returns ``True`` if selected content can be deleted.

   |  

   **Returns:**

   `bool` 

--------

.. method:: CanPaste()

   Returns ``True`` if the clipboard content can be pasted to the buffer.

   |  

   **Returns:**

   `bool` 

--------

.. method:: CanRedo()

   Returns ``True`` if there is a command in the command history that can be redone.

   |  

   **Returns:**

   `bool` 

--------

.. method:: CanUndo()

   Returns ``True`` if there is a command in the command history that can be undone.

   |  

   **Returns:**

   `bool` 

--------

.. method:: ChangeValue(value)

   |
   
   **Parameters:**

   * `value` (string)

--------

.. method:: Clear(range)

   Clears the buffer content, leaving a single empty paragraph. Cannot be undone.

   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 

--------

.. method:: ClearListStyle(range, flags=wx.richtext.RICHTEXT_SETSTYLE_WITH_UNDO)

   Clears the list style from the given range, clearing list-related attributes and applying any named paragraph style associated with each paragraph.

   `flags` is a bit list of the following:
   
   * ``wx.richtext.RICHTEXT_SETSTYLE_WITH_UNDO``: specifies that this command will be undoable.

   |

   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 
   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

.. seealso:: `SetListStyle <#SetListStyle>`_, `PromoteList <#PromoteList>`_, `NumberList <#NumberList>`_

--------

.. method:: Copy()

   Copies the selected content (if any) to the clipboard.


--------

.. method:: Create(parent, id=wx.ID_ANY, value="", pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.richtext.RE_MULTILINE, validator=wx.DefaultValidator, name=wx.TextCtrlNameStr)

   Creates the underlying window.

   **Parameters:**

   * `parent` (`wx.Window <../Widgets/wx.Window.html>`_) 
   * `id` (int) 
   * `value` (string) 
   * `pos` (`wx.Point <../Widgets/wx.Point.html>`_) 
   * `size` (`wx.Size <../Widgets/wx.Size.html>`_) 
   * `style` (long) 
   * `validator` (`wx.Validator <../Widgets/wx.Validator.html>`_) 
   * `name` (string) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: Cut()

   Copies the selected content (if any) to the clipboard and deletes the selection. This is undoable.


--------

.. method:: Delete(range)

   Deletes the content within the given range.

   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: DeleteSelection()

   Deletes the content in the selection, if any. This is undoable.


--------

.. method:: DiscardEdits()

   Sets the buffer's modified status to ``False``, and clears the buffer's command history.


--------

.. method:: EmulateKeyPress(event)

   |

   **Parameters:**

   * `event` (`wx.KeyEvent <../Events/wx.KeyEvent.html>`_)

   |

   **Returns:**

   `bool` 


--------

.. method:: EndAlignment()

   Ends alignment.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndAllStyles()

   Ends application of all styles in the current style stack.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndBatchUndo()

   Ends batching undo command history.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndBold()

   Ends using bold.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndCharacterStyle()

   Ends application of a named character style.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndFont()

   Ends using a font.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndFontSize()

   Ends using a point size.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndItalic()

   Ends using italic.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndLeftIndent()

   Ends left indent.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndLineSpacing()

   Ends line spacing.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndListStyle()

   Ends using a specified list style.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndNumberedBullet()

   Ends application of a numbered bullet.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndParagraphSpacing()

   Ends paragraph spacing.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndParagraphStyle()

   Ends application of a named character style.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndRightIndent()

   Ends right indent.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndStandardBullet()

   End standard bullet.
   
   |
   
   **Returns:**

   `bool` 

--------

.. method:: EndStyle()

   Ends the current style.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndSuppressUndo()

   Ends suppressing undo command history.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndSymbolBullet()

   Ends applying a symbol bullet.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndTextColour()

   Ends applying a text colour.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndURL()

   Ends applying a URL.

   |  

   **Returns:**

   `bool` 

--------

.. method:: EndUnderline()

   End applying underlining.

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetBasicStyle()

   Gets the basic (overall) style. 

   This is the style of the whole buffer before further styles are applied, unlike the default style, which only affects 
   the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).

   |  

   **Returns:**

   `wx.richtext.TextAttrEx <wx.richtext.TextAttrEx.html>`_
 

--------

.. method:: GetBuffer()

   Returns the buffer associated with the control.

   |  

   **Returns:**

   `wx.richtext.RichTextBuffer <wx.richtext.RichTextBuffer.html>`_
 

--------

.. method:: GetDefaultStyle()

   Retrieves a copy of the default style object.
   
   |
   
   **Returns:**

   `wx.richtext.TextAttrEx <wx.richtext.TextAttrEx.html>`_

--------

.. method:: GetDelayedLayoutThreshold()

   Gets the size of the buffer beyond which layout is delayed during resizing. 

   This optimizes sizing for large buffers. The default is 20000.

   |  

   **Returns:**

   `long` 

--------

.. method:: GetFilename()

   Gets the current filename associated with the control.

   |  

   **Returns:**

   `string` 

--------

.. method:: GetHandlerFlags()

   Returns flags that change the behaviour of loading or saving. See the documentation for each handler class to see 
   what flags are relevant for each handler.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetInsertionPoint()

   Returns the current insertion point.

   |  

   **Returns:**

   `long` 

--------

.. method:: GetInternalSelectionRange()

   Get the selection range in character positions. -1, -1 means no selection.  

   The range is in internal format, i.e. a single character selection is denoted by (n, n).
   
   |
   
   **Returns:**

   `wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_

--------

.. method:: GetLastPosition()

   Returns the last position in the buffer.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetLineLength(lineNo)

   Returns the length of the specified line in characters.

   **Parameters:**

   * `lineNo` (long) 

   |  

   **Returns:**

   `int` 

--------

.. method:: GetLineText(lineNo)

   Returns the text for the given line.

   **Parameters:**

   * `lineNo` (long) 

   |  

   **Returns:**

   `string` 

--------

.. method:: GetNumberOfLines()

   Returns the number of lines in the buffer.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetRange(from, to)

   Gets the text for the given range.

   The end point of range is specified as the last character position of the span of text, plus one.

   **Parameters:**

   * `from` (long) 
   * `to` (long) 

   |  

   **Returns:**

   `string` 

--------

.. method:: GetSelection()

   Returns the range of the current selection.

   The end point of range is specified as the last character position of the span of text, plus one.
   If the return values `from` and `to` are the same, there is no selection.

   |

   **Returns:**

   `(from, to)`

--------

.. method:: GetSelectionRange()

   Returns the selection range in character positions. -1, -1 means no selection.

   |  

   **Returns:**

   `wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_
 

--------

.. method:: GetStringSelection()

   Returns the text within the current selection range, if any.

   |  

   **Returns:**

   `string` 

--------

.. method:: GetStyle(position, style)
    
   Gets the attributes at the given position. 

   The `wx.richtext.RichTextAttr <wx.richtext.RichTextAttr.html>`_ version is generally more efficient because it does not 
   use `wx.Font <../Widgets/wx.Font.html>`_ objects.

   This function gets the combined style - that is, the style you see on the screen as a result of combining base style, 
   paragraph style and character style attributes. To get the character or paragraph style alone, use `GetUncombinedStyle <#GetUncombinedStyle>`_.

   Retrieve the style used at the given position. Copies the style values at `position` into the `style` parameter and returns ``True``
   if successful.  Returns ``False`` otherwise.

   **Parameters:**

   * `position` (int)
   * `style` (`wx.richtext.TextAttrEx <wx.richtext.TextAttrEx.html>`_)

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetStyleForRange(range, style)

   Gets the attributes common to the specified range. 

   Attributes that differ in value within the range will not be included in `style`'s flags.

   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 
   * `style` (`wx.richtext.RichTextAttr <wx.richtext.RichTextAttr.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetStyleSheet()

   Returns the style sheet associated with the control, if any. 

   A style sheet allows named character and paragraph styles to be applied.

   |  

   **Returns:**

   `wx.richtext.RichTextStyleSheet`
 
--------

.. method:: GetTextCursor()

   Get text cursor.
   
   |
   
   **Returns:**

   `wx.Cursor <../Widgets/wx.Cursor.html>`_
 

--------

.. method:: GetURLCursor()

   Get URL cursor.
   
   |
   
   **Returns:**

   `wx.Cursor <../Widgets/wx.Cursor.html>`_
 

--------

.. method:: GetUncombinedStyle(position, style)

   Gets the attributes at the given position. 

   The `wx.richtext.RichTextAttr <wx.richtext.RichTextAttr.html>`_ version is generally more efficient because it does not 
   use `wx.Font <../Widgets/wx.Font.html>`_ objects.

   This function gets the **uncombined style** - that is, the attributes associated with the paragraph or character content, 
   and not necessarily the combined attributes you see on the screen. To get the combined attributes, use `GetStyle <#GetStyle>`_.

   If you specify (any) paragraph attribute in `style`'s flags, this function will fetch the paragraph attributes. Otherwise, 
   it will return the character attributes.

   **Parameters:**

   * `position` (long) 
   * `style` (`wx.richtext.RichTextAttr <wx.richtext.RichTextAttr.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetValue()

   Returns the content of the entire control as a string.

   |  

   **Returns:**

   `string` 

--------

.. method:: HasCharacterAttributes(range, style)

   Test if this whole range has character attributes of the specified kind. 

   If any of the attributes are different within the range, the test fails. You can use this to implement, for example, 
   bold button updating. `style` must have flags indicating which attributes are of interest.

   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 
   * `style` (`wx.richtext.TextAttrEx <wx.richtext.TextAttrEx.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: HasParagraphAttributes(range, style)

   Test if this whole range has paragraph attributes of the specified kind. 

   If any of the attributes are different within the range, the test fails. You can use this to implement, for example, 
   centering button updating. `style` must have flags indicating which attributes are of interest.

   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 
   * `style` (`wx.richtext.TextAttrEx <wx.richtext.TextAttrEx.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: HasSelection()

   Returns ``True`` if there is a selection.

   |  

   **Returns:**

   `bool` 

--------

.. method:: IsEditable()

   Returns ``True`` if the control is editable.

   |  

   **Returns:**

   `bool` 

--------

.. method:: IsEmpty()

   `No docstrings available for this method.` 

--------


.. method:: IsModified()

   Returns ``True`` if the buffer has been modified.

   |  

   **Returns:**

   `bool` 

--------

.. method:: IsMultiLine()

   Returns ``True`` if the control is multiline.

   |  

   **Returns:**

   `bool` 

--------

.. method:: IsSelectionAligned(alignment)

   Returns ``True`` if all of the selection is aligned according to the specified flag.

   **Parameters:**

   * `alignment` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: IsSelectionBold()

   Returns ``True`` if all of the selection is bold.

   |  

   **Returns:**

   `bool` 

--------

.. method:: IsSelectionItalics()

   Returns ``True`` if all of the selection is italic.

   |  

   **Returns:**

   `bool` 

--------

.. method:: IsSelectionUnderlined()

   Returns ``True`` if all of the selection is underlined.

   |  

   **Returns:**

   `bool` 

--------

.. method:: IsSingleLine()

   Returns ``True`` if the control is single-line. 

   Currently `wx.richtext.RichTextCtrl` does not support single-line editing.

   |  

   **Returns:**

   `bool` 

--------

.. method:: LayoutContent(onlyVisibleRect=False)

   Lays out the buffer, which must be done before certain operations, such as setting the caret position. 

   This function should not normally be required by the application.

   **Parameters:**

   * `onlyVisibleRect` (bool) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: LineBreak()

   Inserts a line break at the current insertion point. 

   A line break forces wrapping within a paragraph, and can be introduced by using this function, by appending the 
   string value `wx.richtext.RichTextLineBreakChar` to text content, or by typing ``Shift-Return``.

   |  

   **Returns:**

   `bool` 

--------

.. method:: LoadFile(file, type=wx.richtext.RICHTEXT_TYPE_ANY)

   Loads content into the control's buffer using the given type. 

   If the specified type is wx.richtext.RICHTEXT_TYPE_ANY, the type is deduced from the filename extension.
   This function looks for a suitable `wx.richtext.RichTextFileHandler <wx.richtext.RichTextFileHandler.html>`_ object.

   **Parameters:**

   * `file` (string) 
   * `type` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: MarkDirty()

   Marks the buffer as modified.


--------

.. method:: MoveCaret(pos, showAtLineStart=False)

   Move the caret to the given character position.

   **Parameters:**

   * `pos` (long) 
   * `showAtLineStart` (bool) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: MoveDown(noLines=1, flags=0)

   Moves the caret down.

   **Parameters:**

   * `noLines` (int) 
   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: MoveEnd(flags=0)

   Moves to the end of the buffer.

   **Parameters:**

   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: MoveHome(flags=0)

   Moves to the start of the buffer.

   **Parameters:**

   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: MoveLeft(noPositions=1, flags=0)

   Moves left.

   **Parameters:**

   * `noPositions` (int) 
   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: MoveRight(noPositions=1, flags=0)

   Moves right.

   **Parameters:**

   * `noPositions` (int) 
   * `flags` (int) 


   **Returns:**

   `bool` 

--------

.. method:: MoveToLineEnd(flags=0)

   Moves to the end of the line.

   **Parameters:**

   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: MoveToLineStart(flags=0)

   Moves to the start of the line.

   **Parameters:**

   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: MoveToParagraphEnd(flags=0)

   Moves to the end of the paragraph.

   **Parameters:**

   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: MoveToParagraphStart(flags=0)

   Moves to the start of the paragraph.

   **Parameters:**

   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: MoveUp(noLines=1, noLines = 1=0)

   Moves up.

   **Parameters:**

   * `noLines` (int) 
   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: Newline()

   Inserts a new paragraph at the current insertion point. See also `wx.richtext.RichTextCtrl.LineBreak <wx.richtext.RichTextCtrl.html#LineBreak>`_.

   |  

   **Returns:**

   `bool` 

--------

.. method:: NumberList(range, style, flags=wx.richtext.RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=-1, listLevel=-1)

   Numbers the paragraphs in the given range. 

   Pass flags to determine how the attributes are set. Either the style definition or the name of the style definition 
   (in the current sheet) can be passed.

   `flags` is a bit list of the following:
   
   * ``wx.richtext.RICHTEXT_SETSTYLE_WITH_UNDO``: specifies that this command will be undoable.
   * ``wx.richtext.RICHTEXT_SETSTYLE_RENUMBER``: specifies that numbering should start from `startFrom`, otherwise existing attributes are used.
   * ``wx.richtext.RICHTEXT_SETSTYLE_SPECIFY_LEVEL``: specifies that `listLevel` should be used as the level for all paragraphs, 
     otherwise the current indentation will be used.

   |
   
   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 
   * `style` (`wx.richtext.RichTextListStyleDefinition <wx.richtext.RichTextListStyleDefinition.html>`_) 
   * `flags` (int) 
   * `startFrom` (int) 
   * `listLevel` (int) 

   |  

   **Returns:**

   `bool` 

.. seealso:: `SetListStyle <#SetListStyle>`_, `PromoteList <#PromoteList>`_, `ClearListStyle <#ClearListStyle>`_

--------

.. method:: Paste()

   Pastes content from the clipboard to the buffer.


--------

.. method:: PopStyleSheet()

   Pop style sheet from top of stack
   
   |   
   
   **Returns:**

   `wx.richtext.RichTextStyleSheet`

--------

.. method:: PositionToXY(pos)

   Converts a text position to zero-based column and line numbers.

   **Parameters:**

   * `pos` (int)

   |  

   **Returns:**

   `(x, y)` 

--------

.. method:: PromoteList(promoteBy, range, style, flags=wx.richtext.RICHTEXT_SETSTYLE_WITH_UNDO, listLevel=-1)

   Promotes or demotes the paragraphs in the given range. 

   A positive `promoteBy` produces a smaller indent, and a negative number produces a larger indent. 
   Pass flags to determine how the attributes are set. Either the style definition or the name of the style definition 
   (in the current sheet) can be passed.

   `flags` is a bit list of the following:
   
   * ``wx.richtext.RICHTEXT_SETSTYLE_WITH_UNDO``: specifies that this command will be undoable.
   * ``wx.richtext.RICHTEXT_SETSTYLE_RENUMBER``: specifies that numbering should start from `startFrom`, otherwise existing attributes are used.
   * ``wx.richtext.RICHTEXT_SETSTYLE_SPECIFY_LEVEL``: specifies that `listLevel` should be used as the level for all paragraphs, otherwise the 
     current indentation will be used.
   
   |

   **Parameters:**

   * `promoteBy` (int) 
   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 
   * `style` (`wx.richtext.RichTextListStyleDefinition <wx.richtext.RichTextListStyleDefinition.html>`_) 
   * `flags` (int) 
   * `listLevel` (int) 

   |  

   **Returns:**

   `bool` 

.. seealso:: `SetListStyle <#SetListStyle>`_, `ClearListStyle <#ClearListStyle>`_

--------

.. method:: PushStyleSheet(styleSheet)

   Push style sheet to top of stack.

   **Parameters:**

   * `styleSheet` (`wx.richtext.RichTextStyleSheet`)

   |

   **Returns:**

   `bool` 


--------

.. method:: Redo()

   Redoes the current command.


--------

.. method:: Remove(from)

   Removes the content in the specified range.

   **Parameters:**

   * `from` (long) 

--------

.. method:: Replace(from, to, value)

   Replaces the content in the specified range with the string specified by `value`.

   **Parameters:**

   * `from` (long) 
   * `to` (long) 
   * `value` (string) 

--------

.. method:: SaveFile(file="", type=wx.richtext.RICHTEXT_TYPE_ANY)

   Saves the buffer content using the given type. 

   If the specified type is ``wx.richtext.RICHTEXT_TYPE_ANY``, the type is deduced from the filename extension.
   This function looks for a suitable `wx.richtext.RichTextFileHandler <wx.richtext.RichTextFileHandler.html>`_ object.

   **Parameters:**

   * `file` (string) 
   * `type` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: SelectAll()

   Selects all the text in the buffer.


--------

.. method:: SelectNone()

   Cancels any selection.


--------

.. method:: SelectWord(position)

   Select the word at the given character position.
   
   **Parameters:**

   * `position` (long)

   |

   **Returns:**

   `bool` 

--------

.. method:: SetBasicStyle(style)

   Sets the basic (overall) style. 

   This is the style of the whole buffer before further styles are applied, unlike the default style, which only affects the 
   style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).

   **Parameters:**

   * `style` (`wx.richtext.RichTextAttr <wx.richtext.RichTextAttr.html>`_) 

--------

.. method:: SetDefaultStyle(style)

   Sets the current default style, which can be used to change how subsequently inserted text is displayed.

   **Parameters:**

   * `style` (`wx.richtext.TextAttrEx <wx.richtext.TextAttrEx.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: SetDefaultStyleToCursorStyle()

   Sets the default style to the style under the cursor.

   |  

   **Returns:**

   `bool` 

--------

.. method:: SetDelayedLayoutThreshold(threshold)

   Sets the size of the buffer beyond which layout is delayed during resizing. 

   This optimizes sizing for large buffers. The default is 20000.

   **Parameters:**

   * `threshold` (long) 

--------

.. method:: SetEditable(editable)

   Makes the control editable, or not.

   **Parameters:**

   * `editable` (bool) 

--------

.. method:: SetFilename(filename)

   Sets the current filename.

   **Parameters:**

   * `filename` (string) 

--------

.. method:: SetHandlerFlags(flags)

   Sets flags that change the behaviour of loading or saving. 

   See the documentation for each handler class to see what flags are relevant for each handler.

   **Parameters:**

   * `flags` (int) 

--------

.. method:: SetInsertionPoint(pos)

   Sets the insertion point.

   **Parameters:**

   * `pos` (int) 

--------

.. method:: SetInsertionPointEnd()

   Sets the insertion point to the end of the text control.


--------

.. method:: SetInternalSelectionRange(range)

   Set the selection range in character positions. -1, -1 means no selection.  

   The range is in internal format, i.e. a single character selection is denoted by (n, n).
   
   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_)

--------

.. method:: SetListStyle(range, style, flags=wx.richtext.RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=-1, listLevel=-1)

   Sets the list attributes for the given range, passing flags to determine how the attributes are set. 

   Either the style definition or the name of the style definition (in the current sheet) can be passed.

   `flags` is a bit list of the following:
   
   * ``wx.richtext.RICHTEXT_SETSTYLE_WITH_UNDO``: specifies that this command will be undoable.
   * ``wx.richtext.RICHTEXT_SETSTYLE_RENUMBER``: specifies that numbering should start from `startFrom`, otherwise existing attributes are used.
   * ``wx.richtext.RICHTEXT_SETSTYLE_SPECIFY_LEVEL``: specifies that `listLevel` should be used as the level for all paragraphs, otherwise the 
     current indentation will be used.
   
   |

   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 
   * `style` (`wx.richtext.RichTextListStyleDefinition <wx.richtext.RichTextListStyleDefinition.html>`_) 
   * `flags` (int) 
   * `startFrom` (int) 
   * `listLevel` (int) 

   |  

   **Returns:**

   `bool` 


.. seealso:: `NumberList <#NumberList>`_, `PromoteList <#PromoteList>`_, `ClearListStyle <#ClearListStyle>`_.

--------

.. method:: SetMaxLength(len)

   Set the max number of characters which may be entered in a single line
   text control.
   
   **Parameters:**

   * `len` (int) 
   
--------

.. method:: SetModified(modified)

   |
   
   **Parameters:**

   * `modified` (bool)

--------

.. method:: SetSelection(from, to)

   Sets the selection to the given range.

   The end point of range is specified as the last character position of the span of text, plus one. So, for example, to set 
   the selection for a character at position 5, use the range (5, 6).

   **Parameters:**

   * `from` (long) 
   * `to` (long) 

--------

.. method:: SetSelectionRange(range)

   Sets the selection to the given range.

   The end point of range is specified as the last character position of the span of text, plus one. So, for example, to set 
   the selection for a character at position 5, use the range (5, 6).

   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 

--------

.. method:: SetStyle(range, style)

   Sets the attributes for the given range. 

   The `wx.richtext.RichTextAttr <wx.richtext.RichTextAttr.html>`_ version is generally more efficient because it does not 
   use `wx.Font <../Widgets/wx.Font.html>`_ objects.

   The end point of `range` is specified as the last character position of the span of text, plus one. So, for example, to set 
   the style for a character at position 5, use the range (5, 6).

   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 
   * `style` (`wx.richtext.RichTextAttr <wx.richtext.RichTextAttr.html>`_) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: SetStyleEx(range, style, flags=wx.richtext.RICHTEXT_SETSTYLE_WITH_UNDO)

   Sets the attributes for the given range, passing flags to determine how the attributes are set. 

   The `wx.richtext.RichTextAttr <wx.richtext.RichTextAttr.html>`_ version is generally more efficient because it does not 
   use `wx.Font <../Widgets/wx.Font.html>`_ objects.

   The end point of `range` is specified as the last character position of the span of text, plus one. So, for example, to set 
   the style for a character at position 5, use the range (5, 6).

   `flags` may contain a bit list of the following values:
   
   * ``wx.richtext.RICHTEXT_SETSTYLE_NONE``: no style flag.
   * ``wx.richtext.RICHTEXT_SETSTYLE_WITH_UNDO``: specifies that this operation should be undoable.
   * ``wx.richtext.RICHTEXT_SETSTYLE_OPTIMIZE``: specifies that the style should not be applied if the combined style at this point 
     is already the style in question.
   * ``wx.richtext.RICHTEXT_SETSTYLE_PARAGRAPHS_ONLY``: specifies that the style should only be applied to paragraphs, and not the 
     content. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
   * ``wx.richtext.RICHTEXT_SETSTYLE_CHARACTERS_ONLY``: specifies that the style should only be applied to characters, and not the 
     paragraph. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
   * ``wx.richtext.RICHTEXT_SETSTYLE_RESET``: resets (clears) the existing style before applying the new style.
   * ``wx.richtext.RICHTEXT_SETSTYLE_REMOVE``: removes the specified style. Only the style flags are used in this operation.

   |

   **Parameters:**

   * `range` (`wx.richtext.RichTextRange <wx.richtext.RichTextRange.html>`_) 
   * `style` (`wx.richtext.RichTextAttr <wx.richtext.RichTextAttr.html>`_) 
   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: SetStyleSheet(styleSheet)

   Sets the style sheet associated with the control. 

   A style sheet allows named character and paragraph styles to be applied.

   **Parameters:**

   * `styleSheet` (`wx.richtext.RichTextStyleSheet`) 


--------

.. method:: SetTextCursor(cursor)

   Set text cursor.
   
   **Parameters:**

   * `cursor` (`wx.Cursor <../Widgets/wx.Cursor.html>`_)

--------

.. method:: SetURLCursor(cursor)

   Set URL cursor.
   
   **Parameters:**

   * `cursor` (`wx.Cursor <../Widgets/wx.Cursor.html>`_)

--------

.. method:: SetValue(value)

   Replaces existing content with the given text.

   **Parameters:**

   * `value` (string) 

--------

.. method:: ShowPosition(pos)

   Scrolls the buffer so that the given position is in view.

   **Parameters:**

   * `pos` (long) 

--------

.. method:: SuppressingUndo()

   Returns ``True`` if undo history suppression is on.

   |  

   **Returns:**

   `bool` 

--------

.. method:: Undo()

   Undoes the command at the top of the command history, if there is one.


--------

.. method:: WordLeft(noWords=1, flags=0)

   Moves a number of words to the left.

   **Parameters:**

   * `noWords` (int) 
   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: WordRight(noWords=1, flags=0)

   Move a nuber of words to the right.

   **Parameters:**

   * `noWords` (int) 
   * `flags` (int) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: WriteBitmap(bitmap, bitmapType=wx.BITMAP_TYPE_PNG)

   Write a bitmap at the current insertion point. Supply optional type to
   use for internal and file storage of the raw data.
   
   **Parameters:**

   * `bitmap` (`wx.Bitmap <../Widgets/wx.Bitmap.html>`_)
   * `bitmapType` (int)

   |

   **Returns:**

   `bool` 

--------

.. method:: WriteImage(image, bitmapType=wx.BITMAP_TYPE_PNG)

   Write an image at the current insertion point. Supply an optional type to use for internal and file storage of the raw data.

   **Parameters:**

   * `image` (`wx.Image <../Widgets/wx.Image.html>`_)
   * `bitmapType` (int)

   |  

   **Returns:**

   `bool` 

--------

.. method:: WriteImageBlock(imageBlock)

   Write an image block at the current insertion point.
   
   **Parameters:**

   * `imageBlock` (`wx.richtext.RichTextImageBlock`)

   |

   **Returns:**

   `bool` 

--------

.. method:: WriteImageFile(filename, bitmapType=wx.BITMAP_TYPE_PNG)

   Load an image from file and write at the current insertion point.
   
   **Parameters:**

   * `filename` (string)
   * `bitmapType` (int)

   |

   **Returns:**

   `bool` 

--------

.. method:: WriteText(text)

   Writes text at the current position.

   **Parameters:**

   * `text` (string) 

--------

.. method:: XYToPosition(x, y)

   Translates from column and line number to position.

   **Parameters:**

   * `x` (long) 
   * `y` (long) 

   |  

   **Returns:**

   `long` 

--------

Properties
^^^^^^^^^^


.. attribute:: Buffer

   See `GetBuffer <#GetBuffer>`_

.. attribute:: DefaultStyle

   See `GetDefaultStyle <#GetDefaultStyle>`_ and `SetDefaultStyle <#SetDefaultStyle>`_

.. attribute:: DelayedLayoutThreshold

   See `GetDelayedLayoutThreshold <#GetDelayedLayoutThreshold>`_ and `SetDelayedLayoutThreshold <#SetDelayedLayoutThreshold>`_

.. attribute:: Filename

   See `GetFilename <#GetFilename>`_ and `SetFilename <#SetFilename>`_

.. attribute:: InsertionPoint

   See `GetInsertionPoint <#GetInsertionPoint>`_ and `SetInsertionPoint <#SetInsertionPoint>`_

.. attribute:: InternalSelectionRange

   See `GetInternalSelectionRange <#GetInternalSelectionRange>`_ and `SetInternalSelectionRange <#SetInternalSelectionRange>`_

.. attribute:: LastPosition

   See `GetLastPosition <#GetLastPosition>`_

.. attribute:: NumberOfLines

   See `GetNumberOfLines <#GetNumberOfLines>`_

.. attribute:: Selection

   See `GetSelection <#GetSelection>`_ and `SetSelection <#SetSelection>`_

.. attribute:: SelectionRange

   See `GetSelectionRange <#GetSelectionRange>`_ and `SetSelectionRange <#SetSelectionRange>`_

.. attribute:: StringSelection

   See `GetStringSelection <#GetStringSelection>`_

.. attribute:: StyleSheet

   See `GetStyleSheet <#GetStyleSheet>`_ and `SetStyleSheet <#SetStyleSheet>`_

.. attribute:: Value

   See `GetValue <#GetValue>`_ and `SetValue <#SetValue>`_