wxRichTextCtrl Class Reference
[Rich Text]

#include <wx/richtext/richtextctrl.h>


Detailed Description

wxRichTextCtrl provides a generic, ground-up implementation of a text control capable of showing multiple styles and images.

wxRichTextCtrl sends notification events: see wxRichTextEvent.

It also sends the standard wxTextCtrl events wxEVT_COMMAND_TEXT_ENTER and wxEVT_COMMAND_TEXT_UPDATED, and wxTextUrlEvent when URL content is clicked.

For more information, see the wxRichTextCtrl Overview.

Styles

This class supports the following styles:

Library:  wxRichText
Category:  Rich Text

Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance

Public Member Functions

 wxRichTextCtrl ()
 Default Constructor.
 wxRichTextCtrl (wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &value=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxRE_MULTILINE, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxTextCtrlNameStr)
 Constructor, creating and showing a rich text control.
virtual ~wxRichTextCtrl ()
 Destructor.
virtual wxRichTextRange AddImage (const wxImage &image)
 Adds an image to the control's buffer.
virtual wxRichTextRange AddParagraph (const wxString &text)
 Adds a new paragraph of text to the end of the buffer.
virtual void AppendText (const wxString &text)
 Sets the insertion point to the end of the buffer and writes the text.
virtual bool ApplyAlignmentToSelection (wxTextAttrAlignment alignment)
 Applies the given alignment to the selection (undoable).
virtual bool ApplyBoldToSelection ()
 Apples bold to the selection (undoable).
virtual bool ApplyItalicToSelection ()
 Applies italic to the selection (undoable).
virtual bool ApplyStyle (wxRichTextStyleDefinition *def)
 Applies the given style to the selection.
bool ApplyStyleSheet (wxRichTextStyleSheet *sheet=NULL)
 Applies the style sheet to the buffer, matching paragraph styles in the sheet against named styles in the buffer.
virtual bool ApplyUnderlineToSelection ()
 Applies underline to the selection (undoable).
virtual bool BatchingUndo () const
 Returns true if undo commands are being batched.
bool BeginAlignment (wxTextAttrAlignment alignment)
 Begins using alignment.
virtual bool BeginBatchUndo (const wxString &cmdName)
 Starts batching undo history for commands.
bool BeginBold ()
 Begins using bold.
bool BeginCharacterStyle (const wxString &characterStyle)
 Begins using the named character style.
bool BeginFont (const wxFont &font)
 Begins using this font.
bool BeginFontSize (int pointSize)
 Begins using the given point size.
bool BeginItalic ()
 Begins using italic.
bool BeginLeftIndent (int leftIndent, int leftSubIndent=0)
 Begins applying a left indent and subindent in tenths of a millimetre.
bool BeginLineSpacing (int lineSpacing)
 Begins appling line spacing.
bool BeginListStyle (const wxString &listStyle, int level=1, int number=1)
 Begins using a specified list style.
bool BeginNumberedBullet (int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle=wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD)
 Begins a numbered bullet.
bool BeginParagraphSpacing (int before, int after)
 Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of a millimetre.
bool BeginParagraphStyle (const wxString &paragraphStyle)
 Begins applying the named paragraph style.
bool BeginRightIndent (int rightIndent)
 Begins a right indent, specified in tenths of a millimetre.
virtual bool BeginStyle (const wxTextAttr &style)
 Begins applying a style.
virtual bool BeginSuppressUndo ()
 Starts suppressing undo history for commands.
bool BeginSymbolBullet (const wxString &symbol, int leftIndent, int leftSubIndent, int bulletStyle=wxTEXT_ATTR_BULLET_STYLE_SYMBOL)
 Begins applying a symbol bullet, using a character from the current font.
bool BeginTextColour (const wxColour &colour)
 Begins using this colour.
bool BeginURL (const wxString &url, const wxString &characterStyle=wxEmptyString)
 Begins applying wxTEXT_ATTR_URL to the content.
bool BeginUnderline ()
 Begins using underlining.
virtual bool CanCopy () const
 Returns true if selected content can be copied to the clipboard.
virtual bool CanCut () const
 Returns true if selected content can be copied to the clipboard and deleted.
virtual bool CanDeleteSelection () const
 Returns true if selected content can be deleted.
virtual bool CanPaste () const
 Returns true if the clipboard content can be pasted to the buffer.
virtual bool CanRedo () const
 Returns true if there is a command in the command history that can be redone.
virtual bool CanUndo () const
 Returns true if there is a command in the command history that can be undone.
virtual void Clear ()
 Clears the buffer content, leaving a single empty paragraph.
virtual bool ClearListStyle (const wxRichTextRange &range, int flags=wxRICHTEXT_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.
virtual void Command (wxCommandEvent &event)
 Sends the event to the control.
virtual void Copy ()
 Copies the selected content (if any) to the clipboard.
bool Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &value=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxRE_MULTILINE, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxTextCtrlNameStr)
 Creates the underlying window.
virtual void Cut ()
 Copies the selected content (if any) to the clipboard and deletes the selection.
virtual bool Delete (const wxRichTextRange &range)
 Deletes the content within the given range.
bool DeleteSelectedContent (long *newPos=NULL)
 Deletes content if there is a selection, e.g.
virtual void DeleteSelection ()
 Deletes the content in the selection, if any.
virtual void DiscardEdits ()
 Sets the buffer's modified status to false, and clears the buffer's command history.
bool EndAlignment ()
 Ends alignment.
virtual bool EndAllStyles ()
 Ends application of all styles in the current style stack.
virtual bool EndBatchUndo ()
 Ends batching undo command history.
bool EndBold ()
 Ends using bold.
bool EndCharacterStyle ()
 Ends application of a named character style.
bool EndFont ()
 Ends using a font.
bool EndFontSize ()
 Ends using a point size.
bool EndItalic ()
 Ends using italic.
bool EndLeftIndent ()
 Ends left indent.
bool EndLineSpacing ()
 Ends line spacing.
bool EndListStyle ()
 Ends using a specified list style.
bool EndNumberedBullet ()
 Ends application of a numbered bullet.
bool EndParagraphSpacing ()
 Ends paragraph spacing.
bool EndParagraphStyle ()
 Ends application of a named character style.
bool EndRightIndent ()
 Ends right indent.
virtual bool EndStyle ()
 Ends the current style.
virtual bool EndSuppressUndo ()
 Ends suppressing undo command history.
bool EndSymbolBullet ()
 Ends applying a symbol bullet.
bool EndTextColour ()
 Ends applying a text colour.
