Document wxPerl interface differences for wxRichTextCtrl.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63036 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Mattia Barbon
2010-01-02 11:29:00 +00:00
parent b91d65b10f
commit 371ae8b57c

View File

@@ -501,6 +501,11 @@ public:
Deletes content if there is a selection, e.g. when pressing a key. 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 Returns the new caret position in @e newPos, or leaves it if there
was no action. This is undoable. 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); bool DeleteSelectedContent(long* newPos = NULL);
@@ -663,6 +668,12 @@ public:
/** /**
Returns the caret height and position for the given character position. 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); bool GetCaretPositionForIndex(long position, wxRect& rect);
@@ -767,6 +778,11 @@ public:
style attributes. style attributes.
To get the character or paragraph style alone, use GetUncombinedStyle(). 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, wxTextAttr& style);
@@ -774,6 +790,11 @@ public:
Gets the attributes common to the specified range. Gets the attributes common to the specified range.
Attributes that differ in value within the range will not be included Attributes that differ in value within the range will not be included
in @a style flags. 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, virtual bool GetStyleForRange(const wxRichTextRange& range,
wxTextAttr& style); wxTextAttr& style);
@@ -794,6 +815,11 @@ public:
If you specify (any) paragraph attribute in @e style's flags, this function If you specify (any) paragraph attribute in @e style's flags, this function
will fetch the paragraph attributes. will fetch the paragraph attributes.
Otherwise, it will return the character 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); virtual bool GetUncombinedStyle(long position, wxTextAttr& style);