X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fadc2df6823d988f7a264b94e69a7e1bbcac1337..5cb3a695e0f65d71fe0c315766e0d6dafd4c312a:/interface/wx/richtext/richtextctrl.h diff --git a/interface/wx/richtext/richtextctrl.h b/interface/wx/richtext/richtextctrl.h index cb2e6fab52..6af70ad546 100644 --- a/interface/wx/richtext/richtextctrl.h +++ b/interface/wx/richtext/richtextctrl.h @@ -73,11 +73,6 @@ public: */ wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int id = 0); - /** - Clones the event. - */ - wxEvent* Clone() const; - /** Returns the character pressed, within a wxEVT_COMMAND_RICHTEXT_CHARACTER event. */ @@ -114,7 +109,7 @@ public: /** Gets the range for the current operation. */ - wxRichTextRange GetRange() const; + const wxRichTextRange& GetRange() const; /** Sets the character variable. @@ -164,8 +159,19 @@ public: 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} */ class wxRichTextCtrl { @@ -389,7 +395,7 @@ public: See BeginNumberedBullet() for an explanation of how indentation is used to render the bulleted paragraph. */ - bool BeginSymbolBullet(wxChar symbol, int leftIndent, + bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL); @@ -447,7 +453,6 @@ public: */ virtual void Clear(); - //@{ /** Clears the list style from the given range, clearing list-related attributes and applying any named paragraph style associated with each paragraph. @@ -457,11 +462,8 @@ public: @see SetListStyle(), PromoteList(), NumberList(). */ - bool ClearListStyle(const wxRichTextRange& range, + virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); - bool ClearListStyle(const wxRichTextRange& range, - int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); - //@} /** Sends the event to the control. @@ -499,6 +501,11 @@ public: 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); @@ -513,11 +520,6 @@ public: */ virtual void DiscardEdits(); - /** - Currently this simply returns @c wxSize(10, 10). - */ - virtual wxSize DoGetBestSize() const; - /** Ends alignment. */ @@ -649,7 +651,7 @@ public: applied (for example, setting the default style to bold will cause subsequently inserted text to be bold). */ - const wxTextAttr GetBasicStyle() const; + virtual const wxTextAttr& GetBasicStyle() const; //@{ /** @@ -666,6 +668,12 @@ public: /** Returns the caret height and position for the given character position. + + @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); @@ -678,7 +686,7 @@ public: Returns the current default style, which can be used to change how subsequently inserted text is displayed. */ - const wxTextAttr GetDefaultStyle() const; + virtual const wxTextAttr& GetDefaultStyle() const; /** Gets the size of the buffer beyond which layout is delayed during resizing. @@ -756,7 +764,7 @@ public: /** Returns the selection range in character positions. -1, -1 means no selection. */ - const wxRichTextRange GetSelectionRange() const; + wxRichTextRange GetSelectionRange() const; /** Returns the text within the current selection range, if any. @@ -770,6 +778,11 @@ public: 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); @@ -777,6 +790,11 @@ public: 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); @@ -797,6 +815,11 @@ public: 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, wxTextAttr& style); @@ -854,11 +877,6 @@ public: */ void Init(); - /** - Initialises the command event. - */ - void InitCommandEvent(wxCommandEvent& event) const; - /** Returns @true if the user has recently set the default style without moving the caret, and therefore the UI needs to reflect the default style and not @@ -961,6 +979,9 @@ public: /** 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); @@ -1262,8 +1283,13 @@ public: virtual void SetBasicStyle(const wxTextAttr& style); /** + 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); @@ -1310,7 +1336,8 @@ public: void SetHandlerFlags(int flags); /** - Sets the 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); @@ -1381,7 +1408,6 @@ public: bool SetStyle(long start, long end, const wxTextAttr& style); //@} - //@{ /** Sets the attributes for the given range, passing flags to determine how the attributes are set. @@ -1409,13 +1435,9 @@ public: - wxRICHTEXT_SETSTYLE_REMOVE: removes the specified style. Only the style flags are used in this operation. */ - bool SetStyleEx(const wxRichTextRange& range, + virtual bool SetStyleEx(const wxRichTextRange& range, const wxTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); - bool SetStyleEx(long start, long end, - const wxTextAttr& style, - int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO); - //@} /** Sets the style sheet associated with the control. @@ -1466,7 +1488,7 @@ public: /** Loads an image from a file and writes it at the current insertion point. */ - bool WriteImage(const wxString& filename, int bitmapType); + virtual bool WriteImage(const wxString& filename, wxBitmapType bitmapType); /** Writes an image block at the current insertion point. @@ -1493,5 +1515,17 @@ public: Translates from column and line number to position. */ virtual long XYToPosition(long x, long y) const; + +protected: + + /** + Currently this simply returns @c wxSize(10, 10). + */ + virtual wxSize DoGetBestSize() const; + + /** + Initialises the command event. + */ + void InitCommandEvent(wxCommandEvent& event) const; };