bool EndURL ()
 Ends applying a URL.
bool EndUnderline ()
 End applying underlining.
virtual bool ExtendSelection (long oldPosition, long newPosition, int flags)
 Helper function for extending the selection, returning true if the selection was changed.
virtual long FindNextWordPosition (int direction=1) const
 Helper function for finding the caret position for the next word.
void Freeze ()
 Call this function to prevent refresh and allow fast updates, and then Thaw() to refresh the control.
virtual const wxTextAttrGetBasicStyle () const
 Gets the basic (overall) style.
long GetCaretPosition () const
 Returns the current caret position.
bool GetCaretPositionForIndex (long position, wxRect &rect)
 Returns the caret height and position for the given character position.
wxCommandProcessorGetCommandProcessor () const
 Gets the command processor associated with the control's buffer.
virtual const wxTextAttrGetDefaultStyle () const
 Returns the current default style, which can be used to change how subsequently inserted text is displayed.
long GetDelayedLayoutThreshold () const
 Gets the size of the buffer beyond which layout is delayed during resizing.
wxString GetFilename () const
 Gets the current filename associated with the control.
long GetFirstVisiblePosition () const
 Returns the first visible position in the current view.
int GetHandlerFlags () const
 Returns flags that change the behaviour of loading or saving.
virtual long GetInsertionPoint () const
 Returns the current insertion point.
virtual wxTextPos GetLastPosition () const
 Returns the last position in the buffer.
virtual int GetLineLength (long lineNo) const
 Returns the length of the specified line in characters.
virtual wxString GetLineText (long lineNo) const
 Returns the text for the given line.
wxPoint GetLogicalPoint (const wxPoint &ptPhysical) const
 Transforms physical window position to logical (unscrolled) position.
virtual int GetNumberOfLines () const
 Returns the number of lines in the buffer.
wxPoint GetPhysicalPoint (const wxPoint &ptLogical) const
 Transforms logical (unscrolled) position to physical window position.
virtual wxString GetRange (long from, long to) const
 Gets the text for the given range.
virtual void GetSelection (long *from, long *to) const
 Returns the range of the current selection.
wxRichTextRange GetSelectionRange () const
 Returns the selection range in character positions.
virtual wxString GetStringSelection () const
 Returns the text within the current selection range, if any.
virtual bool GetStyle (long position, wxTextAttr &style)
 Gets the attributes at the given position.
virtual bool GetStyleForRange (const wxRichTextRange &range, wxTextAttr &style)
 Gets the attributes common to the specified range.
wxRichTextStyleSheetGetStyleSheet () const
 Returns the style sheet associated with the control, if any.
virtual bool GetUncombinedStyle (long position, wxTextAttr &style)
 Gets the attributes at the given position.
virtual wxString GetValue () const
 Returns the content of the entire control as a string.
wxRichTextLine * GetVisibleLineForCaretPosition (long caretPosition) const
 Internal helper function returning the line for the visible caret position.
virtual bool HasCharacterAttributes (const wxRichTextRange &range, const wxTextAttr &style) const
 Test if this whole range has character attributes of the specified kind.
virtual bool HasParagraphAttributes (const wxRichTextRange &range, const wxTextAttr &style) const
 Test if this whole range has paragraph attributes of the specified kind.
virtual bool HasSelection () const
 Returns true if there is a selection.
void Init ()
 Initialises the members of the control.
bool IsDefaultStyleShowing () const
 Returns true if the user has recently set the default style without moving the caret, and therefore the UI needs to reflect the default style and not the style at the caret.
virtual bool IsEditable () const
 Returns true if the control is editable.
bool IsFrozen () const
 Returns true if Freeze has been called without a Thaw.
virtual bool IsModified () const
 Returns true if the buffer has been modified.
bool IsMultiLine () const
 Returns true if the control is multiline.
bool IsPositionVisible (long pos) const
 Returns true if the given position is visible on the screen.
virtual bool IsSelectionAligned (wxTextAttrAlignment alignment)
 Returns true if all of the selection is aligned according to the specified flag.
virtual bool IsSelectionBold ()
 Returns true if all of the selection is bold.
virtual bool IsSelectionItalics ()
 Returns true if all of the selection is italic.
virtual bool IsSelectionUnderlined ()
 Returns true if all of the selection is underlined.
bool IsSingleLine () const
 Returns true if the control is single-line.
virtual bool KeyboardNavigate (int keyCode, int flags)
 Helper function implementing keyboard navigation.
virtual bool LayoutContent (bool onlyVisibleRect=false)
 Lays out the buffer, which must be done before certain operations, such as setting the caret position.
virtual bool LineBreak ()
 Inserts a line break at the current insertion point.
bool LoadFile (const wxString &file, int type=wxRICHTEXT_TYPE_ANY)
 Loads content into the control's buffer using the given type.
virtual void MarkDirty ()
 Marks the buffer as modified.
virtual bool MoveCaret (long pos, bool showAtLineStart=false)
 Move the caret to the given character position.
void MoveCaretBack (long oldPosition)
 Move the caret one visual step forward: this may mean setting a flag and keeping the same position if we're going from the end of one line to the start of the next, which may be the exact same caret position.
void MoveCaretForward (long oldPosition)
 Move the caret one visual step forward: this may mean setting a flag and keeping the same position if we're going from the end of one line to the start of the next, which may be the exact same caret position.
virtual bool MoveDown (int noLines=1, int flags=0)
 Moves the caret down.
virtual bool MoveEnd (int flags=0)
 Moves to the end of the buffer.
virtual bool MoveHome (int flags=0)
 Moves to the start of the buffer.
virtual bool MoveLeft (int noPositions=1, int flags=0)
 Moves left.
virtual bool MoveRight (int noPositions=1, int flags=0)
 Moves right.
virtual bool MoveToLineEnd (int flags=0)
 Moves to the end of the line.
virtual bool MoveToLineStart (int flags=0)
 Moves to the start of the line.
virtual bool MoveToParagraphEnd (int flags=0)
 Moves to the end of the paragraph.
virtual bool MoveToParagraphStart (int flags=0)
 Moves to the start of the paragraph.
virtual bool MoveUp (int noLines=1, int flags=0)
 Moves up.
virtual bool Newline ()
 Inserts a new paragraph at the current insertion point.
void OnClear (wxCommandEvent &event)
 Standard handler for the wxID_CLEAR command.
void OnContextMenu (wxContextMenuEvent &event)
 Shows a standard context menu with undo, redo, cut, copy, paste, clear, and select all commands.
void OnCopy (wxCommandEvent &event)
 Standard handler for the wxID_COPY command.
