1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/richtext/richeditctrl.cpp
3 // Purpose: A rich edit control
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // For compilers that support precompilation, includes "wx.h".
13 #include "wx/wxprec.h"
21 #include "wx/richtext/richtextctrl.h"
22 #include "wx/richtext/richtextstyles.h"
25 #include "wx/settings.h"
29 #include "wx/stopwatch.h"
32 #include "wx/textfile.h"
34 #include "wx/filename.h"
35 #include "wx/dcbuffer.h"
36 #include "wx/arrimpl.cpp"
38 // DLL options compatibility check:
40 WX_CHECK_BUILD_OPTIONS("wxRichTextCtrl")
42 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_ITEM_SELECTED
)
43 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_ITEM_DESELECTED
)
44 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_LEFT_CLICK
)
45 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK
)
46 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK
)
47 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK
)
48 DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_RETURN
)
50 #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
51 IMPLEMENT_CLASS( wxRichTextCtrl
, wxControl
)
53 IMPLEMENT_CLASS( wxRichTextCtrl
, wxScrolledWindow
)
56 IMPLEMENT_CLASS( wxRichTextEvent
, wxNotifyEvent
)
58 #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
59 BEGIN_EVENT_TABLE( wxRichTextCtrl
, wxControl
)
61 BEGIN_EVENT_TABLE( wxRichTextCtrl
, wxScrolledWindow
)
63 EVT_PAINT(wxRichTextCtrl::OnPaint
)
64 EVT_ERASE_BACKGROUND(wxRichTextCtrl::OnEraseBackground
)
65 EVT_IDLE(wxRichTextCtrl::OnIdle
)
66 EVT_SCROLLWIN(wxRichTextCtrl::OnScroll
)
67 EVT_LEFT_DOWN(wxRichTextCtrl::OnLeftClick
)
68 EVT_MOTION(wxRichTextCtrl::OnMoveMouse
)
69 EVT_LEFT_UP(wxRichTextCtrl::OnLeftUp
)
70 EVT_RIGHT_DOWN(wxRichTextCtrl::OnRightClick
)
71 EVT_MIDDLE_DOWN(wxRichTextCtrl::OnMiddleClick
)
72 EVT_LEFT_DCLICK(wxRichTextCtrl::OnLeftDClick
)
73 EVT_CHAR(wxRichTextCtrl::OnChar
)
74 EVT_SIZE(wxRichTextCtrl::OnSize
)
75 EVT_SET_FOCUS(wxRichTextCtrl::OnSetFocus
)
76 EVT_KILL_FOCUS(wxRichTextCtrl::OnKillFocus
)
77 EVT_CONTEXT_MENU(wxRichTextCtrl::OnContextMenu
)
79 EVT_MENU(wxID_UNDO
, wxRichTextCtrl::OnUndo
)
80 EVT_UPDATE_UI(wxID_UNDO
, wxRichTextCtrl::OnUpdateUndo
)
82 EVT_MENU(wxID_REDO
, wxRichTextCtrl::OnRedo
)
83 EVT_UPDATE_UI(wxID_REDO
, wxRichTextCtrl::OnUpdateRedo
)
85 EVT_MENU(wxID_COPY
, wxRichTextCtrl::OnCopy
)
86 EVT_UPDATE_UI(wxID_COPY
, wxRichTextCtrl::OnUpdateCopy
)
88 EVT_MENU(wxID_PASTE
, wxRichTextCtrl::OnPaste
)
89 EVT_UPDATE_UI(wxID_PASTE
, wxRichTextCtrl::OnUpdatePaste
)
91 EVT_MENU(wxID_CUT
, wxRichTextCtrl::OnCut
)
92 EVT_UPDATE_UI(wxID_CUT
, wxRichTextCtrl::OnUpdateCut
)
94 EVT_MENU(wxID_CLEAR
, wxRichTextCtrl::OnClear
)
95 EVT_UPDATE_UI(wxID_CLEAR
, wxRichTextCtrl::OnUpdateClear
)
97 EVT_MENU(wxID_SELECTALL
, wxRichTextCtrl::OnSelectAll
)
98 EVT_UPDATE_UI(wxID_SELECTALL
, wxRichTextCtrl::OnUpdateSelectAll
)
105 wxRichTextCtrl::wxRichTextCtrl()
106 #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
107 : wxScrollHelper(this)
113 wxRichTextCtrl::wxRichTextCtrl( wxWindow
* parent
, wxWindowID id
, const wxString
& value
, const wxPoint
& pos
, const wxSize
& size
, long style
)
114 #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
115 : wxScrollHelper(this)
119 Create(parent
, id
, value
, pos
, size
, style
);
123 bool wxRichTextCtrl::Create( wxWindow
* parent
, wxWindowID id
, const wxString
& value
, const wxPoint
& pos
, const wxSize
& size
, long style
)
125 #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
126 if (!wxTextCtrlBase::Create(parent
, id
, pos
, size
, style
|wxFULL_REPAINT_ON_RESIZE
130 if (!wxScrolledWindow::Create(parent
, id
, pos
, size
, style
|wxFULL_REPAINT_ON_RESIZE
137 SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
140 GetBuffer().SetRichTextCtrl(this);
142 wxTextAttrEx attributes
;
143 attributes
.SetFont(GetFont());
144 attributes
.SetTextColour(*wxBLACK
);
145 attributes
.SetBackgroundColour(*wxWHITE
);
146 attributes
.SetAlignment(wxTEXT_ALIGNMENT_LEFT
);
147 attributes
.SetFlags(wxTEXT_ATTR_ALL
);
149 SetDefaultStyle(attributes
);
150 SetBasicStyle(attributes
);
152 SetBackgroundColour(*wxWHITE
);
153 SetBackgroundStyle(wxBG_STYLE_CUSTOM
);
155 // Tell the sizers to use the given or best size
156 SetBestFittingSize(size
);
159 RecreateBuffer(size
);
161 SetCursor(wxCursor(wxCURSOR_IBEAM
));
163 if (!value
.IsEmpty())
169 wxRichTextCtrl::~wxRichTextCtrl()
171 delete m_contextMenu
;
174 /// Member initialisation
175 void wxRichTextCtrl::Init()
178 m_contextMenu
= NULL
;
180 m_caretPosition
= -1;
181 m_selectionRange
.SetRange(-2, -2);
182 m_selectionAnchor
= -2;
184 m_caretAtLineStart
= false;
186 m_fullLayoutRequired
= false;
187 m_fullLayoutTime
= 0;
188 m_fullLayoutSavedPosition
= 0;
189 m_delayedLayoutThreshold
= wxRICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD
;
190 m_caretPositionForDefaultStyle
= -2;
193 /// Call Freeze to prevent refresh
194 void wxRichTextCtrl::Freeze()
199 /// Call Thaw to refresh
200 void wxRichTextCtrl::Thaw()
204 if (m_freezeCount
== 0)
212 void wxRichTextCtrl::Clear()
215 m_buffer
.SetDirty(true);
216 m_caretPosition
= -1;
217 m_caretPositionForDefaultStyle
= -2;
218 m_caretAtLineStart
= false;
219 m_selectionRange
.SetRange(-2, -2);
221 SetScrollbars(0, 0, 0, 0, 0, 0);
223 if (m_freezeCount
== 0)
232 void wxRichTextCtrl::OnPaint(wxPaintEvent
& WXUNUSED(event
))
238 wxBufferedPaintDC
dc(this, m_bufferBitmap
);
239 //wxLogDebug(wxT("OnPaint"));
243 if (m_freezeCount
> 0)
246 dc
.SetFont(GetFont());
248 // Paint the background
251 wxRegion dirtyRegion
= GetUpdateRegion();
253 wxRect
drawingArea(GetLogicalPoint(wxPoint(0, 0)), GetClientSize());
254 wxRect
availableSpace(GetClientSize());
255 if (GetBuffer().GetDirty())
257 GetBuffer().Layout(dc
, availableSpace
, wxRICHTEXT_FIXED_WIDTH
|wxRICHTEXT_VARIABLE_HEIGHT
);
258 GetBuffer().SetDirty(false);
262 GetBuffer().Draw(dc
, GetBuffer().GetRange(), GetSelectionRange(), drawingArea
, 0 /* descent */, 0 /* flags */);
271 // Empty implementation, to prevent flicker
272 void wxRichTextCtrl::OnEraseBackground(wxEraseEvent
& WXUNUSED(event
))
276 void wxRichTextCtrl::OnSetFocus(wxFocusEvent
& WXUNUSED(event
))
278 wxCaret
* caret
= new wxCaret(this, wxRICHTEXT_DEFAULT_CARET_WIDTH
, 16);
287 void wxRichTextCtrl::OnKillFocus(wxFocusEvent
& WXUNUSED(event
))
296 void wxRichTextCtrl::OnLeftClick(wxMouseEvent
& event
)
302 dc
.SetFont(GetFont());
305 int hit
= GetBuffer().HitTest(dc
, event
.GetLogicalPosition(dc
), position
);
307 if (hit
!= wxRICHTEXT_HITTEST_NONE
)
309 m_dragStart
= event
.GetLogicalPosition(dc
);
315 bool caretAtLineStart
= false;
317 if (hit
& wxRICHTEXT_HITTEST_BEFORE
)
319 // If we're at the start of a line (but not first in para)
320 // then we should keep the caret showing at the start of the line
321 // by showing the m_caretAtLineStart flag.
322 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(position
);
323 wxRichTextLine
* line
= GetBuffer().GetLineAtPosition(position
);
325 if (line
&& para
&& line
->GetAbsoluteRange().GetStart() == position
&& para
->GetRange().GetStart() != position
)
326 caretAtLineStart
= true;
330 MoveCaret(position
, caretAtLineStart
);
331 SetDefaultStyleToCursorStyle();
334 wxWindow
* p
= GetParent();
335 while (p
&& !p
->IsKindOf(CLASSINFO(wxFrame
)))
338 wxFrame
* frame
= wxDynamicCast(p
, wxFrame
);
341 wxString msg
= wxString::Format(wxT("Found position %ld"), position
);
342 frame
->SetStatusText(msg
, 1);
351 void wxRichTextCtrl::OnLeftUp(wxMouseEvent
& WXUNUSED(event
))
356 if (GetCapture() == this)
362 void wxRichTextCtrl::OnMoveMouse(wxMouseEvent
& event
)
364 if (!event
.Dragging())
372 dc
.SetFont(GetFont());
375 wxPoint logicalPt
= event
.GetLogicalPosition(dc
);
376 int hit
= GetBuffer().HitTest(dc
, logicalPt
, position
);
378 if (m_dragging
&& hit
!= wxRICHTEXT_HITTEST_NONE
)
380 // TODO: test closeness
382 bool caretAtLineStart
= false;
384 if (hit
& wxRICHTEXT_HITTEST_BEFORE
)
386 // If we're at the start of a line (but not first in para)
387 // then we should keep the caret showing at the start of the line
388 // by showing the m_caretAtLineStart flag.
389 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(position
);
390 wxRichTextLine
* line
= GetBuffer().GetLineAtPosition(position
);
392 if (line
&& para
&& line
->GetAbsoluteRange().GetStart() == position
&& para
->GetRange().GetStart() != position
)
393 caretAtLineStart
= true;
397 if (m_caretPosition
!= position
)
399 bool extendSel
= ExtendSelection(m_caretPosition
, position
, wxRICHTEXT_SHIFT_DOWN
);
401 MoveCaret(position
, caretAtLineStart
);
402 SetDefaultStyleToCursorStyle();
411 void wxRichTextCtrl::OnRightClick(wxMouseEvent
& event
)
417 /// Left-double-click
418 void wxRichTextCtrl::OnLeftDClick(wxMouseEvent
& event
)
424 void wxRichTextCtrl::OnMiddleClick(wxMouseEvent
& event
)
430 void wxRichTextCtrl::OnChar(wxKeyEvent
& event
)
433 if (event
.ControlDown())
434 flags
|= wxRICHTEXT_CTRL_DOWN
;
435 if (event
.ShiftDown())
436 flags
|= wxRICHTEXT_SHIFT_DOWN
;
438 flags
|= wxRICHTEXT_ALT_DOWN
;
440 if (event
.GetKeyCode() == WXK_LEFT
||
441 event
.GetKeyCode() == WXK_RIGHT
||
442 event
.GetKeyCode() == WXK_UP
||
443 event
.GetKeyCode() == WXK_DOWN
||
444 event
.GetKeyCode() == WXK_HOME
||
445 event
.GetKeyCode() == WXK_PAGEUP
||
446 event
.GetKeyCode() == WXK_PAGEDOWN
||
447 event
.GetKeyCode() == WXK_END
)
449 KeyboardNavigate(event
.GetKeyCode(), flags
);
453 // all the other keys modify the controls contents which shouldn't be
454 // possible if we're read-only
461 if (event
.GetKeyCode() == WXK_RETURN
)
463 BeginBatchUndo(_("Insert Text"));
465 long newPos
= m_caretPosition
;
467 DeleteSelectedContent(& newPos
);
469 GetBuffer().InsertNewlineWithUndo(newPos
+1, this);
471 wxRichTextEvent
cmdEvent(
472 wxEVT_COMMAND_RICHTEXT_RETURN
,
474 cmdEvent
.SetEventObject(this);
475 cmdEvent
.SetFlags(flags
);
476 GetEventHandler()->ProcessEvent(cmdEvent
);
479 SetDefaultStyleToCursorStyle();
481 ScrollIntoView(m_caretPosition
, WXK_RIGHT
);
483 else if (event
.GetKeyCode() == WXK_BACK
)
485 BeginBatchUndo(_("Delete Text"));
487 // Submit range in character positions, which are greater than caret positions,
488 // so subtract 1 for deleted character and add 1 for conversion to character position.
489 if (m_caretPosition
> -1 && !HasSelection())
491 GetBuffer().DeleteRangeWithUndo(wxRichTextRange(m_caretPosition
, m_caretPosition
),
492 m_caretPosition
, // Current caret position
493 m_caretPosition
-1, // New caret position
497 DeleteSelectedContent();
501 // Shouldn't this be in Do()?
502 if (GetLastPosition() == -1)
506 m_caretPosition
= -1;
508 SetDefaultStyleToCursorStyle();
511 ScrollIntoView(m_caretPosition
, WXK_LEFT
);
513 else if (event
.GetKeyCode() == WXK_DELETE
)
515 BeginBatchUndo(_("Delete Text"));
517 // Submit range in character positions, which are greater than caret positions,
518 if (m_caretPosition
< GetBuffer().GetRange().GetEnd()+1 && !HasSelection())
520 GetBuffer().DeleteRangeWithUndo(wxRichTextRange(m_caretPosition
+1, m_caretPosition
+1),
521 m_caretPosition
, // Current caret position
522 m_caretPosition
+1, // New caret position
526 DeleteSelectedContent();
530 // Shouldn't this be in Do()?
531 if (GetLastPosition() == -1)
535 m_caretPosition
= -1;
537 SetDefaultStyleToCursorStyle();
542 BeginBatchUndo(_("Insert Text"));
544 long newPos
= m_caretPosition
;
545 DeleteSelectedContent(& newPos
);
547 wxString str
= (wxChar
) event
.GetKeyCode();
548 GetBuffer().InsertTextWithUndo(newPos
+1, str
, this);
552 SetDefaultStyleToCursorStyle();
553 ScrollIntoView(m_caretPosition
, WXK_RIGHT
);
557 /// Delete content if there is a selection, e.g. when pressing a key.
558 bool wxRichTextCtrl::DeleteSelectedContent(long* newPos
)
562 long pos
= m_selectionRange
.GetStart();
563 GetBuffer().DeleteRangeWithUndo(m_selectionRange
,
564 m_caretPosition
, // Current caret position
565 pos
, // New caret position
567 m_selectionRange
.SetRange(-2, -2);
577 /// Keyboard navigation
581 Left: left one character
582 Right: right one character
585 Ctrl-Left: left one word
586 Ctrl-Right: right one word
587 Ctrl-Up: previous paragraph start
588 Ctrl-Down: next start of paragraph
591 Ctrl-Home: start of document
592 Ctrl-End: end of document
594 Page-Down: Down a screen
598 Ctrl-Alt-PgUp: Start of window
599 Ctrl-Alt-PgDn: End of window
600 F8: Start selection mode
601 Esc: End selection mode
603 Adding Shift does the above but starts/extends selection.
608 bool wxRichTextCtrl::KeyboardNavigate(int keyCode
, int flags
)
610 bool success
= false;
612 if (keyCode
== WXK_RIGHT
)
614 if (flags
& wxRICHTEXT_CTRL_DOWN
)
615 success
= WordRight(1, flags
);
617 success
= MoveRight(1, flags
);
619 else if (keyCode
== WXK_LEFT
)
621 if (flags
& wxRICHTEXT_CTRL_DOWN
)
622 success
= WordLeft(1, flags
);
624 success
= MoveLeft(1, flags
);
626 else if (keyCode
== WXK_UP
)
628 if (flags
& wxRICHTEXT_CTRL_DOWN
)
629 success
= MoveToParagraphStart(flags
);
631 success
= MoveUp(1, flags
);
633 else if (keyCode
== WXK_DOWN
)
635 if (flags
& wxRICHTEXT_CTRL_DOWN
)
636 success
= MoveToParagraphEnd(flags
);
638 success
= MoveDown(1, flags
);
640 else if (keyCode
== WXK_PAGEUP
)
642 success
= PageUp(1, flags
);
644 else if (keyCode
== WXK_PAGEDOWN
)
646 success
= PageDown(1, flags
);
648 else if (keyCode
== WXK_HOME
)
650 if (flags
& wxRICHTEXT_CTRL_DOWN
)
651 success
= MoveHome(flags
);
653 success
= MoveToLineStart(flags
);
655 else if (keyCode
== WXK_END
)
657 if (flags
& wxRICHTEXT_CTRL_DOWN
)
658 success
= MoveEnd(flags
);
660 success
= MoveToLineEnd(flags
);
665 ScrollIntoView(m_caretPosition
, keyCode
);
666 SetDefaultStyleToCursorStyle();
672 /// Extend the selection. Selections are in caret positions.
673 bool wxRichTextCtrl::ExtendSelection(long oldPos
, long newPos
, int flags
)
675 if (flags
& wxRICHTEXT_SHIFT_DOWN
)
677 // If not currently selecting, start selecting
678 if (m_selectionRange
.GetStart() == -2)
680 m_selectionAnchor
= oldPos
;
683 m_selectionRange
.SetRange(newPos
+1, oldPos
);
685 m_selectionRange
.SetRange(oldPos
+1, newPos
);
689 // Always ensure that the selection range start is greater than
691 if (newPos
> m_selectionAnchor
)
692 m_selectionRange
.SetRange(m_selectionAnchor
+1, newPos
);
694 m_selectionRange
.SetRange(newPos
+1, m_selectionAnchor
);
697 if (m_selectionRange
.GetStart() > m_selectionRange
.GetEnd())
699 wxLogDebug(wxT("Strange selection range"));
708 /// Scroll into view, returning true if we scrolled.
709 /// This takes a _caret_ position.
710 bool wxRichTextCtrl::ScrollIntoView(long position
, int keyCode
)
712 wxRichTextLine
* line
= GetVisibleLineForCaretPosition(position
);
718 GetScrollPixelsPerUnit(& ppuX
, & ppuY
);
720 int startXUnits
, startYUnits
;
721 GetViewStart(& startXUnits
, & startYUnits
);
722 int startY
= startYUnits
* ppuY
;
725 GetVirtualSize(& sx
, & sy
);
731 wxRect rect
= line
->GetRect();
733 bool scrolled
= false;
735 wxSize clientSize
= GetClientSize();
738 if (keyCode
== WXK_DOWN
|| keyCode
== WXK_RIGHT
|| keyCode
== WXK_END
|| keyCode
== WXK_PAGEDOWN
)
740 if ((rect
.y
+ rect
.height
) > (clientSize
.y
+ startY
))
742 // Make it scroll so this item is at the bottom
744 int y
= rect
.y
- (clientSize
.y
- rect
.height
);
745 int yUnits
= (int) (0.5 + ((float) y
)/(float) ppuY
);
747 // If we're still off the screen, scroll another line down
748 if ((rect
.y
+ rect
.height
) > (clientSize
.y
+ (yUnits
*ppuY
)))
751 if (startYUnits
!= yUnits
)
753 SetScrollbars(ppuX
, ppuY
, sxUnits
, syUnits
, 0, yUnits
);
757 else if (rect
.y
< startY
)
759 // Make it scroll so this item is at the top
762 int yUnits
= (int) (0.5 + ((float) y
)/(float) ppuY
);
764 if (startYUnits
!= yUnits
)
766 SetScrollbars(ppuX
, ppuY
, sxUnits
, syUnits
, 0, yUnits
);
772 else if (keyCode
== WXK_UP
|| keyCode
== WXK_LEFT
|| keyCode
== WXK_HOME
|| keyCode
== WXK_PAGEUP
)
776 // Make it scroll so this item is at the top
779 int yUnits
= (int) (0.5 + ((float) y
)/(float) ppuY
);
781 if (startYUnits
!= yUnits
)
783 SetScrollbars(ppuX
, ppuY
, sxUnits
, syUnits
, 0, yUnits
);
787 else if ((rect
.y
+ rect
.height
) > (clientSize
.y
+ startY
))
789 // Make it scroll so this item is at the bottom
791 int y
= rect
.y
- (clientSize
.y
- rect
.height
);
792 int yUnits
= (int) (0.5 + ((float) y
)/(float) ppuY
);
794 // If we're still off the screen, scroll another line down
795 if ((rect
.y
+ rect
.height
) > (clientSize
.y
+ (yUnits
*ppuY
)))
798 if (startYUnits
!= yUnits
)
800 SetScrollbars(ppuX
, ppuY
, sxUnits
, syUnits
, 0, yUnits
);
810 /// Is the given position visible on the screen?
811 bool wxRichTextCtrl::IsPositionVisible(long pos
) const
813 wxRichTextLine
* line
= GetVisibleLineForCaretPosition(pos
-1);
819 GetScrollPixelsPerUnit(& ppuX
, & ppuY
);
822 GetViewStart(& startX
, & startY
);
824 startY
= startY
* ppuY
;
827 GetVirtualSize(& sx
, & sy
);
832 wxRect rect
= line
->GetRect();
834 wxSize clientSize
= GetClientSize();
836 return !(((rect
.y
+ rect
.height
) > (clientSize
.y
+ startY
)) || rect
.y
< startY
);
839 void wxRichTextCtrl::SetCaretPosition(long position
, bool showAtLineStart
)
841 m_caretPosition
= position
;
842 m_caretAtLineStart
= showAtLineStart
;
845 /// Move caret one visual step forward: this may mean setting a flag
846 /// and keeping the same position if we're going from the end of one line
847 /// to the start of the next, which may be the exact same caret position.
848 void wxRichTextCtrl::MoveCaretForward(long oldPosition
)
850 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(oldPosition
);
852 // Only do the check if we're not at the end of the paragraph (where things work OK
854 if (para
&& (oldPosition
!= para
->GetRange().GetEnd() - 1))
856 wxRichTextLine
* line
= GetBuffer().GetLineAtPosition(oldPosition
);
860 wxRichTextRange lineRange
= line
->GetAbsoluteRange();
862 // We're at the end of a line. See whether we need to
863 // stay at the same actual caret position but change visual
865 if (oldPosition
== lineRange
.GetEnd())
867 if (m_caretAtLineStart
)
869 // We're already at the start of the line, so actually move on now.
870 m_caretPosition
= oldPosition
+ 1;
871 m_caretAtLineStart
= false;
875 // We're showing at the end of the line, so keep to
876 // the same position but indicate that we're to show
877 // at the start of the next line.
878 m_caretPosition
= oldPosition
;
879 m_caretAtLineStart
= true;
881 SetDefaultStyleToCursorStyle();
887 SetDefaultStyleToCursorStyle();
890 /// Move caret one visual step backward: this may mean setting a flag
891 /// and keeping the same position if we're going from the end of one line
892 /// to the start of the next, which may be the exact same caret position.
893 void wxRichTextCtrl::MoveCaretBack(long oldPosition
)
895 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(oldPosition
);
897 // Only do the check if we're not at the start of the paragraph (where things work OK
899 if (para
&& (oldPosition
!= para
->GetRange().GetStart()))
901 wxRichTextLine
* line
= GetBuffer().GetLineAtPosition(oldPosition
);
905 wxRichTextRange lineRange
= line
->GetAbsoluteRange();
907 // We're at the start of a line. See whether we need to
908 // stay at the same actual caret position but change visual
910 if (oldPosition
== lineRange
.GetStart())
912 m_caretPosition
= oldPosition
-1;
913 m_caretAtLineStart
= true;
916 else if (oldPosition
== lineRange
.GetEnd())
918 if (m_caretAtLineStart
)
920 // We're at the start of the line, so keep the same caret position
921 // but clear the start-of-line flag.
922 m_caretPosition
= oldPosition
;
923 m_caretAtLineStart
= false;
927 // We're showing at the end of the line, so go back
928 // to the previous character position.
929 m_caretPosition
= oldPosition
- 1;
931 SetDefaultStyleToCursorStyle();
937 SetDefaultStyleToCursorStyle();
941 bool wxRichTextCtrl::MoveRight(int noPositions
, int flags
)
943 long endPos
= GetBuffer().GetRange().GetEnd();
945 if (m_caretPosition
+ noPositions
< endPos
)
947 long oldPos
= m_caretPosition
;
948 long newPos
= m_caretPosition
+ noPositions
;
950 bool extendSel
= ExtendSelection(m_caretPosition
, newPos
, flags
);
954 // Determine by looking at oldPos and m_caretPosition whether
955 // we moved from the end of a line to the start of the next line, in which case
956 // we want to adjust the caret position such that it is positioned at the
957 // start of the next line, rather than jumping past the first character of the
959 if (noPositions
== 1 && !extendSel
)
960 MoveCaretForward(oldPos
);
962 SetCaretPosition(newPos
);
965 SetDefaultStyleToCursorStyle();
976 bool wxRichTextCtrl::MoveLeft(int noPositions
, int flags
)
980 if (m_caretPosition
> startPos
- noPositions
+ 1)
982 long oldPos
= m_caretPosition
;
983 long newPos
= m_caretPosition
- noPositions
;
984 bool extendSel
= ExtendSelection(m_caretPosition
, newPos
, flags
);
988 if (noPositions
== 1 && !extendSel
)
989 MoveCaretBack(oldPos
);
991 SetCaretPosition(newPos
);
994 SetDefaultStyleToCursorStyle();
1005 bool wxRichTextCtrl::MoveUp(int noLines
, int flags
)
1007 return MoveDown(- noLines
, flags
);
1011 bool wxRichTextCtrl::MoveDown(int noLines
, int flags
)
1016 long lineNumber
= GetBuffer().GetVisibleLineNumber(m_caretPosition
, true, m_caretAtLineStart
);
1017 wxPoint pt
= GetCaret()->GetPosition();
1018 long newLine
= lineNumber
+ noLines
;
1020 if (lineNumber
!= -1)
1024 long lastLine
= GetBuffer().GetVisibleLineNumber(GetBuffer().GetRange().GetEnd());
1026 if (newLine
> lastLine
)
1036 wxRichTextLine
* lineObj
= GetBuffer().GetLineForVisibleLineNumber(newLine
);
1039 pt
.y
= lineObj
->GetAbsolutePosition().y
+ 2;
1045 wxClientDC
dc(this);
1047 dc
.SetFont(GetFont());
1049 int hitTest
= GetBuffer().HitTest(dc
, pt
, newPos
);
1051 if (hitTest
!= wxRICHTEXT_HITTEST_NONE
)
1053 // If end of previous line, and hitTest is wxRICHTEXT_HITTEST_BEFORE,
1054 // we want to be at the end of the last line but with m_caretAtLineStart set to true,
1055 // so we view the caret at the start of the line.
1056 bool caretLineStart
= false;
1057 if (hitTest
== wxRICHTEXT_HITTEST_BEFORE
)
1059 wxRichTextLine
* thisLine
= GetBuffer().GetLineAtPosition(newPos
-1);
1060 wxRichTextRange lineRange
;
1062 lineRange
= thisLine
->GetAbsoluteRange();
1064 if (thisLine
&& (newPos
-1) == lineRange
.GetEnd())
1067 caretLineStart
= true;
1071 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(newPos
);
1072 if (para
&& para
->GetRange().GetStart() == newPos
)
1077 long newSelEnd
= newPos
;
1079 bool extendSel
= ExtendSelection(m_caretPosition
, newSelEnd
, flags
);
1083 SetCaretPosition(newPos
, caretLineStart
);
1085 SetDefaultStyleToCursorStyle();
1095 /// Move to the end of the paragraph
1096 bool wxRichTextCtrl::MoveToParagraphEnd(int flags
)
1098 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(m_caretPosition
, true);
1101 long newPos
= para
->GetRange().GetEnd() - 1;
1102 bool extendSel
= ExtendSelection(m_caretPosition
, newPos
, flags
);
1106 SetCaretPosition(newPos
);
1108 SetDefaultStyleToCursorStyle();
1118 /// Move to the start of the paragraph
1119 bool wxRichTextCtrl::MoveToParagraphStart(int flags
)
1121 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(m_caretPosition
, true);
1124 long newPos
= para
->GetRange().GetStart() - 1;
1125 bool extendSel
= ExtendSelection(m_caretPosition
, newPos
, flags
);
1129 SetCaretPosition(newPos
);
1131 SetDefaultStyleToCursorStyle();
1141 /// Move to the end of the line
1142 bool wxRichTextCtrl::MoveToLineEnd(int flags
)
1144 wxRichTextLine
* line
= GetVisibleLineForCaretPosition(m_caretPosition
);
1148 wxRichTextRange lineRange
= line
->GetAbsoluteRange();
1149 long newPos
= lineRange
.GetEnd();
1150 bool extendSel
= ExtendSelection(m_caretPosition
, newPos
, flags
);
1154 SetCaretPosition(newPos
);
1156 SetDefaultStyleToCursorStyle();
1166 /// Move to the start of the line
1167 bool wxRichTextCtrl::MoveToLineStart(int flags
)
1169 wxRichTextLine
* line
= GetVisibleLineForCaretPosition(m_caretPosition
);
1172 wxRichTextRange lineRange
= line
->GetAbsoluteRange();
1173 long newPos
= lineRange
.GetStart()-1;
1175 bool extendSel
= ExtendSelection(m_caretPosition
, newPos
, flags
);
1179 wxRichTextParagraph
* para
= GetBuffer().GetParagraphForLine(line
);
1181 SetCaretPosition(newPos
, para
->GetRange().GetStart() != lineRange
.GetStart());
1183 SetDefaultStyleToCursorStyle();
1193 /// Move to the start of the buffer
1194 bool wxRichTextCtrl::MoveHome(int flags
)
1196 if (m_caretPosition
!= -1)
1198 bool extendSel
= ExtendSelection(m_caretPosition
, -1, flags
);
1202 SetCaretPosition(-1);
1204 SetDefaultStyleToCursorStyle();
1214 /// Move to the end of the buffer
1215 bool wxRichTextCtrl::MoveEnd(int flags
)
1217 long endPos
= GetBuffer().GetRange().GetEnd()-1;
1219 if (m_caretPosition
!= endPos
)
1221 bool extendSel
= ExtendSelection(m_caretPosition
, endPos
, flags
);
1225 SetCaretPosition(endPos
);
1227 SetDefaultStyleToCursorStyle();
1237 /// Move noPages pages up
1238 bool wxRichTextCtrl::PageUp(int noPages
, int flags
)
1240 return PageDown(- noPages
, flags
);
1243 /// Move noPages pages down
1244 bool wxRichTextCtrl::PageDown(int noPages
, int flags
)
1246 // Calculate which line occurs noPages * screen height further down.
1247 wxRichTextLine
* line
= GetVisibleLineForCaretPosition(m_caretPosition
);
1250 wxSize clientSize
= GetClientSize();
1251 int newY
= line
->GetAbsolutePosition().y
+ noPages
*clientSize
.y
;
1253 wxRichTextLine
* newLine
= GetBuffer().GetLineAtYPosition(newY
);
1256 wxRichTextRange lineRange
= newLine
->GetAbsoluteRange();
1257 long pos
= lineRange
.GetStart()-1;
1258 if (pos
!= m_caretPosition
)
1260 wxRichTextParagraph
* para
= GetBuffer().GetParagraphForLine(newLine
);
1262 bool extendSel
= ExtendSelection(m_caretPosition
, pos
, flags
);
1266 SetCaretPosition(pos
, para
->GetRange().GetStart() != lineRange
.GetStart());
1268 SetDefaultStyleToCursorStyle();
1280 // Finds the caret position for the next word
1281 long wxRichTextCtrl::FindNextWordPosition(int direction
) const
1283 long endPos
= GetBuffer().GetRange().GetEnd();
1287 long i
= m_caretPosition
+1+direction
; // +1 for conversion to character pos
1289 // First skip current text to space
1290 while (i
< endPos
&& i
> -1)
1292 // i is in character, not caret positions
1293 wxString text
= GetBuffer().GetTextForRange(wxRichTextRange(i
, i
));
1294 if (text
!= wxT(" ") && !text
.empty())
1301 while (i
< endPos
&& i
> -1)
1303 // i is in character, not caret positions
1304 wxString text
= GetBuffer().GetTextForRange(wxRichTextRange(i
, i
));
1305 if (text
.empty()) // End of paragraph, or maybe an image
1306 return wxMax(-1, i
- 1);
1307 else if (text
== wxT(" ") || text
.empty())
1311 // Convert to caret position
1312 return wxMax(-1, i
- 1);
1321 long i
= m_caretPosition
;
1323 // First skip white space
1324 while (i
< endPos
&& i
> -1)
1326 // i is in character, not caret positions
1327 wxString text
= GetBuffer().GetTextForRange(wxRichTextRange(i
, i
));
1328 if (text
.empty()) // End of paragraph, or maybe an image
1330 else if (text
== wxT(" ") || text
.empty())
1335 // Next skip current text to space
1336 while (i
< endPos
&& i
> -1)
1338 // i is in character, not caret positions
1339 wxString text
= GetBuffer().GetTextForRange(wxRichTextRange(i
, i
));
1340 if (text
!= wxT(" ") /* && !text.empty() */)
1353 /// Move n words left
1354 bool wxRichTextCtrl::WordLeft(int WXUNUSED(n
), int flags
)
1356 long pos
= FindNextWordPosition(-1);
1357 if (pos
!= m_caretPosition
)
1359 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(pos
, true);
1361 bool extendSel
= ExtendSelection(m_caretPosition
, pos
, flags
);
1365 SetCaretPosition(pos
, para
->GetRange().GetStart() != pos
);
1367 SetDefaultStyleToCursorStyle();
1377 /// Move n words right
1378 bool wxRichTextCtrl::WordRight(int WXUNUSED(n
), int flags
)
1380 long pos
= FindNextWordPosition(1);
1381 if (pos
!= m_caretPosition
)
1383 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(pos
, true);
1385 bool extendSel
= ExtendSelection(m_caretPosition
, pos
, flags
);
1389 SetCaretPosition(pos
, para
->GetRange().GetStart() != pos
);
1391 SetDefaultStyleToCursorStyle();
1402 void wxRichTextCtrl::OnSize(wxSizeEvent
& event
)
1404 // Only do sizing optimization for large buffers
1405 if (GetBuffer().GetRange().GetEnd() > m_delayedLayoutThreshold
)
1407 m_fullLayoutRequired
= true;
1408 m_fullLayoutTime
= wxGetLocalTimeMillis();
1409 m_fullLayoutSavedPosition
= GetFirstVisiblePosition();
1410 LayoutContent(true /* onlyVisibleRect */);
1413 GetBuffer().Invalidate(wxRICHTEXT_ALL
);
1421 /// Idle-time processing
1422 void wxRichTextCtrl::OnIdle(wxIdleEvent
& event
)
1424 const int layoutInterval
= wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL
;
1426 if (m_fullLayoutRequired
&& (wxGetLocalTimeMillis() > (m_fullLayoutTime
+ layoutInterval
)))
1428 m_fullLayoutRequired
= false;
1429 m_fullLayoutTime
= 0;
1430 GetBuffer().Invalidate(wxRICHTEXT_ALL
);
1431 ShowPosition(m_fullLayoutSavedPosition
);
1435 if (m_caretPositionForDefaultStyle
!= -2)
1437 // If the caret position has changed, no longer reflect the default style
1439 if (GetCaretPosition() != m_caretPositionForDefaultStyle
)
1440 m_caretPositionForDefaultStyle
= -2;
1447 void wxRichTextCtrl::OnScroll(wxScrollWinEvent
& event
)
1453 /// Set up scrollbars, e.g. after a resize
1454 void wxRichTextCtrl::SetupScrollbars(bool atTop
)
1459 if (GetBuffer().IsEmpty())
1461 SetScrollbars(0, 0, 0, 0, 0, 0);
1465 // TODO: reimplement scrolling so we scroll by line, not by fixed number
1466 // of pixels. See e.g. wxVScrolledWindow for ideas.
1467 int pixelsPerUnit
= 5;
1468 wxSize clientSize
= GetClientSize();
1470 int maxHeight
= GetBuffer().GetCachedSize().y
;
1472 // Round up so we have at least maxHeight pixels
1473 int unitsY
= (int) (((float)maxHeight
/(float)pixelsPerUnit
) + 0.5);
1475 int startX
= 0, startY
= 0;
1477 GetViewStart(& startX
, & startY
);
1479 int maxPositionX
= 0; // wxMax(sz.x - clientSize.x, 0);
1480 int maxPositionY
= (int) ((((float)(wxMax((unitsY
*pixelsPerUnit
) - clientSize
.y
, 0)))/((float)pixelsPerUnit
)) + 0.5);
1482 // Move to previous scroll position if
1484 SetScrollbars(0, pixelsPerUnit
,
1486 wxMin(maxPositionX
, startX
), wxMin(maxPositionY
, startY
));
1489 /// Paint the background
1490 void wxRichTextCtrl::PaintBackground(wxDC
& dc
)
1492 wxColour backgroundColour
= GetBackgroundColour();
1493 if (!backgroundColour
.Ok())
1494 backgroundColour
= wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
);
1496 // Clear the background
1497 dc
.SetBrush(wxBrush(backgroundColour
));
1498 dc
.SetPen(*wxTRANSPARENT_PEN
);
1499 wxRect
windowRect(GetClientSize());
1500 windowRect
.x
-= 2; windowRect
.y
-= 2;
1501 windowRect
.width
+= 4; windowRect
.height
+= 4;
1503 // We need to shift the rectangle to take into account
1504 // scrolling. Converting device to logical coordinates.
1505 CalcUnscrolledPosition(windowRect
.x
, windowRect
.y
, & windowRect
.x
, & windowRect
.y
);
1506 dc
.DrawRectangle(windowRect
);
1509 /// Recreate buffer bitmap if necessary
1510 bool wxRichTextCtrl::RecreateBuffer(const wxSize
& size
)
1513 if (sz
== wxDefaultSize
)
1514 sz
= GetClientSize();
1516 if (sz
.x
< 1 || sz
.y
< 1)
1519 if (!m_bufferBitmap
.Ok() || m_bufferBitmap
.GetWidth() < sz
.x
|| m_bufferBitmap
.GetHeight() < sz
.y
)
1520 m_bufferBitmap
= wxBitmap(sz
.x
, sz
.y
);
1521 return m_bufferBitmap
.Ok();
1524 // ----------------------------------------------------------------------------
1525 // file IO functions
1526 // ----------------------------------------------------------------------------
1528 bool wxRichTextCtrl::LoadFile(const wxString
& filename
, int type
)
1530 bool success
= GetBuffer().LoadFile(filename
, type
);
1532 m_filename
= filename
;
1535 SetInsertionPoint(0);
1538 SetupScrollbars(true);
1546 wxLogError(_("File couldn't be loaded."));
1552 bool wxRichTextCtrl::SaveFile(const wxString
& filename
, int type
)
1554 wxString filenameToUse
= filename
.empty() ? m_filename
: filename
;
1555 if ( filenameToUse
.empty() )
1557 // what kind of message to give? is it an error or a program bug?
1558 wxLogDebug(wxT("Can't save textctrl to file without filename."));
1563 if (GetBuffer().SaveFile(filenameToUse
, type
))
1565 m_filename
= filenameToUse
;
1573 wxLogError(_("The text couldn't be saved."));
1578 // ----------------------------------------------------------------------------
1579 // wxRichTextCtrl specific functionality
1580 // ----------------------------------------------------------------------------
1582 /// Add a new paragraph of text to the end of the buffer
1583 wxRichTextRange
wxRichTextCtrl::AddParagraph(const wxString
& text
)
1585 return GetBuffer().AddParagraph(text
);
1589 wxRichTextRange
wxRichTextCtrl::AddImage(const wxImage
& image
)
1591 return GetBuffer().AddImage(image
);
1594 // ----------------------------------------------------------------------------
1595 // selection and ranges
1596 // ----------------------------------------------------------------------------
1598 void wxRichTextCtrl::SelectAll()
1600 SetSelection(0, GetLastPosition());
1601 m_selectionAnchor
= -1;
1605 void wxRichTextCtrl::SelectNone()
1607 if (!(GetSelectionRange() == wxRichTextRange(-2, -2)))
1608 SetSelection(-2, -2);
1609 m_selectionAnchor
= -2;
1612 wxString
wxRichTextCtrl::GetStringSelection() const
1615 GetSelection(&from
, &to
);
1617 return GetRange(from
, to
);
1620 // do the window-specific processing after processing the update event
1621 #if !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
1622 void wxRichTextCtrl::DoUpdateWindowUI(wxUpdateUIEvent
& event
)
1625 wxWindowBase::DoUpdateWindowUI(event
);
1628 if ( event
.GetSetText() )
1630 if ( event
.GetText() != GetValue() )
1631 SetValue(event
.GetText());
1634 #endif // !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
1636 // ----------------------------------------------------------------------------
1638 // ----------------------------------------------------------------------------
1640 wxTextCtrlHitTestResult
1641 wxRichTextCtrl::HitTest(const wxPoint
& pt
, wxTextCoord
*x
, wxTextCoord
*y
) const
1643 // implement in terms of the other overload as the native ports typically
1644 // can get the position and not (x, y) pair directly (although wxUniv
1645 // directly gets x and y -- and so overrides this method as well)
1647 wxTextCtrlHitTestResult rc
= HitTest(pt
, &pos
);
1649 if ( rc
!= wxTE_HT_UNKNOWN
)
1651 PositionToXY(pos
, x
, y
);
1657 wxTextCtrlHitTestResult
1658 wxRichTextCtrl::HitTest(const wxPoint
& pt
,
1661 wxClientDC
dc((wxRichTextCtrl
*) this);
1662 ((wxRichTextCtrl
*)this)->PrepareDC(dc
);
1664 // Buffer uses logical position (relative to start of buffer)
1666 wxPoint pt2
= GetLogicalPoint(pt
);
1668 int hit
= ((wxRichTextCtrl
*)this)->GetBuffer().HitTest(dc
, pt2
, *pos
);
1672 case wxRICHTEXT_HITTEST_BEFORE
:
1673 return wxTE_HT_BEFORE
;
1675 case wxRICHTEXT_HITTEST_AFTER
:
1676 return wxTE_HT_BEYOND
;
1678 case wxRICHTEXT_HITTEST_ON
:
1679 return wxTE_HT_ON_TEXT
;
1682 return wxTE_HT_UNKNOWN
;
1685 // ----------------------------------------------------------------------------
1686 // set/get the controls text
1687 // ----------------------------------------------------------------------------
1689 wxString
wxRichTextCtrl::GetValue() const
1691 return GetBuffer().GetText();
1694 wxString
wxRichTextCtrl::GetRange(long from
, long to
) const
1696 return GetBuffer().GetTextForRange(wxRichTextRange(from
, to
));
1699 void wxRichTextCtrl::SetValue(const wxString
& value
)
1703 // if the text is long enough, it's faster to just set it instead of first
1704 // comparing it with the old one (chances are that it will be different
1705 // anyhow, this comparison is there to avoid flicker for small single-line
1706 // edit controls mostly)
1707 if ( (value
.length() > 0x400) || (value
!= GetValue()) )
1709 DoWriteText(value
, false /* not selection only */);
1711 // for compatibility, don't move the cursor when doing SetValue()
1712 SetInsertionPoint(0);
1716 // still send an event for consistency
1720 // we should reset the modified flag even if the value didn't really change
1722 // mark the control as being not dirty - we changed its text, not the
1727 void wxRichTextCtrl::WriteText(const wxString
& value
)
1732 void wxRichTextCtrl::DoWriteText(const wxString
& value
, bool WXUNUSED(selectionOnly
))
1734 GetBuffer().InsertTextWithUndo(m_caretPosition
+1, value
, this);
1737 void wxRichTextCtrl::AppendText(const wxString
& text
)
1739 SetInsertionPointEnd();
1744 /// Write an image at the current insertion point
1745 bool wxRichTextCtrl::WriteImage(const wxImage
& image
, int bitmapType
)
1747 wxRichTextImageBlock imageBlock
;
1749 wxImage image2
= image
;
1750 if (imageBlock
.MakeImageBlock(image2
, bitmapType
))
1751 return WriteImage(imageBlock
);
1756 bool wxRichTextCtrl::WriteImage(const wxString
& filename
, int bitmapType
)
1758 wxRichTextImageBlock imageBlock
;
1761 if (imageBlock
.MakeImageBlock(filename
, bitmapType
, image
, false))
1762 return WriteImage(imageBlock
);
1767 bool wxRichTextCtrl::WriteImage(const wxRichTextImageBlock
& imageBlock
)
1769 return GetBuffer().InsertImageWithUndo(m_caretPosition
+1, imageBlock
, this);
1772 bool wxRichTextCtrl::WriteImage(const wxBitmap
& bitmap
, int bitmapType
)
1776 wxRichTextImageBlock imageBlock
;
1778 wxImage image
= bitmap
.ConvertToImage();
1779 if (image
.Ok() && imageBlock
.MakeImageBlock(image
, bitmapType
))
1780 return WriteImage(imageBlock
);
1786 /// Insert a newline (actually paragraph) at the current insertion point.
1787 bool wxRichTextCtrl::Newline()
1789 return GetBuffer().InsertNewlineWithUndo(m_caretPosition
+1, this);
1793 // ----------------------------------------------------------------------------
1794 // Clipboard operations
1795 // ----------------------------------------------------------------------------
1797 void wxRichTextCtrl::Copy()
1801 wxRichTextRange range
= GetSelectionRange();
1802 GetBuffer().CopyToClipboard(range
);
1806 void wxRichTextCtrl::Cut()
1810 wxRichTextRange range
= GetSelectionRange();
1811 GetBuffer().CopyToClipboard(range
);
1813 DeleteSelectedContent();
1819 void wxRichTextCtrl::Paste()
1823 BeginBatchUndo(_("Paste"));
1825 long newPos
= m_caretPosition
;
1826 DeleteSelectedContent(& newPos
);
1828 GetBuffer().PasteFromClipboard(newPos
);
1834 void wxRichTextCtrl::DeleteSelection()
1836 if (CanDeleteSelection())
1838 DeleteSelectedContent();
1842 bool wxRichTextCtrl::HasSelection() const
1844 return m_selectionRange
.GetStart() != -2 && m_selectionRange
.GetEnd() != -2;
1847 bool wxRichTextCtrl::CanCopy() const
1849 // Can copy if there's a selection
1850 return HasSelection();
1853 bool wxRichTextCtrl::CanCut() const
1855 return HasSelection() && IsEditable();
1858 bool wxRichTextCtrl::CanPaste() const
1860 if ( !IsEditable() )
1863 return GetBuffer().CanPasteFromClipboard();
1866 bool wxRichTextCtrl::CanDeleteSelection() const
1868 return HasSelection() && IsEditable();
1872 // ----------------------------------------------------------------------------
1874 // ----------------------------------------------------------------------------
1876 void wxRichTextCtrl::SetEditable(bool editable
)
1878 m_editable
= editable
;
1881 void wxRichTextCtrl::SetInsertionPoint(long pos
)
1885 m_caretPosition
= pos
- 1;
1888 void wxRichTextCtrl::SetInsertionPointEnd()
1890 long pos
= GetLastPosition();
1891 SetInsertionPoint(pos
);
1894 long wxRichTextCtrl::GetInsertionPoint() const
1896 return m_caretPosition
+1;
1899 wxTextPos
wxRichTextCtrl::GetLastPosition() const
1901 return GetBuffer().GetRange().GetEnd();
1904 // If the return values from and to are the same, there is no
1906 void wxRichTextCtrl::GetSelection(long* from
, long* to
) const
1908 *from
= m_selectionRange
.GetStart();
1909 *to
= m_selectionRange
.GetEnd();
1912 bool wxRichTextCtrl::IsEditable() const
1917 // ----------------------------------------------------------------------------
1919 // ----------------------------------------------------------------------------
1921 void wxRichTextCtrl::SetSelection(long from
, long to
)
1923 // if from and to are both -1, it means (in wxWidgets) that all text should
1925 if ( (from
== -1) && (to
== -1) )
1928 to
= GetLastPosition();
1931 DoSetSelection(from
, to
);
1934 void wxRichTextCtrl::DoSetSelection(long from
, long to
, bool WXUNUSED(scrollCaret
))
1936 m_selectionAnchor
= from
;
1937 m_selectionRange
.SetRange(from
, to
);
1942 // ----------------------------------------------------------------------------
1944 // ----------------------------------------------------------------------------
1946 void wxRichTextCtrl::Replace(long WXUNUSED(from
), long WXUNUSED(to
), const wxString
& value
)
1948 BeginBatchUndo(_("Replace"));
1950 DeleteSelectedContent();
1952 DoWriteText(value
, true /* selection only */);
1957 void wxRichTextCtrl::Remove(long from
, long to
)
1961 GetBuffer().DeleteRangeWithUndo(wxRichTextRange(from
, to
),
1962 m_caretPosition
, // Current caret position
1963 from
, // New caret position
1971 bool wxRichTextCtrl::IsModified() const
1973 return m_buffer
.IsModified();
1976 void wxRichTextCtrl::MarkDirty()
1978 m_buffer
.Modify(true);
1981 void wxRichTextCtrl::DiscardEdits()
1983 m_caretPositionForDefaultStyle
= -2;
1984 m_buffer
.Modify(false);
1985 m_buffer
.GetCommandProcessor()->ClearCommands();
1988 int wxRichTextCtrl::GetNumberOfLines() const
1990 return GetBuffer().GetParagraphCount();
1993 // ----------------------------------------------------------------------------
1994 // Positions <-> coords
1995 // ----------------------------------------------------------------------------
1997 long wxRichTextCtrl::XYToPosition(long x
, long y
) const
1999 return GetBuffer().XYToPosition(x
, y
);
2002 bool wxRichTextCtrl::PositionToXY(long pos
, long *x
, long *y
) const
2004 return GetBuffer().PositionToXY(pos
, x
, y
);
2007 // ----------------------------------------------------------------------------
2009 // ----------------------------------------------------------------------------
2011 void wxRichTextCtrl::ShowPosition(long pos
)
2013 if (!IsPositionVisible(pos
))
2014 ScrollIntoView(pos
-1, WXK_DOWN
);
2017 int wxRichTextCtrl::GetLineLength(long lineNo
) const
2019 return GetBuffer().GetParagraphLength(lineNo
);
2022 wxString
wxRichTextCtrl::GetLineText(long lineNo
) const
2024 return GetBuffer().GetParagraphText(lineNo
);
2027 // ----------------------------------------------------------------------------
2029 // ----------------------------------------------------------------------------
2031 void wxRichTextCtrl::Undo()
2035 GetCommandProcessor()->Undo();
2039 void wxRichTextCtrl::Redo()
2043 GetCommandProcessor()->Redo();
2047 bool wxRichTextCtrl::CanUndo() const
2049 return GetCommandProcessor()->CanUndo();
2052 bool wxRichTextCtrl::CanRedo() const
2054 return GetCommandProcessor()->CanRedo();
2057 // ----------------------------------------------------------------------------
2058 // implementation details
2059 // ----------------------------------------------------------------------------
2061 void wxRichTextCtrl::Command(wxCommandEvent
& event
)
2063 SetValue(event
.GetString());
2064 GetEventHandler()->ProcessEvent(event
);
2067 void wxRichTextCtrl::OnDropFiles(wxDropFilesEvent
& event
)
2069 // By default, load the first file into the text window.
2070 if (event
.GetNumberOfFiles() > 0)
2072 LoadFile(event
.GetFiles()[0]);
2076 // ----------------------------------------------------------------------------
2077 // text control event processing
2078 // ----------------------------------------------------------------------------
2080 bool wxRichTextCtrl::SendUpdateEvent()
2082 wxCommandEvent
event(wxEVT_COMMAND_TEXT_UPDATED
, GetId());
2083 InitCommandEvent(event
);
2085 return GetEventHandler()->ProcessEvent(event
);
2088 void wxRichTextCtrl::InitCommandEvent(wxCommandEvent
& event
) const
2090 event
.SetEventObject((wxControlBase
*)this); // const_cast
2092 switch ( m_clientDataType
)
2094 case wxClientData_Void
:
2095 event
.SetClientData(GetClientData());
2098 case wxClientData_Object
:
2099 event
.SetClientObject(GetClientObject());
2102 case wxClientData_None
:
2109 wxSize
wxRichTextCtrl::DoGetBestSize() const
2111 return wxSize(10, 10);
2114 // ----------------------------------------------------------------------------
2115 // standard handlers for standard edit menu events
2116 // ----------------------------------------------------------------------------
2118 void wxRichTextCtrl::OnCut(wxCommandEvent
& WXUNUSED(event
))
2123 void wxRichTextCtrl::OnClear(wxCommandEvent
& WXUNUSED(event
))
2128 void wxRichTextCtrl::OnCopy(wxCommandEvent
& WXUNUSED(event
))
2133 void wxRichTextCtrl::OnPaste(wxCommandEvent
& WXUNUSED(event
))
2138 void wxRichTextCtrl::OnUndo(wxCommandEvent
& WXUNUSED(event
))
2143 void wxRichTextCtrl::OnRedo(wxCommandEvent
& WXUNUSED(event
))
2148 void wxRichTextCtrl::OnUpdateCut(wxUpdateUIEvent
& event
)
2150 event
.Enable( CanCut() );
2153 void wxRichTextCtrl::OnUpdateCopy(wxUpdateUIEvent
& event
)
2155 event
.Enable( CanCopy() );
2158 void wxRichTextCtrl::OnUpdateClear(wxUpdateUIEvent
& event
)
2160 event
.Enable( CanDeleteSelection() );
2163 void wxRichTextCtrl::OnUpdatePaste(wxUpdateUIEvent
& event
)
2165 event
.Enable( CanPaste() );
2168 void wxRichTextCtrl::OnUpdateUndo(wxUpdateUIEvent
& event
)
2170 event
.Enable( CanUndo() );
2171 event
.SetText( GetCommandProcessor()->GetUndoMenuLabel() );
2174 void wxRichTextCtrl::OnUpdateRedo(wxUpdateUIEvent
& event
)
2176 event
.Enable( CanRedo() );
2177 event
.SetText( GetCommandProcessor()->GetRedoMenuLabel() );
2180 void wxRichTextCtrl::OnSelectAll(wxCommandEvent
& WXUNUSED(event
))
2185 void wxRichTextCtrl::OnUpdateSelectAll(wxUpdateUIEvent
& event
)
2187 event
.Enable(GetLastPosition() > 0);
2190 void wxRichTextCtrl::OnContextMenu(wxContextMenuEvent
& WXUNUSED(event
))
2194 m_contextMenu
= new wxMenu
;
2195 m_contextMenu
->Append(wxID_UNDO
, _("&Undo"));
2196 m_contextMenu
->Append(wxID_REDO
, _("&Redo"));
2197 m_contextMenu
->AppendSeparator();
2198 m_contextMenu
->Append(wxID_CUT
, _("Cu&t"));
2199 m_contextMenu
->Append(wxID_COPY
, _("&Copy"));
2200 m_contextMenu
->Append(wxID_PASTE
, _("&Paste"));
2201 m_contextMenu
->Append(wxID_CLEAR
, _("&Delete"));
2202 m_contextMenu
->AppendSeparator();
2203 m_contextMenu
->Append(wxID_SELECTALL
, _("Select &All"));
2205 PopupMenu(m_contextMenu
);
2209 bool wxRichTextCtrl::SetStyle(long start
, long end
, const wxTextAttrEx
& style
)
2211 return GetBuffer().SetStyle(wxRichTextRange(start
, end
), style
);
2214 bool wxRichTextCtrl::SetStyle(long start
, long end
, const wxTextAttr
& style
)
2216 return GetBuffer().SetStyle(wxRichTextRange(start
, end
), wxTextAttrEx(style
));
2219 bool wxRichTextCtrl::SetStyle(const wxRichTextRange
& range
, const wxRichTextAttr
& style
)
2221 return GetBuffer().SetStyle(range
, style
);
2224 bool wxRichTextCtrl::SetDefaultStyle(const wxTextAttrEx
& style
)
2226 return GetBuffer().SetDefaultStyle(style
);
2229 bool wxRichTextCtrl::SetDefaultStyle(const wxTextAttr
& style
)
2231 return GetBuffer().SetDefaultStyle(wxTextAttrEx(style
));
2234 const wxTextAttrEx
& wxRichTextCtrl::GetDefaultStyleEx() const
2236 return GetBuffer().GetDefaultStyle();
2239 const wxTextAttr
& wxRichTextCtrl::GetDefaultStyle() const
2241 return GetBuffer().GetDefaultStyle();
2244 bool wxRichTextCtrl::GetStyle(long position
, wxTextAttr
& style
) const
2247 if (GetBuffer().GetStyle(position
, attr
))
2256 bool wxRichTextCtrl::GetStyle(long position
, wxTextAttrEx
& style
) const
2258 return GetBuffer().GetStyle(position
, style
);
2261 bool wxRichTextCtrl::GetStyle(long position
, wxRichTextAttr
& style
) const
2263 return GetBuffer().GetStyle(position
, style
);
2266 /// Set font, and also the buffer attributes
2267 bool wxRichTextCtrl::SetFont(const wxFont
& font
)
2269 #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
2270 wxControl::SetFont(font
);
2272 wxScrolledWindow::SetFont(font
);
2275 wxTextAttrEx attr
= GetBuffer().GetAttributes();
2277 GetBuffer().SetBasicStyle(attr
);
2278 GetBuffer().SetDefaultStyle(attr
);
2283 /// Transform logical to physical
2284 wxPoint
wxRichTextCtrl::GetPhysicalPoint(const wxPoint
& ptLogical
) const
2287 CalcScrolledPosition(ptLogical
.x
, ptLogical
.y
, & pt
.x
, & pt
.y
);
2292 /// Transform physical to logical
2293 wxPoint
wxRichTextCtrl::GetLogicalPoint(const wxPoint
& ptPhysical
) const
2296 CalcUnscrolledPosition(ptPhysical
.x
, ptPhysical
.y
, & pt
.x
, & pt
.y
);
2301 /// Position the caret
2302 void wxRichTextCtrl::PositionCaret()
2307 //wxLogDebug(wxT("PositionCaret"));
2310 if (GetCaretPositionForIndex(GetCaretPosition(), caretRect
))
2312 wxPoint originalPt
= caretRect
.GetPosition();
2313 wxPoint pt
= GetPhysicalPoint(originalPt
);
2314 if (GetCaret()->GetPosition() != pt
)
2316 GetCaret()->Move(pt
);
2317 GetCaret()->SetSize(caretRect
.GetSize());
2322 /// Get the caret height and position for the given character position
2323 bool wxRichTextCtrl::GetCaretPositionForIndex(long position
, wxRect
& rect
)
2325 wxClientDC
dc(this);
2326 dc
.SetFont(GetFont());
2333 if (GetBuffer().FindPosition(dc
, position
, pt
, & height
, m_caretAtLineStart
))
2335 rect
= wxRect(pt
, wxSize(wxRICHTEXT_DEFAULT_CARET_WIDTH
, height
));
2342 /// Gets the line for the visible caret position. If the caret is
2343 /// shown at the very end of the line, it means the next character is actually
2344 /// on the following line. So let's get the line we're expecting to find
2345 /// if this is the case.
2346 wxRichTextLine
* wxRichTextCtrl::GetVisibleLineForCaretPosition(long caretPosition
) const
2348 wxRichTextLine
* line
= GetBuffer().GetLineAtPosition(caretPosition
, true);
2349 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(caretPosition
, true);
2352 wxRichTextRange lineRange
= line
->GetAbsoluteRange();
2353 if (caretPosition
== lineRange
.GetStart()-1 &&
2354 (para
->GetRange().GetStart() != lineRange
.GetStart()))
2356 if (!m_caretAtLineStart
)
2357 line
= GetBuffer().GetLineAtPosition(caretPosition
-1, true);
2364 /// Move the caret to the given character position
2365 bool wxRichTextCtrl::MoveCaret(long pos
, bool showAtLineStart
)
2367 if (GetBuffer().GetDirty())
2370 if (pos
<= GetBuffer().GetRange().GetEnd())
2372 SetCaretPosition(pos
, showAtLineStart
);
2382 /// Layout the buffer: which we must do before certain operations, such as
2383 /// setting the caret position.
2384 bool wxRichTextCtrl::LayoutContent(bool onlyVisibleRect
)
2386 if (GetBuffer().GetDirty() || onlyVisibleRect
)
2388 wxRect
availableSpace(GetClientSize());
2389 if (availableSpace
.width
== 0)
2390 availableSpace
.width
= 10;
2391 if (availableSpace
.height
== 0)
2392 availableSpace
.height
= 10;
2394 int flags
= wxRICHTEXT_FIXED_WIDTH
|wxRICHTEXT_VARIABLE_HEIGHT
;
2395 if (onlyVisibleRect
)
2397 flags
|= wxRICHTEXT_LAYOUT_SPECIFIED_RECT
;
2398 availableSpace
.SetPosition(GetLogicalPoint(wxPoint(0, 0)));
2401 wxClientDC
dc(this);
2402 dc
.SetFont(GetFont());
2406 GetBuffer().Defragment();
2407 GetBuffer().UpdateRanges(); // If items were deleted, ranges need recalculation
2408 GetBuffer().Layout(dc
, availableSpace
, flags
);
2409 GetBuffer().SetDirty(false);
2418 /// Is all of the selection bold?
2419 bool wxRichTextCtrl::IsSelectionBold() const
2423 wxRichTextAttr attr
;
2424 wxRichTextRange range
= GetSelectionRange();
2425 attr
.SetFlags(wxTEXT_ATTR_FONT_WEIGHT
);
2426 attr
.SetFontWeight(wxBOLD
);
2428 return HasCharacterAttributes(range
, attr
);
2432 // If no selection, then we need to combine current style with default style
2433 // to see what the effect would be if we started typing.
2434 wxRichTextAttr attr
;
2435 attr
.SetFlags(wxTEXT_ATTR_FONT_WEIGHT
);
2437 long pos
= GetAdjustedCaretPosition(GetCaretPosition());
2438 if (GetStyle(pos
, attr
))
2440 if (IsDefaultStyleShowing())
2441 wxRichTextApplyStyle(attr
, GetDefaultStyleEx());
2442 return attr
.GetFontWeight() == wxBOLD
;
2448 /// Is all of the selection italics?
2449 bool wxRichTextCtrl::IsSelectionItalics() const
2453 wxRichTextRange range
= GetSelectionRange();
2454 wxRichTextAttr attr
;
2455 attr
.SetFlags(wxTEXT_ATTR_FONT_ITALIC
);
2456 attr
.SetFontStyle(wxITALIC
);
2458 return HasCharacterAttributes(range
, attr
);
2462 // If no selection, then we need to combine current style with default style
2463 // to see what the effect would be if we started typing.
2464 wxRichTextAttr attr
;
2465 attr
.SetFlags(wxTEXT_ATTR_FONT_ITALIC
);
2467 long pos
= GetAdjustedCaretPosition(GetCaretPosition());
2468 if (GetStyle(pos
, attr
))
2470 if (IsDefaultStyleShowing())
2471 wxRichTextApplyStyle(attr
, GetDefaultStyleEx());
2472 return attr
.GetFontStyle() == wxITALIC
;
2478 /// Is all of the selection underlined?
2479 bool wxRichTextCtrl::IsSelectionUnderlined() const
2483 wxRichTextRange range
= GetSelectionRange();
2484 wxRichTextAttr attr
;
2485 attr
.SetFlags(wxTEXT_ATTR_FONT_UNDERLINE
);
2486 attr
.SetFontUnderlined(true);
2488 return HasCharacterAttributes(range
, attr
);
2492 // If no selection, then we need to combine current style with default style
2493 // to see what the effect would be if we started typing.
2494 wxRichTextAttr attr
;
2495 attr
.SetFlags(wxTEXT_ATTR_FONT_UNDERLINE
);
2497 long pos
= GetAdjustedCaretPosition(GetCaretPosition());
2498 if (GetStyle(pos
, attr
))
2500 if (IsDefaultStyleShowing())
2501 wxRichTextApplyStyle(attr
, GetDefaultStyleEx());
2502 return attr
.GetFontUnderlined();
2508 /// Apply bold to the selection
2509 bool wxRichTextCtrl::ApplyBoldToSelection()
2511 wxRichTextAttr attr
;
2512 attr
.SetFlags(wxTEXT_ATTR_FONT_WEIGHT
);
2513 attr
.SetFontWeight(IsSelectionBold() ? wxNORMAL
: wxBOLD
);
2516 return SetStyle(GetSelectionRange(), attr
);
2518 SetAndShowDefaultStyle(attr
);
2522 /// Apply italic to the selection
2523 bool wxRichTextCtrl::ApplyItalicToSelection()
2525 wxRichTextAttr attr
;
2526 attr
.SetFlags(wxTEXT_ATTR_FONT_ITALIC
);
2527 attr
.SetFontStyle(IsSelectionItalics() ? wxNORMAL
: wxITALIC
);
2530 return SetStyle(GetSelectionRange(), attr
);
2532 SetAndShowDefaultStyle(attr
);
2536 /// Apply underline to the selection
2537 bool wxRichTextCtrl::ApplyUnderlineToSelection()
2539 wxRichTextAttr attr
;
2540 attr
.SetFlags(wxTEXT_ATTR_FONT_UNDERLINE
);
2541 attr
.SetFontUnderlined(!IsSelectionUnderlined());
2544 return SetStyle(GetSelectionRange(), attr
);
2546 SetAndShowDefaultStyle(attr
);
2550 /// Is all of the selection aligned according to the specified flag?
2551 bool wxRichTextCtrl::IsSelectionAligned(wxTextAttrAlignment alignment
) const
2555 wxRichTextRange range
= GetSelectionRange();
2556 wxRichTextAttr attr
;
2557 attr
.SetAlignment(alignment
);
2559 return HasParagraphAttributes(range
, attr
);
2563 // If no selection, then we need to get information from the current paragraph.
2564 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(GetCaretPosition()+1);
2566 return para
->GetAttributes().GetAlignment() == alignment
;
2571 /// Apply alignment to the selection
2572 bool wxRichTextCtrl::ApplyAlignmentToSelection(wxTextAttrAlignment alignment
)
2574 wxRichTextAttr attr
;
2575 attr
.SetAlignment(alignment
);
2577 return SetStyle(GetSelectionRange(), attr
);
2580 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(GetCaretPosition()+1);
2582 return SetStyle(para
->GetRange(), attr
);
2587 /// Apply a named style to the selection
2588 void wxRichTextCtrl::ApplyStyle(wxRichTextStyleDefinition
* def
)
2590 // Flags are defined within each definition, so only certain
2591 // attributes are applied.
2592 wxRichTextAttr
attr(def
->GetStyle());
2594 // Make sure the attr has the style name
2595 if (def
->IsKindOf(CLASSINFO(wxRichTextParagraphStyleDefinition
)))
2596 attr
.SetParagraphStyleName(def
->GetName());
2598 attr
.SetCharacterStyleName(def
->GetName());
2601 SetStyle(GetSelectionRange(), attr
);
2603 SetAndShowDefaultStyle(attr
);
2606 /// Sets the default style to the style under the cursor
2607 bool wxRichTextCtrl::SetDefaultStyleToCursorStyle()
2610 attr
.SetFlags(wxTEXT_ATTR_CHARACTER
);
2612 // If at the start of a paragraph, use the next position.
2613 long pos
= GetAdjustedCaretPosition(GetCaretPosition());
2615 if (GetStyle(pos
, attr
))
2617 SetDefaultStyle(attr
);
2624 /// Returns the first visible position in the current view
2625 long wxRichTextCtrl::GetFirstVisiblePosition() const
2627 wxRichTextLine
* line
= GetBuffer().GetLineAtYPosition(GetLogicalPoint(wxPoint(0, 0)).y
);
2629 return line
->GetAbsoluteRange().GetStart();
2634 /// The adjusted caret position is the character position adjusted to take
2635 /// into account whether we're at the start of a paragraph, in which case
2636 /// style information should be taken from the next position, not current one.
2637 long wxRichTextCtrl::GetAdjustedCaretPosition(long caretPos
) const
2639 wxRichTextParagraph
* para
= GetBuffer().GetParagraphAtPosition(caretPos
+1);
2641 if (para
&& (caretPos
+1 == para
->GetRange().GetStart()))