#include "wx/scrolwin.h"
#include "wx/caret.h"
-#if wxCHECK_VERSION(2,7,0)
-#define wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE 1
-#else
-#define wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE 0
-#endif
-
-#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
#include "wx/textctrl.h"
+
+#if !defined(__WXGTK__) && !defined(__WXMAC__)
+#define wxRICHTEXT_BUFFERED_PAINTING 1
+#else
+#define wxRICHTEXT_BUFFERED_PAINTING 0
#endif
-class WXDLLIMPEXP_RICHTEXT wxRichTextStyleDefinition;
+class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextStyleDefinition;
-/*!
+/*
* Styles and flags
*/
-/* Styles
- */
+/**
+ Styles
+*/
#define wxRE_READONLY 0x0010
#define wxRE_MULTILINE 0x0020
+#define wxRE_CENTRE_CARET 0x8000
+#define wxRE_CENTER_CARET wxRE_CENTRE_CARET
-/* Flags
- */
+/**
+ Flags
+*/
#define wxRICHTEXT_SHIFT_DOWN 0x01
#define wxRICHTEXT_CTRL_DOWN 0x02
#define wxRICHTEXT_ALT_DOWN 0x04
-/* Defaults
- */
+/**
+ Extra flags
+*/
+
+// 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)
// Milliseconds before layout occurs after resize
#define wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL 50
-/*!
- * Forward declarations
+/* 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.
*/
-/*!
- * wxRichTextItem class declaration
+enum wxRichTextCtrlSelectionState
+{
+ wxRichTextCtrlSelectionState_Normal,
+ wxRichTextCtrlSelectionState_CommonAncestor
+};
+
+/**
+ @class wxRichTextContextMenuPropertiesInfo
+
+ wxRichTextContextMenuPropertiesInfo keeps track of objects that appear in the context menu,
+ whose properties are available to be edited.
*/
-// Drawing styles/states
-#define wxRICHTEXT_SELECTED 0x01
-#define wxRICHTEXT_TAGGED 0x02
-// The control is focussed
-#define wxRICHTEXT_FOCUSSED 0x04
-// The item itself has the focus
-#define wxRICHTEXT_IS_FOCUS 0x08
+class WXDLLIMPEXP_RICHTEXT wxRichTextContextMenuPropertiesInfo
+{
+public:
+ /**
+ Constructor.
+ */
+ wxRichTextContextMenuPropertiesInfo() { Init(); }
+
+// Operations
+
+ /**
+ Initialisation.
+ */
+ void Init() {}
+
+ /**
+ Adds an item.
+ */
+ bool AddItem(const wxString& label, wxRichTextObject* obj);
+
+ /**
+ Returns the number of menu items that were added.
+ */
+ int AddMenuItems(wxMenu* menu, int startCmd = wxID_RICHTEXT_PROPERTIES1) const;
+
+ /**
+ Adds appropriate menu items for the current container and clicked on object
+ (and container's parent, if appropriate).
+ */
+ int AddItems(wxRichTextObject* container, wxRichTextObject* obj);
+
+ /**
+ Clears the items.
+ */
+ void Clear() { m_objects.Clear(); m_labels.Clear(); }
+
+// Accessors
+
+ /**
+ Returns the nth label.
+ */
+ wxString GetLabel(int n) const { return m_labels[n]; }
+
+ /**
+ Returns the nth object.
+ */
+ wxRichTextObject* GetObject(int n) const { return m_objects[n]; }
+
+ /**
+ Returns the array of objects.
+ */
+ wxRichTextObjectPtrArray& GetObjects() { return m_objects; }
+
+ /**
+ Returns the array of objects.
+ */
+ const wxRichTextObjectPtrArray& GetObjects() const { return m_objects; }
+
+ /**
+ Returns the array of labels.
+ */
+ wxArrayString& GetLabels() { return m_labels; }
+
+ /**
+ Returns the array of labels.
+ */
+ const wxArrayString& GetLabels() const { return m_labels; }
+
+ /**
+ Returns the number of items.
+ */
+ int GetCount() const { return m_objects.GetCount(); }
+
+ wxRichTextObjectPtrArray m_objects;
+ wxArrayString m_labels;
+};
+
+/**
+ @class wxRichTextCtrl
+
+ wxRichTextCtrl provides a generic, ground-up implementation of a text control
+ capable of showing multiple styles and images.
+
+ wxRichTextCtrl sends notification events: see wxRichTextEvent.
+
+ It also sends the standard wxTextCtrl events @c wxEVT_COMMAND_TEXT_ENTER and
+ @c wxEVT_COMMAND_TEXT_UPDATED, and wxTextUrlEvent when URL content is clicked.
+
+ For more information, see the @ref overview_richtextctrl.
+
+ @beginStyleTable
+ @style{wxRE_CENTRE_CARET}
+ The control will try to keep the caret line centred vertically while editing.
+ wxRE_CENTER_CARET is a synonym for this style.
+ @style{wxRE_MULTILINE}
+ The control will be multiline (mandatory).
+ @style{wxRE_READONLY}
+ The control will not be editable.
+ @endStyleTable
+
+ @library{wxrichtext}
+ @category{richtext}
+ @appearance{richtextctrl.png}
-/*!
- * wxRichTextCtrl class declaration
*/
-class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl:
-#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
- public wxTextCtrlBase, public wxScrollHelper
-#else
- public wxScrolledWindow
-#endif
+class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl : public wxControl,
+ public wxTextCtrlIface,
+ public wxScrollHelper
{
- DECLARE_CLASS( wxRichTextCtrl )
+ DECLARE_DYNAMIC_CLASS( wxRichTextCtrl )
DECLARE_EVENT_TABLE()
public:
// Constructors
+ /**
+ Default constructor.
+ */
wxRichTextCtrl( );
+
+ /**
+ Constructor, creating and showing a rich text control.
+
+ @param parent
+ Parent window. Must not be @NULL.
+ @param id
+ Window identifier. The value @c wxID_ANY indicates a default value.
+ @param value
+ Default string.
+ @param pos
+ Window position.
+ @param size
+ Window size.
+ @param style
+ Window style.
+ @param validator
+ Window validator.
+ @param name
+ Window name.
+
+ @see Create(), wxValidator
+ */
wxRichTextCtrl( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
- long style = wxRE_MULTILINE );
+ long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr);
+
+ /**
+ Destructor.
+ */
virtual ~wxRichTextCtrl( );
// Operations
- /// Creation
+ /**
+ Creates the underlying window.
+ */
bool Create( wxWindow* parent, wxWindowID id = -1, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
- long style = wxRE_MULTILINE );
+ long style = wxRE_MULTILINE, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxTextCtrlNameStr );
- /// Member initialisation
+ /**
+ Initialises the members of the control.
+ */
void Init();
-///// wxTextCtrl compatibility
-
// Accessors
- virtual wxString GetValue() const;
- virtual void SetValue(const wxString& value);
-
+ /**
+ 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 wxString GetRange(long from, long to) const;
+ /**
+ Returns the length of the specified line in characters.
+ */
virtual int GetLineLength(long lineNo) const ;
+
+ /**
+ Returns the text for the given line.
+ */
virtual wxString GetLineText(long lineNo) const ;
+
+ /**
+ Returns the number of lines in the buffer.
+ */
virtual int GetNumberOfLines() const ;
+ /**
+ Returns @true if the buffer has been modified.
+ */
virtual bool IsModified() const ;
+
+ /**
+ Returns @true if the control is editable.
+ */
virtual bool IsEditable() const ;
- // more readable flag testing methods
+ /**
+ Returns @true if the control is single-line.
+ Currently wxRichTextCtrl does not support single-line editing.
+ */
bool IsSingleLine() const { return !HasFlag(wxRE_MULTILINE); }
+
+ /**
+ Returns @true if the control is multiline.
+ */
bool IsMultiLine() const { return !IsSingleLine(); }
- // If the return values from and to are the same, there is no selection.
+ //@{
+ /**
+ 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.
+ */
virtual void GetSelection(long* from, long* to) const;
+ const wxRichTextSelection& GetSelection() const { return m_selection; }
+ wxRichTextSelection& GetSelection() { return m_selection; }
+ //@}
+ /**
+ Returns the text within the current selection range, if any.
+ */
virtual wxString GetStringSelection() const;
- /// Get filename
+ /**
+ Gets the current filename associated with the control.
+ */
wxString GetFilename() const { return m_filename; }
- /// Set filename
+ /**
+ Sets the current filename.
+ */
void SetFilename(const wxString& filename) { m_filename = filename; }
- /// Set the threshold in character positions for doing layout optimization during sizing
+ /**
+ Sets the size of the buffer beyond which layout is delayed during resizing.
+ This optimizes sizing for large buffers. The default is 20000.
+ */
void SetDelayedLayoutThreshold(long threshold) { m_delayedLayoutThreshold = threshold; }
- /// Get the threshold in character positions for doing layout optimization during sizing
+ /**
+ 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 { return m_delayedLayoutThreshold; }
+ /**
+ Gets the flag indicating that full layout is required.
+ */
+ bool GetFullLayoutRequired() const { return m_fullLayoutRequired; }
+
+ /**
+ Sets the flag indicating that full layout is required.
+ */
+ void SetFullLayoutRequired(bool b) { m_fullLayoutRequired = b; }
+
+ /**
+ Returns the last time full layout was performed.
+ */
+ wxLongLong GetFullLayoutTime() const { return m_fullLayoutTime; }
+
+ /**
+ Sets the last time full layout was performed.
+ */
+ void SetFullLayoutTime(wxLongLong t) { m_fullLayoutTime = t; }
+
+ /**
+ Returns the position that should be shown when full (delayed) layout is performed.
+ */
+ long GetFullLayoutSavedPosition() const { return m_fullLayoutSavedPosition; }
+
+ /**
+ Sets the position that should be shown when full (delayed) layout is performed.
+ */
+ void SetFullLayoutSavedPosition(long p) { m_fullLayoutSavedPosition = p; }
+
+ /**
+ Forces any pending layout due to delayed, partial layout when the control
+ was resized.
+ */
+ void ForceDelayedLayout();
+
+ /**
+ Sets the text (normal) cursor.
+ */
+ void SetTextCursor(const wxCursor& cursor ) { m_textCursor = cursor; }
+
+ /**
+ Returns the text (normal) cursor.
+ */
+ wxCursor GetTextCursor() const { return m_textCursor; }
+
+ /**
+ Sets the cursor to be used over URLs.
+ */
+ void SetURLCursor(const wxCursor& cursor ) { m_urlCursor = cursor; }
+
+ /**
+ Returns the cursor to be used over URLs.
+ */
+ wxCursor GetURLCursor() const { return m_urlCursor; }
+
+ /**
+ 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 GetCaretAtLineStart() const { return m_caretAtLineStart; }
+
+ /**
+ 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.
+ */
+ void SetCaretAtLineStart(bool atStart) { m_caretAtLineStart = atStart; }
+
+ /**
+ Returns @true if we are dragging a selection.
+ */
+ bool GetDragging() const { return m_dragging; }
+
+ /**
+ Sets a flag to remember if we are dragging a selection.
+ */
+ void SetDragging(bool dragging) { m_dragging = dragging; }
+
+ /**
+ Returns the drag start position.
+ */
+ const wxPoint& GetDragStart() const { return m_dragStart; }
+
+ /**
+ Sets the drag start position.
+ */
+ void SetDragStart(const wxPoint& pt) { m_dragStart = pt; }
+
+#if wxRICHTEXT_BUFFERED_PAINTING
+ //@{
+ /**
+ Returns the buffer bitmap if using buffered painting.
+ */
+ const wxBitmap& GetBufferBitmap() const { return m_bufferBitmap; }
+ wxBitmap& GetBufferBitmap() { return m_bufferBitmap; }
+ //@}
+#endif
+
+ /**
+ Returns the current context menu.
+ */
+ wxMenu* GetContextMenu() const { return m_contextMenu; }
+
+ /**
+ Sets the current context menu.
+ */
+ void SetContextMenu(wxMenu* menu);
+
+ /**
+ Returns an anchor so we know how to extend the selection.
+ It's a caret position since it's between two characters.
+ */
+ long GetSelectionAnchor() const { return m_selectionAnchor; }
+
+ /**
+ Sets an anchor so we know how to extend the selection.
+ It's a caret position since it's between two characters.
+ */
+ void SetSelectionAnchor(long anchor) { m_selectionAnchor = anchor; }
+
+ /**
+ Returns the anchor object if selecting multiple containers.
+ */
+ wxRichTextObject* GetSelectionAnchorObject() const { return m_selectionAnchorObject; }
+
+ /**
+ Sets the anchor object if selecting multiple containers.
+ */
+ void SetSelectionAnchorObject(wxRichTextObject* anchor) { m_selectionAnchorObject = anchor; }
+
+ //@{
+ /**
+ 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.
+ */
+ wxRichTextContextMenuPropertiesInfo& GetContextMenuPropertiesInfo() { return m_contextMenuPropertiesInfo; }
+ const wxRichTextContextMenuPropertiesInfo& GetContextMenuPropertiesInfo() const { return m_contextMenuPropertiesInfo; }
+ //@}
+
+ /**
+ Returns the wxRichTextObject object that currently has the editing focus.
+ If there are no composite objects, this will be the top-level buffer.
+ */
+ wxRichTextParagraphLayoutBox* GetFocusObject() const { return m_focusObject; }
+
+ /**
+ Sets the wxRichTextObject object that currently has the editing focus.
+ */
+ bool SetFocusObject(wxRichTextParagraphLayoutBox* obj, bool setCaretPosition = true);
+
// Operations
- // editing
+ /**
+ Invalidates the whole buffer to trigger painting later.
+ */
+ void Invalidate() { GetBuffer().Invalidate(wxRICHTEXT_ALL); }
+
+ /**
+ Clears the buffer content, leaving a single empty paragraph. Cannot be undone.
+ */
virtual void Clear();
+
+ /**
+ Replaces the content in the specified range with the string specified by
+ @a value.
+ */
virtual void Replace(long from, long to, const wxString& value);
+
+ /**
+ Removes the content in the specified range.
+ */
virtual void Remove(long from, long to);
-#if !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
- bool LoadFile(const wxString& file, int fileType = wxRICHTEXT_TYPE_ANY);
- bool SaveFile(const wxString& file = wxEmptyString, int fileType = wxRICHTEXT_TYPE_ANY);
+#ifdef DOXYGEN
+ /**
+ Loads content into the control's buffer using the given type.
+
+ If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
+ the filename extension.
+
+ This function looks for a suitable wxRichTextFileHandler object.
+ */
+ bool LoadFile(const wxString& file,
+ int type = wxRICHTEXT_TYPE_ANY);
#endif
- // load/save the controls contents from/to the file
+ /**
+ Helper function for LoadFile(). Loads content into the control's buffer using the given type.
+
+ If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
+ the filename extension.
+
+ This function looks for a suitable wxRichTextFileHandler object.
+ */
virtual bool DoLoadFile(const wxString& file, int fileType);
- virtual bool DoSaveFile(const wxString& file = wxEmptyString, int fileType = wxRICHTEXT_TYPE_ANY);
- // sets/clears the dirty flag
+#ifdef DOXYGEN
+ /**
+ Saves the buffer content using the given type.
+
+ If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
+ the filename extension.
+
+ This function looks for a suitable wxRichTextFileHandler object.
+ */
+ bool SaveFile(const wxString& file = wxEmptyString,
+ int type = wxRICHTEXT_TYPE_ANY);
+#endif
+
+ /**
+ Helper function for SaveFile(). Saves the buffer content using the given type.
+
+ If the specified type is wxRICHTEXT_TYPE_ANY, the type is deduced from
+ the filename extension.
+
+ This function looks for a suitable wxRichTextFileHandler object.
+ */
+ virtual bool DoSaveFile(const wxString& file = wxEmptyString,
+ int fileType = wxRICHTEXT_TYPE_ANY);
+
+ /**
+ Sets flags that change the behaviour of loading or saving.
+
+ See the documentation for each handler class to see what flags are
+ relevant for each handler.
+ */
+ void SetHandlerFlags(int flags) { GetBuffer().SetHandlerFlags(flags); }
+
+ /**
+ 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.
+ */
+ int GetHandlerFlags() const { return GetBuffer().GetHandlerFlags(); }
+
+ /**
+ Marks the buffer as modified.
+ */
virtual void MarkDirty();
+
+ /**
+ Sets the buffer's modified status to @false, and clears the buffer's command
+ history.
+ */
virtual void DiscardEdits();
- // set the max number of characters which may be entered in a single line
- // text control
+ /**
+ Sets the maximum number of characters that may be entered in a single line
+ text control. For compatibility only; currently does nothing.
+ */
virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
- // writing text inserts it at the current position, appending always
- // inserts it at the end
+ /**
+ Writes text at the current position.
+ */
virtual void WriteText(const wxString& text);
+
+ /**
+ Sets the insertion point to the end of the buffer and writes the text.
+ */
virtual void AppendText(const wxString& text);
- // text control under some platforms supports the text styles: these
- // methods allow to apply the given text style to the given selection or to
- // set/get the style which will be used for all appended text
- virtual bool SetStyle(long start, long end, const wxTextAttr& style);
- virtual bool SetStyle(long start, long end, const wxTextAttrEx& style);
- virtual bool SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style);
+ //@{
+ /**
+ 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 bool GetStyle(long position, wxTextAttr& style);
- virtual bool GetStyle(long position, wxTextAttrEx& style);
virtual bool GetStyle(long position, wxRichTextAttr& style);
-
- /// Get the content (uncombined) attributes for this position.
- virtual bool GetUncombinedStyle(long position, wxTextAttr& style);
- virtual bool GetUncombinedStyle(long position, wxTextAttrEx& style);
+ virtual bool GetStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container);
+ //@}
+
+ //@{
+ /**
+ Sets the attributes for the given range.
+ The end point of range is specified as the last character position of the span
+ of text, plus one.
+
+ So, for example, to set the style for a character at position 5, use the range
+ (5,6).
+ */
+ virtual bool 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);
+ //@}
+
+ /**
+ Sets the attributes for a single object
+ */
+ virtual void SetStyle(wxRichTextObject *obj, const wxRichTextAttr& textAttr);
+
+ //@{
+ /**
+ 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
+ */
+ 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);
+ //@}
+
+ /**
+ 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.
+ */
+ virtual bool SetStyleEx(const wxRichTextRange& range, const wxRichTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
+
+ //@{
+ /**
+ 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
+ */
virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style);
-
- virtual bool SetDefaultStyle(const wxTextAttrEx& style);
+ virtual bool GetUncombinedStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container);
+ //@}
+
+ //@{
+ /**
+ Sets the current default style, which can be used to change how subsequently
+ inserted text is displayed.
+ */
virtual bool SetDefaultStyle(const wxTextAttr& style);
-
- // TODO: change to GetDefaultStyle if we merge wxTextAttr and wxTextAttrEx
- virtual const wxTextAttrEx& GetDefaultStyleEx() const;
- virtual const wxTextAttr& GetDefaultStyle() const;
-
- // translate between the position (which is just an index in the text ctrl
- // considering all its contents as a single strings) and (x, y) coordinates
- // which represent column and line.
+ 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 wxRichTextAttr& GetDefaultStyleEx() const;
+
+ //virtual const wxTextAttr& GetDefaultStyle() const;
+
+ //@{
+ /**
+ Sets the list attributes for the given range, passing flags to determine how
+ the attributes are set.
+
+ Either the style definition or the name of the style definition (in the current
+ sheet) can be passed.
+ @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().
+ */
+ 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);
+ //@}
+
+ /**
+ 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().
+ */
+ virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
+
+ //@{
+ /**
+ 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 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);
+ //@}
+
+ //@{
+ /**
+ 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 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);
+ //@}
+
+ /**
+ Deletes the content within the given range.
+ */
+ virtual bool Delete(const wxRichTextRange& range);
+
+ /**
+ Translates from column and line number to position.
+ */
virtual long XYToPosition(long x, long y) const;
+
+ /**
+ Converts a text position to zero-based column and line numbers.
+ */
virtual bool PositionToXY(long pos, long *x, long *y) const;
+ /**
+ Scrolls the buffer so that the given position is in view.
+ */
virtual void ShowPosition(long pos);
- // find the character at position given in pixels
- //
- // NB: pt is in device coords (not adjusted for the client area origin nor
- // scrolling)
+ //@{
+ /**
+ 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 wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
wxTextCoord *col,
wxTextCoord *row) const;
+ //@}
+
+// Clipboard operations
- // Clipboard operations
+ /**
+ Copies the selected content (if any) to the clipboard.
+ */
virtual void Copy();
+
+ /**
+ Copies the selected content (if any) to the clipboard and deletes the selection.
+ This is undoable.
+ */
virtual void Cut();
+
+ /**
+ Pastes content from the clipboard to the buffer.
+ */
virtual void Paste();
+
+ /**
+ Deletes the content in the selection, if any. This is undoable.
+ */
virtual void DeleteSelection();
+ /**
+ Returns @true if selected content can be copied to the clipboard.
+ */
virtual bool CanCopy() const;
+
+ /**
+ Returns @true if selected content can be copied to the clipboard and deleted.
+ */
virtual bool CanCut() const;
+
+ /**
+ Returns @true if the clipboard content can be pasted to the buffer.
+ */
virtual bool CanPaste() const;
+
+ /**
+ Returns @true if selected content can be deleted.
+ */
virtual bool CanDeleteSelection() const;
- // Undo/redo
+ /**
+ Undoes the command at the top of the command history, if there is one.
+ */
virtual void Undo();
+
+ /**
+ Redoes the current command.
+ */
virtual void Redo();
+ /**
+ Returns @true if there is a command in the command history that can be undone.
+ */
virtual bool CanUndo() const;
+
+ /**
+ Returns @true if there is a command in the command history that can be redone.
+ */
virtual bool CanRedo() const;
- // Insertion point
+ /**
+ Sets the insertion point and causes the current editing style to be taken from
+ the new position (unlike wxRichTextCtrl::SetCaretPosition).
+ */
virtual void SetInsertionPoint(long pos);
+
+ /**
+ Sets the insertion point to the end of the text control.
+ */
virtual void SetInsertionPointEnd();
+
+ /**
+ Returns the current insertion point.
+ */
virtual long GetInsertionPoint() const;
+
+ /**
+ Returns the last position in the buffer.
+ */
virtual wxTextPos GetLastPosition() 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.
+
+ So, for example, to set the selection for a character at position 5, use the
+ range (5,6).
+ */
virtual void SetSelection(long from, long to);
- virtual void SelectAll();
- virtual void SetEditable(bool editable);
+ void SetSelection(const wxRichTextSelection& sel) { m_selection = sel; }
+ //@}
- /// Call Freeze to prevent refresh
- virtual void Freeze();
- /// Call Thaw to refresh
- virtual void Thaw();
+ /**
+ Selects all the text in the buffer.
+ */
+ virtual void SelectAll();
- /// Call Thaw to refresh
- virtual bool IsFrozen() const { return m_freezeCount > 0; }
+ /**
+ Makes the control editable, or not.
+ */
+ virtual void SetEditable(bool editable);
+ /**
+ Returns @true if there is a selection and the object containing the selection
+ was the same as the current focus object.
+ */
virtual bool HasSelection() const;
-///// Functionality specific to wxRichTextCtrl
-
- /// Write an image at the current insertion point. Supply optional type to use
- /// for internal and file storage of the raw data.
- virtual bool WriteImage(const wxImage& image, int bitmapType = wxBITMAP_TYPE_PNG);
+ /**
+ Returns @true if there was a selection, whether or not the current focus object
+ is the same as the selection's container object.
+ */
+ virtual bool HasUnfocusedSelection() const;
+
+ //@{
+ /**
+ 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 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());
+ //@}
+
+ /**
+ Loads an image from a file and writes it at the current insertion point.
+ */
+ virtual bool WriteImage(const wxString& filename, wxBitmapType bitmapType,
+ const wxRichTextAttr& textAttr = wxRichTextAttr());
+
+ /**
+ Writes an image block at the current insertion point.
+ */
+ virtual bool WriteImage(const wxRichTextImageBlock& imageBlock,
+ const wxRichTextAttr& textAttr = wxRichTextAttr());
+
+ /**
+ 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 wxRichTextBox* WriteTextBox(const wxRichTextAttr& textAttr = wxRichTextAttr());
+
+ /**
+ 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 wxRichTextTable* WriteTable(int rows, int cols, const wxRichTextAttr& tableAttr = wxRichTextAttr(), const wxRichTextAttr& cellAttr = wxRichTextAttr());
+
+ /**
+ Inserts a new paragraph at the current insertion point. @see LineBreak().
+ */
+ virtual bool Newline();
- /// Write a bitmap at the current insertion point. Supply optional type to use
- /// for internal and file storage of the raw data.
- virtual bool WriteImage(const wxBitmap& bitmap, int bitmapType = wxBITMAP_TYPE_PNG);
+ /**
+ Inserts a line break at the current insertion point.
- /// Load an image from file and write at the current insertion point.
- virtual bool WriteImage(const wxString& filename, int bitmapType);
+ A line break forces wrapping within a paragraph, and can be introduced by
+ using this function, by appending the wxChar value @b wxRichTextLineBreakChar
+ to text content, or by typing Shift-Return.
+ */
+ virtual bool LineBreak();
- /// Write an image block at the current insertion point.
- virtual bool WriteImage(const wxRichTextImageBlock& imageBlock);
+ /**
+ Sets the basic (overall) style.
- /// Insert a newline (actually paragraph) at the current insertion point.
- virtual bool Newline();
-
- /// Set basic (overall) style
- virtual void SetBasicStyle(const wxTextAttrEx& style) { GetBuffer().SetBasicStyle(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).
+ */
virtual void SetBasicStyle(const wxRichTextAttr& style) { GetBuffer().SetBasicStyle(style); }
- /// Get basic (overall) style
- virtual const wxTextAttrEx& GetBasicStyle() const { return GetBuffer().GetBasicStyle(); }
+ /**
+ Gets the basic (overall) style.
+
+ This is the style of the whole buffer before further styles are applied,
+ unlike the default style, which only affects the style currently being
+ applied (for example, setting the default style to bold will cause
+ subsequently inserted text to be bold).
+ */
+ virtual const wxRichTextAttr& GetBasicStyle() const { return GetBuffer().GetBasicStyle(); }
- /// Begin using a style
- virtual bool BeginStyle(const wxTextAttrEx& style) { return GetBuffer().BeginStyle(style); }
+ /**
+ Begins applying a style.
+ */
+ virtual bool BeginStyle(const wxRichTextAttr& style) { return GetBuffer().BeginStyle(style); }
- /// End the style
+ /**
+ Ends the current style.
+ */
virtual bool EndStyle() { return GetBuffer().EndStyle(); }
- /// End all styles
+ /**
+ Ends application of all styles in the current style stack.
+ */
virtual bool EndAllStyles() { return GetBuffer().EndAllStyles(); }
- /// Begin using bold
+ /**
+ Begins using bold.
+ */
bool BeginBold() { return GetBuffer().BeginBold(); }
- /// End using bold
+ /**
+ Ends using bold.
+ */
bool EndBold() { return GetBuffer().EndBold(); }
- /// Begin using italic
+ /**
+ Begins using italic.
+ */
bool BeginItalic() { return GetBuffer().BeginItalic(); }
- /// End using italic
+ /**
+ Ends using italic.
+ */
bool EndItalic() { return GetBuffer().EndItalic(); }
- /// Begin using underline
+ /**
+ Begins using underlining.
+ */
bool BeginUnderline() { return GetBuffer().BeginUnderline(); }
- /// End using underline
+ /**
+ End applying underlining.
+ */
bool EndUnderline() { return GetBuffer().EndUnderline(); }
- /// Begin using point size
+ /**
+ Begins using the given point size.
+ */
bool BeginFontSize(int pointSize) { return GetBuffer().BeginFontSize(pointSize); }
- /// End using point size
+ /**
+ Ends using a point size.
+ */
bool EndFontSize() { return GetBuffer().EndFontSize(); }
- /// Begin using this font
+ /**
+ Begins using this font.
+ */
bool BeginFont(const wxFont& font) { return GetBuffer().BeginFont(font); }
- /// End using a font
+ /**
+ Ends using a font.
+ */
bool EndFont() { return GetBuffer().EndFont(); }
- /// Begin using this colour
+ /**
+ Begins using this colour.
+ */
bool BeginTextColour(const wxColour& colour) { return GetBuffer().BeginTextColour(colour); }
- /// End using a colour
+ /**
+ Ends applying a text colour.
+ */
bool EndTextColour() { return GetBuffer().EndTextColour(); }
- /// Begin using alignment
+ /**
+ Begins using alignment.
+ For alignment values, see wxTextAttr.
+ */
bool BeginAlignment(wxTextAttrAlignment alignment) { return GetBuffer().BeginAlignment(alignment); }
- /// End alignment
+ /**
+ Ends alignment.
+ */
bool EndAlignment() { return GetBuffer().EndAlignment(); }
- /// Begin left indent
+ /**
+ 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.
+ */
bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0) { return GetBuffer().BeginLeftIndent(leftIndent, leftSubIndent); }
- /// End left indent
+ /**
+ Ends left indent.
+ */
bool EndLeftIndent() { return GetBuffer().EndLeftIndent(); }
- /// Begin right indent
+ /**
+ Begins a right indent, specified in tenths of a millimetre.
+ */
bool BeginRightIndent(int rightIndent) { return GetBuffer().BeginRightIndent(rightIndent); }
- /// End right indent
+ /**
+ Ends right indent.
+ */
bool EndRightIndent() { return GetBuffer().EndRightIndent(); }
- /// Begin paragraph spacing
+ /**
+ Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing
+ in tenths of a millimetre.
+ */
bool BeginParagraphSpacing(int before, int after) { return GetBuffer().BeginParagraphSpacing(before, after); }
- /// End paragraph spacing
+ /**
+ Ends paragraph spacing.
+ */
bool EndParagraphSpacing() { return GetBuffer().EndParagraphSpacing(); }
- /// Begin line spacing
+ /**
+ 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.
+ */
bool BeginLineSpacing(int lineSpacing) { return GetBuffer().BeginLineSpacing(lineSpacing); }
- /// End line spacing
+ /**
+ Ends line spacing.
+ */
bool EndLineSpacing() { return GetBuffer().EndLineSpacing(); }
- /// Begin numbered bullet
+ /**
+ 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)
{ return GetBuffer().BeginNumberedBullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle); }
- /// End numbered bullet
+ /**
+ Ends application of a numbered bullet.
+ */
bool EndNumberedBullet() { return GetBuffer().EndNumberedBullet(); }
- /// Begin symbol bullet
- bool BeginSymbolBullet(wxChar symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL)
+ /**
+ Begins applying a symbol bullet, using a character from the current font.
+ See BeginNumberedBullet() for an explanation of how indentation is used
+ to render the bulleted paragraph.
+ */
+ bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL)
{ return GetBuffer().BeginSymbolBullet(symbol, leftIndent, leftSubIndent, bulletStyle); }
- /// End symbol bullet
+ /**
+ Ends applying a symbol bullet.
+ */
bool EndSymbolBullet() { return GetBuffer().EndSymbolBullet(); }
- /// Begin named character style
+ /**
+ Begins applying a symbol bullet.
+ */
+ bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD)
+ { return GetBuffer().BeginStandardBullet(bulletName, leftIndent, leftSubIndent, bulletStyle); }
+
+ /**
+ Begins applying a standard bullet.
+ */
+ bool EndStandardBullet() { return GetBuffer().EndStandardBullet(); }
+
+ /**
+ Begins using the named character style.
+ */
bool BeginCharacterStyle(const wxString& characterStyle) { return GetBuffer().BeginCharacterStyle(characterStyle); }
- /// End named character style
+ /**
+ Ends application of a named character style.
+ */
bool EndCharacterStyle() { return GetBuffer().EndCharacterStyle(); }
- /// Begin named paragraph style
+ /**
+ Begins applying the named paragraph style.
+ */
bool BeginParagraphStyle(const wxString& paragraphStyle) { return GetBuffer().BeginParagraphStyle(paragraphStyle); }
- /// End named character style
+ /**
+ Ends application of a named paragraph style.
+ */
bool EndParagraphStyle() { return GetBuffer().EndParagraphStyle(); }
- /// Sets the default style to the style under the cursor
+ /**
+ 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) { return GetBuffer().BeginListStyle(listStyle, level, number); }
+
+ /**
+ Ends using a specified list style.
+ */
+ bool EndListStyle() { return GetBuffer().EndListStyle(); }
+
+ /**
+ Begins applying wxTEXT_ATTR_URL to the content.
+
+ Pass a URL and optionally, a character style to apply, since it is common
+ to mark a URL with a familiar style such as blue text with underlining.
+ */
+ bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString) { return GetBuffer().BeginURL(url, characterStyle); }
+
+ /**
+ Ends applying a URL.
+ */
+ bool EndURL() { return GetBuffer().EndURL(); }
+
+ /**
+ Sets the default style to the style under the cursor.
+ */
bool SetDefaultStyleToCursorStyle();
- /// Clear the selection
+ /**
+ Cancels any selection.
+ */
virtual void SelectNone();
- /// Get/set the selection range in character positions. -1, -1 means no selection.
- /// The range is in API convention, i.e. a single character selection is denoted
- /// by (n, n+1)
+ /**
+ Selects the word at the given character position.
+ */
+ virtual bool SelectWord(long position);
+
+ /**
+ Returns the selection range in character positions. -1, -1 means no selection.
+
+ The range is in API convention, i.e. a single character selection is denoted
+ by (n, n+1)
+ */
wxRichTextRange GetSelectionRange() const;
- void SetSelectionRange(const wxRichTextRange& range);
- /// Get/set the selection range in character positions. -1, -1 means no selection.
- /// The range is in internal format, i.e. a single character selection is denoted
- /// by (n, n)
- const wxRichTextRange& GetInternalSelectionRange() const { return m_selectionRange; }
- void SetInternalSelectionRange(const wxRichTextRange& range) { m_selectionRange = range; }
+ /**
+ Sets the selection to the given range.
+ The end point of range is specified as the last character position of the span
+ of text, plus one.
+
+ So, for example, to set the selection for a character at position 5, use the
+ range (5,6).
+ */
+ void SetSelectionRange(const wxRichTextRange& range);
- /// Add a new paragraph of text to the end of 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)
+ */
+ wxRichTextRange GetInternalSelectionRange() const { return m_selection.GetRange(); }
+
+ /**
+ 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)
+ */
+ void SetInternalSelectionRange(const wxRichTextRange& range) { m_selection.Set(range, GetFocusObject()); }
+
+ /**
+ Adds a new paragraph of text to the end of the buffer.
+ */
virtual wxRichTextRange AddParagraph(const wxString& text);
- /// Add an image
+ /**
+ Adds an image to the control's buffer.
+ */
virtual wxRichTextRange AddImage(const wxImage& image);
- /// Layout the buffer: which we must do before certain operations, such as
- /// setting the caret position.
+ /**
+ Lays out the buffer, which must be done before certain operations, such as
+ setting the caret position.
+ This function should not normally be required by the application.
+ */
virtual bool LayoutContent(bool onlyVisibleRect = false);
- /// Move the caret to the given character position
- virtual bool MoveCaret(long pos, bool showAtLineStart = false);
+ /**
+ 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.
+ */
+ virtual bool MoveCaret(long pos, bool showAtLineStart = false, wxRichTextParagraphLayoutBox* container = NULL);
- /// Move right
+ /**
+ Moves right.
+ */
virtual bool MoveRight(int noPositions = 1, int flags = 0);
- /// Move left
+ /**
+ Moves left.
+ */
virtual bool MoveLeft(int noPositions = 1, int flags = 0);
- /// Move up
+ /**
+ Moves to the start of the paragraph.
+ */
virtual bool MoveUp(int noLines = 1, int flags = 0);
- /// Move up
+ /**
+ Moves the caret down.
+ */
virtual bool MoveDown(int noLines = 1, int flags = 0);
- /// Move to the end of the line
+ /**
+ Moves to the end of the line.
+ */
virtual bool MoveToLineEnd(int flags = 0);
- /// Move to the start of the line
+ /**
+ Moves to the start of the line.
+ */
virtual bool MoveToLineStart(int flags = 0);
- /// Move to the end of the paragraph
+ /**
+ Moves to the end of the paragraph.
+ */
virtual bool MoveToParagraphEnd(int flags = 0);
- /// Move to the start of the paragraph
+ /**
+ Moves to the start of the paragraph.
+ */
virtual bool MoveToParagraphStart(int flags = 0);
- /// Move to the start of the buffer
+ /**
+ Moves to the start of the buffer.
+ */
virtual bool MoveHome(int flags = 0);
- /// Move to the end of the buffer
+ /**
+ Moves to the end of the buffer.
+ */
virtual bool MoveEnd(int flags = 0);
- /// Move n pages up
+ /**
+ Moves one or more pages up.
+ */
virtual bool PageUp(int noPages = 1, int flags = 0);
- /// Move n pages down
+ /**
+ Moves one or more pages down.
+ */
virtual bool PageDown(int noPages = 1, int flags = 0);
- /// Move n words left
+ /**
+ Moves a number of words to the left.
+ */
virtual bool WordLeft(int noPages = 1, int flags = 0);
- /// Move n words right
+ /**
+ Move a nuber of words to the right.
+ */
virtual bool WordRight(int noPages = 1, int flags = 0);
- /// Returns the buffer associated with the control.
+ //@{
+ /**
+ Returns the buffer associated with the control.
+ */
wxRichTextBuffer& GetBuffer() { return m_buffer; }
const wxRichTextBuffer& GetBuffer() const { return m_buffer; }
+ //@}
- /// Start batching undo history for commands.
+ /**
+ Starts batching undo history for commands.
+ */
virtual bool BeginBatchUndo(const wxString& cmdName) { return m_buffer.BeginBatchUndo(cmdName); }
- /// End batching undo history for commands.
+ /**
+ Ends batching undo command history.
+ */
virtual bool EndBatchUndo() { return m_buffer.EndBatchUndo(); }
- /// Are we batching undo history for commands?
+ /**
+ Returns @true if undo commands are being batched.
+ */
virtual bool BatchingUndo() const { return m_buffer.BatchingUndo(); }
- /// Start suppressing undo history for commands.
+ /**
+ Starts suppressing undo history for commands.
+ */
virtual bool BeginSuppressUndo() { return m_buffer.BeginSuppressUndo(); }
- /// End suppressing undo history for commands.
+ /**
+ Ends suppressing undo command history.
+ */
virtual bool EndSuppressUndo() { return m_buffer.EndSuppressUndo(); }
- /// Are we suppressing undo history for commands?
+ /**
+ Returns @true if undo history suppression is on.
+ */
virtual bool SuppressingUndo() const { return m_buffer.SuppressingUndo(); }
- /// Test if this whole range has character attributes of the specified kind. If any
- /// of the attributes are different within the range, the test fails. You
- /// can use this to implement, for example, bold button updating. style must have
- /// flags indicating which attributes are of interest.
- virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxTextAttrEx& style) const
- {
- return GetBuffer().HasCharacterAttributes(range, style);
- }
+ /**
+ Test if this whole range has character attributes of the specified kind.
+ If any of the attributes are different within the range, the test fails.
+
+ You can use this to implement, for example, bold button updating.
+ @a style must have flags indicating which attributes are of interest.
+ */
virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const
{
- return GetBuffer().HasCharacterAttributes(range, style);
+ return GetBuffer().HasCharacterAttributes(range.ToInternal(), style);
}
- /// Test if this whole range has paragraph attributes of the specified kind. If any
- /// of the attributes are different within the range, the test fails. You
- /// can use this to implement, for example, centering button updating. style must have
- /// flags indicating which attributes are of interest.
- virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxTextAttrEx& style) const
- {
- return GetBuffer().HasParagraphAttributes(range, style);
- }
+ /**
+ Test if this whole range has paragraph attributes of the specified kind.
+ If any of the attributes are different within the range, the test fails.
+ You can use this to implement, for example, centering button updating.
+ @a style must have flags indicating which attributes are of interest.
+ */
virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const
{
- return GetBuffer().HasParagraphAttributes(range, style);
+ return GetBuffer().HasParagraphAttributes(range.ToInternal(), style);
}
- /// Is all of the selection bold?
+ /**
+ Returns @true if all of the selection is bold.
+ */
virtual bool IsSelectionBold();
- /// Is all of the selection italics?
+ /**
+ Returns @true if all of the selection is italic.
+ */
virtual bool IsSelectionItalics();
- /// Is all of the selection underlined?
+ /**
+ Returns @true if all of the selection is underlined.
+ */
virtual bool IsSelectionUnderlined();
- /// Is all of the selection aligned according to the specified flag?
+ /**
+ Returns @true if all of the selection is aligned according to the specified flag.
+ */
virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
- /// Apply bold to the selection
+ /**
+ Apples bold to the selection (undoable).
+ */
virtual bool ApplyBoldToSelection();
- /// Apply italic to the selection
+ /**
+ Applies italic to the selection (undoable).
+ */
virtual bool ApplyItalicToSelection();
- /// Apply underline to the selection
+ /**
+ Applies underline to the selection (undoable).
+ */
virtual bool ApplyUnderlineToSelection();
- /// Apply alignment to the selection
+ /**
+ Applies the given alignment to the selection (undoable).
+ For alignment values, see wxTextAttr.
+ */
virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
- /// Apply a named style to the selection
- virtual void ApplyStyle(wxRichTextStyleDefinition* def);
+ /**
+ 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 ApplyStyle(wxRichTextStyleDefinition* def);
- /// Set style sheet, if any.
+ /**
+ Sets the style sheet associated with the control.
+ A style sheet allows named character and paragraph styles to be applied.
+ */
void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { GetBuffer().SetStyleSheet(styleSheet); }
+
+ /**
+ Returns the style sheet associated with the control, if any.
+ A style sheet allows named character and paragraph styles to be applied.
+ */
wxRichTextStyleSheet* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); }
- /// Apply the style sheet to the buffer, for example if the styles have changed.
+ /**
+ Push the style sheet to top of stack.
+ */
+ bool PushStyleSheet(wxRichTextStyleSheet* styleSheet) { return GetBuffer().PushStyleSheet(styleSheet); }
+
+ /**
+ Pops the style sheet from top of stack.
+ */
+ wxRichTextStyleSheet* PopStyleSheet() { return GetBuffer().PopStyleSheet(); }
+
+ /**
+ Applies the style sheet to the buffer, for example if the styles have changed.
+ */
bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL);
// 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);
- // Show a context menu for Rich Edit controls (the standard
- // EDIT control has one already)
+ /**
+ Shows a standard context menu with undo, redo, cut, copy, paste, clear, and
+ select all commands.
+ */
void OnContextMenu(wxContextMenuEvent& event);
// Event handlers
- /// Painting
+ // Painting
void OnPaint(wxPaintEvent& event);
void OnEraseBackground(wxEraseEvent& event);
- /// Left-click
+ // Left-click
void OnLeftClick(wxMouseEvent& event);
- /// Left-up
+ // Left-up
void OnLeftUp(wxMouseEvent& event);
- /// Motion
+ // Motion
void OnMoveMouse(wxMouseEvent& event);
- /// Left-double-click
+ // Left-double-click
void OnLeftDClick(wxMouseEvent& event);
- /// Middle-click
+ // Middle-click
void OnMiddleClick(wxMouseEvent& event);
- /// Right-click
+ // Right-click
void OnRightClick(wxMouseEvent& event);
- /// Key press
+ // Key press
void OnChar(wxKeyEvent& event);
- /// Sizing
+ // Sizing
void OnSize(wxSizeEvent& event);
- /// Setting/losing focus
+ // Setting/losing focus
void OnSetFocus(wxFocusEvent& event);
void OnKillFocus(wxFocusEvent& event);
- /// Idle-time processing
+ // Idle-time processing
void OnIdle(wxIdleEvent& event);
- /// Scrolling
+ // Scrolling
void OnScroll(wxScrollWinEvent& event);
- /// Set font, and also default attributes
+ /**
+ Sets the font, and also the basic and default attributes
+ (see wxRichTextCtrl::SetDefaultStyle).
+ */
virtual bool SetFont(const wxFont& font);
- /// Set up scrollbars, e.g. after a resize
+ /**
+ A helper function setting up scrollbars, for example after a resize.
+ */
virtual void SetupScrollbars(bool atTop = false);
- /// Keyboard navigation
+ /**
+ Helper function implementing keyboard navigation.
+ */
virtual bool KeyboardNavigate(int keyCode, int flags);
- /// Paint the background
+ /**
+ Paints the background.
+ */
virtual void PaintBackground(wxDC& dc);
- /// Recreate buffer bitmap if necessary
- virtual bool RecreateBuffer(const wxSize& size = wxDefaultSize);
-
- /// Set the selection
- virtual void DoSetSelection(long from, long to, bool scrollCaret = true);
-
- /// Write text
- virtual void DoWriteText(const wxString& value, bool selectionOnly = true);
+ /**
+ Other user defined painting after everything else (i.e. all text) is painted.
- /// Send an update event
- virtual bool SendUpdateEvent();
+ @since 2.9.1
+ */
+ virtual void PaintAboveContent(wxDC& WXUNUSED(dc)) {}
- /// Init command event
- void InitCommandEvent(wxCommandEvent& event) const;
-
- /// do the window-specific processing after processing the update event
- // (duplicated code from wxTextCtrlBase)
-#if !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
- virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
+#if wxRICHTEXT_BUFFERED_PAINTING
+ /**
+ Recreates the buffer bitmap if necessary.
+ */
+ virtual bool RecreateBuffer(const wxSize& size = wxDefaultSize);
#endif
- /// Should we inherit colours?
+ // Write text
+ virtual void DoWriteText(const wxString& value, int flags = 0);
+
+ // Should we inherit colours?
virtual bool ShouldInheritColours() const { return false; }
- /// Position the caret
- virtual void PositionCaret();
+ /**
+ Internal function to position the visible caret according to the current caret
+ position.
+ */
+ virtual void PositionCaret(wxRichTextParagraphLayoutBox* container = NULL);
- /// Extend the selection, returning true if the selection was
- /// changed. Selections are in caret positions.
+ /**
+ 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);
- /// Scroll into view. This takes a _caret_ position.
+ /**
+ Scrolls @a position into view. This function takes a caret position.
+ */
virtual bool ScrollIntoView(long position, int keyCode);
- /// 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.
+ /**
+ 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 { return m_caretPosition; }
- /// 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.
+ /**
+ 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 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.
+ /**
+ 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 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.
+ /**
+ 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) ;
- /// Get the caret height and position for the given character position
- bool GetCaretPositionForIndex(long position, wxRect& rect);
-
- /// Gets 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 let's get the line we're expecting to find
- /// if this is the case.
+ /**
+ 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
+ /**
+ Gets the command processor associated with the control's buffer.
+ */
wxCommandProcessor* GetCommandProcessor() const { return GetBuffer().GetCommandProcessor(); }
- /// Delete content if there is a selection, e.g. when pressing a key.
- /// Returns the new caret position in newPos, or leaves it if there
- /// was no action.
+ /**
+ 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);
- /// Transform logical to physical
+ /**
+ Transforms logical (unscrolled) position to physical window position.
+ */
wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const;
- /// Transform physical to logical
+ /**
+ Transforms physical window position to logical (unscrolled) position.
+ */
wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const;
- /// Finds the caret position for the next word. Direction
- /// is 1 (forward) or -1 (backwards).
+ /**
+ 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;
- /// Is the given position visible on the screen?
+ /**
+ 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
+ /**
+ 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.
+ /**
+ 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 { return m_caretPositionForDefaultStyle; }
- /// Set the caret position for the default style that the user is selecting.
+ /**
+ Set the caret position for the default style that the user is selecting.
+ */
void SetCaretPositionForDefaultStyle(long pos) { m_caretPositionForDefaultStyle = pos; }
- /// Should the UI reflect the default style chosen by the user, rather than the style under
- /// the caret?
+ /**
+ 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 { return m_caretPositionForDefaultStyle != -2; }
- /// Convenience function that tells the control to start reflecting the default
- /// style, since the user is changing it.
+ /**
+ 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)
{
SetDefaultStyle(attr);
SetCaretPositionForDefaultStyle(GetCaretPosition());
}
+ /**
+ Returns the first visible point in the window.
+ */
+ wxPoint GetFirstVisiblePoint() const;
+
+#ifdef DOXYGEN
+ /**
+ 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);
+
+ /**
+ Call this function to prevent refresh and allow fast updates, and then Thaw() to
+ refresh the control.
+ */
+ void Freeze();
+
+ /**
+ Call this function to end a Freeze and refresh the display.
+ */
+ void Thaw();
+
+ /**
+ Returns @true if Freeze has been called without a Thaw.
+ */
+ bool IsFrozen() const;
+
+#endif
+
// Implementation
-#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
- WX_FORWARD_TO_SCROLL_HELPER()
+ /**
+ 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);
+
+ /**
+ 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();
+
+ WX_FORWARD_TO_SCROLL_HELPER()
+
+ // implement wxTextEntry methods
+ virtual wxString DoGetValue() const;
+
+protected:
+ // implement the wxTextEntry pure virtual method
+ virtual wxWindow *GetEditableWindow() { return this; }
+
+ // margins functions
+ virtual bool DoSetMargins(const wxPoint& pt);
+ virtual wxPoint DoGetMargins() const;
+
+ // FIXME: this does not work, it allows this code to compile but will fail
+ // during run-time
+#ifndef __WXUNIVERSAL__
+#ifdef __WXMSW__
+ virtual WXHWND GetEditHWND() const { return GetHWND(); }
+#endif
+#ifdef __WXMOTIF__
+ virtual WXWidget GetTextWidget() const { return NULL; }
#endif
+#ifdef __WXGTK20__
+ virtual GtkEditable *GetEditable() const { return NULL; }
+ virtual GtkEntry *GetEntry() const { return NULL; }
+#endif
+#endif // !__WXUNIVERSAL__
// Overrides
protected:
+ /**
+ Currently this simply returns @c wxSize(10, 10).
+ */
virtual wxSize DoGetBestSize() const ;
-// Data members
-private:
+ virtual void DoSetValue(const wxString& value, int flags = 0);
+
+ virtual void DoThaw();
- /// Allows nested Freeze/Thaw
- int m_freezeCount;
+// Data members
+private:
+#if wxRICHTEXT_BUFFERED_PAINTING
/// Buffer bitmap
wxBitmap m_bufferBitmap;
+#endif
/// Text buffer
wxRichTextBuffer m_buffer;
-#if !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
- /// Filename
- wxString m_filename;
-#endif
-
wxMenu* m_contextMenu;
/// Caret position (1 less than the character position, so -1 is the
long m_caretPositionForDefaultStyle;
/// Selection range in character positions. -2, -2 means no selection.
- wxRichTextRange m_selectionRange;
+ 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;
/// 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;
};
-/*!
- * wxRichTextEvent - the event class for wxRichTextCtrl notifications
- */
+/**
+ @class wxRichTextEvent
+
+ This is the event class for wxRichTextCtrl notifications.
+
+ @beginEventTable{wxRichTextEvent}
+ @event{EVT_RICHTEXT_LEFT_CLICK(id, func)}
+ Process a @c wxEVT_COMMAND_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_COMMAND_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_COMMAND_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_COMMAND_RICHTEXT_DLEFT_CLICK event, generated when the user
+ double-clicks an object.
+ @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_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.
+ @event{EVT_RICHTEXT_SELECTION_CHANGED(id, func)}
+ Process a @c wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED event, generated when the
+ selection range has changed.
+ @event{EVT_RICHTEXT_FOCUS_OBJECT_CHANGED(id, func)}
+ Process a @c wxEVT_COMMAND_RICHTEXT_FOCUS_OBJECT_CHANGED event, generated when the
+ current focus object has changed.
+ @endEventTable
+
+ @library{wxrichtext}
+ @category{events,richtext}
+*/
class WXDLLIMPEXP_RICHTEXT 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)
: wxNotifyEvent(commandType, winid),
- m_itemIndex(-1), m_flags(0)
+ m_flags(0), m_position(-1), m_oldStyleSheet(NULL), m_newStyleSheet(NULL),
+ m_char((wxChar) 0), m_container(NULL), m_oldContainer(NULL)
{ }
+ /**
+ Copy constructor.
+ */
wxRichTextEvent(const wxRichTextEvent& event)
: wxNotifyEvent(event),
- m_itemIndex(event.m_itemIndex), m_flags(event.m_flags)
+ m_flags(event.m_flags), m_position(-1),
+ m_oldStyleSheet(event.m_oldStyleSheet), m_newStyleSheet(event.m_newStyleSheet),
+ m_char((wxChar) 0), m_container(event.m_container), m_oldContainer(event.m_oldContainer)
{ }
- int GetIndex() const { return m_itemIndex; }
- void SetIndex(int n) { m_itemIndex = n; }
+ /**
+ Returns the buffer position at which the event occured.
+ */
+ long GetPosition() const { return m_position; }
+ /**
+ Sets the buffer position variable.
+ */
+ void SetPosition(long pos) { m_position = 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 { return m_flags; }
+
+ /**
+ 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) { m_flags = flags; }
+ /**
+ 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.
+ */
+ wxRichTextStyleSheet* GetOldStyleSheet() const { return m_oldStyleSheet; }
+
+ /**
+ Sets the old style sheet variable.
+ */
+ void SetOldStyleSheet(wxRichTextStyleSheet* sheet) { m_oldStyleSheet = sheet; }
+
+ /**
+ 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.
+ */
+ wxRichTextStyleSheet* GetNewStyleSheet() const { return m_newStyleSheet; }
+
+ /**
+ Sets the new style sheet variable.
+ */
+ void SetNewStyleSheet(wxRichTextStyleSheet* sheet) { m_newStyleSheet = sheet; }
+
+ /**
+ Gets the range for the current operation.
+ */
+ const wxRichTextRange& GetRange() const { return m_range; }
+
+ /**
+ Sets the range variable.
+ */
+ void SetRange(const wxRichTextRange& range) { m_range = range; }
+
+ /**
+ Returns the character pressed, within a @c wxEVT_COMMAND_RICHTEXT_CHARACTER event.
+ */
+ wxChar GetCharacter() const { return m_char; }
+
+ /**
+ Sets the character variable.
+ */
+ void SetCharacter(wxChar ch) { m_char = ch; }
+
+ /**
+ Returns the container for which the event is relevant.
+ */
+ wxRichTextParagraphLayoutBox* GetContainer() const { return m_container; }
+
+ /**
+ Sets the container for which the event is relevant.
+ */
+ void SetContainer(wxRichTextParagraphLayoutBox* container) { m_container = container; }
+
+ /**
+ Returns the old container, for a focus change event.
+ */
+ wxRichTextParagraphLayoutBox* GetOldContainer() const { return m_oldContainer; }
+
+ /**
+ Sets the old container, for a focus change event.
+ */
+ void SetOldContainer(wxRichTextParagraphLayoutBox* container) { m_oldContainer = container; }
+
virtual wxEvent *Clone() const { return new wxRichTextEvent(*this); }
protected:
- int m_itemIndex;
- int m_flags;
+ int m_flags;
+ long m_position;
+ wxRichTextStyleSheet* m_oldStyleSheet;
+ wxRichTextStyleSheet* m_newStyleSheet;
+ wxRichTextRange m_range;
+ wxChar m_char;
+ wxRichTextParagraphLayoutBox* m_container;
+ wxRichTextParagraphLayoutBox* m_oldContainer;
private:
DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRichTextEvent)
};
/*!
- * wxRichTextCtrl event macros
+ * wxRichTextCtrl events
*/
-
-BEGIN_DECLARE_EVENT_TYPES()
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_ITEM_SELECTED, 2600)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_ITEM_DESELECTED, 2601)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, 2602)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, 2603)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, 2604)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, 2605)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RETURN, 2606)
-END_DECLARE_EVENT_TYPES()
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RETURN, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CHARACTER, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_DELETE, wxRichTextEvent );
+
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED, wxRichTextEvent );
+
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_FOCUS_OBJECT_CHANGED, wxRichTextEvent );
typedef void (wxEvtHandler::*wxRichTextEventFunction)(wxRichTextEvent&);
-#define EVT_RICHTEXT_ITEM_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
-#define EVT_RICHTEXT_ITEM_DESELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
-#define EVT_RICHTEXT_LEFT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
-#define EVT_RICHTEXT_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
-#define EVT_RICHTEXT_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
-#define EVT_RICHTEXT_LEFT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
-#define EVT_RICHTEXT_RETURN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RETURN, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
+#define wxRichTextEventHandler(func) \
+ wxEVENT_HANDLER_CAST(wxRichTextEventFunction, func)
+
+#define EVT_RICHTEXT_LEFT_CLICK(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_RIGHT_CLICK(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_MIDDLE_CLICK(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_LEFT_DCLICK(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_RETURN(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RETURN, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_CHARACTER(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CHARACTER, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_DELETE(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_DELETE, id, -1, wxRichTextEventHandler( fn ), NULL ),
+
+#define EVT_RICHTEXT_STYLESHEET_CHANGING(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_STYLESHEET_CHANGED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_STYLESHEET_REPLACING(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_STYLESHEET_REPLACED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED, id, -1, wxRichTextEventHandler( fn ), NULL ),
+
+#define EVT_RICHTEXT_CONTENT_INSERTED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_CONTENT_DELETED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_STYLE_CHANGED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_SELECTION_CHANGED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_BUFFER_RESET(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, id, -1, wxRichTextEventHandler( fn ), NULL ),
#endif
// wxUSE_RICHTEXT
projects / wxWidgets.git / blobdiff