void OnCut (wxCommandEvent &event)
 Standard handler for the wxID_CUT command.
void OnDropFiles (wxDropFilesEvent &event)
 Loads the first dropped file.
void OnPaste (wxCommandEvent &event)
 Standard handler for the wxID_PASTE command.
void OnRedo (wxCommandEvent &event)
 Standard handler for the wxID_REDO command.
void OnSelectAll (wxCommandEvent &event)
 Standard handler for the wxID_SELECTALL command.
void OnUndo (wxCommandEvent &event)
 Standard handler for the wxID_PASTE command.
void OnUpdateClear (wxUpdateUIEvent &event)
 Standard update handler for the wxID_CLEAR command.
void OnUpdateCopy (wxUpdateUIEvent &event)
 Standard update handler for the wxID_COPY command.
void OnUpdateCut (wxUpdateUIEvent &event)
 Standard update handler for the wxID_CUT command.
void OnUpdatePaste (wxUpdateUIEvent &event)
 Standard update handler for the wxID_PASTE command.
void OnUpdateRedo (wxUpdateUIEvent &event)
 Standard update handler for the wxID_REDO command.
void OnUpdateSelectAll (wxUpdateUIEvent &event)
 Standard update handler for the wxID_SELECTALL command.
void OnUpdateUndo (wxUpdateUIEvent &event)
 Standard update handler for the wxID_UNDO command.
virtual bool PageDown (int noPages=1, int flags=0)
 Moves one or more pages down.
virtual bool PageUp (int noPages=1, int flags=0)
 Moves one or more pages up.
virtual void PaintBackground (wxDC &dc)
 Paints the background.
virtual void Paste ()
 Pastes content from the clipboard to the buffer.
virtual void PositionCaret ()
 Internal function to position the visible caret according to the current caret position.
virtual bool PositionToXY (long pos, long *x, long *y) const
 Converts a text position to zero-based column and line numbers.
virtual void Redo ()
 Redoes the current command.
virtual void Remove (long from, long to)
 Removes the content in the specified range.
virtual void Replace (long from, long to, const wxString &value)
 Replaces the content in the specified range with the string specified by value.
bool SaveFile (const wxString &file=wxEmptyString, int type=wxRICHTEXT_TYPE_ANY)
 Saves the buffer content using the given type.
virtual bool ScrollIntoView (long position, int keyCode)
 Scrolls position into view.
virtual void SelectAll ()
 Selects all the text in the buffer.
virtual void SelectNone ()
 Cancels any selection.
void SetAndShowDefaultStyle (const wxTextAttr &attr)
 Sets attr as the default style and tells the control that the UI should reflect this attribute until the user moves the caret.
virtual void SetBasicStyle (const wxTextAttr &style)
 Sets the basic (overall) style.
void SetCaretPosition (long position, bool showAtLineStart=false)
 Sets the caret position.
virtual bool SetDefaultStyle (const wxTextAttr &style)
 Sets the current default style, which can be used to change how subsequently inserted text is displayed.
bool SetDefaultStyleToCursorStyle ()
 Sets the default style to the style under the cursor.
void SetDelayedLayoutThreshold (long threshold)
 Sets the size of the buffer beyond which layout is delayed during resizing.
virtual void SetEditable (bool editable)
 Makes the control editable, or not.
void SetFilename (const wxString &filename)
 Sets the current filename.
virtual bool SetFont (const wxFont &font)
 Sets the font, and also the basic and default attributes (see wxRichTextCtrl::SetDefaultStyle).
void SetHandlerFlags (int flags)
 Sets flags that change the behaviour of loading or saving.
virtual void SetInsertionPoint (long pos)
 Sets the insertion point and causes the current editing style to be taken from the new position (unlike wxRichTextCtrl::SetCaretPosition).
virtual void SetInsertionPointEnd ()
 Sets the insertion point to the end of the text control.
virtual void SetSelection (long from, long to)
 Sets the selection to the given range.
void SetSelectionRange (const wxRichTextRange &range)
 Sets the selection to the given range.
virtual bool SetStyleEx (const wxRichTextRange &range, const wxTextAttr &style, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO)
 Sets the attributes for the given range, passing flags to determine how the attributes are set.
void SetStyleSheet (wxRichTextStyleSheet *styleSheet)
 Sets the style sheet associated with the control.
virtual void SetValue (const wxString &value)
 Replaces existing content with the given text.
virtual void SetupScrollbars (bool atTop=false)
 A helper function setting up scrollbars, for example after a resize.
virtual void ShowPosition (long pos)
 Scrolls the buffer so that the given position is in view.
virtual bool SuppressingUndo () const
 Returns true if undo history suppression is on.
void Thaw ()
 Call this function to end a Freeze and refresh the display.
virtual void Undo ()
 Undoes the command at the top of the command history, if there is one.
virtual bool WordLeft (int noWords=1, int flags=0)
 Moves a number of words to the left.
virtual bool WordRight (int noWords=1, int flags=0)
 Move a nuber of words to the right.
virtual bool WriteImage (const wxString &filename, wxBitmapType bitmapType)
 Loads an image from a file and writes it at the current insertion point.
virtual bool WriteImage (const wxRichTextImageBlock &imageBlock)
 Writes an image block at the current insertion point.
virtual void WriteText (const wxString &text)
 Writes text at the current position.
virtual long XYToPosition (long x, long y) const
 Translates from column and line number to position.



const wxRichTextBuffer GetBuffer ()
 Returns the buffer associated with the control.
const wxRichTextBufferGetBuffer ()
 Returns the buffer associated with the control.
wxTextCtrlHitTestResult HitTest (const wxPoint &pt, long *pos) const
 Finds the character at the given position in pixels.
const wxTextCtrlHitTestResult HitTest (const wxPoint &pt, wxTextCoord *col, wxTextCoord *row) const
 Returns the buffer associated with the control.
bool NumberList (const wxRichTextRange &range, const wxRichTextListStyleDefinition *style, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=-1, int listLevel=-1)
 Numbers the paragraphs in the given range.
bool Number (const wxRichTextRange &range, const wxString &styleName, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=-1, int listLevel=-1)
 Returns the buffer associated with the control.
bool PromoteList (int promoteBy, const wxRichTextRange &range, const wxRichTextListStyleDefinition *style, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int listLevel=-1)
 Promotes or demotes the paragraphs in the given range.
bool PromoteList (int promoteBy, const wxRichTextRange &range, const wxString &styleName, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int listLevel=-1)
 Returns the buffer associated with the control.
