X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/232fdc630c42eb165f7659981043e794be03b3b7..d3fa4bc22e84e3ca4d88cc1772f2d414140a1017:/interface/wx/richtext/richtextctrl.h?ds=inline diff --git a/interface/wx/richtext/richtextctrl.h b/interface/wx/richtext/richtextctrl.h index 86c3f0a144..862b297d22 100644 --- a/interface/wx/richtext/richtextctrl.h +++ b/interface/wx/richtext/richtextctrl.h @@ -1,150 +1,163 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: richtext/richtextctrl.h -// Purpose: interface of wxRichTextCtrl and wxRichTextEvent -// Author: wxWidgets team +// Name: wx/richtext/richtextctrl.h +// Purpose: A rich edit control +// Author: Julian Smart +// Modified by: +// Created: 2005-09-30 // RCS-ID: $Id$ +// Copyright: (c) Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +/* + * Styles and flags + */ + /** - @class wxRichTextEvent + Styles +*/ - This is the event class for wxRichTextCtrl notifications. +#define wxRE_READONLY 0x0010 +#define wxRE_MULTILINE 0x0020 +#define wxRE_CENTRE_CARET 0x8000 +#define wxRE_CENTER_CARET wxRE_CENTRE_CARET - @beginEventTable{wxRichTextEvent} - @event{EVT_RICHTEXT_CHARACTER(id, func)} - Process a @c wxEVT_COMMAND_RICHTEXT_CHARACTER event, generated when the user - presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter. - @event{EVT_RICHTEXT_DELETE(id, func)} - Process a @c wxEVT_COMMAND_RICHTEXT_DELETE event, generated when the user - presses the backspace or delete key. Valid event functions: GetFlags, GetPosition. - @event{EVT_RICHTEXT_RETURN(id, func)} - Process a @c wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user - presses the return key. Valid event functions: GetFlags, GetPosition. - @event{EVT_RICHTEXT_STYLE_CHANGED(id, func)} - Process a @c wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED event, generated when - styling has been applied to the control. Valid event functions: GetPosition, GetRange. - @event{EVT_RICHTEXT_STYLESHEET_CHANGED(id, func)} - Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING event, generated - when the control's stylesheet has changed, for example the user added, - edited or deleted a style. Valid event functions: GetRange, GetPosition. - @event{EVT_RICHTEXT_STYLESHEET_REPLACING(id, func)} - Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING event, generated - when the control's stylesheet is about to be replaced, for example when - a file is loaded into the control. - Valid event functions: Veto, GetOldStyleSheet, GetNewStyleSheet. - @event{EVT_RICHTEXT_STYLESHEET_REPLACED(id, func)} - Process a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED event, generated - when the control's stylesheet has been replaced, for example when a file - is loaded into the control. - Valid event functions: GetOldStyleSheet, GetNewStyleSheet. - @event{EVT_RICHTEXT_CONTENT_INSERTED(id, func)} - Process a @c wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED event, generated when - content has been inserted into the control. - Valid event functions: GetPosition, GetRange. - @event{EVT_RICHTEXT_CONTENT_DELETED(id, func)} - Process a @c wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED event, generated when - content has been deleted from the control. - Valid event functions: GetPosition, GetRange. - @event{EVT_RICHTEXT_BUFFER_RESET(id, func)} - Process a @c wxEVT_COMMAND_RICHTEXT_BUFFER_RESET event, generated when the - buffer has been reset by deleting all content. - You can use this to set a default style for the first new paragraph. - @endEventTable +/** + Flags +*/ - @library{wxrichtext} - @category{events,richtext} +#define wxRICHTEXT_SHIFT_DOWN 0x01 +#define wxRICHTEXT_CTRL_DOWN 0x02 +#define wxRICHTEXT_ALT_DOWN 0x04 + +/** + Extra flags */ -class wxRichTextEvent : public wxNotifyEvent + +// Don't draw guide lines around boxes and tables +#define wxRICHTEXT_EX_NO_GUIDELINES 0x00000100 + + +/* + Defaults +*/ + +#define wxRICHTEXT_DEFAULT_OVERALL_SIZE wxSize(-1, -1) +#define wxRICHTEXT_DEFAULT_IMAGE_SIZE wxSize(80, 80) +#define wxRICHTEXT_DEFAULT_SPACING 3 +#define wxRICHTEXT_DEFAULT_MARGIN 3 +#define wxRICHTEXT_DEFAULT_UNFOCUSSED_BACKGROUND wxColour(175, 175, 175) +#define wxRICHTEXT_DEFAULT_FOCUSSED_BACKGROUND wxColour(140, 140, 140) +#define wxRICHTEXT_DEFAULT_UNSELECTED_BACKGROUND wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE) +#define wxRICHTEXT_DEFAULT_TYPE_COLOUR wxColour(0, 0, 200) +#define wxRICHTEXT_DEFAULT_FOCUS_RECT_COLOUR wxColour(100, 80, 80) +#define wxRICHTEXT_DEFAULT_CARET_WIDTH 2 +// Minimum buffer size before delayed layout kicks in +#define wxRICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD 20000 +// Milliseconds before layout occurs after resize +#define wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL 50 + +/* Identifiers + */ +#define wxID_RICHTEXT_PROPERTIES1 (wxID_HIGHEST + 1) +#define wxID_RICHTEXT_PROPERTIES2 (wxID_HIGHEST + 2) +#define wxID_RICHTEXT_PROPERTIES3 (wxID_HIGHEST + 3) + +/* + Normal selection occurs initially and as user drags within one container. + Common ancestor selection occurs when the user starts dragging across containers + that have a common ancestor, for example the cells in a table. + */ + +enum wxRichTextCtrlSelectionState { -public: - /** - Copy constructor. - */ - wxRichTextEvent(const wxRichTextEvent& event); + wxRichTextCtrlSelectionState_Normal, + wxRichTextCtrlSelectionState_CommonAncestor +}; +/** + @class wxRichTextContextMenuPropertiesInfo + + wxRichTextContextMenuPropertiesInfo keeps track of objects that appear in the context menu, + whose properties are available to be edited. + */ + +class wxRichTextContextMenuPropertiesInfo +{ +public: /** Constructor. - - @param commandType - The type of the event. - @param id - Window identifier. The value @c wxID_ANY indicates a default value. */ - wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int id = 0); + wxRichTextContextMenuPropertiesInfo(); + +// Operations /** - Returns the character pressed, within a @c wxEVT_COMMAND_RICHTEXT_CHARACTER event. + Initialisation. */ - wxChar GetCharacter() const; + void Init(); /** - Returns flags indicating modifier keys pressed. - - Possible values are @c wxRICHTEXT_CTRL_DOWN, @c wxRICHTEXT_SHIFT_DOWN, and @c wxRICHTEXT_ALT_DOWN. + Adds an item. */ - int GetFlags() const; + bool AddItem(const wxString& label, wxRichTextObject* obj); /** - Returns the new style sheet. - - Can be used in a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or - @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler. + Returns the number of menu items that were added. */ - wxRichTextStyleSheet* GetNewStyleSheet() const; + int AddMenuItems(wxMenu* menu, int startCmd = wxID_RICHTEXT_PROPERTIES1) const; /** - Returns the old style sheet. - - Can be used in a @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING or - @c wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED event handler. + Adds appropriate menu items for the current container and clicked on object + (and container's parent, if appropriate). */ - wxRichTextStyleSheet* GetOldStyleSheet() const; + int AddItems(wxRichTextCtrl* ctrl, wxRichTextObject* container, wxRichTextObject* obj); /** - Returns the buffer position at which the event occured. + Clears the items. */ - long GetPosition() const; + void Clear(); + +// Accessors /** - Gets the range for the current operation. + Returns the nth label. */ - const wxRichTextRange& GetRange() const; + wxString GetLabel(int n) const; /** - Sets the character variable. + Returns the nth object. */ - void SetCharacter(wxChar ch); + wxRichTextObject* GetObject(int n) const; /** - Sets flags indicating modifier keys pressed. - - Possible values are @c wxRICHTEXT_CTRL_DOWN, @c wxRICHTEXT_SHIFT_DOWN, and @c wxRICHTEXT_ALT_DOWN. + Returns the array of objects. */ - void SetFlags(int flags); + wxRichTextObjectPtrArray& GetObjects(); /** - Sets the new style sheet variable. + Returns the array of objects. */ - void SetNewStyleSheet(wxRichTextStyleSheet* sheet); + const wxRichTextObjectPtrArray& GetObjects() const; /** - Sets the old style sheet variable. + Returns the array of labels. */ - void SetOldStyleSheet(wxRichTextStyleSheet* sheet); + wxArrayString& GetLabels(); /** - Sets the buffer position variable. + Returns the array of labels. */ - void SetPosition(long pos); + const wxArrayString& GetLabels() const; /** - Sets the range variable. + Returns the number of items. */ - void SetRange(const wxRichTextRange& range); -}; - + int GetCount() const; + wxRichTextObjectPtrArray m_objects; + wxArrayString m_labels; +}; /** @class wxRichTextCtrl @@ -154,8 +167,8 @@ public: 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. + It also sends the standard wxTextCtrl events @c wxEVT_TEXT_ENTER and + @c wxEVT_TEXT, and wxTextUrlEvent when URL content is clicked. For more information, see the @ref overview_richtextctrl. @@ -171,15 +184,21 @@ public: @library{wxrichtext} @category{richtext} - @appearance{richtextctrl.png} -*/ -class wxRichTextCtrl + @appearance{richtextctrl} + + */ + +class wxRichTextCtrl : public wxControl, + public wxTextCtrlIface, + public wxScrollHelper { public: +// Constructors + /** - Default Constructor. + Default constructor. */ - wxRichTextCtrl(); + wxRichTextCtrl( ); /** Constructor, creating and showing a rich text control. @@ -203,754 +222,824 @@ public: @see Create(), wxValidator */ - 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); + wxRichTextCtrl( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, + long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr); /** Destructor. */ - virtual ~wxRichTextCtrl(); + virtual ~wxRichTextCtrl( ); + +// Operations /** - Adds an image to the control's buffer. + Creates the underlying window. */ - virtual wxRichTextRange AddImage(const wxImage& image); + bool Create( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, + long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr ); /** - Adds a new paragraph of text to the end of the buffer. + Initialises the members of the control. */ - virtual wxRichTextRange AddParagraph(const wxString& text); + void Init(); + +// Accessors /** - Sets the insertion point to the end of the buffer and writes the text. + 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 AppendText(const wxString& text); + virtual wxString GetRange(long from, long to) const; /** - Applies the given alignment to the selection (undoable). - For alignment values, see wxTextAttr. + Returns the length of the specified line in characters. */ - virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment); + virtual int GetLineLength(long lineNo) const ; /** - Apples bold to the selection (undoable). + Returns the text for the given line. */ - virtual bool ApplyBoldToSelection(); + virtual wxString GetLineText(long lineNo) const ; /** - Applies italic to the selection (undoable). + Returns the number of lines in the buffer. */ - virtual bool ApplyItalicToSelection(); + virtual int GetNumberOfLines() const ; /** - Applies the given style to the selection. + Returns @true if the buffer has been modified. */ - virtual bool ApplyStyle(wxRichTextStyleDefinition* def); + virtual bool IsModified() const ; /** - 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 @a sheet is @NULL, the sheet set with SetStyleSheet() is used. - Currently this applies paragraph styles only. + Returns @true if the control is editable. */ - bool ApplyStyleSheet(wxRichTextStyleSheet* sheet = NULL); + virtual bool IsEditable() const ; /** - Applies underline to the selection (undoable). + Returns @true if the control is single-line. + Currently wxRichTextCtrl does not support single-line editing. */ - virtual bool ApplyUnderlineToSelection(); + bool IsSingleLine() const; /** - Returns @true if undo commands are being batched. + Returns @true if the control is multiline. */ - virtual bool BatchingUndo() const; + bool IsMultiLine() const; + //@{ /** - Begins using alignment. - For alignment values, see wxTextAttr. + 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 @a from and @a to are the same, there is no selection. */ - bool BeginAlignment(wxTextAttrAlignment alignment); + virtual void GetSelection(long* from, long* to) const; + const wxRichTextSelection& GetSelection() const; + wxRichTextSelection& GetSelection(); + //@} /** - Starts batching undo history for commands. + Returns the text within the current selection range, if any. */ - virtual bool BeginBatchUndo(const wxString& cmdName); + virtual wxString GetStringSelection() const; /** - Begins using bold. + Gets the current filename associated with the control. */ - bool BeginBold(); + wxString GetFilename() const; /** - Begins using the named character style. + Sets the current filename. */ - bool BeginCharacterStyle(const wxString& characterStyle); + void SetFilename(const wxString& filename); /** - Begins using this font. + Sets the size of the buffer beyond which layout is delayed during resizing. + This optimizes sizing for large buffers. The default is 20000. */ - bool BeginFont(const wxFont& font); + void SetDelayedLayoutThreshold(long threshold); /** - Begins using the given point size. + Gets the size of the buffer beyond which layout is delayed during resizing. + This optimizes sizing for large buffers. The default is 20000. */ - bool BeginFontSize(int pointSize); + long GetDelayedLayoutThreshold() const; /** - Begins using italic. */ - bool BeginItalic(); + bool GetFullLayoutRequired() const; /** - 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 - @a leftIndent plus the @a leftSubIndent. + */ + void SetFullLayoutRequired(bool b); - @param leftIndent - The distance between the margin and the bullet. - @param leftSubIndent - The distance between the left edge of the bullet and the left edge - of the actual paragraph. + /** */ - bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0); + wxLongLong GetFullLayoutTime() const; /** - Begins appling line spacing. @e spacing is a multiple, where 10 means - single-spacing, 15 means 1.5 spacing, and 20 means double spacing. + */ + void SetFullLayoutTime(wxLongLong t); - The ::wxTextAttrLineSpacing constants are defined for convenience. + /** */ - bool BeginLineSpacing(int lineSpacing); + long GetFullLayoutSavedPosition() const; /** - Begins using a specified list style. - Optionally, you can also pass a level and a number. */ - bool BeginListStyle(const wxString& listStyle, int level = 1, - int number = 1); + void SetFullLayoutSavedPosition(long p); + // Force any pending layout due to large buffer /** - Begins a numbered bullet. + */ + void ForceDelayedLayout(); - This call will be needed for each item in the list, and the - application should take care of incrementing the numbering. + /** + Sets the text (normal) cursor. + */ + void SetTextCursor(const wxCursor& cursor ); - @a bulletNumber is a number, usually starting with 1. - @a leftIndent and @a leftSubIndent are values in tenths of a millimetre. - @a bulletStyle is a bitlist of the ::wxTextAttrBulletStyle values. + /** + Returns the text (normal) cursor. + */ + wxCursor GetTextCursor() const; - 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. + /** + Sets the cursor to be used over URLs. */ - bool BeginNumberedBullet(int bulletNumber, int leftIndent, - int leftSubIndent, - int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD); + void SetURLCursor(const wxCursor& cursor ); /** - Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing - in tenths of a millimetre. + Returns the cursor to be used over URLs. */ - bool BeginParagraphSpacing(int before, int after); + wxCursor GetURLCursor() const; /** - Begins applying the named paragraph style. + Returns @true if we are showing the caret position at the start of a line + instead of at the end of the previous one. */ - bool BeginParagraphStyle(const wxString& paragraphStyle); + bool GetCaretAtLineStart() const; /** - Begins a right indent, specified in tenths of a millimetre. + Sets a flag to remember that we are showing the caret position at the start of a line + instead of at the end of the previous one. */ - bool BeginRightIndent(int rightIndent); + void SetCaretAtLineStart(bool atStart); /** - Begins applying a style. + Returns @true if we are extending a selection. */ - virtual bool BeginStyle(const wxTextAttr& style); + bool GetDragging() const; /** - Starts suppressing undo history for commands. + Sets a flag to remember if we are extending a selection. */ - virtual bool BeginSuppressUndo(); + void SetDragging(bool dragging); /** - 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. + Are we trying to start Drag'n'Drop? */ - bool BeginSymbolBullet(const wxString& symbol, int leftIndent, - int leftSubIndent, - int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL); + bool GetPreDrag() const; /** - Begins using this colour. + Set if we're trying to start Drag'n'Drop */ - bool BeginTextColour(const wxColour& colour); + void SetPreDrag(bool pd); /** - Begins applying wxTEXT_ATTR_URL to the content. + Get the possible Drag'n'Drop start point + */ + const wxPoint GetDragStartPoint() const; - 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. + /** + Set the possible Drag'n'Drop start point */ - bool BeginURL(const wxString& url, - const wxString& characterStyle = wxEmptyString); + void SetDragStartPoint(wxPoint sp); /** - Begins using underlining. + Get the possible Drag'n'Drop start time */ - bool BeginUnderline(); + const wxDateTime GetDragStartTime() const; /** - Returns @true if selected content can be copied to the clipboard. + Set the possible Drag'n'Drop start time */ - virtual bool CanCopy() const; + void SetDragStartTime(wxDateTime st); +#if wxRICHTEXT_BUFFERED_PAINTING + //@{ /** - Returns @true if selected content can be copied to the clipboard and deleted. + Returns the buffer bitmap if using buffered painting. */ - virtual bool CanCut() const; + const wxBitmap& GetBufferBitmap() const; + wxBitmap& GetBufferBitmap(); + //@} +#endif /** - Returns @true if selected content can be deleted. + Returns the current context menu. */ - virtual bool CanDeleteSelection() const; + wxMenu* GetContextMenu() const; /** - Returns @true if the clipboard content can be pasted to the buffer. + Sets the current context menu. */ - virtual bool CanPaste() const; + void SetContextMenu(wxMenu* menu); /** - Returns @true if there is a command in the command history that can be redone. + Returns an anchor so we know how to extend the selection. + It's a caret position since it's between two characters. */ - virtual bool CanRedo() const; + long GetSelectionAnchor() const; /** - Returns @true if there is a command in the command history that can be undone. + Sets an anchor so we know how to extend the selection. + It's a caret position since it's between two characters. */ - virtual bool CanUndo() const; + void SetSelectionAnchor(long anchor); /** - Clears the buffer content, leaving a single empty paragraph. Cannot be undone. + Returns the anchor object if selecting multiple containers. */ - virtual void Clear(); + wxRichTextObject* GetSelectionAnchorObject() const; /** - Clears the list style from the given range, clearing list-related attributes - and applying any named paragraph style associated with each paragraph. - - @a flags is a bit list of the following: - - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. - - @see SetListStyle(), PromoteList(), NumberList(). + Sets the anchor object if selecting multiple containers. */ - virtual bool ClearListStyle(const wxRichTextRange& range, - int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); + void SetSelectionAnchorObject(wxRichTextObject* anchor); + //@{ /** - Sends the event to the control. + Returns an object that stores information about context menu property item(s), + in order to communicate between the context menu event handler and the code + that responds to it. The wxRichTextContextMenuPropertiesInfo stores one + item for each object that could respond to a property-editing event. If + objects are nested, several might be editable. */ - virtual void Command(wxCommandEvent& event); + wxRichTextContextMenuPropertiesInfo& GetContextMenuPropertiesInfo(); + const wxRichTextContextMenuPropertiesInfo& GetContextMenuPropertiesInfo() const; + //@} /** - Copies the selected content (if any) to the clipboard. + Returns the wxRichTextObject object that currently has the editing focus. + If there are no composite objects, this will be the top-level buffer. */ - virtual void Copy(); + wxRichTextParagraphLayoutBox* GetFocusObject() const; /** - Creates the underlying window. + Setter for m_focusObject. */ - 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); + void StoreFocusObject(wxRichTextParagraphLayoutBox* obj); /** - Copies the selected content (if any) to the clipboard and deletes the selection. - This is undoable. + Sets the wxRichTextObject object that currently has the editing focus. + @param setCaretPosition + Optionally set the caret position. */ - virtual void Cut(); + bool SetFocusObject(wxRichTextParagraphLayoutBox* obj, bool setCaretPosition = true); - /** - Deletes the content within the given range. - */ - virtual bool Delete(const wxRichTextRange& range); +// Operations /** - Deletes content if there is a selection, e.g. when pressing a key. - Returns the new caret position in @e newPos, or leaves it if there - was no action. This is undoable. - - @beginWxPerlOnly - In wxPerl this method takes no arguments and returns a 2-element - list (ok, newPos). - @endWxPerlOnly + Invalidates the whole buffer to trigger painting later. */ - bool DeleteSelectedContent(long* newPos = NULL); + void Invalidate(); /** - Deletes the content in the selection, if any. This is undoable. + Clears the buffer content, leaving a single empty paragraph. Cannot be undone. */ - virtual void DeleteSelection(); + virtual void Clear(); /** - Sets the buffer's modified status to @false, and clears the buffer's command - history. + Replaces the content in the specified range with the string specified by + @a value. */ - virtual void DiscardEdits(); + virtual void Replace(long from, long to, const wxString& value); /** - Ends alignment. + Removes the content in the specified range. */ - bool EndAlignment(); + virtual void Remove(long from, long to); /** - Ends application of all styles in the current style stack. - */ - virtual bool EndAllStyles(); + Loads content into the control's buffer using the given type. - /** - Ends batching undo command history. - */ - virtual bool EndBatchUndo(); + If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from + the filename extension. - /** - Ends using bold. + This function looks for a suitable wxRichTextFileHandler object. */ - bool EndBold(); + bool LoadFile(const wxString& file, + int type = wxRICHTEXT_TYPE_ANY); /** - Ends application of a named character style. - */ - bool EndCharacterStyle(); + Helper function for LoadFile(). Loads content into the control's buffer using the given type. - /** - Ends using a font. - */ - bool EndFont(); + If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from + the filename extension. - /** - Ends using a point size. + This function looks for a suitable wxRichTextFileHandler object. */ - bool EndFontSize(); + virtual bool DoLoadFile(const wxString& file, int fileType); /** - Ends using italic. - */ - bool EndItalic(); + Saves the buffer content using the given type. - /** - Ends left indent. - */ - bool EndLeftIndent(); + If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from + the filename extension. - /** - Ends line spacing. + This function looks for a suitable wxRichTextFileHandler object. */ - bool EndLineSpacing(); + bool SaveFile(const wxString& file = wxEmptyString, + int type = wxRICHTEXT_TYPE_ANY); /** - Ends using a specified list style. - */ - bool EndListStyle(); + Helper function for SaveFile(). Saves the buffer content using the given type. - /** - Ends application of a numbered bullet. - */ - bool EndNumberedBullet(); + If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from + the filename extension. - /** - Ends paragraph spacing. + This function looks for a suitable wxRichTextFileHandler object. */ - bool EndParagraphSpacing(); + virtual bool DoSaveFile(const wxString& file = wxEmptyString, + int fileType = wxRICHTEXT_TYPE_ANY); /** - Ends application of a named character style. - */ - bool EndParagraphStyle(); + Sets flags that change the behaviour of loading or saving. - /** - Ends right indent. + See the documentation for each handler class to see what flags are + relevant for each handler. */ - bool EndRightIndent(); + void SetHandlerFlags(int flags); /** - Ends the current style. + 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 bool EndStyle(); + int GetHandlerFlags() const; /** - Ends suppressing undo command history. + Marks the buffer as modified. */ - virtual bool EndSuppressUndo(); + virtual void MarkDirty(); /** - Ends applying a symbol bullet. + Sets the buffer's modified status to @false, and clears the buffer's command + history. */ - bool EndSymbolBullet(); + virtual void DiscardEdits(); - /** - Ends applying a text colour. - */ - bool EndTextColour(); + + void SetModified(bool modified); /** - Ends applying a URL. + Sets the maximum number of characters that may be entered in a single line + text control. For compatibility only; currently does nothing. */ - bool EndURL(); + virtual void SetMaxLength(unsigned long len); /** - End applying underlining. + Writes text at the current position. */ - bool EndUnderline(); + virtual void WriteText(const wxString& text); /** - Helper function for extending the selection, returning @true if the selection - was changed. Selections are in caret positions. + Sets the insertion point to the end of the buffer and writes the text. */ - virtual bool ExtendSelection(long oldPosition, long newPosition, int flags); + virtual void AppendText(const wxString& text); + //@{ /** - Helper function for finding the caret position for the next word. - Direction is 1 (forward) or -1 (backwards). + 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(). + + @beginWxPerlOnly + In wxPerl this method is implemented as GetStyle(@a position) + returning a 2-element list (ok, attr). + @endWxPerlOnly */ - virtual long FindNextWordPosition(int direction = 1) const; + virtual bool GetStyle(long position, wxTextAttr& style); + virtual bool GetStyle(long position, wxRichTextAttr& style); + virtual bool GetStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container); + //@} + //@{ /** - Call this function to prevent refresh and allow fast updates, and then Thaw() to - refresh the control. + 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). */ - void Freeze(); + virtual bool SetStyle(long start, long end, const wxTextAttr& style); + virtual bool SetStyle(long start, long end, const wxRichTextAttr& style); + virtual bool SetStyle(const wxRichTextRange& range, const wxTextAttr& style); + virtual bool SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style); + //@} /** - 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). + Sets the attributes for a single object */ - virtual const wxTextAttr& GetBasicStyle() const; + virtual void SetStyle(wxRichTextObject *obj, const wxRichTextAttr& textAttr, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); //@{ /** - Returns the buffer associated with the control. + Gets the attributes common to the specified range. + Attributes that differ in value within the range will not be included + in @a style flags. + + @beginWxPerlOnly + In wxPerl this method is implemented as GetStyleForRange(@a position) + returning a 2-element list (ok, attr). + @endWxPerlOnly */ - const wxRichTextBuffer GetBuffer(); - const wxRichTextBuffer& GetBuffer(); + virtual bool GetStyleForRange(const wxRichTextRange& range, wxTextAttr& style); + virtual bool GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style); + virtual bool GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container); //@} /** - Returns the current caret position. + 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). + + @a 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. */ - long GetCaretPosition() const; + virtual bool SetStyleEx(const wxRichTextRange& range, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); + //@{ /** - Returns the caret height and position for the given character position. + Gets the attributes at the given position. + This function gets the @e 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 @e style's flags, this function + will fetch the paragraph attributes. + Otherwise, it will return the character attributes. @beginWxPerlOnly - In wxPerl this method is implemented as - GetCaretPositionForIndex(@a position) returning a - 2-element list (ok, rect). + In wxPerl this method is implemented as GetUncombinedStyle(@a position) + returning a 2-element list (ok, attr). @endWxPerlOnly */ - bool GetCaretPositionForIndex(long position, wxRect& rect); + virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style); + virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container); + //@} + //@{ /** - Gets the command processor associated with the control's buffer. + Sets the current default style, which can be used to change how subsequently + inserted text is displayed. */ - wxCommandProcessor* GetCommandProcessor() const; + virtual bool SetDefaultStyle(const wxTextAttr& style); + virtual bool SetDefaultStyle(const wxRichTextAttr& style); + //@} /** Returns the current default style, which can be used to change how subsequently inserted text is displayed. */ - virtual const wxTextAttr& GetDefaultStyle() const; + virtual const wxRichTextAttr& GetDefaultStyleEx() const; - /** - Gets the size of the buffer beyond which layout is delayed during resizing. - This optimizes sizing for large buffers. The default is 20000. - */ - long GetDelayedLayoutThreshold() const; + //virtual const wxTextAttr& GetDefaultStyle() const; + //@{ /** - Gets the current filename associated with the control. - */ - wxString GetFilename() const; + Sets the list attributes for the given range, passing flags to determine how + the attributes are set. - /** - Returns the first visible position in the current view. + Either the style definition or the name of the style definition (in the current + sheet) can be passed. + @a 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 + @a startFrom, otherwise existing attributes are used. + - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used + as the level for all paragraphs, otherwise the current indentation will be used. + + @see NumberList(), PromoteList(), ClearListStyle(). */ - long GetFirstVisiblePosition() const; + virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); + virtual bool SetListStyle(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); + //@} /** - 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. + Clears the list style from the given range, clearing list-related attributes + and applying any named paragraph style associated with each paragraph. + + @a flags is a bit list of the following: + - wxRICHTEXT_SETSTYLE_WITH_UNDO: specifies that this command will be undoable. + + @see SetListStyle(), PromoteList(), NumberList(). */ - int GetHandlerFlags() const; + virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); + //@{ /** - Returns the current insertion point. + 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. + + @a 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 + @a startFrom, otherwise existing attributes are used. + - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used + as the level for all paragraphs, otherwise the current indentation will be used. + + @see SetListStyle(), PromoteList(), ClearListStyle(). */ - virtual long GetInsertionPoint() const; + virtual bool NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); + virtual bool NumberList(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1); + //@} + //@{ /** - Returns the last position in the buffer. + Promotes or demotes the paragraphs in the given range. + A positive @a 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. + + @a 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 + @a startFrom, otherwise existing attributes are used. + - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used + as the level for all paragraphs, otherwise the current indentation will be used. + + @see SetListStyle(), @see SetListStyle(), ClearListStyle(). */ - virtual wxTextPos GetLastPosition() const; + virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); + virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1); + //@} /** - Returns the length of the specified line in characters. + Sets the properties for the given range, passing flags to determine how the + attributes are set. You can merge properties or replace them. + + 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 properties for a character at + position 5, use the range (5,6). + + @a flags may contain a bit list of the following values: + - wxRICHTEXT_SETSPROPERTIES_NONE: no flag. + - wxRICHTEXT_SETPROPERTIES_WITH_UNDO: specifies that this operation should be + undoable. + - wxRICHTEXT_SETPROPERTIES_PARAGRAPHS_ONLY: specifies that the properties should only be + applied to paragraphs, and not the content. + - wxRICHTEXT_SETPROPERTIES_CHARACTERS_ONLY: specifies that the properties should only be + applied to characters, and not the paragraph. + - wxRICHTEXT_SETPROPERTIES_RESET: resets (clears) the existing properties before applying + the new properties. + - wxRICHTEXT_SETPROPERTIES_REMOVE: removes the specified properties. */ - virtual int GetLineLength(long lineNo) const; + virtual bool SetProperties(const wxRichTextRange& range, const wxRichTextProperties& properties, int flags = wxRICHTEXT_SETPROPERTIES_WITH_UNDO); /** - Returns the text for the given line. + Deletes the content within the given range. */ - virtual wxString GetLineText(long lineNo) const; + virtual bool Delete(const wxRichTextRange& range); /** - Transforms physical window position to logical (unscrolled) position. + Translates from column and line number to position. */ - wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const; + virtual long XYToPosition(long x, long y) const; /** - Returns the number of lines in the buffer. + Converts a text position to zero-based column and line numbers. */ - virtual int GetNumberOfLines() const; + virtual bool PositionToXY(long pos, long *x, long *y) const; /** - Transforms logical (unscrolled) position to physical window position. + Scrolls the buffer so that the given position is in view. */ - wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const; + virtual void ShowPosition(long pos); + //@{ /** - 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. + Finds the character at the given position in pixels. + @a pt is in device coords (not adjusted for the client area origin nor for + scrolling). */ - virtual wxString GetRange(long from, long to) const; + virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const; + virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, + wxTextCoord *col, + wxTextCoord *row) const; /** - 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 @a from and @a to are the same, there is no selection. + Finds the container at the given point, which is assumed to be in client coordinates. */ - virtual void GetSelection(long* from, long* to) const; + wxRichTextParagraphLayoutBox* FindContainerAtPoint(const wxPoint pt, long& position, int& hit, wxRichTextObject* hitObj, int flags = 0); + //@} + +// Clipboard operations /** - Returns the selection range in character positions. -1, -1 means no selection. + Copies the selected content (if any) to the clipboard. */ - wxRichTextRange GetSelectionRange() const; + virtual void Copy(); /** - Returns the text within the current selection range, if any. + Copies the selected content (if any) to the clipboard and deletes the selection. + This is undoable. */ - virtual wxString GetStringSelection() const; + virtual void Cut(); /** - 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(). - - @beginWxPerlOnly - In wxPerl this method is implemented as GetStyle(@a position) - returning a 2-element list (ok, attr). - @endWxPerlOnly + Pastes content from the clipboard to the buffer. */ - virtual bool GetStyle(long position, wxTextAttr& style); + virtual void Paste(); /** - Gets the attributes common to the specified range. - Attributes that differ in value within the range will not be included - in @a style flags. - - @beginWxPerlOnly - In wxPerl this method is implemented as GetStyleForRange(@a position) - returning a 2-element list (ok, attr). - @endWxPerlOnly + Deletes the content in the selection, if any. This is undoable. */ - virtual bool GetStyleForRange(const wxRichTextRange& range, - wxTextAttr& style); + virtual void DeleteSelection(); /** - Returns the style sheet associated with the control, if any. - A style sheet allows named character and paragraph styles to be applied. + Returns @true if selected content can be copied to the clipboard. */ - wxRichTextStyleSheet* GetStyleSheet() const; + virtual bool CanCopy() const; /** - Gets the attributes at the given position. - This function gets the @e 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 @e style's flags, this function - will fetch the paragraph attributes. - Otherwise, it will return the character attributes. - - @beginWxPerlOnly - In wxPerl this method is implemented as GetUncombinedStyle(@a position) - returning a 2-element list (ok, attr). - @endWxPerlOnly + Returns @true if selected content can be copied to the clipboard and deleted. */ - virtual bool GetUncombinedStyle(long position, wxTextAttr& style); + virtual bool CanCut() const; /** - Returns the content of the entire control as a string. + Returns @true if the clipboard content can be pasted to the buffer. */ - virtual wxString GetValue() const; + virtual bool CanPaste() 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. + Returns @true if selected content can be deleted. */ - wxRichTextLine* GetVisibleLineForCaretPosition(long caretPosition) const; + virtual bool CanDeleteSelection() const; /** - 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. - @a style must have flags indicating which attributes are of interest. + Undoes the command at the top of the command history, if there is one. */ - virtual bool HasCharacterAttributes(const wxRichTextRange& range, - const wxTextAttr& style) const; + virtual void Undo(); /** - 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. - @a style must have flags indicating which attributes are of interest. + Redoes the current command. */ - virtual bool HasParagraphAttributes(const wxRichTextRange& range, - const wxTextAttr& style) const; + virtual void Redo(); /** - Returns @true if there is a selection. + Returns @true if there is a command in the command history that can be undone. */ - virtual bool HasSelection() const; + virtual bool CanUndo() const; - //@{ /** - Finds the character at the given position in pixels. - @a pt is in device coords (not adjusted for the client area origin nor for - scrolling). + Returns @true if there is a command in the command history that can be redone. */ - wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long* pos) const; - const wxTextCtrlHitTestResult HitTest(const wxPoint& pt, - wxTextCoord* col, - wxTextCoord* row) const; - //@} + virtual bool CanRedo() const; /** - Initialises the members of the control. + Sets the insertion point and causes the current editing style to be taken from + the new position (unlike wxRichTextCtrl::SetCaretPosition). */ - void Init(); + virtual void SetInsertionPoint(long pos); /** - 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. + Sets the insertion point to the end of the text control. + */ + virtual void SetInsertionPointEnd(); - Below is an example of code that uses this function to determine whether the UI - should show that the current style is bold. + /** + Returns the current insertion point. + */ + virtual long GetInsertionPoint() const; - @see SetAndShowDefaultStyle(). + /** + Returns the last position in the buffer. */ - bool IsDefaultStyleShowing() const; + virtual wxTextPos GetLastPosition() const; + //@{ /** - Returns @true if the control is editable. + 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). */ - virtual bool IsEditable() const; + virtual void SetSelection(long from, long to); + void SetSelection(const wxRichTextSelection& sel); + //@} + /** - Returns @true if Freeze has been called without a Thaw. + Selects all the text in the buffer. */ - bool IsFrozen() const; + virtual void SelectAll(); /** - Returns @true if the buffer has been modified. + Makes the control editable, or not. */ - virtual bool IsModified() const; + virtual void SetEditable(bool editable); /** - Returns @true if the control is multiline. + Returns @true if there is a selection and the object containing the selection + was the same as the current focus object. */ - bool IsMultiLine() const; + virtual bool HasSelection() const; /** - Returns @true if the given position is visible on the screen. + Returns @true if there was a selection, whether or not the current focus object + is the same as the selection's container object. */ - bool IsPositionVisible(long pos) const; + virtual bool HasUnfocusedSelection() const; + //@{ /** - Returns @true if all of the selection is aligned according to the specified flag. + 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 IsSelectionAligned(wxTextAttrAlignment alignment); + virtual bool WriteImage(const wxImage& image, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG, + const wxRichTextAttr& textAttr = wxRichTextAttr()); + + virtual bool WriteImage(const wxBitmap& bitmap, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG, + const wxRichTextAttr& textAttr = wxRichTextAttr()); + //@} /** - Returns @true if all of the selection is bold. + Loads an image from a file and writes it at the current insertion point. */ - virtual bool IsSelectionBold(); + virtual bool WriteImage(const wxString& filename, wxBitmapType bitmapType, + const wxRichTextAttr& textAttr = wxRichTextAttr()); /** - Returns @true if all of the selection is italic. + Writes an image block at the current insertion point. */ - virtual bool IsSelectionItalics(); + virtual bool WriteImage(const wxRichTextImageBlock& imageBlock, + const wxRichTextAttr& textAttr = wxRichTextAttr()); /** - Returns @true if all of the selection is underlined. + Write a text box at the current insertion point, returning the text box. + You can then call SetFocusObject() to set the focus to the new object. */ - virtual bool IsSelectionUnderlined(); + virtual wxRichTextBox* WriteTextBox(const wxRichTextAttr& textAttr = wxRichTextAttr()); /** - Returns @true if the control is single-line. - Currently wxRichTextCtrl does not support single-line editing. + Writes a field at the current insertion point. + + @param fieldType + The field type, matching an existing field type definition. + @param properties + Extra data for the field. + @param textAttr + Optional attributes. + + @see wxRichTextField, wxRichTextFieldType, wxRichTextFieldTypeStandard */ - bool IsSingleLine() const; + virtual wxRichTextField* WriteField(const wxString& fieldType, const wxRichTextProperties& properties, + const wxRichTextAttr& textAttr = wxRichTextAttr()); /** - Helper function implementing keyboard navigation. + Write a table at the current insertion point, returning the table. + You can then call SetFocusObject() to set the focus to the new object. */ - virtual bool KeyboardNavigate(int keyCode, int flags); + virtual wxRichTextTable* WriteTable(int rows, int cols, const wxRichTextAttr& tableAttr = wxRichTextAttr(), const wxRichTextAttr& cellAttr = wxRichTextAttr()); /** - 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. + Inserts a new paragraph at the current insertion point. @see LineBreak(). */ - virtual bool LayoutContent(bool onlyVisibleRect = false); + virtual bool Newline(); /** Inserts a line break at the current insertion point. @@ -962,489 +1051,522 @@ public: virtual bool LineBreak(); /** - 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. + Sets the basic (overall) style. - This function looks for a suitable wxRichTextFileHandler object. + 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). */ - bool LoadFile(const wxString& file, - int type = wxRICHTEXT_TYPE_ANY); + virtual void SetBasicStyle(const wxRichTextAttr& style); /** - Marks the buffer as modified. - */ - virtual void MarkDirty(); + Gets the basic (overall) style. - /** - 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. + 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). */ - virtual bool MoveCaret(long pos, bool showAtLineStart = false); + virtual const wxRichTextAttr& GetBasicStyle() const; /** - 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. + Begins applying a style. */ - void MoveCaretBack(long oldPosition); + virtual bool BeginStyle(const wxRichTextAttr& style); /** - 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. + Ends the current style. */ - void MoveCaretForward(long oldPosition); + virtual bool EndStyle(); /** - Moves the caret down. + Ends application of all styles in the current style stack. */ - virtual bool MoveDown(int noLines = 1, int flags = 0); + virtual bool EndAllStyles(); /** - Moves to the end of the buffer. + Begins using bold. */ - virtual bool MoveEnd(int flags = 0); + bool BeginBold(); /** - Moves to the start of the buffer. + Ends using bold. */ - virtual bool MoveHome(int flags = 0); + bool EndBold(); /** - Moves left. + Begins using italic. */ - virtual bool MoveLeft(int noPositions = 1, int flags = 0); + bool BeginItalic(); /** - Moves right. + Ends using italic. */ - virtual bool MoveRight(int noPositions = 1, int flags = 0); + bool EndItalic(); /** - Moves to the end of the line. + Begins using underlining. */ - virtual bool MoveToLineEnd(int flags = 0); + bool BeginUnderline(); /** - Moves to the start of the line. + End applying underlining. */ - virtual bool MoveToLineStart(int flags = 0); + bool EndUnderline(); /** - Moves to the end of the paragraph. + Begins using the given point size. */ - virtual bool MoveToParagraphEnd(int flags = 0); + bool BeginFontSize(int pointSize); /** - Moves to the start of the paragraph. + Ends using a point size. */ - virtual bool MoveToParagraphStart(int flags = 0); + bool EndFontSize(); /** - Moves up. + Begins using this font. */ - virtual bool MoveUp(int noLines = 1, int flags = 0); + bool BeginFont(const wxFont& font); /** - Inserts a new paragraph at the current insertion point. @see LineBreak(). + Ends using a font. */ - virtual bool Newline(); + bool EndFont(); - //@{ /** - 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. - - @a 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 - @a startFrom, otherwise existing attributes are used. - - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used - as the level for all paragraphs, otherwise the current indentation will be used. - - @see SetListStyle(), PromoteList(), ClearListStyle(). + Begins using this colour. */ - bool NumberList(const wxRichTextRange& range, - const wxRichTextListStyleDefinition* style, - int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, - int startFrom = -1, - int listLevel = -1); - bool Number(const wxRichTextRange& range, - const wxString& styleName, - int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, - int startFrom = -1, - int listLevel = -1); - //@} + bool BeginTextColour(const wxColour& colour); /** - Standard handler for the wxID_CLEAR command. + Ends applying a text colour. */ - void OnClear(wxCommandEvent& event); + bool EndTextColour(); /** - Shows a standard context menu with undo, redo, cut, copy, paste, clear, and - select all commands. + Begins using alignment. + For alignment values, see wxTextAttr. */ - void OnContextMenu(wxContextMenuEvent& event); + bool BeginAlignment(wxTextAttrAlignment alignment); /** - Standard handler for the wxID_COPY command. + Ends alignment. */ - void OnCopy(wxCommandEvent& event); + bool EndAlignment(); /** - Standard handler for the wxID_CUT command. + 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 + @a leftIndent plus the @a leftSubIndent. + + @param leftIndent + The distance between the margin and the bullet. + @param leftSubIndent + The distance between the left edge of the bullet and the left edge + of the actual paragraph. */ - void OnCut(wxCommandEvent& event); + bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0); /** - Loads the first dropped file. + Ends left indent. */ - void OnDropFiles(wxDropFilesEvent& event); + bool EndLeftIndent(); /** - Standard handler for the wxID_PASTE command. + Begins a right indent, specified in tenths of a millimetre. */ - void OnPaste(wxCommandEvent& event); + bool BeginRightIndent(int rightIndent); /** - Standard handler for the wxID_REDO command. + Ends right indent. */ - void OnRedo(wxCommandEvent& event); + bool EndRightIndent(); /** - Standard handler for the wxID_SELECTALL command. + Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing + in tenths of a millimetre. */ - void OnSelectAll(wxCommandEvent& event); + bool BeginParagraphSpacing(int before, int after); /** - Standard handler for the wxID_UNDO command. + Ends paragraph spacing. */ - void OnUndo(wxCommandEvent& event); + bool EndParagraphSpacing(); /** - Standard update handler for the wxID_CLEAR command. + Begins appling line spacing. @e 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. */ - void OnUpdateClear(wxUpdateUIEvent& event); + bool BeginLineSpacing(int lineSpacing); /** - Standard update handler for the wxID_COPY command. + Ends line spacing. */ - void OnUpdateCopy(wxUpdateUIEvent& event); + bool EndLineSpacing(); /** - Standard update handler for the wxID_CUT command. - */ - void OnUpdateCut(wxUpdateUIEvent& event); + 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. + + @a bulletNumber is a number, usually starting with 1. + @a leftIndent and @a leftSubIndent are values in tenths of a millimetre. + @a 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 BeginNumberedBullet(int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD); + /** - Standard update handler for the wxID_PASTE command. + Ends application of a numbered bullet. */ - void OnUpdatePaste(wxUpdateUIEvent& event); + bool EndNumberedBullet(); /** - Standard update handler for the wxID_REDO command. + 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. */ - void OnUpdateRedo(wxUpdateUIEvent& event); - + bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL); + /** - Standard update handler for the wxID_SELECTALL command. + Ends applying a symbol bullet. */ - void OnUpdateSelectAll(wxUpdateUIEvent& event); + bool EndSymbolBullet(); /** - Standard update handler for the wxID_UNDO command. + Begins applying a symbol bullet. */ - void OnUpdateUndo(wxUpdateUIEvent& event); + bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD); /** - Moves one or more pages down. + Begins applying a standard bullet. */ - virtual bool PageDown(int noPages = 1, int flags = 0); + bool EndStandardBullet(); /** - Moves one or more pages up. + Begins using the named character style. */ - virtual bool PageUp(int noPages = 1, int flags = 0); + bool BeginCharacterStyle(const wxString& characterStyle); /** - Paints the background. + Ends application of a named character style. */ - virtual void PaintBackground(wxDC& dc); + bool EndCharacterStyle(); /** - Other user defined painting after everything else (i.e. all text) is painted. - - @since 2.9.1 + Begins applying the named paragraph style. */ - virtual void PaintAboveContent(wxDC& dc); + bool BeginParagraphStyle(const wxString& paragraphStyle); /** - Pastes content from the clipboard to the buffer. + Ends application of a named paragraph style. */ - virtual void Paste(); + bool EndParagraphStyle(); /** - Internal function to position the visible caret according to the current caret - position. + Begins using a specified list style. + Optionally, you can also pass a level and a number. */ - virtual void PositionCaret(); + bool BeginListStyle(const wxString& listStyle, int level = 1, int number = 1); /** - Converts a text position to zero-based column and line numbers. + Ends using a specified list style. */ - virtual bool PositionToXY(long pos, long* x, long* y) const; + bool EndListStyle(); - //@{ /** - Promotes or demotes the paragraphs in the given range. - A positive @a 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. - - @a 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 - @a startFrom, otherwise existing attributes are used. - - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used - as the level for all paragraphs, otherwise the current indentation will be used. + Begins applying wxTEXT_ATTR_URL to the content. - @see SetListStyle(), @see SetListStyle(), ClearListStyle(). + 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. */ - bool PromoteList(int promoteBy, const wxRichTextRange& range, - const wxRichTextListStyleDefinition* style, - int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, - int listLevel = -1); - bool PromoteList(int promoteBy, const wxRichTextRange& range, - const wxString& styleName, - int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, - int listLevel = -1); - //@} + bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString); /** - Redoes the current command. + Ends applying a URL. */ - virtual void Redo(); + bool EndURL(); /** - Removes the content in the specified range. + Sets the default style to the style under the cursor. */ - virtual void Remove(long from, long to); + bool SetDefaultStyleToCursorStyle(); /** - Replaces the content in the specified range with the string specified by - @a value. + Cancels any selection. */ - virtual void Replace(long from, long to, const wxString& value); + virtual void SelectNone(); /** - Saves the buffer content using the given type. + Selects the word at the given character position. + */ + virtual bool SelectWord(long position); - If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from - the filename extension. + /** + Returns the selection range in character positions. -1, -1 means no selection. - This function looks for a suitable wxRichTextFileHandler object. + The range is in API convention, i.e. a single character selection is denoted + by (n, n+1) */ - bool SaveFile(const wxString& file = wxEmptyString, - int type = wxRICHTEXT_TYPE_ANY); + wxRichTextRange GetSelectionRange() const; /** - Scrolls @a position into view. This function takes a caret position. + 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). */ - virtual bool ScrollIntoView(long position, int keyCode); + void SetSelectionRange(const wxRichTextRange& range); /** - Selects all the text in the buffer. + Returns the selection range in character positions. -2, -2 means no selection + -1, -1 means select everything. + The range is in internal format, i.e. a single character selection is denoted + by (n, n) */ - virtual void SelectAll(); + wxRichTextRange GetInternalSelectionRange() const; /** - Cancels any selection. + Sets the selection range in character positions. -2, -2 means no selection + -1, -1 means select everything. + The range is in internal format, i.e. a single character selection is denoted + by (n, n) */ - virtual void SelectNone(); + void SetInternalSelectionRange(const wxRichTextRange& range); /** - Sets @a attr as the default style and tells the control that the UI should - reflect this attribute until the user moves the caret. - - @see IsDefaultStyleShowing(). + Adds a new paragraph of text to the end of the buffer. */ - void SetAndShowDefaultStyle(const wxTextAttr& attr); + virtual wxRichTextRange AddParagraph(const wxString& text); /** - Sets the basic (overall) style. + Adds an image to the control's buffer. + */ + virtual wxRichTextRange AddImage(const wxImage& image); - 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). + /** + 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 void SetBasicStyle(const wxTextAttr& style); + virtual bool LayoutContent(bool onlyVisibleRect = false); /** - Sets the caret position. + Move the caret to the given character 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. + from the new position; to do that, call wxRichTextCtrl::SetInsertionPoint instead. */ - void SetCaretPosition(long position, - bool showAtLineStart = false); + virtual bool MoveCaret(long pos, bool showAtLineStart = false, wxRichTextParagraphLayoutBox* container = NULL); /** - Sets the current default style, which can be used to change how subsequently - inserted text is displayed. + Moves right. */ - virtual bool SetDefaultStyle(const wxTextAttr& style); + virtual bool MoveRight(int noPositions = 1, int flags = 0); /** - Sets the default style to the style under the cursor. + Moves left. */ - bool SetDefaultStyleToCursorStyle(); + virtual bool MoveLeft(int noPositions = 1, int flags = 0); /** - Sets the size of the buffer beyond which layout is delayed during resizing. - This optimizes sizing for large buffers. The default is 20000. + Moves to the start of the paragraph. */ - void SetDelayedLayoutThreshold(long threshold); + virtual bool MoveUp(int noLines = 1, int flags = 0); /** - Makes the control editable, or not. + Moves the caret down. */ - virtual void SetEditable(bool editable); + virtual bool MoveDown(int noLines = 1, int flags = 0); /** - Sets the current filename. + Moves to the end of the line. */ - void SetFilename(const wxString& filename); + virtual bool MoveToLineEnd(int flags = 0); /** - Sets the font, and also the basic and default attributes - (see wxRichTextCtrl::SetDefaultStyle). + Moves to the start of the line. */ - virtual bool SetFont(const wxFont& font); + virtual bool MoveToLineStart(int flags = 0); /** - Sets flags that change the behaviour of loading or saving. + Moves to the end of the paragraph. + */ + virtual bool MoveToParagraphEnd(int flags = 0); - See the documentation for each handler class to see what flags are - relevant for each handler. + /** + Moves to the start of the paragraph. */ - void SetHandlerFlags(int flags); + virtual bool MoveToParagraphStart(int flags = 0); /** - Sets the insertion point and causes the current editing style to be taken from - the new position (unlike wxRichTextCtrl::SetCaretPosition). + Moves to the start of the buffer. */ - virtual void SetInsertionPoint(long pos); + virtual bool MoveHome(int flags = 0); /** - Sets the insertion point to the end of the text control. + Moves to the end of the buffer. */ - virtual void SetInsertionPointEnd(); + virtual bool MoveEnd(int flags = 0); - //@{ /** - Sets the list attributes for the given range, passing flags to determine how - the attributes are set. + Moves one or more pages up. + */ + virtual bool PageUp(int noPages = 1, int flags = 0); - Either the style definition or the name of the style definition (in the current - sheet) can be passed. - @a 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 - @a startFrom, otherwise existing attributes are used. - - wxRICHTEXT_SETSTYLE_SPECIFY_LEVEL: specifies that @a listLevel should be used - as the level for all paragraphs, otherwise the current indentation will be used. + /** + Moves one or more pages down. + */ + virtual bool PageDown(int noPages = 1, int flags = 0); - @see NumberList(), PromoteList(), ClearListStyle(). + /** + Moves a number of words to the left. + */ + virtual bool WordLeft(int noPages = 1, int flags = 0); + + /** + Move a nuber of words to the right. */ - bool SetListStyle(const wxRichTextRange& range, - const wxRichTextListStyleDefinition* style, - int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, - int startFrom = -1, - int listLevel = -1); - bool SetListStyle(const wxRichTextRange& range, - const wxString& styleName, - int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, - int startFrom = -1, - int listLevel = -1); + virtual bool WordRight(int noPages = 1, int flags = 0); + + //@{ + /** + Returns the buffer associated with the control. + */ + wxRichTextBuffer& GetBuffer(); + const wxRichTextBuffer& GetBuffer() const; //@} /** - 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. + Starts batching undo history for commands. + */ + virtual bool BeginBatchUndo(const wxString& cmdName); - So, for example, to set the selection for a character at position 5, use the - range (5,6). + /** + Ends batching undo command history. */ - virtual void SetSelection(long from, long to); + virtual bool EndBatchUndo(); /** - 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. + Returns @true if undo commands are being batched. + */ + virtual bool BatchingUndo() const; - So, for example, to set the selection for a character at position 5, use the - range (5,6). + /** + Starts suppressing undo history for commands. */ - void SetSelectionRange(const wxRichTextRange& range); + virtual bool BeginSuppressUndo(); - //@{ /** - 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. + Ends suppressing undo command history. + */ + virtual bool EndSuppressUndo(); - So, for example, to set the style for a character at position 5, use the range - (5,6). + /** + Returns @true if undo history suppression is on. */ - bool SetStyle(const wxRichTextRange& range, - const wxTextAttr& style); - bool SetStyle(long start, long end, const wxTextAttr& style); - //@} + virtual bool SuppressingUndo() const; /** - Sets the attributes for the given range, passing flags to determine how the - attributes are set. + 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. - 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). + You can use this to implement, for example, bold button updating. + @a style must have flags indicating which attributes are of interest. + */ + virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const; + - @a 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. + /** + 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. + @a style must have flags indicating which attributes are of interest. + */ + virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const; + + + /** + Returns @true if all of the selection, or the content at the caret position, is bold. + */ + virtual bool IsSelectionBold(); + + /** + Returns @true if all of the selection, or the content at the caret position, is italic. + */ + virtual bool IsSelectionItalics(); + + /** + Returns @true if all of the selection, or the content at the caret position, is underlined. + */ + virtual bool IsSelectionUnderlined(); + + /** + Returns @true if all of the selection, or the content at the current caret position, has the supplied wxTextAttrEffects flag(s). + */ + virtual bool DoesSelectionHaveTextEffectFlag(int flag); + + /** + Returns @true if all of the selection is aligned according to the specified flag. + */ + virtual bool IsSelectionAligned(wxTextAttrAlignment alignment); + + /** + Apples bold to the selection or the default style (undoable). + */ + virtual bool ApplyBoldToSelection(); + + /** + Applies italic to the selection or the default style (undoable). + */ + virtual bool ApplyItalicToSelection(); + + /** + Applies underline to the selection or the default style (undoable). + */ + virtual bool ApplyUnderlineToSelection(); + + /** + Applies one or more wxTextAttrEffects flags to the selection (undoable). + If there is no selection, it is applied to the default style. + */ + virtual bool ApplyTextEffectToSelection(int flags); + + /** + Applies the given alignment to the selection or the default style (undoable). + For alignment values, see wxTextAttr. + */ + virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment); + + /** + 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 @a sheet is @NULL, the sheet set with SetStyleSheet() is used. + Currently this applies paragraph styles only. */ - virtual bool SetStyleEx(const wxRichTextRange& range, - const wxTextAttr& style, - int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); + virtual bool ApplyStyle(wxRichTextStyleDefinition* def); /** Sets the style sheet associated with the control. @@ -1453,86 +1575,854 @@ public: void SetStyleSheet(wxRichTextStyleSheet* styleSheet); /** - Replaces existing content with the given text. + Returns the style sheet associated with the control, if any. + A style sheet allows named character and paragraph styles to be applied. */ - virtual void SetValue(const wxString& value); + wxRichTextStyleSheet* GetStyleSheet() const; /** - A helper function setting up scrollbars, for example after a resize. + Push the style sheet to top of stack. */ - virtual void SetupScrollbars(bool atTop = false); + bool PushStyleSheet(wxRichTextStyleSheet* styleSheet); /** - Scrolls the buffer so that the given position is in view. + Pops the style sheet from top of stack. */ - virtual void ShowPosition(long pos); + wxRichTextStyleSheet* PopStyleSheet(); /** - Returns @true if undo history suppression is on. + Applies the style sheet to the buffer, for example if the styles have changed. */ - virtual bool SuppressingUndo() const; + bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL); /** - Call this function to end a Freeze and refresh the display. + Shows the given context menu, optionally adding appropriate property-editing commands for the current position in the object hierarchy. */ - void Thaw(); + virtual bool ShowContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands); /** - Undoes the command at the top of the command history, if there is one. + Prepares the context menu, optionally adding appropriate property-editing commands. + Returns the number of property commands added. */ - virtual void Undo(); + virtual int PrepareContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands); /** - Moves a number of words to the left. + Returns @true if we can edit the object's properties via a GUI. */ - virtual bool WordLeft(int noWords = 1, int flags = 0); + virtual bool CanEditProperties(wxRichTextObject* obj) const; /** - Move a nuber of words to the right. + Edits the object's properties via a GUI. */ - virtual bool WordRight(int noWords = 1, int flags = 0); + virtual bool EditProperties(wxRichTextObject* obj, wxWindow* parent); /** - Loads an image from a file and writes it at the current insertion point. + Gets the object's properties menu label. */ - virtual bool WriteImage(const wxString& filename, wxBitmapType bitmapType); + virtual wxString GetPropertiesMenuLabel(wxRichTextObject* obj); /** - Writes an image block at the current insertion point. + Prepares the content just before insertion (or after buffer reset). Called by the same function in wxRichTextBuffer. + Currently is only called if undo mode is on. */ - virtual bool WriteImage(const wxRichTextImageBlock& imageBlock); + virtual void PrepareContent(wxRichTextParagraphLayoutBox& container); - //@{ /** - 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. + Can we delete this range? + Sends an event to the control. */ - bool WriteImage(const wxBitmap& bitmap, - int bitmapType = wxBITMAP_TYPE_PNG); - bool WriteImage(const wxImage& image, - int bitmapType = wxBITMAP_TYPE_PNG); - //@} + virtual bool CanDeleteRange(wxRichTextParagraphLayoutBox& container, const wxRichTextRange& range) const; /** - Writes text at the current position. + Can we insert content at this position? + Sends an event to the control. */ - virtual void WriteText(const wxString& text); + virtual bool CanInsertContent(wxRichTextParagraphLayoutBox& container, long pos) const; /** - Translates from column and line number to position. + Enable or disable the vertical scrollbar. */ - virtual long XYToPosition(long x, long y) const; + virtual void EnableVerticalScrollbar(bool enable); -protected: + /** + Returns @true if the vertical scrollbar is enabled. + */ + virtual bool GetVerticalScrollbarEnabled() const; /** - Currently this simply returns @c wxSize(10, 10). + Sets the scale factor for displaying fonts, for example for more comfortable + editing. */ - virtual wxSize DoGetBestSize() const; + void SetFontScale(double fontScale, bool refresh = false); /** - Initialises the command event. + Returns the scale factor for displaying fonts, for example for more comfortable + editing. */ - void InitCommandEvent(wxCommandEvent& event) const; -}; + double GetFontScale() const { return GetBuffer().GetFontScale(); } + + /** + Sets the scale factor for displaying certain dimensions such as indentation and + inter-paragraph spacing. This can be useful when editing in a small control + where you still want legible text, but a minimum of wasted white space. + */ + void SetDimensionScale(double dimScale, bool refresh = false); + + /** + Returns the scale factor for displaying certain dimensions such as indentation + and inter-paragraph spacing. + */ + double GetDimensionScale() const { return GetBuffer().GetDimensionScale(); } + + /** + Sets an overall scale factor for displaying and editing the content. + */ + void SetScale(double scale, bool refresh = false); + + /** + Returns an overall scale factor for displaying and editing the content. + */ + double GetScale() const; + + /** + Returns an unscaled point. + */ + wxPoint GetUnscaledPoint(const wxPoint& pt) const; + + /** + Returns a scaled point. + */ + wxPoint GetScaledPoint(const wxPoint& pt) const; + + /** + Returns an unscaled size. + */ + wxSize GetUnscaledSize(const wxSize& sz) const; + + /** + Returns a scaled size. + */ + wxSize GetScaledSize(const wxSize& sz) const; + + /** + Returns an unscaled rectangle. + */ + wxRect GetUnscaledRect(const wxRect& rect) const; + + /** + Returns a scaled rectangle. + */ + wxRect GetScaledRect(const wxRect& rect) const; + + /** + Returns @true if this control can use virtual attributes and virtual text. + The default is @false. + */ + bool GetVirtualAttributesEnabled() const; + + /** + Pass @true to let the control use virtual attributes. + The default is @false. + */ + void EnableVirtualAttributes(bool b); + +// Command handlers + + /** + Sends the event to the control. + */ + void Command(wxCommandEvent& event); + + /** + Loads the first dropped file. + */ + void OnDropFiles(wxDropFilesEvent& event); + + void OnCaptureLost(wxMouseCaptureLostEvent& event); + void OnSysColourChanged(wxSysColourChangedEvent& event); + + /** + Standard handler for the wxID_CUT command. + */ + void OnCut(wxCommandEvent& event); + + /** + Standard handler for the wxID_COPY command. + */ + void OnCopy(wxCommandEvent& event); + + /** + Standard handler for the wxID_PASTE command. + */ + void OnPaste(wxCommandEvent& event); + + /** + Standard handler for the wxID_UNDO command. + */ + void OnUndo(wxCommandEvent& event); + + /** + Standard handler for the wxID_REDO command. + */ + void OnRedo(wxCommandEvent& event); + + /** + Standard handler for the wxID_SELECTALL command. + */ + void OnSelectAll(wxCommandEvent& event); + + /** + Standard handler for property commands. + */ + void OnProperties(wxCommandEvent& event); + + /** + Standard handler for the wxID_CLEAR command. + */ + void OnClear(wxCommandEvent& event); + + /** + Standard update handler for the wxID_CUT command. + */ + void OnUpdateCut(wxUpdateUIEvent& event); + + /** + Standard update handler for the wxID_COPY command. + */ + void OnUpdateCopy(wxUpdateUIEvent& event); + + /** + Standard update handler for the wxID_PASTE command. + */ + void OnUpdatePaste(wxUpdateUIEvent& event); + + /** + Standard update handler for the wxID_UNDO command. + */ + void OnUpdateUndo(wxUpdateUIEvent& event); + + /** + Standard update handler for the wxID_REDO command. + */ + void OnUpdateRedo(wxUpdateUIEvent& event); + + /** + Standard update handler for the wxID_SELECTALL command. + */ + void OnUpdateSelectAll(wxUpdateUIEvent& event); + + /** + Standard update handler for property commands. + */ + + void OnUpdateProperties(wxUpdateUIEvent& event); + + /** + Standard update handler for the wxID_CLEAR command. + */ + void OnUpdateClear(wxUpdateUIEvent& event); + + /** + Shows a standard context menu with undo, redo, cut, copy, paste, clear, and + select all commands. + */ + void OnContextMenu(wxContextMenuEvent& event); + +// Event handlers + + // Painting + void OnPaint(wxPaintEvent& event); + void OnEraseBackground(wxEraseEvent& event); + + // Left-click + void OnLeftClick(wxMouseEvent& event); + + // Left-up + void OnLeftUp(wxMouseEvent& event); + + // Motion + void OnMoveMouse(wxMouseEvent& event); + + // Left-double-click + void OnLeftDClick(wxMouseEvent& event); + + // Middle-click + void OnMiddleClick(wxMouseEvent& event); + + // Right-click + void OnRightClick(wxMouseEvent& event); + + // Key press + void OnChar(wxKeyEvent& event); + + // Sizing + void OnSize(wxSizeEvent& event); + + // Setting/losing focus + void OnSetFocus(wxFocusEvent& event); + void OnKillFocus(wxFocusEvent& event); + + // Idle-time processing + void OnIdle(wxIdleEvent& event); + + // Scrolling + void OnScroll(wxScrollWinEvent& event); + + /** + Sets the font, and also the basic and default attributes + (see wxRichTextCtrl::SetDefaultStyle). + */ + virtual bool SetFont(const wxFont& font); + + /** + A helper function setting up scrollbars, for example after a resize. + */ + virtual void SetupScrollbars(bool atTop = false); + + /** + Helper function implementing keyboard navigation. + */ + virtual bool KeyboardNavigate(int keyCode, int flags); + + /** + Paints the background. + */ + virtual void PaintBackground(wxDC& dc); + + /** + Other user defined painting after everything else (i.e.\ all text) is painted. + + @since 2.9.1 + */ + virtual void PaintAboveContent(wxDC& WXUNUSED(dc)) {} + +#if wxRICHTEXT_BUFFERED_PAINTING + /** + Recreates the buffer bitmap if necessary. + */ + virtual bool RecreateBuffer(const wxSize& size = wxDefaultSize); +#endif + + // Write text + virtual void DoWriteText(const wxString& value, int flags = 0); + + // Should we inherit colours? + virtual bool ShouldInheritColours() const; + + /** + Internal function to position the visible caret according to the current caret + position. + */ + virtual void PositionCaret(wxRichTextParagraphLayoutBox* container = NULL); + + /** + Helper function for extending the selection, returning @true if the selection + was changed. Selections are in caret positions. + */ + virtual bool ExtendSelection(long oldPosition, long newPosition, int flags); + + /** + Scrolls @a position into view. This function takes a caret position. + */ + virtual bool ScrollIntoView(long position, int keyCode); + + /** + Refreshes the area affected by a selection change. + */ + bool RefreshForSelectionChange(const wxRichTextSelection& oldSelection, const wxRichTextSelection& newSelection); + + /** + 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. + */ + void SetCaretPosition(long position, bool showAtLineStart = false) ; + + /** + Returns the current caret position. + */ + long GetCaretPosition() const; + + /** + The adjusted caret position is the character position adjusted to take + into account whether we're at the start of a paragraph, in which case + style information should be taken from the next position, not current one. + */ + long GetAdjustedCaretPosition(long caretPos) const; + + /** + 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. + */ + void MoveCaretBack(long oldPosition) ; + + /** + Returns the caret height and position for the given character position. + If container is null, the current focus object will be used. + + @beginWxPerlOnly + In wxPerl this method is implemented as + GetCaretPositionForIndex(@a position) returning a + 2-element list (ok, rect). + @endWxPerlOnly + */ + bool GetCaretPositionForIndex(long position, wxRect& rect, wxRichTextParagraphLayoutBox* container = NULL); + + /** + 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. + */ + wxRichTextLine* GetVisibleLineForCaretPosition(long caretPosition) const; + + /** + Gets the command processor associated with the control's buffer. + */ + wxCommandProcessor* GetCommandProcessor() const; + + /** + Deletes content if there is a selection, e.g. when pressing a key. + Returns the new caret position in @e newPos, or leaves it if there + was no action. This is undoable. + + @beginWxPerlOnly + In wxPerl this method takes no arguments and returns a 2-element + list (ok, newPos). + @endWxPerlOnly + */ + bool DeleteSelectedContent(long* newPos= NULL); + + /** + Transforms logical (unscrolled) position to physical window position. + */ + wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const; + + /** + Transforms physical window position to logical (unscrolled) position. + */ + wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const; + + /** + Helper function for finding the caret position for the next word. + Direction is 1 (forward) or -1 (backwards). + */ + virtual long FindNextWordPosition(int direction = 1) const; + + /** + Returns @true if the given position is visible on the screen. + */ + bool IsPositionVisible(long pos) const; + + /** + Returns the first visible position in the current view. + */ + long GetFirstVisiblePosition() const; + + /** + Returns the caret position since the default formatting was changed. As + soon as this position changes, we no longer reflect the default style + in the UI. A value of -2 means that we should only reflect the style of the + content under the caret. + */ + long GetCaretPositionForDefaultStyle() const; + + /** + Set the caret position for the default style that the user is selecting. + */ + void SetCaretPositionForDefaultStyle(long pos); + + /** + 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 SetAndShowDefaultStyle(). + */ + bool IsDefaultStyleShowing() const; + + /** + Sets @a attr as the default style and tells the control that the UI should + reflect this attribute until the user moves the caret. + + @see IsDefaultStyleShowing(). + */ + void SetAndShowDefaultStyle(const wxRichTextAttr& attr); + + /** + Returns the first visible point in the window. + */ + wxPoint GetFirstVisiblePoint() const; + + /** + Returns the content of the entire control as a string. + */ + virtual wxString GetValue() const; + + /** + Replaces existing content with the given text. + */ + virtual void SetValue(const wxString& value); + + +// Implementation + + /** + Processes the back key. + */ + virtual bool ProcessBackKey(wxKeyEvent& event, int flags); + + /** + Given a character position at which there is a list style, find the range + encompassing the same list style by looking backwards and forwards. + */ + virtual wxRichTextRange FindRangeForList(long pos, bool& isNumberedList); + + /** + Sets up the caret for the given position and container, after a mouse click. + */ + bool SetCaretPositionAfterClick(wxRichTextParagraphLayoutBox* container, long position, int hitTestFlags, bool extendSelection = false); + + /** + Find the caret position for the combination of hit-test flags and character position. + Returns the caret position and also an indication of where to place the caret (caretLineStart) + since this is ambiguous (same position used for end of line and start of next). + */ + long FindCaretPositionForCharacterPosition(long position, int hitTestFlags, wxRichTextParagraphLayoutBox* container, + bool& caretLineStart); + + /** + Processes mouse movement in order to change the cursor + */ + virtual bool ProcessMouseMovement(wxRichTextParagraphLayoutBox* container, wxRichTextObject* obj, long position, const wxPoint& pos); + + /** + Font names take a long time to retrieve, so cache them (on demand). + */ + static const wxArrayString& GetAvailableFontNames(); + + /** + Clears the cache of available font names. + */ + static void ClearAvailableFontNames(); + + // implement wxTextEntry methods + virtual wxString DoGetValue() const; + +protected: + // implement the wxTextEntry pure virtual method + virtual wxWindow *GetEditableWindow(); + + // margins functions + virtual bool DoSetMargins(const wxPoint& pt); + virtual wxPoint DoGetMargins() const; + + +// Overrides +protected: + + /** + Currently this simply returns @c wxSize(10, 10). + */ + virtual wxSize DoGetBestSize() const ; + + virtual void DoSetValue(const wxString& value, int flags = 0); + + virtual void DoThaw(); + + +// Data members +protected: +#if wxRICHTEXT_BUFFERED_PAINTING + /// Buffer bitmap + wxBitmap m_bufferBitmap; +#endif + + /// Text buffer + wxRichTextBuffer m_buffer; + + wxMenu* m_contextMenu; + + /// Caret position (1 less than the character position, so -1 is the + /// first caret position). + long m_caretPosition; + + /// Caret position when the default formatting has been changed. As + /// soon as this position changes, we no longer reflect the default style + /// in the UI. + long m_caretPositionForDefaultStyle; + + /// Selection range in character positions. -2, -2 means no selection. + wxRichTextSelection m_selection; + + wxRichTextCtrlSelectionState m_selectionState; + + /// Anchor so we know how to extend the selection + /// It's a caret position since it's between two characters. + long m_selectionAnchor; + + /// Anchor object if selecting multiple container objects, such as grid cells. + wxRichTextObject* m_selectionAnchorObject; + + /// Are we editable? + bool m_editable; + + /// Are we showing the caret position at the start of a line + /// instead of at the end of the previous one? + bool m_caretAtLineStart; + + /// Are we dragging a selection? + bool m_dragging; + + /// Do we need full layout in idle? + bool m_fullLayoutRequired; + wxLongLong m_fullLayoutTime; + long m_fullLayoutSavedPosition; + + /// Threshold for doing delayed layout + long m_delayedLayoutThreshold; + + /// Cursors + wxCursor m_textCursor; + wxCursor m_urlCursor; + + static wxArrayString sm_availableFontNames; + + wxRichTextContextMenuPropertiesInfo m_contextMenuPropertiesInfo; + + /// The object that currently has the editing focus + wxRichTextParagraphLayoutBox* m_focusObject; +}; + +/** + @class wxRichTextEvent + + This is the event class for wxRichTextCtrl notifications. + + @beginEventTable{wxRichTextEvent} + @event{EVT_RICHTEXT_LEFT_CLICK(id, func)} + Process a @c wxEVT_RICHTEXT_LEFT_CLICK event, generated when the user + releases the left mouse button over an object. + @event{EVT_RICHTEXT_RIGHT_CLICK(id, func)} + Process a @c wxEVT_RICHTEXT_RIGHT_CLICK event, generated when the user + releases the right mouse button over an object. + @event{EVT_RICHTEXT_MIDDLE_CLICK(id, func)} + Process a @c wxEVT_RICHTEXT_MIDDLE_CLICK event, generated when the user + releases the middle mouse button over an object. + @event{EVT_RICHTEXT_LEFT_DCLICK(id, func)} + Process a @c wxEVT_RICHTEXT_LEFT_DCLICK event, generated when the user + double-clicks an object. + @event{EVT_RICHTEXT_RETURN(id, func)} + Process a @c wxEVT_RICHTEXT_RETURN event, generated when the user + presses the return key. Valid event functions: GetFlags, GetPosition. + @event{EVT_RICHTEXT_CHARACTER(id, func)} + Process a @c wxEVT_RICHTEXT_CHARACTER event, generated when the user + presses a character key. Valid event functions: GetFlags, GetPosition, GetCharacter. + @event{EVT_RICHTEXT_DELETE(id, func)} + Process a @c wxEVT_RICHTEXT_DELETE event, generated when the user + presses the backspace or delete key. Valid event functions: GetFlags, GetPosition. + @event{EVT_RICHTEXT_RETURN(id, func)} + Process a @c wxEVT_RICHTEXT_RETURN event, generated when the user + presses the return key. Valid event functions: GetFlags, GetPosition. + @event{EVT_RICHTEXT_STYLE_CHANGED(id, func)} + Process a @c wxEVT_RICHTEXT_STYLE_CHANGED event, generated when + styling has been applied to the control. Valid event functions: GetPosition, GetRange. + @event{EVT_RICHTEXT_STYLESHEET_CHANGED(id, func)} + Process a @c wxEVT_RICHTEXT_STYLESHEET_CHANGING event, generated + when the control's stylesheet has changed, for example the user added, + edited or deleted a style. Valid event functions: GetRange, GetPosition. + @event{EVT_RICHTEXT_STYLESHEET_REPLACING(id, func)} + Process a @c wxEVT_RICHTEXT_STYLESHEET_REPLACING event, generated + when the control's stylesheet is about to be replaced, for example when + a file is loaded into the control. + Valid event functions: Veto, GetOldStyleSheet, GetNewStyleSheet. + @event{EVT_RICHTEXT_STYLESHEET_REPLACED(id, func)} + Process a @c wxEVT_RICHTEXT_STYLESHEET_REPLACED event, generated + when the control's stylesheet has been replaced, for example when a file + is loaded into the control. + Valid event functions: GetOldStyleSheet, GetNewStyleSheet. + @event{EVT_RICHTEXT_PROPERTIES_CHANGED(id, func)} + Process a @c wxEVT_RICHTEXT_PROPERTIES_CHANGED event, generated when + properties have been applied to the control. Valid event functions: GetPosition, GetRange. + @event{EVT_RICHTEXT_CONTENT_INSERTED(id, func)} + Process a @c wxEVT_RICHTEXT_CONTENT_INSERTED event, generated when + content has been inserted into the control. + Valid event functions: GetPosition, GetRange. + @event{EVT_RICHTEXT_CONTENT_DELETED(id, func)} + Process a @c wxEVT_RICHTEXT_CONTENT_DELETED event, generated when + content has been deleted from the control. + Valid event functions: GetPosition, GetRange. + @event{EVT_RICHTEXT_BUFFER_RESET(id, func)} + Process a @c wxEVT_RICHTEXT_BUFFER_RESET event, generated when the + buffer has been reset by deleting all content. + You can use this to set a default style for the first new paragraph. + @event{EVT_RICHTEXT_SELECTION_CHANGED(id, func)} + Process a @c wxEVT_RICHTEXT_SELECTION_CHANGED event, generated when the + selection range has changed. + @event{EVT_RICHTEXT_FOCUS_OBJECT_CHANGED(id, func)} + Process a @c wxEVT_RICHTEXT_FOCUS_OBJECT_CHANGED event, generated when the + current focus object has changed. + @endEventTable + + @library{wxrichtext} + @category{events,richtext} +*/ + +class wxRichTextEvent : public wxNotifyEvent +{ +public: + /** + Constructor. + + @param commandType + The type of the event. + @param id + Window identifier. The value @c wxID_ANY indicates a default value. + */ + wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0); + + /** + Copy constructor. + */ + wxRichTextEvent(const wxRichTextEvent& event); + + /** + Returns the buffer position at which the event occurred. + */ + long GetPosition() const; + + /** + Sets the buffer position variable. + */ + void SetPosition(long pos); + + /** + Returns flags indicating modifier keys pressed. + + Possible values are @c wxRICHTEXT_CTRL_DOWN, @c wxRICHTEXT_SHIFT_DOWN, and @c wxRICHTEXT_ALT_DOWN. + */ + int GetFlags() const; + + /** + Sets flags indicating modifier keys pressed. + + Possible values are @c wxRICHTEXT_CTRL_DOWN, @c wxRICHTEXT_SHIFT_DOWN, and @c wxRICHTEXT_ALT_DOWN. + */ + void SetFlags(int flags); + + /** + Returns the old style sheet. + + Can be used in a @c wxEVT_RICHTEXT_STYLESHEET_CHANGING or + @c wxEVT_RICHTEXT_STYLESHEET_CHANGED event handler. + */ + wxRichTextStyleSheet* GetOldStyleSheet() const; + + /** + Sets the old style sheet variable. + */ + void SetOldStyleSheet(wxRichTextStyleSheet* sheet); + + /** + Returns the new style sheet. + + Can be used in a @c wxEVT_RICHTEXT_STYLESHEET_CHANGING or + @c wxEVT_RICHTEXT_STYLESHEET_CHANGED event handler. + */ + wxRichTextStyleSheet* GetNewStyleSheet() const; + + /** + Sets the new style sheet variable. + */ + void SetNewStyleSheet(wxRichTextStyleSheet* sheet); + + /** + Gets the range for the current operation. + */ + const wxRichTextRange& GetRange() const; + + /** + Sets the range variable. + */ + void SetRange(const wxRichTextRange& range); + + /** + Returns the character pressed, within a @c wxEVT_RICHTEXT_CHARACTER event. + */ + wxChar GetCharacter() const; + + /** + Sets the character variable. + */ + void SetCharacter(wxChar ch); + + /** + Returns the container for which the event is relevant. + */ + wxRichTextParagraphLayoutBox* GetContainer() const; + + /** + Sets the container for which the event is relevant. + */ + void SetContainer(wxRichTextParagraphLayoutBox* container); + + /** + Returns the old container, for a focus change event. + */ + wxRichTextParagraphLayoutBox* GetOldContainer() const; + + /** + Sets the old container, for a focus change event. + */ + void SetOldContainer(wxRichTextParagraphLayoutBox* container); + + virtual wxEvent *Clone() const; + +protected: + int m_flags; + long m_position; + wxRichTextStyleSheet* m_oldStyleSheet; + wxRichTextStyleSheet* m_newStyleSheet; + wxRichTextRange m_range; + wxChar m_char; + wxRichTextParagraphLayoutBox* m_container; + wxRichTextParagraphLayoutBox* m_oldContainer; + +}; + +wxEventType wxEVT_RICHTEXT_LEFT_CLICK; +wxEventType wxEVT_RICHTEXT_RIGHT_CLICK; +wxEventType wxEVT_RICHTEXT_MIDDLE_CLICK; +wxEventType wxEVT_RICHTEXT_LEFT_DCLICK; +wxEventType wxEVT_RICHTEXT_RETURN; +wxEventType wxEVT_RICHTEXT_CHARACTER; +wxEventType wxEVT_RICHTEXT_DELETE; + +wxEventType wxEVT_RICHTEXT_STYLESHEET_CHANGING; +wxEventType wxEVT_RICHTEXT_STYLESHEET_CHANGED; +wxEventType wxEVT_RICHTEXT_STYLESHEET_REPLACING; +wxEventType wxEVT_RICHTEXT_STYLESHEET_REPLACED; + +wxEventType wxEVT_RICHTEXT_CONTENT_INSERTED; +wxEventType wxEVT_RICHTEXT_CONTENT_DELETED; +wxEventType wxEVT_RICHTEXT_STYLE_CHANGED; +wxEventType wxEVT_RICHTEXT_PROPERTIES_CHANGED; +wxEventType wxEVT_RICHTEXT_SELECTION_CHANGED; +wxEventType wxEVT_RICHTEXT_BUFFER_RESET; +wxEventType wxEVT_RICHTEXT_FOCUS_OBJECT_CHANGED;