%{

%}

%newgroup

enum {

wxRE_READONLY,

wxRE_MULTILINE,

wxRICHTEXT_SHIFT_DOWN,

wxRICHTEXT_CTRL_DOWN,

wxRICHTEXT_ALT_DOWN,

wxRICHTEXT_SELECTED,

wxRICHTEXT_TAGGED,

wxRICHTEXT_FOCUSSED,

wxRICHTEXT_IS_FOCUS,

};

MAKE_CONST_WXSTRING2(RichTextCtrlNameStr, wxT("richText"));

MustHaveApp(wxRichTextCtrl);

DocStr(wxRichTextCtrl,

"", "");

class wxRichTextCtrl : public wxControl,

public wxTextCtrlIface,

public wxScrollHelper

{

%pythonAppend wxRichTextCtrl "self._setOORInfo(self)"

%pythonAppend wxRichTextCtrl() ""

wxRichTextCtrl( wxWindow* parent,

wxWindowID id = -1,

const wxString& value = wxPyEmptyString,

const wxPoint& pos = wxDefaultPosition,

const wxSize& size = wxDefaultSize,

long style = wxRE_MULTILINE,

const wxValidator& validator = wxDefaultValidator,

const wxString& name = wxPyRichTextCtrlNameStr );

%RenameCtor(PreRichTextCtrl, wxRichTextCtrl());

bool Create( wxWindow* parent,

wxWindowID id = -1,

const wxString& value = wxPyEmptyString,

const wxPoint& pos = wxDefaultPosition,

const wxSize& size = wxDefaultSize,

long style = wxRE_MULTILINE,

const wxValidator& validator = wxDefaultValidator,

const wxString& name = wxPyRichTextCtrlNameStr );

DocDeclStr(

virtual wxString , GetValue() const,

"", "");

DocDeclStr(

virtual void , SetValue(const wxString& value),

"", "");

DocDeclStr(

virtual wxString , GetRange(long from, long to) const,

"", "");

DocDeclStr(

virtual int , GetLineLength(long lineNo) const ,

"", "");

DocDeclStr(

virtual wxString , GetLineText(long lineNo) const ,

"", "");

DocDeclStr(

virtual int , GetNumberOfLines() const ,

"", "");

DocDeclStr(

virtual bool , IsModified() const ,

"", "");

DocDeclStr(

virtual bool , IsEditable() const ,

"", "");

// more readable flag testing methods

DocDeclStr(

bool , IsSingleLine() const,

"", "");

DocDeclStr(

bool , IsMultiLine() const,

"", "");

DocDeclAStr(

virtual void , GetSelection(long* OUTPUT, long* OUTPUT) const,

"GetSelection() --> (start, end)",

"Returns the start and end positions of the current selection. If the

values are the same then there is no selection.", "");

DocDeclStr(

virtual wxString , GetStringSelection() const,

"", "");

DocDeclStr(

wxString , GetFilename() const,

"", "");

DocDeclStr(

void , SetFilename(const wxString& filename),

"", "");

DocDeclStr(

void , SetDelayedLayoutThreshold(long threshold),

"Set the threshold in character positions for doing layout optimization

during sizing.", "");

DocDeclStr(

long , GetDelayedLayoutThreshold() const,

"Get the threshold in character positions for doing layout optimization

during sizing.", "");

DocDeclStr(

void , SetTextCursor(const wxCursor& cursor ),

"Set text cursor", "");

DocDeclStr(

wxCursor , GetTextCursor() const,

"Get text cursor", "");

DocDeclStr(

void , SetURLCursor(const wxCursor& cursor ),

"Set URL cursor", "");

DocDeclStr(

wxCursor , GetURLCursor() const,

"Get URL cursor", "");

DocDeclStr(

virtual void , Clear(),

"", "");

DocDeclStr(

virtual void , Replace(long from, long to, const wxString& value),

"", "");

DocDeclStr(

virtual void , Remove(long from, long to),

"", "");

DocDeclStr(

virtual bool , LoadFile(const wxString& file, int type = wxRICHTEXT_TYPE_ANY),

"Load the contents of the document from the given filename.", "");

DocDeclStr(

virtual bool , SaveFile(const wxString& file = wxPyEmptyString,

int type = wxRICHTEXT_TYPE_ANY),

"Save the contents of the document to the given filename, or if the

empty string is passed then to the filename set with `SetFilename`.", "");

DocDeclStr(

void , SetHandlerFlags(int flags),

"Set the handler flags, controlling loading and saving.", "");

DocDeclStr(

int , GetHandlerFlags() const,

"Get the handler flags, controlling loading and saving.", "");

// sets/clears the dirty flag

DocDeclStr(

virtual void , MarkDirty(),

"Sets the dirty flag, meaning that the contents of the control have

changed and need to be saved.", "");

DocDeclStr(

virtual void , DiscardEdits(),

"Clears the dirty flag.

:see: `MarkDirty`", "");

DocDeclStr(

virtual void , SetMaxLength(unsigned long len),

"Set the max number of characters which may be entered in a single line

text control.", "");

DocDeclStr(

virtual void , WriteText(const wxString& text),

"Insert text at the current position.", "");

DocDeclStr(

virtual void , AppendText(const wxString& text),

"Append text to the end of the document.", "");

DocDeclStr(

virtual bool , SetStyle(const wxRichTextRange& range, const wxTextAttr& style),

"Set the style for the text in ``range`` to ``style``", "");

DocDeclStr(

virtual bool , GetStyle(long position, wxTextAttr& style),

"Retrieve the style used at the given position. Copies the style

if successful. Returns ``False`` otherwise.", "");

DocDeclStr(

virtual bool , GetStyleForRange(const wxRichTextRange& range, wxTextAttr& style),

"Get the common set of styles for the range", "");

DocDeclStr(

virtual bool , SetStyleEx(const wxRichTextRange& range, const wxTextAttr& style,

int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO),

"Extended style setting operation with flags including:

RICHTEXT_SETSTYLE_PARAGRAPHS_ONLY, RICHTEXT_SETSTYLE_CHARACTERS_ONLY", "");

DocDeclStr(

virtual bool , GetUncombinedStyle(long position, wxTextAttr& style),

"Get the content (uncombined) attributes for this position. Copies the

``True`` if successful. Returns ``False`` otherwise.", "");

DocDeclStr(

virtual bool , SetDefaultStyle(const wxTextAttr& style),

"Set the style used by default for the rich text document.", "");

DocDeclStrName(

virtual const wxTextAttr , GetDefaultStyleEx() const,

"Retrieves a copy of the default style object.", "",

GetDefaultStyle);

/// Set list style

virtual bool SetListStyle(const wxRichTextRange& range,

const wxString& defName,

int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,

int startFrom = 1, int specifiedLevel = -1);

/// Clear list for given range

virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);

/// Number/renumber any list elements in the given range

/// def/defName can be NULL/empty to indicate that the existing list style should be used.

virtual bool NumberList(const wxRichTextRange& range,

const wxString& defName,

int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,

int startFrom = 1, int specifiedLevel = -1);

/// Promote the list items within the given range. promoteBy can be a positive or negative number, e.g. 1 or -1

/// def/defName can be NULL/empty to indicate that the existing list style should be used.

virtual bool PromoteList(int promoteBy, const wxRichTextRange& range,

const wxString& defName,

int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO,

int specifiedLevel = -1);

/// Deletes the content in the given range

virtual bool Delete(const wxRichTextRange& range);

DocDeclStr(

virtual long , XYToPosition(long x, long y) const,

"Translate a col,row coordinants into a document position.", "");

DocDeclAStr(

virtual void , PositionToXY(long pos, long *OUTPUT, long *OUTPUT) const,

"PositionToXY(self, long pos) --> (x, y)",

"Retrieves the col,row for the given position within the document", "");

DocDeclStr(

virtual void , ShowPosition(long position),

"Ensure that the given position in the document is visible.", "");

DocDeclAStr(

virtual wxTextCtrlHitTestResult , HitTest(const wxPoint& pt, long *OUTPUT) const,

"HitTest(self, Point pt) --> (result, pos)",

"Returns the character position at the given point in pixels. Note

tuple of the hit test result and the position.", "

");

DocDeclAStrName(

virtual wxTextCtrlHitTestResult , HitTest(const wxPoint& pt,

wxTextCoord *OUTPUT,

wxTextCoord *OUTPUT) const,

"HitTestRC(self, Point pt) --> (result, col, row)",

"Returns the column and row of the given point in pixels. Note that

of the hit test result and the column and row values.", "

:see: `HitTest`",

HitTestXY);

// Clipboard operations

DocDeclStr(

virtual void , Copy(),

"Copies the selected text to the clipboard.", "");

DocDeclStr(

virtual void , Cut(),

"Copies the selected text to the clipboard and removes the selection.", "");

DocDeclStr(

virtual void , Paste(),

"Pastes text from the clipboard into the document at the current

insertion point.", "");

DocDeclStr(

virtual void , DeleteSelection(),

"Remove the current selection.", "");

DocDeclStr(

virtual bool , CanCopy() const,

"Returns ``True`` if the selection can be copied to the clipboard.", "");

DocDeclStr(

virtual bool , CanCut() const,

"Returns ``True`` if the selection can be cut to the clipboard.", "");

DocDeclStr(

virtual bool , CanPaste() const,

"Returns ``True`` if the current contents of the clipboard can be

pasted into the document.", "");

DocDeclStr(

virtual bool , CanDeleteSelection() const,

"Returns ``True`` if the selection can be removed from the document.", "");

// Undo/redo

DocDeclStr(

virtual void , Undo(),

"If the last operation can be undone, undoes the last operation.", "");

DocDeclStr(

virtual void , Redo(),

"If the last operation can be redone, redoes the last operation.", "");

DocDeclStr(

virtual bool , CanUndo() const,

"Returns ``True`` if the last operation can be undone.", "");

DocDeclStr(

virtual bool , CanRedo() const,

"Returns ``True`` if the last operation can be redone.", "");

// Insertion point

DocDeclStr(

virtual void , SetInsertionPoint(long pos),

"Sets the insertion point at the given position.", "");

DocDeclStr(

virtual void , SetInsertionPointEnd(),

"Moves the insertion point to the end of the document.", "");

DocDeclStr(

virtual long , GetInsertionPoint() const,

"Returns the insertion point. This is defined as the zero based index

of the character position to the right of the insertion point.", "");

DocDeclStr(

virtual long , GetLastPosition() const,

"Returns the zero based index of the last position in the document.", "");

DocDeclStr(

virtual void , SetSelection(long from, long to),

"Selects the text starting at the first position up to (but not

equal to -1 then all text in the control is selected.", "");

DocDeclStr(

virtual void , SelectAll(),

"Select all text in the document.", "");

DocDeclStr(

virtual void , SetEditable(bool editable),

"Makes the document editable or read-only, overriding the RE_READONLY

flag.", "");

DocDeclStr(

virtual bool , HasSelection() const,

"", "");

DocDeclStr(

virtual bool , WriteImage(const wxImage& image,

wxBitmapType bitmapType = wxBITMAP_TYPE_PNG),

"Write an image at the current insertion point. Supply optional type to

", "");

DocDeclStrName(

virtual bool , WriteImage(const wxBitmap& bitmap,

wxBitmapType bitmapType = wxBITMAP_TYPE_PNG),

"Write a bitmap at the current insertion point. Supply optional type to

use for internal and file storage of the raw data.", "",

WriteBitmap);

DocDeclStrName(

virtual bool , WriteImage(const wxString& filename,

wxBitmapType bitmapType),

"Load an image from file and write at the current insertion point.", "",

WriteImageFile);

DocDeclStrName(

virtual bool , WriteImage(const wxRichTextImageBlock& imageBlock),

"Write an image block at the current insertion point.", "",

WriteImageBlock);

DocDeclStr(

virtual bool , Newline(),

"Insert a newline (actually paragraph) at the current insertion point.", "");

DocDeclStr(

virtual bool , LineBreak(),

"Insert a line break at the current insertion point.", "");

DocDeclStr(

virtual void , SetBasicStyle(const wxTextAttr& style),

"", "");

DocDeclStr(

virtual const wxTextAttr , GetBasicStyle() const,

"Get basic (overall) style", "");

DocDeclStr(

virtual bool , BeginStyle(const wxTextAttr& style),

"Begin using a style", "");

DocDeclStr(

virtual bool , EndStyle(),

"End the style", "");

DocDeclStr(

virtual bool , EndAllStyles(),

"End all styles", "");

DocDeclStr(

bool , BeginBold(),

"Begin using bold", "");

DocDeclStr(

bool , EndBold(),

"End using bold", "");

DocDeclStr(

bool , BeginItalic(),

"Begin using italic", "");

DocDeclStr(

bool , EndItalic(),

"End using italic", "");

DocDeclStr(

bool , BeginUnderline(),

"Begin using underline", "");

DocDeclStr(

bool , EndUnderline(),

"End using underline", "");

DocDeclStr(

bool , BeginFontSize(int pointSize),

"Begin using point size", "");

DocDeclStr(

bool , EndFontSize(),

"End using point size", "");

DocDeclStr(

bool , BeginFont(const wxFont& font),

"Begin using this font", "");

DocDeclStr(

bool , EndFont(),

"End using a font", "");

DocDeclStr(

bool , BeginTextColour(const wxColour& colour),

"Begin using this colour", "");

DocDeclStr(

bool , EndTextColour(),

"End using a colour", "");

DocDeclStr(

bool , BeginAlignment(wxTextAttrAlignment alignment),

"Begin using alignment", "");

DocDeclStr(

bool , EndAlignment(),

"End alignment", "");

DocDeclStr(

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

"Begin left indent", "");

DocDeclStr(

bool , EndLeftIndent(),

"End left indent", "");

DocDeclStr(

bool , BeginRightIndent(int rightIndent),

"Begin right indent", "");

DocDeclStr(

bool , EndRightIndent(),

"End right indent", "");

DocDeclStr(

bool , BeginParagraphSpacing(int before, int after),

"Begin paragraph spacing", "");

DocDeclStr(

bool , EndParagraphSpacing(),

"End paragraph spacing", "");

DocDeclStr(

bool , BeginLineSpacing(int lineSpacing),

"Begin line spacing", "");

DocDeclStr(

bool , EndLineSpacing(),

"End line spacing", "");

DocDeclStr(

bool , BeginNumberedBullet(int bulletNumber,

int leftIndent,

int leftSubIndent,

int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD),

"Begin numbered bullet", "");

DocDeclStr(

bool , EndNumberedBullet(),

"End numbered bullet", "");

DocDeclStr(

bool , BeginSymbolBullet(const wxString& symbol,

int leftIndent,

int leftSubIndent,

int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL),

"Begin symbol bullet", "");

DocDeclStr(

bool , EndSymbolBullet(),

"End symbol bullet", "");

DocDeclStr(

bool , BeginStandardBullet(const wxString& bulletName,

int leftIndent,

int leftSubIndent,

int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD),

"Begin standard bullet", "");

DocDeclStr(

bool , EndStandardBullet(),

"End standard bullet", "");

DocDeclStr(

bool , BeginCharacterStyle(const wxString& characterStyle),

"Begin named character style", "");

DocDeclStr(

bool , EndCharacterStyle(),

"End named character style", "");

DocDeclStr(

bool , BeginParagraphStyle(const wxString& paragraphStyle),

"Begin named paragraph style", "");

DocDeclStr(

bool , EndParagraphStyle(),

"End named character style", "");

DocDeclStr(

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

"Begin named list style.", "");

DocDeclStr(

bool , EndListStyle(), "End named list style.", "");

DocDeclStr(

bool , BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString),

"Begin URL.", "");

DocDeclStr(

bool , EndURL(), "End URL.", "");

DocDeclStr(

bool , SetDefaultStyleToCursorStyle(),

"Sets the default style to the style under the cursor", "");

DocDeclStr(

virtual void , SelectNone(),

"Clear the selection", "");

DocDeclStr(

virtual bool , SelectWord(long position),

"Select the word at the given character position", "");

DocDeclStr(

wxRichTextRange , GetSelectionRange() const,

"Get the selection range in character positions.", "");

DocDeclStr(

void , SetSelectionRange(const wxRichTextRange& range),

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

DocDeclStr(

const wxRichTextRange& , GetInternalSelectionRange() const,

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

", "");

DocDeclStr(

void , SetInternalSelectionRange(const wxRichTextRange& range),

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

selection is denoted by (n, n).", "");

DocDeclStr(

virtual wxRichTextRange , AddParagraph(const wxString& text),

"Add a new paragraph of text to the end of the buffer", "");

DocDeclStr(

virtual wxRichTextRange , AddImage(const wxImage& image),

"Add an image", "");

DocDeclStr(

virtual bool , LayoutContent(bool onlyVisibleRect = false),

"Layout the buffer: which we must do before certain operations, such as

setting the caret position.", "");

DocDeclStr(

virtual bool , MoveCaret(long pos, bool showAtLineStart = false),

"Move the caret to the given character position", "");

DocDeclStr(

virtual bool , MoveRight(int noPositions = 1, int flags = 0),

"Move right", "");

DocDeclStr(

virtual bool , MoveLeft(int noPositions = 1, int flags = 0),

"Move left", "");

DocDeclStr(

virtual bool , MoveUp(int noLines = 1, int flags = 0),

"Move up", "");

DocDeclStr(

virtual bool , MoveDown(int noLines = 1, int flags = 0),

"Move down", "");

DocDeclStr(

virtual bool , MoveToLineEnd(int flags = 0),

"Move to the end of the line", "");

DocDeclStr(

virtual bool , MoveToLineStart(int flags = 0),

"Move to the start of the line", "");

DocDeclStr(

virtual bool , MoveToParagraphEnd(int flags = 0),

"Move to the end of the paragraph", "");

DocDeclStr(

virtual bool , MoveToParagraphStart(int flags = 0),

"Move to the start of the paragraph", "");

DocDeclStr(

virtual bool , MoveHome(int flags = 0),

"Move to the start of the buffer", "");

DocDeclStr(

virtual bool , MoveEnd(int flags = 0),

"Move to the end of the buffer", "");

DocDeclStr(

virtual bool , PageUp(int noPages = 1, int flags = 0),

"Move n pages up", "");

DocDeclStr(

virtual bool , PageDown(int noPages = 1, int flags = 0),

"Move n pages down", "");

DocDeclStr(

virtual bool , WordLeft(int noPages = 1, int flags = 0),

"Move n words left", "");

DocDeclStr(

virtual bool , WordRight(int noPages = 1, int flags = 0),

"Move n words right", "");

DocDeclStr(

wxRichTextBuffer& , GetBuffer(),

"Returns the buffer associated with the control.

", "");

DocDeclStr(

virtual bool , BeginBatchUndo(const wxString& cmdName),

"Start batching undo history for commands", "");

DocDeclStr(

virtual bool , EndBatchUndo(),

"End batching undo history for commands.", "");

DocDeclStr(

virtual bool , BatchingUndo() const,

"Are we batching undo history for commands?", "");

DocDeclStr(

virtual bool , BeginSuppressUndo(),

"Start suppressing undo history for commands.", "");

DocDeclStr(

virtual bool , EndSuppressUndo(),

"End suppressing undo history for commands.", "");

DocDeclStr(

virtual bool , SuppressingUndo() const,

"Are we suppressing undo history for commands?", "");

DocDeclStr(

virtual bool , HasCharacterAttributes(const wxRichTextRange& range,

const wxTextAttr& style) const,

"Test if this whole range has character attributes of the specified

", "");

DocDeclStr(

virtual bool , HasParagraphAttributes(const wxRichTextRange& range,

const wxTextAttr& style) const,

"Test if this whole range has paragraph attributes of the specified

", "");

DocDeclStr(

virtual bool , IsSelectionBold(),

"Is all of the selection bold?", "");

DocDeclStr(

virtual bool , IsSelectionItalics(),

"Is all of the selection italics?", "");

DocDeclStr(

virtual bool , IsSelectionUnderlined(),

"Is all of the selection underlined?", "");

DocDeclStr(

virtual bool , IsSelectionAligned(wxTextAttrAlignment alignment),

"Is all of the selection aligned according to the specified flag?", "");

DocDeclStr(

virtual bool , ApplyBoldToSelection(),

"Apply bold to the selection", "");

DocDeclStr(

virtual bool , ApplyItalicToSelection(),

"Apply italic to the selection", "");

DocDeclStr(

virtual bool , ApplyUnderlineToSelection(),

"Apply underline to the selection", "");

DocDeclStr(

virtual bool , ApplyAlignmentToSelection(wxTextAttrAlignment alignment),

"Apply alignment to the selection", "");

DocDeclStr(

virtual bool , ApplyStyle(wxRichTextStyleDefinition* def),

"Apply a named style to the selection", "");

DocDeclStr(

void , SetStyleSheet(wxRichTextStyleSheet* styleSheet),

"Set style sheet, if any.", "");

DocDeclStr(

wxRichTextStyleSheet* , GetStyleSheet() const,

"", "");

DocDeclStr(

bool , PushStyleSheet(wxRichTextStyleSheet* styleSheet),

"Push style sheet to top of stack", "");

DocDeclStr(

wxRichTextStyleSheet* , PopStyleSheet(),

"Pop style sheet from top of stack", "");

DocDeclStr(

bool , ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL),

"Apply the style sheet to the buffer, for example if the styles have

changed.", "");

%property(Buffer, GetBuffer);

%property(DelayedLayoutThreshold, GetDelayedLayoutThreshold, SetDelayedLayoutThreshold);

%property(Filename, GetFilename, SetFilename);

%property(InternalSelectionRange, GetInternalSelectionRange, SetInternalSelectionRange);

%property(SelectionRange, GetSelectionRange, SetSelectionRange);

%property(StyleSheet, GetStyleSheet, SetStyleSheet);

%property(TextCursor, GetTextCursor, SetTextCursor);

%property(URLCursor, GetURLCursor, SetURLCursor);

};

%newgroup