bool SetListStyle (const wxRichTextRange &range, const wxRichTextListStyleDefinition *style, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=-1, int listLevel=-1)
 Sets the list attributes for the given range, passing flags to determine how the attributes are set.
bool SetListStyle (const wxRichTextRange &range, const wxString &styleName, int flags=wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom=-1, int listLevel=-1)
 Returns the buffer associated with the control.
bool SetStyle (const wxRichTextRange &range, const wxTextAttr &style)
 Sets the attributes for the given range.
bool SetStyle (long start, long end, const wxTextAttr &style)
 Returns the buffer associated with the control.
bool WriteImage (const wxBitmap &bitmap, int bitmapType=wxBITMAP_TYPE_PNG)
 Write a bitmap or image at the current insertion point.
bool WriteImage (const wxImage &image, int bitmapType=wxBITMAP_TYPE_PNG)
 Returns the buffer associated with the control.

Protected Member Functions

virtual wxSize DoGetBestSize () const
 Currently this simply returns wxSize(10, 10).
void InitCommandEvent (wxCommandEvent &event) const
 Initialises the command event.

List of all members.


Constructor & Destructor Documentation

wxRichTextCtrl::wxRichTextCtrl (  ) 

Default Constructor.

wxRichTextCtrl::wxRichTextCtrl ( wxWindow parent,
wxWindowID  id = wxID_ANY,
const wxString value = wxEmptyString,
const wxPoint pos = wxDefaultPosition,
const wxSize size = wxDefaultSize,
long  style = wxRE_MULTILINE,
const wxValidator validator = wxDefaultValidator,
const wxString name = wxTextCtrlNameStr 
)

Constructor, creating and showing a rich text control.

Parameters:
parent Parent window. Must not be NULL.
id Window identifier. The value wxID_ANY indicates a default value.
value Default string.
pos Window position.
size Window size.
style Window style.
validator Window validator.
name Window name.
See also:
Create(), wxValidator
virtual wxRichTextCtrl::~wxRichTextCtrl (  )  [virtual]

Destructor.


Member Function Documentation

virtual wxRichTextRange wxRichTextCtrl::AddImage ( const wxImage image  )  [virtual]

Adds an image to the control's buffer.

virtual wxRichTextRange wxRichTextCtrl::AddParagraph ( const wxString text  )  [virtual]

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

virtual void wxRichTextCtrl::AppendText ( const wxString text  )  [virtual]

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

virtual bool wxRichTextCtrl::ApplyAlignmentToSelection ( wxTextAttrAlignment  alignment  )  [virtual]

Applies the given alignment to the selection (undoable).

For alignment values, see wxTextAttr.

virtual bool wxRichTextCtrl::ApplyBoldToSelection (  )  [virtual]

Apples bold to the selection (undoable).

virtual bool wxRichTextCtrl::ApplyItalicToSelection (  )  [virtual]

Applies italic to the selection (undoable).

virtual bool wxRichTextCtrl::ApplyStyle ( wxRichTextStyleDefinition def  )  [virtual]

Applies the given style to the selection.

bool wxRichTextCtrl::ApplyStyleSheet ( wxRichTextStyleSheet sheet = NULL  ) 

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 NULL, the sheet set with SetStyleSheet() is used. Currently this applies paragraph styles only.

virtual bool wxRichTextCtrl::ApplyUnderlineToSelection (  )  [virtual]

Applies underline to the selection (undoable).

virtual bool wxRichTextCtrl::BatchingUndo (  )  const [virtual]

Returns true if undo commands are being batched.

bool wxRichTextCtrl::BeginAlignment ( wxTextAttrAlignment  alignment  ) 

Begins using alignment.

For alignment values, see wxTextAttr.

virtual bool wxRichTextCtrl::BeginBatchUndo ( const wxString cmdName  )  [virtual]

Starts batching undo history for commands.

bool wxRichTextCtrl::BeginBold (  ) 

Begins using bold.

bool wxRichTextCtrl::BeginCharacterStyle ( const wxString characterStyle  ) 

Begins using the named character style.

bool wxRichTextCtrl::BeginFont ( const wxFont font  ) 

Begins using this font.

bool wxRichTextCtrl::BeginFontSize ( int  pointSize  ) 

Begins using the given point size.

bool wxRichTextCtrl::BeginItalic (  ) 

Begins using italic.

bool wxRichTextCtrl::BeginLeftIndent ( int  leftIndent,
int  leftSubIndent = 0 
)

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

The subindent is an offset from the left edge 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 to the right of the subsequent lines.

wxRichTextBuffer uses indentation to render a bulleted item. The content of the paragraph, including the first line, starts at the leftIndent plus the leftSubIndent.

Parameters:
leftIndent The distance between the margin and the bullet.
leftSubIndent The distance between the left edge of the bullet and the left edge of the actual paragraph.
bool wxRichTextCtrl::BeginLineSpacing ( int  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 wxTextAttrLineSpacing constants are defined for convenience.

bool wxRichTextCtrl::BeginListStyle ( const wxString listStyle,
int  level = 1,
int  number = 1 
)

Begins using a specified list style.

Optionally, you can also pass a level and a number.

bool wxRichTextCtrl::BeginNumberedBullet ( int  bulletNumber,
int  leftIndent,
int  leftSubIndent,
int  bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_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.

bulletNumber is a number, usually starting with 1. leftIndent and leftSubIndent are values in tenths of a millimetre. bulletStyle is a bitlist of the wxTextAttrBulletStyle values.

wxRichTextBuffer 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.

bool wxRichTextCtrl::BeginParagraphSpacing ( int  before,
int  after 
)

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

bool wxRichTextCtrl::BeginParagraphStyle ( const wxString paragraphStyle  ) 

Begins applying the named paragraph style.

bool wxRichTextCtrl::BeginRightIndent ( int  rightIndent  ) 

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

virtual bool wxRichTextCtrl::BeginStyle ( const wxTextAttr style  )  [virtual]

Begins applying a style.

virtual bool wxRichTextCtrl::BeginSuppressUndo (  )  [virtual]

Starts suppressing undo history for commands.

bool wxRichTextCtrl::BeginSymbolBullet ( const wxString symbol,
int  leftIndent,
int  leftSubIndent,
int  bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL 
)

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

See BeginNumberedBullet() for an explanation of how indentation is used to render the bulleted paragraph.

bool wxRichTextCtrl::BeginTextColour ( const wxColour colour  ) 

Begins using this colour.

bool wxRichTextCtrl::BeginUnderline (  ) 

Begins using underlining.

bool wxRichTextCtrl::BeginURL ( const wxString url,
const wxString characterStyle = wxEmptyString 
)

Begins applying wxTEXT_ATTR_URL to the content.

Pass a URL and optionally, a character style to apply, since it is common to mark a URL with a familiar style such as blue text with underlining.

virtual bool wxRichTextCtrl::CanCopy (  )  const [virtual]

Returns true if selected content can be copied to the clipboard.

virtual bool wxRichTextCtrl::CanCut (  )  const [virtual]

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

virtual bool wxRichTextCtrl::CanDeleteSelection (  )  const [virtual]

Returns true if selected content can be deleted.

virtual bool wxRichTextCtrl::CanPaste (  )  const [virtual]

Returns true if the clipboard content can be pasted to the buffer.

virtual bool wxRichTextCtrl::CanRedo (  )  const [virtual]

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

virtual bool wxRichTextCtrl::CanUndo (  )  const [virtual]

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

virtual void wxRichTextCtrl::Clear (  )  [virtual]

Clears the buffer content, leaving a single empty paragraph.

Cannot be undone.

virtual bool wxRichTextCtrl::ClearListStyle ( const wxRichTextRange range,
int  flags = wxRICHTEXT_SETSTYLE_WITH_UNDO 
) [virtual]

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:

  • wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
See also:
SetListStyle(), PromoteList(), NumberList().
virtual void wxRichTextCtrl::Command ( wxCommandEvent event  )  [virtual]

Sends the event to the control.

virtual void wxRichTextCtrl::Copy (  )  [virtual]

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

bool wxRichTextCtrl::Create ( wxWindow parent,
wxWindowID  id = wxID_ANY,
const wxString value = wxEmptyString,
const wxPoint pos = wxDefaultPosition,
const wxSize size = wxDefaultSize,
long  style = wxRE_MULTILINE,
const wxValidator validator = wxDefaultValidator,
const wxString name = wxTextCtrlNameStr 
)

Creates the underlying window.

virtual void wxRichTextCtrl::Cut (  )  [virtual]

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

This is undoable.

virtual bool wxRichTextCtrl::Delete ( const wxRichTextRange range  )  [virtual]

Deletes the content within the given range.

bool wxRichTextCtrl::DeleteSelectedContent ( long *  newPos = NULL  ) 

Deletes content if there is a selection, e.g.

when pressing a key. Returns the new caret position in newPos, or leaves it if there was no action. This is undoable.

wxPerl Note: In wxPerl this method takes no arguments and returns a 2-element list (ok, newPos).

virtual void wxRichTextCtrl::DeleteSelection (  )  [virtual]

Deletes the content in the selection, if any.

This is undoable.

virtual void wxRichTextCtrl::DiscardEdits (  )  [virtual]

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

virtual wxSize wxRichTextCtrl::DoGetBestSize (  )  const [protected, virtual]

Currently this simply returns wxSize(10, 10).

bool wxRichTextCtrl::EndAlignment (  ) 

Ends alignment.

virtual bool wxRichTextCtrl::EndAllStyles (  )  [virtual]

Ends application of all styles in the current style stack.

virtual bool wxRichTextCtrl::EndBatchUndo (  )  [virtual]

Ends batching undo command history.

bool wxRichTextCtrl::EndBold (  ) 

Ends using bold.

bool wxRichTextCtrl::EndCharacterStyle (  ) 

Ends application of a named character style.

bool wxRichTextCtrl::EndFont (  ) 

Ends using a font.

bool wxRichTextCtrl::EndFontSize (  ) 

Ends using a point size.

bool wxRichTextCtrl::EndItalic (  ) 

Ends using italic.

bool wxRichTextCtrl::EndLeftIndent (  ) 

Ends left indent.

bool wxRichTextCtrl::EndLineSpacing (  ) 

Ends line spacing.

bool wxRichTextCtrl::EndListStyle (  ) 

Ends using a specified list style.

bool wxRichTextCtrl::EndNumberedBullet (  ) 

Ends application of a numbered bullet.

bool wxRichTextCtrl::EndParagraphSpacing (  ) 

Ends paragraph spacing.

bool wxRichTextCtrl::EndParagraphStyle (  ) 

Ends application of a named character style.

bool wxRichTextCtrl::EndRightIndent (  ) 

Ends right indent.

virtual bool wxRichTextCtrl::EndStyle (  )  [virtual]

Ends the current style.

virtual bool wxRichTextCtrl::EndSuppressUndo (  )  [virtual]

Ends suppressing undo command history.

bool wxRichTextCtrl::EndSymbolBullet (  ) 

Ends applying a symbol bullet.

bool wxRichTextCtrl::EndTextColour (  ) 

Ends applying a text colour.

bool wxRichTextCtrl::EndUnderline (  ) 

End applying underlining.

bool wxRichTextCtrl::EndURL (  ) 

Ends applying a URL.

virtual bool wxRichTextCtrl::ExtendSelection ( long  oldPosition,
long  newPosition,
int  flags 
) [virtual]

Helper function for extending the selection, returning true if the selection was changed.

Selections are in caret positions.

virtual long wxRichTextCtrl::FindNextWordPosition ( int  direction = 1  )  const [virtual]

Helper function for finding the caret position for the next word.

Direction is 1 (forward) or -1 (backwards).

void wxRichTextCtrl::Freeze (  ) 

Call this function to prevent refresh and allow fast updates, and then Thaw() to refresh the control.

virtual const wxTextAttr& wxRichTextCtrl::GetBasicStyle (  )  const [virtual]

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).

const wxRichTextBuffer& wxRichTextCtrl::GetBuffer (  ) 

Returns the buffer associated with the control.

const wxRichTextBuffer wxRichTextCtrl::GetBuffer (  ) 

Returns the buffer associated with the control.

long wxRichTextCtrl::GetCaretPosition (  )  const

Returns the current caret position.

bool wxRichTextCtrl::GetCaretPositionForIndex ( long  position,
wxRect rect 
)

Returns the caret height and position for the given character position.

wxPerl Note: In wxPerl this method is implemented as GetCaretPositionForIndex(position) returning a 2-element list (ok, rect).

wxCommandProcessor* wxRichTextCtrl::GetCommandProcessor (  )  const

Gets the command processor associated with the control's buffer.

virtual const wxTextAttr& wxRichTextCtrl::GetDefaultStyle (  )  const [virtual]

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

long wxRichTextCtrl::GetDelayedLayoutThreshold (  )  const

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

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

wxString wxRichTextCtrl::GetFilename (  )  const

Gets the current filename associated with the control.

long wxRichTextCtrl::GetFirstVisiblePosition (  )  const

Returns the first visible position in the current view.

int wxRichTextCtrl::GetHandlerFlags (  )  const

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.

virtual long wxRichTextCtrl::GetInsertionPoint (  )  const [virtual]

Returns the current insertion point.

virtual wxTextPos wxRichTextCtrl::GetLastPosition (  )  const [virtual]

Returns the last position in the buffer.

virtual int wxRichTextCtrl::GetLineLength ( long  lineNo  )  const [virtual]

Returns the length of the specified line in characters.

virtual wxString wxRichTextCtrl::GetLineText ( long  lineNo  )  const [virtual]

Returns the text for the given line.

wxPoint wxRichTextCtrl::GetLogicalPoint ( const wxPoint ptPhysical  )  const

Transforms physical window position to logical (unscrolled) position.

virtual int wxRichTextCtrl::GetNumberOfLines (  )  const [virtual]

Returns the number of lines in the buffer.

wxPoint wxRichTextCtrl::GetPhysicalPoint ( const wxPoint ptLogical  )  const

Transforms logical (unscrolled) position to physical window position.

virtual wxString wxRichTextCtrl::GetRange ( long  from,
long  to 
) const [virtual]

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.

virtual void wxRichTextCtrl::GetSelection ( long *  from,
long *  to 
) const [virtual]

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.

wxRichTextRange wxRichTextCtrl::GetSelectionRange (  )  const

Returns the selection range in character positions.

-1, -1 means no selection.

virtual wxString wxRichTextCtrl::GetStringSelection (  )  const [virtual]

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

virtual bool wxRichTextCtrl::GetStyle ( long  position,
wxTextAttr style 
) [virtual]

Gets the attributes at the given position.

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().

wxPerl Note: In wxPerl this method is implemented as GetStyle(position) returning a 2-element list (ok, attr).

virtual bool wxRichTextCtrl::GetStyleForRange ( const wxRichTextRange range,
wxTextAttr style 
) [virtual]

Gets the attributes common to the specified range.

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

wxPerl Note: In wxPerl this method is implemented as GetStyleForRange(position) returning a 2-element list (ok, attr).

wxRichTextStyleSheet* wxRichTextCtrl::GetStyleSheet (  )  const

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

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

virtual bool wxRichTextCtrl::GetUncombinedStyle ( long  position,
wxTextAttr style 
) [virtual]

Gets the attributes at the given position.

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().

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

wxPerl Note: In wxPerl this method is implemented as GetUncombinedStyle(position) returning a 2-element list (ok, attr).

virtual wxString wxRichTextCtrl::GetValue (  )  const [virtual]

Returns the content of the entire control as a string.

wxRichTextLine* wxRichTextCtrl::GetVisibleLineForCaretPosition ( long  caretPosition  )  const

Internal helper function returning the line for the visible caret position.

If the caret is shown at the very end of the line, it means the next character is actually on the following line. So this function gets the line we're expecting to find if this is the case.

virtual bool wxRichTextCtrl::HasCharacterAttributes ( const wxRichTextRange range,
const wxTextAttr style 
) const [virtual]

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.

virtual bool wxRichTextCtrl::HasParagraphAttributes ( const wxRichTextRange range,
const wxTextAttr style 
) const [virtual]

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.

virtual bool wxRichTextCtrl::HasSelection (  )  const [virtual]

Returns true if there is a selection.

const wxTextCtrlHitTestResult wxRichTextCtrl::HitTest ( const wxPoint pt,
wxTextCoord *  col,
wxTextCoord *  row 
) const

Returns the buffer associated with the control.

wxTextCtrlHitTestResult wxRichTextCtrl::HitTest ( const wxPoint pt,
long *  pos 
) const

Finds the character at the given position in pixels.

pt is in device coords (not adjusted for the client area origin nor for scrolling).

void wxRichTextCtrl::Init (  ) 

Initialises the members of the control.

void wxRichTextCtrl::InitCommandEvent ( wxCommandEvent event  )  const [protected]

Initialises the command event.

bool wxRichTextCtrl::IsDefaultStyleShowing (  )  const

Returns true if the user has recently set the default style without moving the caret, and therefore the UI needs to reflect the default style and not the style at the caret.

Below is an example of code that uses this function to determine whether the UI should show that the current style is bold.

See also:
SetAndShowDefaultStyle().
virtual bool wxRichTextCtrl::IsEditable (  )  const [virtual]

Returns true if the control is editable.

bool wxRichTextCtrl::IsFrozen (  )  const

Returns true if Freeze has been called without a Thaw.

virtual bool wxRichTextCtrl::IsModified (  )  const [virtual]

Returns true if the buffer has been modified.

bool wxRichTextCtrl::IsMultiLine (  )  const

Returns true if the control is multiline.

bool wxRichTextCtrl::IsPositionVisible ( long  pos  )  const

Returns true if the given position is visible on the screen.

virtual bool wxRichTextCtrl::IsSelectionAligned ( wxTextAttrAlignment  alignment  )  [virtual]

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

virtual bool wxRichTextCtrl::IsSelectionBold (  )  [virtual]

Returns true if all of the selection is bold.

virtual bool wxRichTextCtrl::IsSelectionItalics (  )  [virtual]

Returns true if all of the selection is italic.

virtual bool wxRichTextCtrl::IsSelectionUnderlined (  )  [virtual]

Returns true if all of the selection is underlined.

bool wxRichTextCtrl::IsSingleLine (  )  const

Returns true if the control is single-line.

Currently wxRichTextCtrl does not support single-line editing.

virtual bool wxRichTextCtrl::KeyboardNavigate ( int  keyCode,
int  flags 
) [virtual]

Helper function implementing keyboard navigation.

virtual bool wxRichTextCtrl::LayoutContent ( bool  onlyVisibleRect = false  )  [virtual]

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.

virtual bool wxRichTextCtrl::LineBreak (  )  [virtual]

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 wxChar value wxRichTextLineBreakChar to text content, or by typing Shift-Return.

bool wxRichTextCtrl::LoadFile ( const wxString file,
int  type = wxRICHTEXT_TYPE_ANY 
)

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

If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from the filename extension.

This function looks for a suitable wxRichTextFileHandler object.

virtual void wxRichTextCtrl::MarkDirty (  )  [virtual]

Marks the buffer as modified.

virtual bool wxRichTextCtrl::MoveCaret ( long  pos,
bool  showAtLineStart = false 
) [virtual]

Move the caret to the given character position.

Please note that this does not update the current editing style from the new position; to do that, call wxRichTextCtrl::SetInsertionPoint instead.

void wxRichTextCtrl::MoveCaretBack ( long  oldPosition  ) 

Move the caret one visual step forward: this may mean setting a flag and keeping the same position if we're going from the end of one line to the start of the next, which may be the exact same caret position.

void wxRichTextCtrl::MoveCaretForward ( long  oldPosition  ) 

Move the caret one visual step forward: this may mean setting a flag and keeping the same position if we're going from the end of one line to the start of the next, which may be the exact same caret position.

virtual bool wxRichTextCtrl::MoveDown ( int  noLines = 1,
int  flags = 0 
) [virtual]

Moves the caret down.

virtual bool wxRichTextCtrl::MoveEnd ( int  flags = 0  )  [virtual]

Moves to the end of the buffer.

virtual bool wxRichTextCtrl::MoveHome ( int  flags = 0  )  [virtual]

Moves to the start of the buffer.

virtual bool wxRichTextCtrl::MoveLeft ( int  noPositions = 1,
int  flags = 0 
) [virtual]

Moves left.

virtual bool wxRichTextCtrl::MoveRight ( int  noPositions = 1,
int  flags = 0 
) [virtual]

Moves right.

virtual bool wxRichTextCtrl::MoveToLineEnd ( int  flags = 0  )  [virtual]

Moves to the end of the line.

virtual bool wxRichTextCtrl::MoveToLineStart ( int  flags = 0  )  [virtual]

Moves to the start of the line.

virtual bool wxRichTextCtrl::MoveToParagraphEnd ( int  flags = 0  )  [virtual]

Moves to the end of the paragraph.

virtual bool wxRichTextCtrl::MoveToParagraphStart ( int  flags = 0  )  [virtual]

Moves to the start of the paragraph.

virtual bool wxRichTextCtrl::MoveUp ( int  noLines = 1,
int  flags = 0 
) [virtual]

Moves up.

virtual bool wxRichTextCtrl::Newline (  )  [virtual]

Inserts a new paragraph at the current insertion point.

See also:
LineBreak().
bool wxRichTextCtrl::Number ( const wxRichTextRange range,
const wxString styleName,
int  flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int  startFrom = -1,
int  listLevel = -1 
)

Returns the buffer associated with the control.

bool wxRichTextCtrl::NumberList ( const wxRichTextRange range,
const wxRichTextListStyleDefinition style,
int  flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int  startFrom = -1,
int  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:

  • wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
  • wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from startFrom, otherwise existing attributes are used.
  • wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
See also:
SetListStyle(), PromoteList(), ClearListStyle().
void wxRichTextCtrl::OnClear ( wxCommandEvent event  ) 

Standard handler for the wxID_CLEAR command.

void wxRichTextCtrl::OnContextMenu ( wxContextMenuEvent event  ) 

Shows a standard context menu with undo, redo, cut, copy, paste, clear, and select all commands.

void wxRichTextCtrl::OnCopy ( wxCommandEvent event  ) 

Standard handler for the wxID_COPY command.

void wxRichTextCtrl::OnCut ( wxCommandEvent event  ) 

Standard handler for the wxID_CUT command.

void wxRichTextCtrl::OnDropFiles ( wxDropFilesEvent event  ) 

Loads the first dropped file.

void wxRichTextCtrl::OnPaste ( wxCommandEvent event  ) 

Standard handler for the wxID_PASTE command.

void wxRichTextCtrl::OnRedo ( wxCommandEvent event  ) 

Standard handler for the wxID_REDO command.

void wxRichTextCtrl::OnSelectAll ( wxCommandEvent event  ) 

Standard handler for the wxID_SELECTALL command.

void wxRichTextCtrl::OnUndo ( wxCommandEvent event  ) 

Standard handler for the wxID_PASTE command.

void wxRichTextCtrl::OnUpdateClear ( wxUpdateUIEvent event  ) 

Standard update handler for the wxID_CLEAR command.

void wxRichTextCtrl::OnUpdateCopy ( wxUpdateUIEvent event  ) 

Standard update handler for the wxID_COPY command.

void wxRichTextCtrl::OnUpdateCut ( wxUpdateUIEvent event  ) 

Standard update handler for the wxID_CUT command.

void wxRichTextCtrl::OnUpdatePaste ( wxUpdateUIEvent event  ) 

Standard update handler for the wxID_PASTE command.

void wxRichTextCtrl::OnUpdateRedo ( wxUpdateUIEvent event  ) 

Standard update handler for the wxID_REDO command.

void wxRichTextCtrl::OnUpdateSelectAll ( wxUpdateUIEvent event  ) 

Standard update handler for the wxID_SELECTALL command.

void wxRichTextCtrl::OnUpdateUndo ( wxUpdateUIEvent event  ) 

Standard update handler for the wxID_UNDO command.

virtual bool wxRichTextCtrl::PageDown ( int  noPages = 1,
int  flags = 0 
) [virtual]

Moves one or more pages down.

virtual bool wxRichTextCtrl::PageUp ( int  noPages = 1,
int  flags = 0 
) [virtual]

Moves one or more pages up.

virtual void wxRichTextCtrl::PaintBackground ( wxDC dc  )  [virtual]

Paints the background.

virtual void wxRichTextCtrl::Paste (  )  [virtual]

Pastes content from the clipboard to the buffer.

virtual void wxRichTextCtrl::PositionCaret (  )  [virtual]

Internal function to position the visible caret according to the current caret position.

virtual bool wxRichTextCtrl::PositionToXY ( long  pos,
long *  x,
long *  y 
) const [virtual]

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

bool wxRichTextCtrl::PromoteList ( int  promoteBy,
const wxRichTextRange range,
const wxString styleName,
int  flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int  listLevel = -1 
)

Returns the buffer associated with the control.

bool wxRichTextCtrl::PromoteList ( int  promoteBy,
const wxRichTextRange range,
const wxRichTextListStyleDefinition style,
int  flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int  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:

  • wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
  • wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from startFrom, otherwise existing attributes are used.
  • wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
See also:
SetListStyle(),
SetListStyle(), ClearListStyle().
virtual void wxRichTextCtrl::Redo (  )  [virtual]

Redoes the current command.

virtual void wxRichTextCtrl::Remove ( long  from,
long  to 
) [virtual]

Removes the content in the specified range.

virtual void wxRichTextCtrl::Replace ( long  from,
long  to,
const wxString value 
) [virtual]

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

bool wxRichTextCtrl::SaveFile ( const wxString file = wxEmptyString,
int  type = wxRICHTEXT_TYPE_ANY 
)

Saves the buffer content using the given type.

If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from the filename extension.

This function looks for a suitable wxRichTextFileHandler object.

virtual bool wxRichTextCtrl::ScrollIntoView ( long  position,
int  keyCode 
) [virtual]

Scrolls position into view.

This function takes a caret position.

virtual void wxRichTextCtrl::SelectAll (  )  [virtual]

Selects all the text in the buffer.

virtual void wxRichTextCtrl::SelectNone (  )  [virtual]

Cancels any selection.

void wxRichTextCtrl::SetAndShowDefaultStyle ( const wxTextAttr attr  ) 

Sets attr as the default style and tells the control that the UI should reflect this attribute until the user moves the caret.

See also:
IsDefaultStyleShowing().
virtual void wxRichTextCtrl::SetBasicStyle ( const wxTextAttr style  )  [virtual]

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).

void wxRichTextCtrl::SetCaretPosition ( long  position,
bool  showAtLineStart = false 
)

Sets the caret position.

The caret position is the character position just before the caret. A value of -1 means the caret is at the start of the buffer. Please note that this does not update the current editing style from the new position or cause the actual caret to be refreshed; to do that, call wxRichTextCtrl::SetInsertionPoint instead.

virtual bool wxRichTextCtrl::SetDefaultStyle ( const wxTextAttr style  )  [virtual]

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

bool wxRichTextCtrl::SetDefaultStyleToCursorStyle (  ) 

Sets the default style to the style under the cursor.

void wxRichTextCtrl::SetDelayedLayoutThreshold ( long  threshold  ) 

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

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

virtual void wxRichTextCtrl::SetEditable ( bool  editable  )  [virtual]

Makes the control editable, or not.

void wxRichTextCtrl::SetFilename ( const wxString filename  ) 

Sets the current filename.

virtual bool wxRichTextCtrl::SetFont ( const wxFont font  )  [virtual]

Sets the font, and also the basic and default attributes (see wxRichTextCtrl::SetDefaultStyle).

void wxRichTextCtrl::SetHandlerFlags ( int  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.

virtual void wxRichTextCtrl::SetInsertionPoint ( long  pos  )  [virtual]

Sets the insertion point and causes the current editing style to be taken from the new position (unlike wxRichTextCtrl::SetCaretPosition).

virtual void wxRichTextCtrl::SetInsertionPointEnd (  )  [virtual]

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

bool wxRichTextCtrl::SetListStyle ( const wxRichTextRange range,
const wxString styleName,
int  flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int  startFrom = -1,
int  listLevel = -1 
)

Returns the buffer associated with the control.

bool wxRichTextCtrl::SetListStyle ( const wxRichTextRange range,
const wxRichTextListStyleDefinition style,
int  flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,
int  startFrom = -1,
int  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:

  • wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable.
  • wxRICHTEXT_SETSTYLE_RENUMBER: specifies that numbering should start from startFrom, otherwise existing attributes are used.
  • wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
See also:
NumberList(), PromoteList(), ClearListStyle().
virtual void wxRichTextCtrl::SetSelection ( long  from,
long  to 
) [virtual]

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).

void wxRichTextCtrl::SetSelectionRange ( const wxRichTextRange 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).

bool wxRichTextCtrl::SetStyle ( long  start,
long  end,
const wxTextAttr style 
)

Returns the buffer associated with the control.

bool wxRichTextCtrl::SetStyle ( const wxRichTextRange range,
const wxTextAttr style 
)

Sets the attributes for 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 style for a character at position 5, use the range (5,6).

virtual bool wxRichTextCtrl::SetStyleEx ( const wxRichTextRange range,
const wxTextAttr style,
int  flags = wxRICHTEXT_SETSTYLE_WITH_UNDO 
) [virtual]

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

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:

  • wxRICHTEXT_SETSTYLE_NONE: no style flag.
  • wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this operation should be undoable.
  • wxRICHTEXT_SETSTYLE_OPTIMIZE: specifies that the style should not be applied if the combined style at this point is already the style in question.
  • wxRICHTEXT_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.
  • wxRICHTEXT_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.
  • wxRICHTEXT_SETSTYLE_RESET: resets (clears) the existing style before applying the new style.
  • wxRICHTEXT_SETSTYLE_REMOVE: removes the specified style. Only the style flags are used in this operation.
void wxRichTextCtrl::SetStyleSheet ( wxRichTextStyleSheet styleSheet  ) 

Sets the style sheet associated with the control.

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

virtual void wxRichTextCtrl::SetupScrollbars ( bool  atTop = false  )  [virtual]

A helper function setting up scrollbars, for example after a resize.

virtual void wxRichTextCtrl::SetValue ( const wxString value  )  [virtual]

Replaces existing content with the given text.

virtual void wxRichTextCtrl::ShowPosition ( long  pos  )  [virtual]

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

virtual bool wxRichTextCtrl::SuppressingUndo (  )  const [virtual]

Returns true if undo history suppression is on.

void wxRichTextCtrl::Thaw (  ) 

Call this function to end a Freeze and refresh the display.

virtual void wxRichTextCtrl::Undo (  )  [virtual]

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

virtual bool wxRichTextCtrl::WordLeft ( int  noWords = 1,
int  flags = 0 
) [virtual]

Moves a number of words to the left.

virtual bool wxRichTextCtrl::WordRight ( int  noWords = 1,
int  flags = 0 
) [virtual]

Move a nuber of words to the right.

bool wxRichTextCtrl::WriteImage ( const wxImage image,
int  bitmapType = wxBITMAP_TYPE_PNG 
)

Returns the buffer associated with the control.

bool wxRichTextCtrl::WriteImage ( const wxBitmap bitmap,
int  bitmapType = wxBITMAP_TYPE_PNG 
)

Write a bitmap or image at the current insertion point.

Supply an optional type to use for internal and file storage of the raw data.

virtual bool wxRichTextCtrl::WriteImage ( const wxRichTextImageBlock &  imageBlock  )  [virtual]

Writes an image block at the current insertion point.

virtual bool wxRichTextCtrl::WriteImage ( const wxString filename,
wxBitmapType  bitmapType 
) [virtual]

Loads an image from a file and writes it at the current insertion point.

virtual void wxRichTextCtrl::WriteText ( const wxString text  )  [virtual]

Writes text at the current position.

virtual long wxRichTextCtrl::XYToPosition ( long  x,
long  y 
) const [virtual]

Translates from column and line number to position.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]