X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/99257cbe01d32c8bd2e8393ba4ce6a71e5953c7e..fb8d7eb7a880f1f2e32d8830f9c5e12b2536e05f:/src/richtext/richtextctrl.cpp diff --git a/src/richtext/richtextctrl.cpp b/src/richtext/richtextctrl.cpp index f09732ccd2..b330581885 100644 --- a/src/richtext/richtextctrl.cpp +++ b/src/richtext/richtextctrl.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: src/richtext/richeditctrl.cpp +// Name: src/richtext/richtextctrl.cpp // Purpose: A rich edit control // Author: Julian Smart // Modified by: @@ -13,45 +13,150 @@ #include "wx/wxprec.h" #ifdef __BORLANDC__ - #pragma hdrstop + #pragma hdrstop #endif #if wxUSE_RICHTEXT #include "wx/richtext/richtextctrl.h" +#include "wx/richtext/richtextstyles.h" #ifndef WX_PRECOMP - #include "wx/wx.h" + #include "wx/wx.h" + #include "wx/settings.h" #endif +#include "wx/timer.h" #include "wx/textfile.h" #include "wx/ffile.h" -#include "wx/settings.h" #include "wx/filename.h" #include "wx/dcbuffer.h" #include "wx/arrimpl.cpp" +#include "wx/fontenum.h" +#include "wx/accel.h" -DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_ITEM_SELECTED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_ITEM_DESELECTED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_LEFT_CLICK) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_RICHTEXT_RETURN) - -#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE -IMPLEMENT_CLASS( wxRichTextCtrl, wxControl ) +#if defined (__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__) +#define wxHAVE_PRIMARY_SELECTION 1 #else -IMPLEMENT_CLASS( wxRichTextCtrl, wxScrolledWindow ) +#define wxHAVE_PRIMARY_SELECTION 0 #endif -IMPLEMENT_CLASS( wxRichTextEvent, wxNotifyEvent ) +#if wxUSE_CLIPBOARD && wxHAVE_PRIMARY_SELECTION +#include "wx/clipbrd.h" +#endif -#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE -BEGIN_EVENT_TABLE( wxRichTextCtrl, wxControl ) -#else -BEGIN_EVENT_TABLE( wxRichTextCtrl, wxScrolledWindow ) +// DLL options compatibility check: +#include "wx/app.h" +WX_CHECK_BUILD_OPTIONS("wxRichTextCtrl") + +wxDEFINE_EVENT( wxEVT_RICHTEXT_LEFT_CLICK, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_MIDDLE_CLICK, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_RIGHT_CLICK, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_LEFT_DCLICK, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_RETURN, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_CHARACTER, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_DELETE, wxRichTextEvent ); + +wxDEFINE_EVENT( wxEVT_RICHTEXT_STYLESHEET_REPLACING, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_STYLESHEET_REPLACED, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_STYLESHEET_CHANGING, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_STYLESHEET_CHANGED, wxRichTextEvent ); + +wxDEFINE_EVENT( wxEVT_RICHTEXT_CONTENT_INSERTED, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_CONTENT_DELETED, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_STYLE_CHANGED, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_PROPERTIES_CHANGED, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_SELECTION_CHANGED, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_BUFFER_RESET, wxRichTextEvent ); +wxDEFINE_EVENT( wxEVT_RICHTEXT_FOCUS_OBJECT_CHANGED, wxRichTextEvent ); + +#if wxRICHTEXT_USE_OWN_CARET + +/*! + * wxRichTextCaret + * + * This implements a non-flashing cursor in case there + * are platform-specific problems with the generic caret. + * wxRICHTEXT_USE_OWN_CARET is set in richtextbuffer.h. + */ + +class wxRichTextCaret; +class wxRichTextCaretTimer: public wxTimer +{ + public: + wxRichTextCaretTimer(wxRichTextCaret* caret) + { + m_caret = caret; + } + virtual void Notify(); + wxRichTextCaret* m_caret; +}; + +class wxRichTextCaret: public wxCaret +{ +public: + // ctors + // ----- + // default - use Create() + wxRichTextCaret(): m_timer(this) { Init(); } + // creates a block caret associated with the given window + wxRichTextCaret(wxRichTextCtrl *window, int width, int height) + : wxCaret(window, width, height), m_timer(this) { Init(); m_richTextCtrl = window; } + wxRichTextCaret(wxRichTextCtrl *window, const wxSize& size) + : wxCaret(window, size), m_timer(this) { Init(); m_richTextCtrl = window; } + + virtual ~wxRichTextCaret(); + + // implementation + // -------------- + + // called by wxWindow (not using the event tables) + virtual void OnSetFocus(); + virtual void OnKillFocus(); + + // draw the caret on the given DC + void DoDraw(wxDC *dc); + + // get the visible count + int GetVisibleCount() const { return m_countVisible; } + + // delay repositioning + bool GetNeedsUpdate() const { return m_needsUpdate; } + void SetNeedsUpdate(bool needsUpdate = true ) { m_needsUpdate = needsUpdate; } + + void Notify(); + + bool GetRefreshEnabled() const { return m_refreshEnabled; } + void EnableRefresh(bool b) { m_refreshEnabled = b; } + +protected: + virtual void DoShow(); + virtual void DoHide(); + virtual void DoMove(); + virtual void DoSize(); + + // refresh the caret + void Refresh(); + +private: + void Init(); + + int m_xOld, + m_yOld; + bool m_hasFocus; // true => our window has focus + bool m_needsUpdate; // must be repositioned + bool m_flashOn; + wxRichTextCaretTimer m_timer; + wxRichTextCtrl* m_richTextCtrl; + bool m_refreshEnabled; +}; #endif + +IMPLEMENT_DYNAMIC_CLASS( wxRichTextCtrl, wxControl ) + +IMPLEMENT_DYNAMIC_CLASS( wxRichTextEvent, wxNotifyEvent ) + +BEGIN_EVENT_TABLE( wxRichTextCtrl, wxControl ) EVT_PAINT(wxRichTextCtrl::OnPaint) EVT_ERASE_BACKGROUND(wxRichTextCtrl::OnEraseBackground) EVT_IDLE(wxRichTextCtrl::OnIdle) @@ -63,10 +168,13 @@ BEGIN_EVENT_TABLE( wxRichTextCtrl, wxScrolledWindow ) EVT_MIDDLE_DOWN(wxRichTextCtrl::OnMiddleClick) EVT_LEFT_DCLICK(wxRichTextCtrl::OnLeftDClick) EVT_CHAR(wxRichTextCtrl::OnChar) + EVT_KEY_DOWN(wxRichTextCtrl::OnChar) EVT_SIZE(wxRichTextCtrl::OnSize) EVT_SET_FOCUS(wxRichTextCtrl::OnSetFocus) EVT_KILL_FOCUS(wxRichTextCtrl::OnKillFocus) + EVT_MOUSE_CAPTURE_LOST(wxRichTextCtrl::OnCaptureLost) EVT_CONTEXT_MENU(wxRichTextCtrl::OnContextMenu) + EVT_SYS_COLOUR_CHANGED(wxRichTextCtrl::OnSysColourChanged) EVT_MENU(wxID_UNDO, wxRichTextCtrl::OnUndo) EVT_UPDATE_UI(wxID_UNDO, wxRichTextCtrl::OnUpdateUndo) @@ -88,169 +196,312 @@ BEGIN_EVENT_TABLE( wxRichTextCtrl, wxScrolledWindow ) EVT_MENU(wxID_SELECTALL, wxRichTextCtrl::OnSelectAll) EVT_UPDATE_UI(wxID_SELECTALL, wxRichTextCtrl::OnUpdateSelectAll) + + EVT_MENU(wxID_RICHTEXT_PROPERTIES1, wxRichTextCtrl::OnProperties) + EVT_UPDATE_UI(wxID_RICHTEXT_PROPERTIES1, wxRichTextCtrl::OnUpdateProperties) + + EVT_MENU(wxID_RICHTEXT_PROPERTIES2, wxRichTextCtrl::OnProperties) + EVT_UPDATE_UI(wxID_RICHTEXT_PROPERTIES2, wxRichTextCtrl::OnUpdateProperties) + + EVT_MENU(wxID_RICHTEXT_PROPERTIES3, wxRichTextCtrl::OnProperties) + EVT_UPDATE_UI(wxID_RICHTEXT_PROPERTIES3, wxRichTextCtrl::OnUpdateProperties) + END_EVENT_TABLE() /*! * wxRichTextCtrl */ +wxArrayString wxRichTextCtrl::sm_availableFontNames; + wxRichTextCtrl::wxRichTextCtrl() -#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE - : wxScrollHelper(this) -#endif + : wxScrollHelper(this) { Init(); } -wxRichTextCtrl::wxRichTextCtrl( wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style) -#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE - : wxScrollHelper(this) -#endif +wxRichTextCtrl::wxRichTextCtrl(wxWindow* parent, + wxWindowID id, + const wxString& value, + const wxPoint& pos, + const wxSize& size, + long style, + const wxValidator& validator, + const wxString& name) + : wxScrollHelper(this) { Init(); - Create(parent, id, pos, size, style); + Create(parent, id, value, pos, size, style, validator, name); } /// Creation -bool wxRichTextCtrl::Create( wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style) +bool wxRichTextCtrl::Create( wxWindow* parent, wxWindowID id, const wxString& value, const wxPoint& pos, const wxSize& size, long style, + const wxValidator& validator, const wxString& name) { -#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE - if (!wxTextCtrlBase::Create(parent, id, pos, size, style|wxFULL_REPAINT_ON_RESIZE - )) - return false; -#else - if (!wxScrolledWindow::Create(parent, id, pos, size, style|wxFULL_REPAINT_ON_RESIZE - )) + style |= wxVSCROLL; + + if (!wxControl::Create(parent, id, pos, size, + style|wxFULL_REPAINT_ON_RESIZE, + validator, name)) return false; -#endif - if (!GetFont().Ok()) + if (!GetFont().IsOk()) { SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT)); } - GetBuffer().SetRichTextCtrl(this); + // No physical scrolling, so we can preserve margins + EnableScrolling(false, false); + + if (style & wxTE_READONLY) + SetEditable(false); - wxTextAttrEx attributes; + // The base attributes must all have default values + wxRichTextAttr attributes; attributes.SetFont(GetFont()); - attributes.SetTextColour(*wxBLACK); - attributes.SetBackgroundColour(*wxWHITE); + attributes.SetTextColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT)); attributes.SetAlignment(wxTEXT_ALIGNMENT_LEFT); - attributes.SetFlags(wxTEXT_ATTR_ALL); - - SetDefaultStyle(attributes); + attributes.SetLineSpacing(10); + attributes.SetParagraphSpacingAfter(10); + attributes.SetParagraphSpacingBefore(0); SetBasicStyle(attributes); - SetBackgroundColour(*wxWHITE); + int margin = 5; + SetMargins(margin, margin); + + // The default attributes will be merged with base attributes, so + // can be empty to begin with + wxRichTextAttr defaultAttributes; + SetDefaultStyle(defaultAttributes); + + SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW)); SetBackgroundStyle(wxBG_STYLE_CUSTOM); + GetBuffer().Reset(); + GetBuffer().SetRichTextCtrl(this); + +#if wxRICHTEXT_USE_OWN_CARET + SetCaret(new wxRichTextCaret(this, wxRICHTEXT_DEFAULT_CARET_WIDTH, 16)); +#else + SetCaret(new wxCaret(this, wxRICHTEXT_DEFAULT_CARET_WIDTH, 16)); +#endif + // Tell the sizers to use the given or best size - SetBestFittingSize(size); + SetInitialSize(size); +#if wxRICHTEXT_BUFFERED_PAINTING // Create a buffer RecreateBuffer(size); +#endif + + m_textCursor = wxCursor(wxCURSOR_IBEAM); + m_urlCursor = wxCursor(wxCURSOR_HAND); + + SetCursor(m_textCursor); + + if (!value.IsEmpty()) + SetValue(value); - SetCursor(wxCursor(wxCURSOR_IBEAM)); + GetBuffer().AddEventHandler(this); + + // Accelerators + wxAcceleratorEntry entries[6]; + + entries[0].Set(wxACCEL_CTRL, (int) 'C', wxID_COPY); + entries[1].Set(wxACCEL_CTRL, (int) 'X', wxID_CUT); + entries[2].Set(wxACCEL_CTRL, (int) 'V', wxID_PASTE); + entries[3].Set(wxACCEL_CTRL, (int) 'A', wxID_SELECTALL); + entries[4].Set(wxACCEL_CTRL, (int) 'Z', wxID_UNDO); + entries[5].Set(wxACCEL_CTRL, (int) 'Y', wxID_REDO); + + wxAcceleratorTable accel(6, entries); + SetAcceleratorTable(accel); + + m_contextMenu = new wxMenu; + m_contextMenu->Append(wxID_UNDO, _("&Undo")); + m_contextMenu->Append(wxID_REDO, _("&Redo")); + m_contextMenu->AppendSeparator(); + m_contextMenu->Append(wxID_CUT, _("Cu&t")); + m_contextMenu->Append(wxID_COPY, _("&Copy")); + m_contextMenu->Append(wxID_PASTE, _("&Paste")); + m_contextMenu->Append(wxID_CLEAR, _("&Delete")); + m_contextMenu->AppendSeparator(); + m_contextMenu->Append(wxID_SELECTALL, _("Select &All")); + m_contextMenu->AppendSeparator(); + m_contextMenu->Append(wxID_RICHTEXT_PROPERTIES1, _("&Properties")); + +#if wxUSE_DRAG_AND_DROP + SetDropTarget(new wxRichTextDropTarget(this)); +#endif return true; } wxRichTextCtrl::~wxRichTextCtrl() { + SetFocusObject(& GetBuffer(), false); + GetBuffer().RemoveEventHandler(this); + delete m_contextMenu; } /// Member initialisation void wxRichTextCtrl::Init() { - m_freezeCount = 0; m_contextMenu = NULL; m_caret = NULL; m_caretPosition = -1; - m_selectionRange.SetRange(-2, -2); m_selectionAnchor = -2; + m_selectionAnchorObject = NULL; + m_selectionState = wxRichTextCtrlSelectionState_Normal; m_editable = true; + m_useVirtualAttributes = false; + m_verticalScrollbarEnabled = true; m_caretAtLineStart = false; m_dragging = false; +#if wxUSE_DRAG_AND_DROP + m_preDrag = false; +#endif m_fullLayoutRequired = false; m_fullLayoutTime = 0; m_fullLayoutSavedPosition = 0; m_delayedLayoutThreshold = wxRICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD; + m_caretPositionForDefaultStyle = -2; + m_focusObject = & m_buffer; + m_scale = 1.0; } -/// Call Freeze to prevent refresh -void wxRichTextCtrl::Freeze() +void wxRichTextCtrl::DoThaw() { - m_freezeCount ++; -} - -/// Call Thaw to refresh -void wxRichTextCtrl::Thaw() -{ - m_freezeCount --; - - if (m_freezeCount == 0) - { + if (GetBuffer().IsDirty()) + LayoutContent(); + else SetupScrollbars(); - Refresh(false); - } + + wxWindow::DoThaw(); } /// Clear all text void wxRichTextCtrl::Clear() { - m_buffer.Reset(); - m_buffer.SetDirty(true); + if (GetFocusObject() == & GetBuffer()) + { + m_buffer.ResetAndClearCommands(); + m_buffer.Invalidate(wxRICHTEXT_ALL); + } + else + { + GetFocusObject()->Reset(); + } + m_caretPosition = -1; + m_caretPositionForDefaultStyle = -2; m_caretAtLineStart = false; - m_selectionRange.SetRange(-2, -2); + m_selection.Reset(); + m_selectionState = wxRichTextCtrlSelectionState_Normal; - if (m_freezeCount == 0) + Scroll(0,0); + + if (!IsFrozen()) { - SetupScrollbars(); + LayoutContent(); Refresh(false); } - SendUpdateEvent(); + + wxTextCtrl::SendTextUpdatedEvent(this); } /// Painting void wxRichTextCtrl::OnPaint(wxPaintEvent& WXUNUSED(event)) { - if (GetCaret()) +#if !wxRICHTEXT_USE_OWN_CARET + if (GetCaret() && !IsFrozen()) GetCaret()->Hide(); +#else + // Stop the caret refreshing the control from within the + // paint handler + if (GetCaret()) + ((wxRichTextCaret*) GetCaret())->EnableRefresh(false); +#endif { +#if wxRICHTEXT_BUFFERED_PAINTING wxBufferedPaintDC dc(this, m_bufferBitmap); - //wxLogDebug(wxT("OnPaint")); - - PrepareDC(dc); +#else + wxPaintDC dc(this); +#endif - if (m_freezeCount > 0) + if (IsFrozen()) return; + PrepareDC(dc); + dc.SetFont(GetFont()); + wxRect drawingArea(GetUpdateRegion().GetBox()); + drawingArea.SetPosition(GetUnscaledPoint(GetLogicalPoint(drawingArea.GetPosition()))); + drawingArea.SetSize(GetUnscaledSize(drawingArea.GetSize())); + + wxRect availableSpace(GetUnscaledSize(GetClientSize())); + wxRichTextDrawingContext context(& GetBuffer()); + if (GetBuffer().IsDirty()) + { + dc.SetUserScale(GetScale(), GetScale()); + + GetBuffer().Layout(dc, context, availableSpace, availableSpace, wxRICHTEXT_FIXED_WIDTH|wxRICHTEXT_VARIABLE_HEIGHT); + GetBuffer().Invalidate(wxRICHTEXT_NONE); + + dc.SetUserScale(1.0, 1.0); + + SetupScrollbars(); + } + // Paint the background PaintBackground(dc); - wxRegion dirtyRegion = GetUpdateRegion(); + wxRect clipRect(availableSpace); + clipRect.x += GetBuffer().GetLeftMargin(); + clipRect.y += GetBuffer().GetTopMargin(); + clipRect.width -= (GetBuffer().GetLeftMargin() + GetBuffer().GetRightMargin()); + clipRect.height -= (GetBuffer().GetTopMargin() + GetBuffer().GetBottomMargin()); + + clipRect = GetScaledRect(clipRect); + clipRect.SetPosition(GetLogicalPoint(clipRect.GetPosition())); - wxRect drawingArea(GetLogicalPoint(wxPoint(0, 0)), GetClientSize()); - wxRect availableSpace(GetClientSize()); - if (GetBuffer().GetDirty()) + dc.SetClippingRegion(clipRect); + + int flags = 0; + if ((GetExtraStyle() & wxRICHTEXT_EX_NO_GUIDELINES) == 0) + flags |= wxRICHTEXT_DRAW_GUIDELINES; + + dc.SetUserScale(GetScale(), GetScale()); + + GetBuffer().Draw(dc, context, GetBuffer().GetOwnRange(), GetSelection(), drawingArea, 0 /* descent */, flags); + + dc.DestroyClippingRegion(); + + // Other user defined painting after everything else (i.e. all text) is painted + PaintAboveContent(dc); + +#if wxRICHTEXT_USE_OWN_CARET + if (GetCaret()->IsVisible()) { - GetBuffer().Layout(dc, availableSpace, wxRICHTEXT_FIXED_WIDTH|wxRICHTEXT_VARIABLE_HEIGHT); - GetBuffer().SetDirty(false); - SetupScrollbars(); + PositionCaret(); + ((wxRichTextCaret*) GetCaret())->DoDraw(& dc); } +#endif - GetBuffer().Draw(dc, GetBuffer().GetRange(), GetSelectionRange(), drawingArea, 0 /* descent */, 0 /* flags */); + dc.SetUserScale(1.0, 1.0); } +#if !wxRICHTEXT_USE_OWN_CARET if (GetCaret()) GetCaret()->Show(); - PositionCaret(); +#else + if (GetCaret()) + ((wxRichTextCaret*) GetCaret())->EnableRefresh(true); +#endif } // Empty implementation, to prevent flicker @@ -260,21 +511,67 @@ void wxRichTextCtrl::OnEraseBackground(wxEraseEvent& WXUNUSED(event)) void wxRichTextCtrl::OnSetFocus(wxFocusEvent& WXUNUSED(event)) { - wxCaret* caret = new wxCaret(this, wxRICHTEXT_DEFAULT_CARET_WIDTH, 16); - SetCaret(caret); - caret->Show(); - PositionCaret(); + if (GetCaret()) + { +#if !wxRICHTEXT_USE_OWN_CARET + PositionCaret(); +#endif + GetCaret()->Show(); + } +#if defined(__WXGTK__) && !wxRICHTEXT_USE_OWN_CARET + // Work around dropouts when control is focused if (!IsFrozen()) + { Refresh(false); + } +#endif } void wxRichTextCtrl::OnKillFocus(wxFocusEvent& WXUNUSED(event)) { - SetCaret(NULL); + if (GetCaret()) + GetCaret()->Hide(); +#if defined(__WXGTK__) && !wxRICHTEXT_USE_OWN_CARET + // Work around dropouts when control is focused if (!IsFrozen()) + { Refresh(false); + } +#endif +} + +void wxRichTextCtrl::OnCaptureLost(wxMouseCaptureLostEvent& WXUNUSED(event)) +{ + m_dragging = false; +} + +// Set up the caret for the given position and container, after a mouse click +bool wxRichTextCtrl::SetCaretPositionAfterClick(wxRichTextParagraphLayoutBox* container, long position, int hitTestFlags, bool extendSelection) +{ + bool caretAtLineStart = false; + + if (hitTestFlags & wxRICHTEXT_HITTEST_BEFORE) + { + // If we're at the start of a line (but not first in para) + // then we should keep the caret showing at the start of the line + // by showing the m_caretAtLineStart flag. + wxRichTextParagraph* para = container->GetParagraphAtPosition(position); + wxRichTextLine* line = container->GetLineAtPosition(position); + + if (line && para && line->GetAbsoluteRange().GetStart() == position && para->GetRange().GetStart() != position) + caretAtLineStart = true; + position --; + } + + if (extendSelection && (m_caretPosition != position)) + ExtendSelection(m_caretPosition, position, wxRICHTEXT_SHIFT_DOWN); + + MoveCaret(position, caretAtLineStart); + SetDefaultStyleToCursorStyle(); + + return true; } /// Left-click @@ -286,2253 +583,4420 @@ void wxRichTextCtrl::OnLeftClick(wxMouseEvent& event) PrepareDC(dc); dc.SetFont(GetFont()); + // TODO: detect change of focus object long position = 0; - int hit = GetBuffer().HitTest(dc, event.GetLogicalPosition(dc), position); - - if (hit != wxRICHTEXT_HITTEST_NONE) + wxRichTextObject* hitObj = NULL; + wxRichTextObject* contextObj = NULL; + wxRichTextDrawingContext context(& GetBuffer()); + int hit = GetBuffer().HitTest(dc, context, GetUnscaledPoint(event.GetLogicalPosition(dc)), position, & hitObj, & contextObj, wxRICHTEXT_HITTEST_HONOUR_ATOMIC); + +#if wxUSE_DRAG_AND_DROP + // If there's no selection, or we're not inside it, this isn't an attempt to initiate Drag'n'Drop + if (IsEditable() && HasSelection() && GetSelectionRange().ToInternal().Contains(position)) { - m_dragStart = event.GetLogicalPosition(dc); - m_dragging = true; - CaptureMouse(); + // This might be an attempt at initiating Drag'n'Drop. So set the time & flags + m_preDrag = true; + m_dragStartPoint = event.GetPosition(); // No need to worry about logical positions etc, we only care about the distance from the original pt - SelectNone(); +#if wxUSE_DATETIME + m_dragStartTime = wxDateTime::UNow(); +#endif // wxUSE_DATETIME - bool caretAtLineStart = false; + // Preserve behaviour of clicking on an object within the selection + if (hit != wxRICHTEXT_HITTEST_NONE && hitObj) + m_dragging = true; - if (hit & wxRICHTEXT_HITTEST_BEFORE) - { - // If we're at the start of a line (but not first in para) - // then we should keep the caret showing at the start of the line - // by showing the m_caretAtLineStart flag. - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(position); - wxRichTextLine* line = GetBuffer().GetLineAtPosition(position); + return; // Don't skip the event, else the selection will be lost + } +#endif // wxUSE_DRAG_AND_DROP - if (line && para && line->GetAbsoluteRange().GetStart() == position && para->GetRange().GetStart() != position) - caretAtLineStart = true; - position --; + if (hit != wxRICHTEXT_HITTEST_NONE && hitObj) + { + wxRichTextParagraphLayoutBox* oldFocusObject = GetFocusObject(); + wxRichTextParagraphLayoutBox* container = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox); + if (container && container != GetFocusObject() && container->AcceptsFocus()) + { + SetFocusObject(container, false /* don't set caret position yet */); } - MoveCaret(position, caretAtLineStart); - SetDefaultStyleToCursorStyle(); + m_dragging = true; + CaptureMouse(); -#if 0 - wxWindow* p = GetParent(); - while (p && !p->IsKindOf(CLASSINFO(wxFrame))) - p = p->GetParent(); + long oldCaretPos = m_caretPosition; - wxFrame* frame = wxDynamicCast(p, wxFrame); - if (frame) - { - wxString msg = wxString::Format(wxT("Found position %ld"), position); - frame->SetStatusText(msg, 1); - } -#endif + SetCaretPositionAfterClick(container, position, hit); + + // For now, don't handle shift-click when we're selecting multiple objects. + if (event.ShiftDown() && GetFocusObject() == oldFocusObject && m_selectionState == wxRichTextCtrlSelectionState_Normal) + ExtendSelection(oldCaretPos, m_caretPosition, wxRICHTEXT_SHIFT_DOWN); + else + SelectNone(); } event.Skip(); } /// Left-up -void wxRichTextCtrl::OnLeftUp(wxMouseEvent& WXUNUSED(event)) +void wxRichTextCtrl::OnLeftUp(wxMouseEvent& event) { if (m_dragging) { m_dragging = false; if (GetCapture() == this) ReleaseMouse(); - } -} - -/// Left-click -void wxRichTextCtrl::OnMoveMouse(wxMouseEvent& event) -{ - if (!event.Dragging()) - { - event.Skip(); - return; - } - wxClientDC dc(this); - PrepareDC(dc); - dc.SetFont(GetFont()); + // See if we clicked on a URL + wxClientDC dc(this); + PrepareDC(dc); + dc.SetFont(GetFont()); - long position = 0; - wxPoint logicalPt = event.GetLogicalPosition(dc); - int hit = GetBuffer().HitTest(dc, logicalPt, position); + long position = 0; + wxPoint logicalPt = event.GetLogicalPosition(dc); + wxRichTextObject* hitObj = NULL; + wxRichTextObject* contextObj = NULL; + wxRichTextDrawingContext context(& GetBuffer()); + // Only get objects at this level, not nested, because otherwise we couldn't swipe text at a single level. + int hit = GetFocusObject()->HitTest(dc, context, GetUnscaledPoint(logicalPt), position, & hitObj, & contextObj, wxRICHTEXT_HITTEST_NO_NESTED_OBJECTS|wxRICHTEXT_HITTEST_HONOUR_ATOMIC); - if (m_dragging && hit != wxRICHTEXT_HITTEST_NONE) - { - // TODO: test closeness +#if wxUSE_DRAG_AND_DROP + if (m_preDrag) + { + // Preserve the behaviour that would have happened without drag-and-drop detection, in OnLeftClick + m_preDrag = false; // Tell DnD not to happen now: we are processing Left Up ourselves. + + // Do the actions that would have been done in OnLeftClick if we hadn't tried to drag + long position = 0; + wxRichTextObject* hitObj = NULL; + wxRichTextObject* contextObj = NULL; + int hit = GetBuffer().HitTest(dc, context, GetUnscaledPoint(event.GetLogicalPosition(dc)), position, & hitObj, & contextObj, wxRICHTEXT_HITTEST_HONOUR_ATOMIC); + wxRichTextParagraphLayoutBox* oldFocusObject = GetFocusObject(); + wxRichTextParagraphLayoutBox* container = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox); + if (container && container != GetFocusObject() && container->AcceptsFocus()) + { + SetFocusObject(container, false /* don't set caret position yet */); + } - bool caretAtLineStart = false; + long oldCaretPos = m_caretPosition; - if (hit & wxRICHTEXT_HITTEST_BEFORE) - { - // If we're at the start of a line (but not first in para) - // then we should keep the caret showing at the start of the line - // by showing the m_caretAtLineStart flag. - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(position); - wxRichTextLine* line = GetBuffer().GetLineAtPosition(position); + SetCaretPositionAfterClick(container, position, hit); - if (line && para && line->GetAbsoluteRange().GetStart() == position && para->GetRange().GetStart() != position) - caretAtLineStart = true; - position --; + // For now, don't handle shift-click when we're selecting multiple objects. + if (event.ShiftDown() && GetFocusObject() == oldFocusObject && m_selectionState == wxRichTextCtrlSelectionState_Normal) + ExtendSelection(oldCaretPos, m_caretPosition, wxRICHTEXT_SHIFT_DOWN); + else + SelectNone(); } +#endif - if (m_caretPosition != position) + if ((hit != wxRICHTEXT_HITTEST_NONE) && !(hit & wxRICHTEXT_HITTEST_OUTSIDE)) { - bool extendSel = ExtendSelection(m_caretPosition, position, wxRICHTEXT_SHIFT_DOWN); - - MoveCaret(position, caretAtLineStart); - SetDefaultStyleToCursorStyle(); - - if (extendSel) - Refresh(false); + wxRichTextEvent cmdEvent( + wxEVT_RICHTEXT_LEFT_CLICK, + GetId()); + cmdEvent.SetEventObject(this); + cmdEvent.SetPosition(position); + if (hitObj) + cmdEvent.SetContainer(hitObj->GetContainer()); + + if (!GetEventHandler()->ProcessEvent(cmdEvent)) + { + wxRichTextAttr attr; + if (GetStyle(position, attr)) + { + if (attr.HasFlag(wxTEXT_ATTR_URL)) + { + wxString urlTarget = attr.GetURL(); + if (!urlTarget.IsEmpty()) + { + wxMouseEvent mouseEvent(event); + + long startPos = 0, endPos = 0; + wxRichTextObject* obj = GetFocusObject()->GetLeafObjectAtPosition(position); + if (obj) + { + startPos = obj->GetRange().GetStart(); + endPos = obj->GetRange().GetEnd(); + } + + wxTextUrlEvent urlEvent(GetId(), mouseEvent, startPos, endPos); + InitCommandEvent(urlEvent); + + urlEvent.SetString(urlTarget); + + GetEventHandler()->ProcessEvent(urlEvent); + } + } + } + } } } -} -/// Right-click -void wxRichTextCtrl::OnRightClick(wxMouseEvent& event) -{ - SetFocus(); - event.Skip(); -} +#if wxUSE_DRAG_AND_DROP + m_preDrag = false; +#endif // wxUSE_DRAG_AND_DROP -/// Left-double-click -void wxRichTextCtrl::OnLeftDClick(wxMouseEvent& event) -{ - event.Skip(); -} +#if wxUSE_CLIPBOARD && wxUSE_DATAOBJ && wxHAVE_PRIMARY_SELECTION + if (HasSelection() && GetFocusObject() && GetFocusObject()->GetBuffer()) + { + // Put the selection in PRIMARY, if it exists + wxTheClipboard->UsePrimarySelection(true); -/// Middle-click -void wxRichTextCtrl::OnMiddleClick(wxMouseEvent& event) -{ - event.Skip(); + wxRichTextRange range = GetInternalSelectionRange(); + GetFocusObject()->GetBuffer()->CopyToClipboard(range); + + wxTheClipboard->UsePrimarySelection(false); + } +#endif } -/// Key press -void wxRichTextCtrl::OnChar(wxKeyEvent& event) +/// Mouse-movements +void wxRichTextCtrl::OnMoveMouse(wxMouseEvent& event) { - int flags = 0; - if (event.ControlDown()) - flags |= wxRICHTEXT_CTRL_DOWN; - if (event.ShiftDown()) - flags |= wxRICHTEXT_SHIFT_DOWN; - if (event.AltDown()) - flags |= wxRICHTEXT_ALT_DOWN; - - if (event.GetKeyCode() == WXK_LEFT || - event.GetKeyCode() == WXK_RIGHT || - event.GetKeyCode() == WXK_UP || - event.GetKeyCode() == WXK_DOWN || - event.GetKeyCode() == WXK_HOME || - event.GetKeyCode() == WXK_PAGEUP || - event.GetKeyCode() == WXK_PAGEDOWN || - event.GetKeyCode() == WXK_END) + if (!event.Dragging() && m_dragging) { - KeyboardNavigate(event.GetKeyCode(), flags); - return; + // We may have accidentally lost a mouse-up event, especially on Linux + m_dragging = false; + if (GetCapture() == this) + ReleaseMouse(); } - // all the other keys modify the controls contents which shouldn't be - // possible if we're read-only - if ( !IsEditable() ) +#if wxUSE_DRAG_AND_DROP + size_t distance = 0; + if (m_preDrag || m_dragging) { - event.Skip(); - return; + int x = m_dragStartPoint.x - event.GetPosition().x; + int y = m_dragStartPoint.y - event.GetPosition().y; + distance = abs(x) + abs(y); } - if (event.GetKeyCode() == WXK_RETURN) + // See if we're starting Drag'n'Drop + if (m_preDrag) { - BeginBatchUndo(_("Insert Text")); +#if wxUSE_DATETIME + wxTimeSpan diff = wxDateTime::UNow() - m_dragStartTime; +#endif + if ((distance > 10) +#if wxUSE_DATETIME + && (diff.GetMilliseconds() > 100) +#endif + ) + { + m_dragging = false; - long newPos = m_caretPosition; + // Start drag'n'drop + wxRichTextRange range = GetInternalSelectionRange(); + if (range == wxRICHTEXT_NONE) + { + // Don't try to drag an empty range + m_preDrag = false; + return; + } - DeleteSelectedContent(& newPos); + // Cache the current situation, to be restored if Drag'n'Drop is cancelled + long oldPos = GetCaretPosition(); + wxRichTextParagraphLayoutBox* oldFocus = GetFocusObject(); - GetBuffer().InsertNewlineWithUndo(newPos+1, this); + wxDataObjectComposite* compositeObject = new wxDataObjectComposite(); + wxString text = GetFocusObject()->GetTextForRange(range); +#ifdef __WXMSW__ + text = wxTextFile::Translate(text, wxTextFileType_Dos); +#endif + compositeObject->Add(new wxTextDataObject(text), false /* not preferred */); - wxRichTextEvent cmdEvent( - wxEVT_COMMAND_RICHTEXT_RETURN, - GetId()); - cmdEvent.SetEventObject(this); - cmdEvent.SetFlags(flags); - GetEventHandler()->ProcessEvent(cmdEvent); + wxRichTextBuffer* richTextBuf = new wxRichTextBuffer; + GetFocusObject()->CopyFragment(range, *richTextBuf); + compositeObject->Add(new wxRichTextBufferDataObject(richTextBuf), true /* preferred */); - EndBatchUndo(); - SetDefaultStyleToCursorStyle(); + wxRichTextDropSource source(*compositeObject, this); + // Use wxDrag_DefaultMove, not because it's the likelier choice but because pressing Ctrl for Copy obeys the principle of least surprise + // The alternative, wxDrag_DefaultCopy, requires the user to know that Move needs the Shift key pressed + BeginBatchUndo(_("Drag")); + switch (source.DoDragDrop(wxDrag_AllowMove | wxDrag_DefaultMove)) + { + case wxDragMove: + case wxDragCopy: break; + + case wxDragError: + wxLogError(wxT("An error occurred during drag and drop operation")); + case wxDragNone: + case wxDragCancel: + Refresh(); // This is needed in wxMSW, otherwise resetting the position doesn't 'take' + SetCaretPosition(oldPos); + SetFocusObject(oldFocus, false); + default: break; + } + EndBatchUndo(); - ScrollIntoView(m_caretPosition, WXK_RIGHT); + m_preDrag = false; + return; + } } - else if (event.GetKeyCode() == WXK_BACK) - { - BeginBatchUndo(_("Delete Text")); +#endif // wxUSE_DRAG_AND_DROP - // Submit range in character positions, which are greater than caret positions, - // so subtract 1 for deleted character and add 1 for conversion to character position. - if (m_caretPosition > -1 && !HasSelection()) - { - GetBuffer().DeleteRangeWithUndo(wxRichTextRange(m_caretPosition, m_caretPosition), - m_caretPosition, // Current caret position - m_caretPosition-1, // New caret position - this); - } - else - DeleteSelectedContent(); + wxClientDC dc(this); + PrepareDC(dc); + dc.SetFont(GetFont()); - EndBatchUndo(); + long position = 0; + wxPoint logicalPt = event.GetLogicalPosition(dc); + wxRichTextObject* hitObj = NULL; + wxRichTextObject* contextObj = NULL; - // Shouldn't this be in Do()? - if (GetLastPosition() == -1) - { - GetBuffer().Reset(); - - m_caretPosition = -1; - PositionCaret(); - SetDefaultStyleToCursorStyle(); - } + int flags = 0; - ScrollIntoView(m_caretPosition, WXK_LEFT); - } - else if (event.GetKeyCode() == WXK_DELETE) + // If we're dragging, let's only consider positions at this level; otherwise + // selecting a range is not going to work. + wxRichTextParagraphLayoutBox* container = & GetBuffer(); + if (m_dragging) { - BeginBatchUndo(_("Delete Text")); + flags = wxRICHTEXT_HITTEST_NO_NESTED_OBJECTS; + container = GetFocusObject(); + } + wxRichTextDrawingContext context(& GetBuffer()); + int hit = container->HitTest(dc, context, GetUnscaledPoint(logicalPt), position, & hitObj, & contextObj, flags); - // Submit range in character positions, which are greater than caret positions, - if (m_caretPosition < GetBuffer().GetRange().GetEnd()+1 && !HasSelection()) + // See if we need to change the cursor + + { + if (hit != wxRICHTEXT_HITTEST_NONE && !(hit & wxRICHTEXT_HITTEST_OUTSIDE) && hitObj) { - GetBuffer().DeleteRangeWithUndo(wxRichTextRange(m_caretPosition+1, m_caretPosition+1), - m_caretPosition, // Current caret position - m_caretPosition+1, // New caret position - this); + wxRichTextParagraphLayoutBox* actualContainer = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox); + if (actualContainer) + ProcessMouseMovement(actualContainer, hitObj, position, logicalPt); } else - DeleteSelectedContent(); - - EndBatchUndo(); - - // Shouldn't this be in Do()? - if (GetLastPosition() == -1) - { - GetBuffer().Reset(); + SetCursor(m_textCursor); + } - m_caretPosition = -1; - PositionCaret(); - SetDefaultStyleToCursorStyle(); - } + if (!event.Dragging()) + { + event.Skip(); + return; } - else + + if (m_dragging +#if wxUSE_DRAG_AND_DROP + && !m_preDrag + && (distance > 4) +#endif + ) { - BeginBatchUndo(_("Insert Text")); + wxRichTextParagraphLayoutBox* commonAncestor = NULL; + wxRichTextParagraphLayoutBox* otherContainer = NULL; + wxRichTextParagraphLayoutBox* firstContainer = NULL; + + // Check for dragging across multiple containers + long position2 = 0; + wxRichTextObject* hitObj2 = NULL, *contextObj2 = NULL; + int hit2 = GetBuffer().HitTest(dc, context, GetUnscaledPoint(logicalPt), position2, & hitObj2, & contextObj2, 0); + if (hit2 != wxRICHTEXT_HITTEST_NONE && !(hit2 & wxRICHTEXT_HITTEST_OUTSIDE) && hitObj2 && hitObj != hitObj2) + { + // See if we can find a common ancestor + if (m_selectionState == wxRichTextCtrlSelectionState_Normal) + { + firstContainer = GetFocusObject(); + commonAncestor = wxDynamicCast(firstContainer->GetParent(), wxRichTextParagraphLayoutBox); + } + else + { + firstContainer = wxDynamicCast(m_selectionAnchorObject, wxRichTextParagraphLayoutBox); + //commonAncestor = GetFocusObject(); // when the selection state is not normal, the focus object (e.g. table) + // is the common ancestor. + commonAncestor = wxDynamicCast(firstContainer->GetParent(), wxRichTextParagraphLayoutBox); + } - long newPos = m_caretPosition; - DeleteSelectedContent(& newPos); + if (commonAncestor && commonAncestor->HandlesChildSelections()) + { + wxRichTextObject* p = hitObj2; + while (p) + { + if (p->GetParent() == commonAncestor) + { + otherContainer = wxDynamicCast(p, wxRichTextParagraphLayoutBox); + break; + } + p = p->GetParent(); + } + } - wxString str = (wxChar) event.GetKeyCode(); - GetBuffer().InsertTextWithUndo(newPos+1, str, this); + if (commonAncestor && firstContainer && otherContainer) + { + // We have now got a second container that shares a parent with the current or anchor object. + if (m_selectionState == wxRichTextCtrlSelectionState_Normal) + { + // Don't go into common-ancestor selection mode if we still have the same + // container. + if (otherContainer != firstContainer) + { + m_selectionState = wxRichTextCtrlSelectionState_CommonAncestor; + m_selectionAnchorObject = firstContainer; + m_selectionAnchor = firstContainer->GetRange().GetStart(); + + // The common ancestor, such as a table, returns the cell selection + // between the anchor and current position. + m_selection = commonAncestor->GetSelection(m_selectionAnchor, otherContainer->GetRange().GetStart()); + } + } + else + { + m_selection = commonAncestor->GetSelection(m_selectionAnchor, otherContainer->GetRange().GetStart()); + } - EndBatchUndo(); + Refresh(); - SetDefaultStyleToCursorStyle(); - ScrollIntoView(m_caretPosition, WXK_RIGHT); + if (otherContainer->AcceptsFocus()) + SetFocusObject(otherContainer, false /* don't set caret and clear selection */); + MoveCaret(-1, false); + SetDefaultStyleToCursorStyle(); + } + } } -} -/// Delete content if there is a selection, e.g. when pressing a key. -bool wxRichTextCtrl::DeleteSelectedContent(long* newPos) -{ - if (HasSelection()) + if (hitObj && m_dragging && hit != wxRICHTEXT_HITTEST_NONE && m_selectionState == wxRichTextCtrlSelectionState_Normal +#if wxUSE_DRAG_AND_DROP + && !m_preDrag + && (distance > 4) +#endif + ) { - long pos = m_selectionRange.GetStart(); - GetBuffer().DeleteRangeWithUndo(m_selectionRange, - m_caretPosition, // Current caret position - pos, // New caret position - this); - m_selectionRange.SetRange(-2, -2); - - if (newPos) - *newPos = pos-1; - return true; + SetCaretPositionAfterClick(container, position, hit, true /* extend selection */); } - else - return false; } -/// Keyboard navigation - -/* - -Left: left one character -Right: right one character -Up: up one line -Down: down one line -Ctrl-Left: left one word -Ctrl-Right: right one word -Ctrl-Up: previous paragraph start -Ctrl-Down: next start of paragraph -Home: start of line -End: end of line -Ctrl-Home: start of document -Ctrl-End: end of document -Page-Up: Up a screen -Page-Down: Down a screen +/// Right-click +void wxRichTextCtrl::OnRightClick(wxMouseEvent& event) +{ + SetFocus(); -Maybe: + wxClientDC dc(this); + PrepareDC(dc); + dc.SetFont(GetFont()); -Ctrl-Alt-PgUp: Start of window -Ctrl-Alt-PgDn: End of window -F8: Start selection mode -Esc: End selection mode + long position = 0; + wxPoint logicalPt = event.GetLogicalPosition(dc); + wxRichTextObject* hitObj = NULL; + wxRichTextObject* contextObj = NULL; + wxRichTextDrawingContext context(& GetBuffer()); + int hit = GetFocusObject()->HitTest(dc, context, GetUnscaledPoint(logicalPt), position, & hitObj, & contextObj, wxRICHTEXT_HITTEST_HONOUR_ATOMIC); -Adding Shift does the above but starts/extends selection. + if (hitObj && hitObj->GetContainer() != GetFocusObject()) + { + wxRichTextParagraphLayoutBox* actualContainer = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox); + if (actualContainer && actualContainer->AcceptsFocus()) + { + SetFocusObject(actualContainer, false /* don't set caret position yet */); + SetCaretPositionAfterClick(actualContainer, position, hit); + } + } + wxRichTextEvent cmdEvent( + wxEVT_RICHTEXT_RIGHT_CLICK, + GetId()); + cmdEvent.SetEventObject(this); + cmdEvent.SetPosition(position); + if (hitObj) + cmdEvent.SetContainer(hitObj->GetContainer()); - */ + if (!GetEventHandler()->ProcessEvent(cmdEvent)) + event.Skip(); +} -bool wxRichTextCtrl::KeyboardNavigate(int keyCode, int flags) +/// Left-double-click +void wxRichTextCtrl::OnLeftDClick(wxMouseEvent& WXUNUSED(event)) { - bool success = false; + wxRichTextEvent cmdEvent( + wxEVT_RICHTEXT_LEFT_DCLICK, + GetId()); + cmdEvent.SetEventObject(this); + cmdEvent.SetPosition(m_caretPosition+1); + cmdEvent.SetContainer(GetFocusObject()); - if (keyCode == WXK_RIGHT) - { - if (flags & wxRICHTEXT_CTRL_DOWN) - success = WordRight(1, flags); - else - success = MoveRight(1, flags); - } - else if (keyCode == WXK_LEFT) - { - if (flags & wxRICHTEXT_CTRL_DOWN) - success = WordLeft(1, flags); - else - success = MoveLeft(1, flags); - } - else if (keyCode == WXK_UP) - { - if (flags & wxRICHTEXT_CTRL_DOWN) - success = MoveToParagraphStart(flags); - else - success = MoveUp(1, flags); - } - else if (keyCode == WXK_DOWN) - { - if (flags & wxRICHTEXT_CTRL_DOWN) - success = MoveToParagraphEnd(flags); - else - success = MoveDown(1, flags); - } - else if (keyCode == WXK_PAGEUP) - { - success = PageUp(1, flags); - } - else if (keyCode == WXK_PAGEDOWN) - { - success = PageDown(1, flags); - } - else if (keyCode == WXK_HOME) - { - if (flags & wxRICHTEXT_CTRL_DOWN) - success = MoveHome(flags); - else - success = MoveToLineStart(flags); - } - else if (keyCode == WXK_END) + if (!GetEventHandler()->ProcessEvent(cmdEvent)) { - if (flags & wxRICHTEXT_CTRL_DOWN) - success = MoveEnd(flags); - else - success = MoveToLineEnd(flags); + SelectWord(GetCaretPosition()+1); } +} - if (success) - { - ScrollIntoView(m_caretPosition, keyCode); - SetDefaultStyleToCursorStyle(); - } +/// Middle-click +void wxRichTextCtrl::OnMiddleClick(wxMouseEvent& event) +{ + wxRichTextEvent cmdEvent( + wxEVT_RICHTEXT_MIDDLE_CLICK, + GetId()); + cmdEvent.SetEventObject(this); + cmdEvent.SetPosition(m_caretPosition+1); + cmdEvent.SetContainer(GetFocusObject()); - return success; + if (!GetEventHandler()->ProcessEvent(cmdEvent)) + event.Skip(); + +#if wxUSE_CLIPBOARD && wxUSE_DATAOBJ && wxHAVE_PRIMARY_SELECTION + // Paste any PRIMARY selection, if it exists + wxTheClipboard->UsePrimarySelection(true); + Paste(); + wxTheClipboard->UsePrimarySelection(false); +#endif } -/// Extend the selection. Selections are in caret positions. -bool wxRichTextCtrl::ExtendSelection(long oldPos, long newPos, int flags) +/// Key press +void wxRichTextCtrl::OnChar(wxKeyEvent& event) { - if (flags & wxRICHTEXT_SHIFT_DOWN) + int flags = 0; + if (event.CmdDown()) + flags |= wxRICHTEXT_CTRL_DOWN; + if (event.ShiftDown()) + flags |= wxRICHTEXT_SHIFT_DOWN; + if (event.AltDown()) + flags |= wxRICHTEXT_ALT_DOWN; + + if (event.GetEventType() == wxEVT_KEY_DOWN) { - // If not currently selecting, start selecting - if (m_selectionRange.GetStart() == -2) + if (event.IsKeyInCategory(WXK_CATEGORY_NAVIGATION)) { - m_selectionAnchor = oldPos; - - if (oldPos > newPos) - m_selectionRange.SetRange(newPos+1, oldPos); - else - m_selectionRange.SetRange(oldPos+1, newPos); + KeyboardNavigate(event.GetKeyCode(), flags); + return; } - else + + long keycode = event.GetKeyCode(); + switch ( keycode ) { - // Always ensure that the selection range start is greater than - // the end. - if (newPos > m_selectionAnchor) - m_selectionRange.SetRange(m_selectionAnchor+1, newPos); - else - m_selectionRange.SetRange(newPos+1, m_selectionAnchor); + case WXK_ESCAPE: + case WXK_START: + case WXK_LBUTTON: + case WXK_RBUTTON: + case WXK_CANCEL: + case WXK_MBUTTON: + case WXK_CLEAR: + case WXK_SHIFT: + case WXK_ALT: + case WXK_CONTROL: + case WXK_MENU: + case WXK_PAUSE: + case WXK_CAPITAL: + case WXK_END: + case WXK_HOME: + case WXK_LEFT: + case WXK_UP: + case WXK_RIGHT: + case WXK_DOWN: + case WXK_SELECT: + case WXK_PRINT: + case WXK_EXECUTE: + case WXK_SNAPSHOT: + case WXK_INSERT: + case WXK_HELP: + case WXK_F1: + case WXK_F2: + case WXK_F3: + case WXK_F4: + case WXK_F5: + case WXK_F6: + case WXK_F7: + case WXK_F8: + case WXK_F9: + case WXK_F10: + case WXK_F11: + case WXK_F12: + case WXK_F13: + case WXK_F14: + case WXK_F15: + case WXK_F16: + case WXK_F17: + case WXK_F18: + case WXK_F19: + case WXK_F20: + case WXK_F21: + case WXK_F22: + case WXK_F23: + case WXK_F24: + case WXK_NUMLOCK: + case WXK_SCROLL: + case WXK_PAGEUP: + case WXK_PAGEDOWN: + case WXK_NUMPAD_F1: + case WXK_NUMPAD_F2: + case WXK_NUMPAD_F3: + case WXK_NUMPAD_F4: + case WXK_NUMPAD_HOME: + case WXK_NUMPAD_LEFT: + case WXK_NUMPAD_UP: + case WXK_NUMPAD_RIGHT: + case WXK_NUMPAD_DOWN: + case WXK_NUMPAD_PAGEUP: + case WXK_NUMPAD_PAGEDOWN: + case WXK_NUMPAD_END: + case WXK_NUMPAD_BEGIN: + case WXK_NUMPAD_INSERT: + case WXK_WINDOWS_LEFT: + { + return; + } + default: + { + } } - if (m_selectionRange.GetStart() > m_selectionRange.GetEnd()) + // Must process this before translation, otherwise it's translated into a WXK_DELETE event. + if (event.CmdDown() && event.GetKeyCode() == WXK_BACK) { - wxLogDebug(wxT("Strange selection range")); + if (!ProcessBackKey(event, flags)) + return; } + else + event.Skip(); - return true; + return; } - else - return false; -} - -/// Scroll into view, returning true if we scrolled. -/// This takes a _caret_ position. -bool wxRichTextCtrl::ScrollIntoView(long position, int keyCode) -{ - wxRichTextLine* line = GetVisibleLineForCaretPosition(position); - - if (!line) - return false; - int ppuX, ppuY; - GetScrollPixelsPerUnit(& ppuX, & ppuY); + // all the other keys modify the controls contents which shouldn't be + // possible if we're read-only + if ( !IsEditable() ) + { + event.Skip(); + return; + } - int startX, startY; - GetViewStart(& startX, & startY); - startX = 0; - startY = startY * ppuY; + if (event.GetKeyCode() == WXK_RETURN) + { + if (!CanInsertContent(* GetFocusObject(), m_caretPosition+1)) + return; - int sx = 0, sy = 0; - GetVirtualSize(& sx, & sy); - sx = 0; - if (ppuY != 0) - sy = sy/ppuY; + long newPos = m_caretPosition; - wxRect rect = line->GetRect(); + if (HasSelection() && !CanDeleteRange(* GetFocusObject(), GetSelectionRange())) + { + return; + } - bool scrolled = false; + BeginBatchUndo(_("Insert Text")); - wxSize clientSize = GetClientSize(); + DeleteSelectedContent(& newPos); - // Going down - if (keyCode == WXK_DOWN || keyCode == WXK_RIGHT || keyCode == WXK_END || keyCode == WXK_PAGEDOWN) - { - if ((rect.y + rect.height) > (clientSize.y + startY)) + if (event.ShiftDown()) { - // Make it scroll so this item is at the bottom - // of the window - int y = rect.y - (clientSize.y - rect.height); - y = (int) (0.5 + y/ppuY); - - if (startY != y) - { - SetScrollbars(ppuX, ppuY, sx, sy, 0, y); - scrolled = true; - } + wxString text; + text = wxRichTextLineBreakChar; + GetFocusObject()->InsertTextWithUndo(& GetBuffer(), newPos+1, text, this); + m_caretAtLineStart = true; + PositionCaret(); } - else if (rect.y < startY) + else + GetFocusObject()->InsertNewlineWithUndo(& GetBuffer(), newPos+1, this, wxRICHTEXT_INSERT_WITH_PREVIOUS_PARAGRAPH_STYLE|wxRICHTEXT_INSERT_INTERACTIVE); + + // Automatically renumber list + bool isNumberedList = false; + wxRichTextRange numberedListRange = FindRangeForList(newPos+1, isNumberedList); + if (isNumberedList && numberedListRange != wxRichTextRange(-1, -1)) { - // Make it scroll so this item is at the top - // of the window - int y = rect.y ; - y = (int) (0.5 + y/ppuY); + NumberList(numberedListRange, NULL, wxRICHTEXT_SETSTYLE_RENUMBER|wxRICHTEXT_SETSTYLE_WITH_UNDO); + } - if (startY != y) - { - SetScrollbars(ppuX, ppuY, sx, sy, 0, y); - scrolled = true; - } + EndBatchUndo(); + SetDefaultStyleToCursorStyle(); + + ScrollIntoView(m_caretPosition, WXK_RIGHT); + + wxRichTextEvent cmdEvent( + wxEVT_RICHTEXT_RETURN, + GetId()); + cmdEvent.SetEventObject(this); + cmdEvent.SetFlags(flags); + cmdEvent.SetPosition(newPos+1); + cmdEvent.SetContainer(GetFocusObject()); + + if (!GetEventHandler()->ProcessEvent(cmdEvent)) + { + // Generate conventional event + wxCommandEvent textEvent(wxEVT_TEXT_ENTER, GetId()); + InitCommandEvent(textEvent); + + GetEventHandler()->ProcessEvent(textEvent); } + Update(); } - // Going up - else if (keyCode == WXK_UP || keyCode == WXK_LEFT || keyCode == WXK_HOME || keyCode == WXK_PAGEUP ) + else if (event.GetKeyCode() == WXK_BACK) + { + ProcessBackKey(event, flags); + } + else if (event.GetKeyCode() == WXK_DELETE) { - if (rect.y < startY) + long newPos = m_caretPosition; + + if (HasSelection() && !CanDeleteRange(* GetFocusObject(), GetSelectionRange())) { - // Make it scroll so this item is at the top - // of the window - int y = rect.y ; - y = (int) (0.5 + y/ppuY); + return; + } + + BeginBatchUndo(_("Delete Text")); + + bool processed = DeleteSelectedContent(& newPos); + + int deletions = 0; + if (processed) + deletions ++; + + // Submit range in character positions, which are greater than caret positions, + if (newPos < GetFocusObject()->GetOwnRange().GetEnd()+1) + { + if (event.CmdDown()) + { + long pos = wxRichTextCtrl::FindNextWordPosition(1); + if (pos != -1 && (pos > newPos)) + { + wxRichTextRange range(newPos+1, pos); + if (CanDeleteRange(* GetFocusObject(), range.FromInternal())) + { + GetFocusObject()->DeleteRangeWithUndo(range, this, & GetBuffer()); + deletions ++; + } + processed = true; + } + } - if (startY != y) + if (!processed && newPos < (GetLastPosition()-1)) { - SetScrollbars(ppuX, ppuY, sx, sy, 0, y); - scrolled = true; + wxRichTextRange range(newPos+1, newPos+1); + if (CanDeleteRange(* GetFocusObject(), range.FromInternal())) + { + GetFocusObject()->DeleteRangeWithUndo(range, this, & GetBuffer()); + deletions ++; + } } } - else if ((rect.y + rect.height) > (clientSize.y + startY)) + + EndBatchUndo(); + + if (GetLastPosition() == -1) { - // Make it scroll so this item is at the bottom - // of the window - int y = rect.y - (clientSize.y - rect.height); - y = (int) (0.5 + y/ppuY); + GetFocusObject()->Reset(); - if (startY != y) - { - SetScrollbars(ppuX, ppuY, sx, sy, 0, y); - scrolled = true; - } + m_caretPosition = -1; + PositionCaret(); + SetDefaultStyleToCursorStyle(); + } + + ScrollIntoView(m_caretPosition, WXK_LEFT); + + // Always send this event; wxEVT_RICHTEXT_CONTENT_DELETED will be sent only if there is an actual deletion. + { + wxRichTextEvent cmdEvent( + wxEVT_RICHTEXT_DELETE, + GetId()); + cmdEvent.SetEventObject(this); + cmdEvent.SetFlags(flags); + cmdEvent.SetPosition(m_caretPosition+1); + cmdEvent.SetContainer(GetFocusObject()); + GetEventHandler()->ProcessEvent(cmdEvent); } + + Update(); } - PositionCaret(); + else + { + long keycode = event.GetKeyCode(); + switch ( keycode ) + { + case WXK_ESCAPE: + { + event.Skip(); + return; + } - return scrolled; -} + default: + { +#ifdef __WXMAC__ + if (event.CmdDown()) +#else + // Fixes AltGr+key with European input languages on Windows + if ((event.CmdDown() && !event.AltDown()) || (event.AltDown() && !event.CmdDown())) +#endif + { + event.Skip(); + return; + } -/// Is the given position visible on the screen? -bool wxRichTextCtrl::IsPositionVisible(long pos) const -{ - wxRichTextLine* line = GetVisibleLineForCaretPosition(pos-1); + wxRichTextEvent cmdEvent( + wxEVT_RICHTEXT_CHARACTER, + GetId()); + cmdEvent.SetEventObject(this); + cmdEvent.SetFlags(flags); +#if wxUSE_UNICODE + cmdEvent.SetCharacter(event.GetUnicodeKey()); +#else + cmdEvent.SetCharacter((wxChar) keycode); +#endif + cmdEvent.SetPosition(m_caretPosition+1); + cmdEvent.SetContainer(GetFocusObject()); - if (!line) - return false; + if (keycode == wxT('\t')) + { + // See if we need to promote or demote the selection or paragraph at the cursor + // position, instead of inserting a tab. + long pos = GetAdjustedCaretPosition(GetCaretPosition()); + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(pos); + if (para && para->GetRange().GetStart() == pos && para->GetAttributes().HasListStyleName()) + { + wxRichTextRange range; + if (HasSelection()) + range = GetSelectionRange(); + else + range = para->GetRange().FromInternal(); + + int promoteBy = event.ShiftDown() ? 1 : -1; + + PromoteList(promoteBy, range, NULL); + + GetEventHandler()->ProcessEvent(cmdEvent); + + return; + } + } - int ppuX, ppuY; - GetScrollPixelsPerUnit(& ppuX, & ppuY); + if (!CanInsertContent(* GetFocusObject(), m_caretPosition+1)) + return; - int startX, startY; - GetViewStart(& startX, & startY); - startX = 0; - startY = startY * ppuY; + if (HasSelection() && !CanDeleteRange(* GetFocusObject(), GetSelectionRange())) + return; - int sx = 0, sy = 0; - GetVirtualSize(& sx, & sy); - sx = 0; - if (ppuY != 0) - sy = sy/ppuY; + BeginBatchUndo(_("Insert Text")); - wxRect rect = line->GetRect(); + long newPos = m_caretPosition; + DeleteSelectedContent(& newPos); - wxSize clientSize = GetClientSize(); +#if wxUSE_UNICODE + wxString str = event.GetUnicodeKey(); +#else + wxString str = (wxChar) event.GetKeyCode(); +#endif + GetFocusObject()->InsertTextWithUndo(& GetBuffer(), newPos+1, str, this, 0); - return !(((rect.y + rect.height) > (clientSize.y + startY)) || rect.y < startY); + EndBatchUndo(); + + SetDefaultStyleToCursorStyle(); + ScrollIntoView(m_caretPosition, WXK_RIGHT); + + cmdEvent.SetPosition(m_caretPosition); + GetEventHandler()->ProcessEvent(cmdEvent); + + Update(); + } + } + } } -void wxRichTextCtrl::SetCaretPosition(long position, bool showAtLineStart) +bool wxRichTextCtrl::ProcessMouseMovement(wxRichTextParagraphLayoutBox* container, wxRichTextObject* WXUNUSED(obj), long position, const wxPoint& WXUNUSED(pos)) { - m_caretPosition = position; - m_caretAtLineStart = showAtLineStart; + wxRichTextAttr attr; + if (container && GetStyle(position, attr, container)) + { + if (attr.HasFlag(wxTEXT_ATTR_URL)) + { + SetCursor(m_urlCursor); + } + else if (!attr.HasFlag(wxTEXT_ATTR_URL)) + { + SetCursor(m_textCursor); + } + return true; + } + else + return false; } -/// 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. -void wxRichTextCtrl::MoveCaretForward(long oldPosition) +// Processes the back key +bool wxRichTextCtrl::ProcessBackKey(wxKeyEvent& event, int flags) { - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(oldPosition); + if (!IsEditable()) + { + return false; + } - // Only do the check if we're not at the end of the paragraph (where things work OK - // anyway) - if (para && (oldPosition != para->GetRange().GetEnd() - 1)) + if (HasSelection() && !CanDeleteRange(* GetFocusObject(), GetSelectionRange())) { - wxRichTextLine* line = GetBuffer().GetLineAtPosition(oldPosition); + return false; + } - if (line) + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(m_caretPosition, true); + + // If we're at the start of a list item with a bullet, let's 'delete' the bullet, i.e. + // make it a continuation paragraph. + if (!HasSelection() && para && ((m_caretPosition+1) == para->GetRange().GetStart()) && + para->GetAttributes().HasBulletStyle() && (para->GetAttributes().GetBulletStyle() & wxTEXT_ATTR_BULLET_STYLE_CONTINUATION) == 0) + { + wxRichTextParagraph* newPara = wxDynamicCast(para->Clone(), wxRichTextParagraph); + newPara->GetAttributes().SetBulletStyle(newPara->GetAttributes().GetBulletStyle() | wxTEXT_ATTR_BULLET_STYLE_CONTINUATION); + + wxRichTextAction* action = new wxRichTextAction(NULL, _("Remove Bullet"), wxRICHTEXT_CHANGE_STYLE, & GetBuffer(), GetFocusObject(), this); + action->SetRange(newPara->GetRange()); + action->SetPosition(GetCaretPosition()); + action->GetNewParagraphs().AppendChild(newPara); + // Also store the old ones for Undo + action->GetOldParagraphs().AppendChild(new wxRichTextParagraph(*para)); + + GetBuffer().Invalidate(para->GetRange()); + GetBuffer().SubmitAction(action); + + // Automatically renumber list + bool isNumberedList = false; + wxRichTextRange numberedListRange = FindRangeForList(m_caretPosition, isNumberedList); + if (isNumberedList && numberedListRange != wxRichTextRange(-1, -1)) { - wxRichTextRange lineRange = line->GetAbsoluteRange(); + NumberList(numberedListRange, NULL, wxRICHTEXT_SETSTYLE_RENUMBER|wxRICHTEXT_SETSTYLE_WITH_UNDO); + } - // We're at the end of a line. See whether we need to - // stay at the same actual caret position but change visual - // position, or not. - if (oldPosition == lineRange.GetEnd()) + Update(); + } + else + { + BeginBatchUndo(_("Delete Text")); + + long newPos = m_caretPosition; + + bool processed = DeleteSelectedContent(& newPos); + + int deletions = 0; + if (processed) + deletions ++; + + // Submit range in character positions, which are greater than caret positions, + // so subtract 1 for deleted character and add 1 for conversion to character position. + if (newPos > -1) + { + if (event.CmdDown()) { - if (m_caretAtLineStart) + long pos = wxRichTextCtrl::FindNextWordPosition(-1); + if (pos < newPos) { - // We're already at the start of the line, so actually move on now. - m_caretPosition = oldPosition + 1; - m_caretAtLineStart = false; + wxRichTextRange range(pos+1, newPos); + if (CanDeleteRange(* GetFocusObject(), range.FromInternal())) + { + GetFocusObject()->DeleteRangeWithUndo(range, this, & GetBuffer()); + deletions ++; + } + processed = true; } - else + } + + if (!processed) + { + wxRichTextRange range(newPos, newPos); + if (CanDeleteRange(* GetFocusObject(), range.FromInternal())) { - // We're showing at the end of the line, so keep to - // the same position but indicate that we're to show - // at the start of the next line. - m_caretPosition = oldPosition; - m_caretAtLineStart = true; + GetFocusObject()->DeleteRangeWithUndo(range, this, & GetBuffer()); + deletions ++; } - SetDefaultStyleToCursorStyle(); - return; } } + + EndBatchUndo(); + + if (GetLastPosition() == -1) + { + GetFocusObject()->Reset(); + + m_caretPosition = -1; + PositionCaret(); + SetDefaultStyleToCursorStyle(); + } + + ScrollIntoView(m_caretPosition, WXK_LEFT); + + // Always send this event; wxEVT_RICHTEXT_CONTENT_DELETED will be sent only if there is an actual deletion. + { + wxRichTextEvent cmdEvent( + wxEVT_RICHTEXT_DELETE, + GetId()); + cmdEvent.SetEventObject(this); + cmdEvent.SetFlags(flags); + cmdEvent.SetPosition(m_caretPosition+1); + cmdEvent.SetContainer(GetFocusObject()); + GetEventHandler()->ProcessEvent(cmdEvent); + } + + Update(); } - m_caretPosition ++; - SetDefaultStyleToCursorStyle(); + + return true; } -/// Move caret one visual step backward: 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 wxRichTextCtrl::MoveCaretBack(long oldPosition) +/// Delete content if there is a selection, e.g. when pressing a key. +bool wxRichTextCtrl::DeleteSelectedContent(long* newPos) { - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(oldPosition); - - // Only do the check if we're not at the start of the paragraph (where things work OK - // anyway) - if (para && (oldPosition != para->GetRange().GetStart())) + if (HasSelection()) { - wxRichTextLine* line = GetBuffer().GetLineAtPosition(oldPosition); + long pos = m_selection.GetRange().GetStart(); + wxRichTextRange range = m_selection.GetRange(); - if (line) - { - wxRichTextRange lineRange = line->GetAbsoluteRange(); + // SelectAll causes more to be selected than doing it interactively, + // and causes a new paragraph to be inserted. So for multiline buffers, + // don't delete the final position. + if (range.GetEnd() == GetLastPosition() && GetNumberOfLines() > 0) + range.SetEnd(range.GetEnd()-1); - // We're at the start of a line. See whether we need to - // stay at the same actual caret position but change visual - // position, or not. - if (oldPosition == lineRange.GetStart()) - { - m_caretPosition = oldPosition-1; - m_caretAtLineStart = true; - return; - } - else if (oldPosition == lineRange.GetEnd()) - { - if (m_caretAtLineStart) - { - // We're at the start of the line, so keep the same caret position - // but clear the start-of-line flag. - m_caretPosition = oldPosition; - m_caretAtLineStart = false; - } - else - { - // We're showing at the end of the line, so go back - // to the previous character position. - m_caretPosition = oldPosition - 1; - } - SetDefaultStyleToCursorStyle(); - return; - } - } + GetFocusObject()->DeleteRangeWithUndo(range, this, & GetBuffer()); + m_selection.Reset(); + m_selectionState = wxRichTextCtrlSelectionState_Normal; + + if (newPos) + *newPos = pos-1; + return true; } - m_caretPosition --; - SetDefaultStyleToCursorStyle(); + else + return false; +} + +/// Keyboard navigation + +/* + +Left: left one character +Right: right one character +Up: up one line +Down: down one line +Ctrl-Left: left one word +Ctrl-Right: right one word +Ctrl-Up: previous paragraph start +Ctrl-Down: next start of paragraph +Home: start of line +End: end of line +Ctrl-Home: start of document +Ctrl-End: end of document +Page-Up: Up a screen +Page-Down: Down a screen + +Maybe: + +Ctrl-Alt-PgUp: Start of window +Ctrl-Alt-PgDn: End of window +F8: Start selection mode +Esc: End selection mode + +Adding Shift does the above but starts/extends selection. + + + */ + +bool wxRichTextCtrl::KeyboardNavigate(int keyCode, int flags) +{ + bool success = false; + + if (keyCode == WXK_RIGHT || keyCode == WXK_NUMPAD_RIGHT) + { + if (flags & wxRICHTEXT_CTRL_DOWN) + success = WordRight(1, flags); + else + success = MoveRight(1, flags); + } + else if (keyCode == WXK_LEFT || keyCode == WXK_NUMPAD_LEFT) + { + if (flags & wxRICHTEXT_CTRL_DOWN) + success = WordLeft(1, flags); + else + success = MoveLeft(1, flags); + } + else if (keyCode == WXK_UP || keyCode == WXK_NUMPAD_UP) + { + if (flags & wxRICHTEXT_CTRL_DOWN) + success = MoveToParagraphStart(flags); + else + success = MoveUp(1, flags); + } + else if (keyCode == WXK_DOWN || keyCode == WXK_NUMPAD_DOWN) + { + if (flags & wxRICHTEXT_CTRL_DOWN) + success = MoveToParagraphEnd(flags); + else + success = MoveDown(1, flags); + } + else if (keyCode == WXK_PAGEUP || keyCode == WXK_NUMPAD_PAGEUP) + { + success = PageUp(1, flags); + } + else if (keyCode == WXK_PAGEDOWN || keyCode == WXK_NUMPAD_PAGEDOWN) + { + success = PageDown(1, flags); + } + else if (keyCode == WXK_HOME || keyCode == WXK_NUMPAD_HOME) + { + if (flags & wxRICHTEXT_CTRL_DOWN) + success = MoveHome(flags); + else + success = MoveToLineStart(flags); + } + else if (keyCode == WXK_END || keyCode == WXK_NUMPAD_END) + { + if (flags & wxRICHTEXT_CTRL_DOWN) + success = MoveEnd(flags); + else + success = MoveToLineEnd(flags); + } + + if (success) + { + ScrollIntoView(m_caretPosition, keyCode); + SetDefaultStyleToCursorStyle(); + } + + return success; +} + +/// Extend the selection. Selections are in caret positions. +bool wxRichTextCtrl::ExtendSelection(long oldPos, long newPos, int flags) +{ + if (flags & wxRICHTEXT_SHIFT_DOWN) + { + if (oldPos == newPos) + return false; + + wxRichTextSelection oldSelection = m_selection; + + m_selection.SetContainer(GetFocusObject()); + + wxRichTextRange oldRange; + if (m_selection.IsValid()) + oldRange = m_selection.GetRange(); + else + oldRange = wxRICHTEXT_NO_SELECTION; + wxRichTextRange newRange; + + // If not currently selecting, start selecting + if (oldRange.GetStart() == -2) + { + m_selectionAnchor = oldPos; + + if (oldPos > newPos) + newRange.SetRange(newPos+1, oldPos); + else + newRange.SetRange(oldPos+1, newPos); + } + else + { + // Always ensure that the selection range start is greater than + // the end. + if (newPos > m_selectionAnchor) + newRange.SetRange(m_selectionAnchor+1, newPos); + else if (newPos == m_selectionAnchor) + newRange = wxRichTextRange(-2, -2); + else + newRange.SetRange(newPos+1, m_selectionAnchor); + } + + m_selection.SetRange(newRange); + + RefreshForSelectionChange(oldSelection, m_selection); + + if (newRange.GetStart() > newRange.GetEnd()) + { + wxLogDebug(wxT("Strange selection range")); + } + + return true; + } + else + return false; +} + +/// Scroll into view, returning true if we scrolled. +/// This takes a _caret_ position. +bool wxRichTextCtrl::ScrollIntoView(long position, int keyCode) +{ + wxRichTextLine* line = GetVisibleLineForCaretPosition(position); + + if (!line) + return false; + + int ppuX, ppuY; + GetScrollPixelsPerUnit(& ppuX, & ppuY); + + int startXUnits, startYUnits; + GetViewStart(& startXUnits, & startYUnits); + int startY = startYUnits * ppuY; + + int sx = 0, sy = 0; + GetVirtualSize(& sx, & sy); + int sxUnits = 0; + int syUnits = 0; + if (ppuY != 0) + syUnits = sy/ppuY; + + wxRect rect = GetScaledRect(line->GetRect()); + + bool scrolled = false; + + wxSize clientSize = GetClientSize(); + + int leftMargin, rightMargin, topMargin, bottomMargin; + + { + wxClientDC dc(this); + wxRichTextObject::GetTotalMargin(dc, & GetBuffer(), GetBuffer().GetAttributes(), leftMargin, rightMargin, + topMargin, bottomMargin); + } + clientSize.y -= (int) (0.5 + bottomMargin * GetScale()); + + if (GetWindowStyle() & wxRE_CENTRE_CARET) + { + int y = rect.y - GetClientSize().y/2; + int yUnits = (int) (0.5 + ((float) y)/(float) ppuY); + if (y >= 0 && (y + clientSize.y) < (int) (0.5 + GetBuffer().GetCachedSize().y * GetScale())) + { + if (startYUnits != yUnits) + { + SetScrollbars(ppuX, ppuY, sxUnits, syUnits, 0, yUnits); + scrolled = true; + } +#if !wxRICHTEXT_USE_OWN_CARET + if (scrolled) +#endif + PositionCaret(); + + return scrolled; + } + } + + // Going down + if (keyCode == WXK_DOWN || keyCode == WXK_NUMPAD_DOWN || + keyCode == WXK_RIGHT || keyCode == WXK_NUMPAD_RIGHT || + keyCode == WXK_END || keyCode == WXK_NUMPAD_END || + keyCode == WXK_PAGEDOWN || keyCode == WXK_NUMPAD_PAGEDOWN) + { + if ((rect.y + rect.height) > (clientSize.y + startY)) + { + // Make it scroll so this item is at the bottom + // of the window + int y = rect.y - (clientSize.y - rect.height); + int yUnits = (int) (0.5 + ((float) y)/(float) ppuY); + + // If we're still off the screen, scroll another line down + if ((rect.y + rect.height) > (clientSize.y + (yUnits*ppuY))) + yUnits ++; + + if (startYUnits != yUnits) + { + SetScrollbars(ppuX, ppuY, sxUnits, syUnits, 0, yUnits); + scrolled = true; + } + } + else if (rect.y < (startY + (int) (0.5 + GetBuffer().GetTopMargin() * GetScale()))) + { + // Make it scroll so this item is at the top + // of the window + int y = rect.y - (int) (0.5 + GetBuffer().GetTopMargin() * GetScale()); + int yUnits = (int) (0.5 + ((float) y)/(float) ppuY); + + if (startYUnits != yUnits) + { + SetScrollbars(ppuX, ppuY, sxUnits, syUnits, 0, yUnits); + scrolled = true; + } + } + } + // Going up + else if (keyCode == WXK_UP || keyCode == WXK_NUMPAD_UP || + keyCode == WXK_LEFT || keyCode == WXK_NUMPAD_LEFT || + keyCode == WXK_HOME || keyCode == WXK_NUMPAD_HOME || + keyCode == WXK_PAGEUP || keyCode == WXK_NUMPAD_PAGEUP ) + { + if (rect.y < (startY + (int) (0.5 + GetBuffer().GetBottomMargin() * GetScale()))) + { + // Make it scroll so this item is at the top + // of the window + int y = rect.y - (int) (0.5 + GetBuffer().GetTopMargin() * GetScale()); + int yUnits = (int) (0.5 + ((float) y)/(float) ppuY); + + if (startYUnits != yUnits) + { + SetScrollbars(ppuX, ppuY, sxUnits, syUnits, 0, yUnits); + scrolled = true; + } + } + else if ((rect.y + rect.height) > (clientSize.y + startY)) + { + // Make it scroll so this item is at the bottom + // of the window + int y = rect.y - (clientSize.y - rect.height); + int yUnits = (int) (0.5 + ((float) y)/(float) ppuY); + + // If we're still off the screen, scroll another line down + if ((rect.y + rect.height) > (clientSize.y + (yUnits*ppuY))) + yUnits ++; + + if (startYUnits != yUnits) + { + SetScrollbars(ppuX, ppuY, sxUnits, syUnits, 0, yUnits); + scrolled = true; + } + } + } + +#if !wxRICHTEXT_USE_OWN_CARET + if (scrolled) +#endif + PositionCaret(); + + return scrolled; +} + +/// Is the given position visible on the screen? +bool wxRichTextCtrl::IsPositionVisible(long pos) const +{ + wxRichTextLine* line = GetVisibleLineForCaretPosition(pos-1); + + if (!line) + return false; + + int ppuX, ppuY; + GetScrollPixelsPerUnit(& ppuX, & ppuY); + + int startX, startY; + GetViewStart(& startX, & startY); + startX = 0; + startY = startY * ppuY; + + wxRect rect = GetScaledRect(line->GetRect()); + wxSize clientSize = GetClientSize(); + clientSize.y -= (int) (0.5 + GetBuffer().GetBottomMargin() * GetScale()); + + return (rect.GetTop() >= (startY + (int) (0.5 + GetBuffer().GetTopMargin() * GetScale()))) && + (rect.GetBottom() <= (startY + clientSize.y)); +} + +void wxRichTextCtrl::SetCaretPosition(long position, bool showAtLineStart) +{ + m_caretPosition = position; + m_caretAtLineStart = showAtLineStart; +} + +/// 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. +void wxRichTextCtrl::MoveCaretForward(long oldPosition) +{ + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(oldPosition); + + // Only do the check if we're not at the end of the paragraph (where things work OK + // anyway) + if (para && (oldPosition != para->GetRange().GetEnd() - 1)) + { + wxRichTextLine* line = GetFocusObject()->GetLineAtPosition(oldPosition); + + if (line) + { + wxRichTextRange lineRange = line->GetAbsoluteRange(); + + // We're at the end of a line. See whether we need to + // stay at the same actual caret position but change visual + // position, or not. + if (oldPosition == lineRange.GetEnd()) + { + if (m_caretAtLineStart) + { + // We're already at the start of the line, so actually move on now. + m_caretPosition = oldPosition + 1; + m_caretAtLineStart = false; + } + else + { + // We're showing at the end of the line, so keep to + // the same position but indicate that we're to show + // at the start of the next line. + m_caretPosition = oldPosition; + m_caretAtLineStart = true; + } + SetDefaultStyleToCursorStyle(); + return; + } + } + } + m_caretPosition ++; + SetDefaultStyleToCursorStyle(); +} + +/// Move caret one visual step backward: 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 wxRichTextCtrl::MoveCaretBack(long oldPosition) +{ + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(oldPosition); + + // Only do the check if we're not at the start of the paragraph (where things work OK + // anyway) + if (para && (oldPosition != para->GetRange().GetStart())) + { + wxRichTextLine* line = GetFocusObject()->GetLineAtPosition(oldPosition); + + if (line) + { + wxRichTextRange lineRange = line->GetAbsoluteRange(); + + // We're at the start of a line. See whether we need to + // stay at the same actual caret position but change visual + // position, or not. + if (oldPosition == lineRange.GetStart()) + { + m_caretPosition = oldPosition-1; + m_caretAtLineStart = true; + return; + } + else if (oldPosition == lineRange.GetEnd()) + { + if (m_caretAtLineStart) + { + // We're at the start of the line, so keep the same caret position + // but clear the start-of-line flag. + m_caretPosition = oldPosition; + m_caretAtLineStart = false; + } + else + { + // We're showing at the end of the line, so go back + // to the previous character position. + m_caretPosition = oldPosition - 1; + } + SetDefaultStyleToCursorStyle(); + return; + } + } + } + m_caretPosition --; + SetDefaultStyleToCursorStyle(); +} + +/// Move right +bool wxRichTextCtrl::MoveRight(int noPositions, int flags) +{ + long endPos = GetFocusObject()->GetOwnRange().GetEnd(); + + if (m_caretPosition + noPositions < endPos) + { + long oldPos = m_caretPosition; + long newPos = m_caretPosition + noPositions; + + bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); + if (!extendSel) + SelectNone(); + + // Determine by looking at oldPos and m_caretPosition whether + // we moved from the end of a line to the start of the next line, in which case + // we want to adjust the caret position such that it is positioned at the + // start of the next line, rather than jumping past the first character of the + // line. + if (noPositions == 1) + MoveCaretForward(oldPos); + else + SetCaretPosition(newPos); + + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + else + return false; +} + +/// Move left +bool wxRichTextCtrl::MoveLeft(int noPositions, int flags) +{ + long startPos = -1; + + if (m_caretPosition > startPos - noPositions + 1) + { + long oldPos = m_caretPosition; + long newPos = m_caretPosition - noPositions; + bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); + if (!extendSel) + SelectNone(); + + if (noPositions == 1) + MoveCaretBack(oldPos); + else + SetCaretPosition(newPos); + + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + else + return 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 wxRichTextCtrl::FindCaretPositionForCharacterPosition(long position, int hitTestFlags, wxRichTextParagraphLayoutBox* container, + bool& caretLineStart) +{ + // If end of previous line, and hitTest is wxRICHTEXT_HITTEST_BEFORE, + // we want to be at the end of the last line but with m_caretAtLineStart set to true, + // so we view the caret at the start of the line. + caretLineStart = false; + long caretPosition = position; + + if (hitTestFlags & wxRICHTEXT_HITTEST_BEFORE) + { + wxRichTextLine* thisLine = container->GetLineAtPosition(position-1); + wxRichTextRange lineRange; + if (thisLine) + lineRange = thisLine->GetAbsoluteRange(); + + if (thisLine && (position-1) == lineRange.GetEnd()) + { + caretPosition --; + caretLineStart = true; + } + else + { + wxRichTextParagraph* para = container->GetParagraphAtPosition(position); + if (para && para->GetRange().GetStart() == position) + caretPosition --; + } + } + return caretPosition; +} + +/// Move up +bool wxRichTextCtrl::MoveUp(int noLines, int flags) +{ + return MoveDown(- noLines, flags); +} + +/// Move up +bool wxRichTextCtrl::MoveDown(int noLines, int flags) +{ + if (!GetCaret()) + return false; + + long lineNumber = GetFocusObject()->GetVisibleLineNumber(m_caretPosition, true, m_caretAtLineStart); + wxPoint pt = GetCaret()->GetPosition(); + long newLine = lineNumber + noLines; + bool notInThisObject = false; + + if (lineNumber != -1) + { + if (noLines > 0) + { + long lastLine = GetFocusObject()->GetVisibleLineNumber(GetFocusObject()->GetOwnRange().GetEnd()); + if (newLine > lastLine) + notInThisObject = true; + } + else + { + if (newLine < 0) + notInThisObject = true; + } + } + + wxRichTextParagraphLayoutBox* container = GetFocusObject(); + int hitTestFlags = wxRICHTEXT_HITTEST_NO_NESTED_OBJECTS|wxRICHTEXT_HITTEST_NO_FLOATING_OBJECTS|wxRICHTEXT_HITTEST_HONOUR_ATOMIC; + + bool lineIsEmpty = false; + if (notInThisObject) + { + // If we know we're navigating out of the current object, + // try to find an object anywhere in the buffer at the new position (up or down a bit) + container = & GetBuffer(); + hitTestFlags &= ~wxRICHTEXT_HITTEST_NO_NESTED_OBJECTS; + + if (noLines > 0) // going down + { + pt.y = GetFocusObject()->GetPosition().y + GetFocusObject()->GetCachedSize().y + 2; + } + else // going up + { + pt.y = GetFocusObject()->GetPosition().y - 2; + } + } + else + { + wxRichTextLine* lineObj = GetFocusObject()->GetLineForVisibleLineNumber(newLine); + if (lineObj) + { + pt.y = lineObj->GetAbsolutePosition().y + 2; + if (lineObj->GetRange().GetStart() == lineObj->GetRange().GetEnd()) + lineIsEmpty = true; + } + else + return false; + } + + long newPos = 0; + wxClientDC dc(this); + PrepareDC(dc); + dc.SetFont(GetFont()); + + wxRichTextObject* hitObj = NULL; + wxRichTextObject* contextObj = NULL; + wxRichTextDrawingContext context(& GetBuffer()); + int hitTest = container->HitTest(dc, context, pt, newPos, & hitObj, & contextObj, hitTestFlags); + + if (hitObj && + ((hitTest & wxRICHTEXT_HITTEST_NONE) == 0) && + (! (hitObj == (& m_buffer) && ((hitTest & wxRICHTEXT_HITTEST_OUTSIDE) != 0))) // outside the buffer counts as 'do nothing' + ) + { + if (notInThisObject) + { + wxRichTextParagraphLayoutBox* actualContainer = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox); + if (actualContainer && actualContainer != GetFocusObject() && actualContainer->AcceptsFocus()) + { + SetFocusObject(actualContainer, false /* don't set caret position yet */); + + container = actualContainer; + } + } + + bool caretLineStart = true; + + // If the line is empty, there is only one possible position for the caret, + // so force the 'before' state so FindCaretPositionForCharacterPosition doesn't + // just return the same position. + if (lineIsEmpty) + { + hitTest &= ~wxRICHTEXT_HITTEST_AFTER; + hitTest |= wxRICHTEXT_HITTEST_BEFORE; + } + long caretPosition = FindCaretPositionForCharacterPosition(newPos, hitTest, container, caretLineStart); + long newSelEnd = caretPosition; + bool extendSel; + + if (notInThisObject) + extendSel = false; + else + extendSel = ExtendSelection(m_caretPosition, newSelEnd, flags); + + if (!extendSel) + SelectNone(); + + SetCaretPosition(caretPosition, caretLineStart); + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + + return false; +} + +/// Move to the end of the paragraph +bool wxRichTextCtrl::MoveToParagraphEnd(int flags) +{ + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(m_caretPosition, true); + if (para) + { + long newPos = para->GetRange().GetEnd() - 1; + bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); + if (!extendSel) + SelectNone(); + + SetCaretPosition(newPos); + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + + return false; +} + +/// Move to the start of the paragraph +bool wxRichTextCtrl::MoveToParagraphStart(int flags) +{ + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(m_caretPosition, true); + if (para) + { + long newPos = para->GetRange().GetStart() - 1; + bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); + if (!extendSel) + SelectNone(); + + SetCaretPosition(newPos, true); + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + + return false; +} + +/// Move to the end of the line +bool wxRichTextCtrl::MoveToLineEnd(int flags) +{ + wxRichTextLine* line = GetVisibleLineForCaretPosition(m_caretPosition); + + if (line) + { + wxRichTextRange lineRange = line->GetAbsoluteRange(); + long newPos = lineRange.GetEnd(); + bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); + if (!extendSel) + SelectNone(); + + SetCaretPosition(newPos); + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + + return false; +} + +/// Move to the start of the line +bool wxRichTextCtrl::MoveToLineStart(int flags) +{ + wxRichTextLine* line = GetVisibleLineForCaretPosition(m_caretPosition); + if (line) + { + wxRichTextRange lineRange = line->GetAbsoluteRange(); + long newPos = lineRange.GetStart()-1; + + bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); + if (!extendSel) + SelectNone(); + + wxRichTextParagraph* para = GetFocusObject()->GetParagraphForLine(line); + + SetCaretPosition(newPos, para->GetRange().GetStart() != lineRange.GetStart()); + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + + return false; +} + +/// Move to the start of the buffer +bool wxRichTextCtrl::MoveHome(int flags) +{ + if (m_caretPosition != -1) + { + bool extendSel = ExtendSelection(m_caretPosition, -1, flags); + if (!extendSel) + SelectNone(); + + SetCaretPosition(-1); + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + else + return false; +} + +/// Move to the end of the buffer +bool wxRichTextCtrl::MoveEnd(int flags) +{ + long endPos = GetFocusObject()->GetOwnRange().GetEnd()-1; + + if (m_caretPosition != endPos) + { + bool extendSel = ExtendSelection(m_caretPosition, endPos, flags); + if (!extendSel) + SelectNone(); + + SetCaretPosition(endPos); + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + else + return false; +} + +/// Move noPages pages up +bool wxRichTextCtrl::PageUp(int noPages, int flags) +{ + return PageDown(- noPages, flags); +} + +/// Move noPages pages down +bool wxRichTextCtrl::PageDown(int noPages, int flags) +{ + // Calculate which line occurs noPages * screen height further down. + wxRichTextLine* line = GetVisibleLineForCaretPosition(m_caretPosition); + if (line) + { + wxSize clientSize = GetClientSize(); + int newY = line->GetAbsolutePosition().y + noPages*clientSize.y; + + wxRichTextLine* newLine = GetFocusObject()->GetLineAtYPosition(newY); + if (newLine) + { + wxRichTextRange lineRange = newLine->GetAbsoluteRange(); + long pos = lineRange.GetStart()-1; + if (pos != m_caretPosition) + { + wxRichTextParagraph* para = GetFocusObject()->GetParagraphForLine(newLine); + + bool extendSel = ExtendSelection(m_caretPosition, pos, flags); + if (!extendSel) + SelectNone(); + + SetCaretPosition(pos, para->GetRange().GetStart() != lineRange.GetStart()); + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + } + } + + return false; +} + +static bool wxRichTextCtrlIsWhitespace(const wxString& str) +{ + return str == wxT(" ") || str == wxT("\t") || (!str.empty() && (str[0] == (wxChar) 160)); +} + +// Finds the caret position for the next word +long wxRichTextCtrl::FindNextWordPosition(int direction) const +{ + long endPos = GetFocusObject()->GetOwnRange().GetEnd(); + + if (direction > 0) + { + long i = m_caretPosition+1+direction; // +1 for conversion to character pos + + // First skip current text to space + while (i < endPos && i > -1) + { + // i is in character, not caret positions + wxString text = GetFocusObject()->GetTextForRange(wxRichTextRange(i, i)); + wxRichTextLine* line = GetFocusObject()->GetLineAtPosition(i, false); + if (line && (i == line->GetAbsoluteRange().GetEnd())) + { + break; + } + else if (!wxRichTextCtrlIsWhitespace(text) && !text.empty()) + i += direction; + else + { + break; + } + } + while (i < endPos && i > -1) + { + // i is in character, not caret positions + wxString text = GetFocusObject()->GetTextForRange(wxRichTextRange(i, i)); + wxRichTextLine* line = GetFocusObject()->GetLineAtPosition(i, false); + if (line && (i == line->GetAbsoluteRange().GetEnd())) + return wxMax(-1, i); + + if (text.empty()) // End of paragraph, or maybe an image + return wxMax(-1, i - 1); + else if (wxRichTextCtrlIsWhitespace(text) || text.empty()) + i += direction; + else + { + // Convert to caret position + return wxMax(-1, i - 1); + } + } + if (i >= endPos) + return endPos-1; + return i-1; + } + else + { + long i = m_caretPosition; + + // First skip white space + while (i < endPos && i > -1) + { + // i is in character, not caret positions + wxString text = GetFocusObject()->GetTextForRange(wxRichTextRange(i, i)); + wxRichTextLine* line = GetFocusObject()->GetLineAtPosition(i, false); + + if (text.empty() || (line && (i == line->GetAbsoluteRange().GetStart()))) // End of paragraph, or maybe an image + break; + else if (wxRichTextCtrlIsWhitespace(text) || text.empty()) + i += direction; + else + break; + } + // Next skip current text to space + while (i < endPos && i > -1) + { + // i is in character, not caret positions + wxString text = GetFocusObject()->GetTextForRange(wxRichTextRange(i, i)); + wxRichTextLine* line = GetFocusObject()->GetLineAtPosition(i, false); + if (line && line->GetAbsoluteRange().GetStart() == i) + return i-1; + + if (!wxRichTextCtrlIsWhitespace(text) /* && !text.empty() */) + i += direction; + else + { + return i; + } + } + if (i < -1) + return -1; + return i; + } +} + +/// Move n words left +bool wxRichTextCtrl::WordLeft(int WXUNUSED(n), int flags) +{ + long pos = FindNextWordPosition(-1); + if (pos != m_caretPosition) + { + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(pos, true); + + bool extendSel = ExtendSelection(m_caretPosition, pos, flags); + if (!extendSel) + SelectNone(); + + SetCaretPosition(pos, para->GetRange().GetStart() != pos); + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + + return false; +} + +/// Move n words right +bool wxRichTextCtrl::WordRight(int WXUNUSED(n), int flags) +{ + long pos = FindNextWordPosition(1); + if (pos != m_caretPosition) + { + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(pos, true); + + bool extendSel = ExtendSelection(m_caretPosition, pos, flags); + if (!extendSel) + SelectNone(); + + SetCaretPosition(pos, para->GetRange().GetStart() != pos); + PositionCaret(); + SetDefaultStyleToCursorStyle(); + + return true; + } + + return false; +} + +/// Sizing +void wxRichTextCtrl::OnSize(wxSizeEvent& event) +{ + // Only do sizing optimization for large buffers + if (GetBuffer().GetOwnRange().GetEnd() > m_delayedLayoutThreshold) + { + m_fullLayoutRequired = true; + m_fullLayoutTime = wxGetLocalTimeMillis(); + m_fullLayoutSavedPosition = GetFirstVisiblePosition(); + LayoutContent(true /* onlyVisibleRect */); + } + else + GetBuffer().Invalidate(wxRICHTEXT_ALL); + +#if wxRICHTEXT_BUFFERED_PAINTING + RecreateBuffer(); +#endif + + event.Skip(); +} + +// Force any pending layout due to large buffer +void wxRichTextCtrl::ForceDelayedLayout() +{ + if (m_fullLayoutRequired) + { + m_fullLayoutRequired = false; + m_fullLayoutTime = 0; + GetBuffer().Invalidate(wxRICHTEXT_ALL); + ShowPosition(m_fullLayoutSavedPosition); + Refresh(false); + Update(); + } +} + +/// Idle-time processing +void wxRichTextCtrl::OnIdle(wxIdleEvent& event) +{ +#if wxRICHTEXT_USE_OWN_CARET + if (((wxRichTextCaret*) GetCaret())->GetNeedsUpdate()) + { + ((wxRichTextCaret*) GetCaret())->SetNeedsUpdate(false); + PositionCaret(); + GetCaret()->Show(); + } +#endif + + const int layoutInterval = wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL; + + if (m_fullLayoutRequired && (wxGetLocalTimeMillis() > (m_fullLayoutTime + layoutInterval))) + { + m_fullLayoutRequired = false; + m_fullLayoutTime = 0; + GetBuffer().Invalidate(wxRICHTEXT_ALL); + ShowPosition(m_fullLayoutSavedPosition); + Refresh(false); + } + + if (m_caretPositionForDefaultStyle != -2) + { + // If the caret position has changed, no longer reflect the default style + // in the UI. + if (GetCaretPosition() != m_caretPositionForDefaultStyle) + m_caretPositionForDefaultStyle = -2; + } + + event.Skip(); +} + +/// Scrolling +void wxRichTextCtrl::OnScroll(wxScrollWinEvent& event) +{ +#if wxRICHTEXT_USE_OWN_CARET + if (!((wxRichTextCaret*) GetCaret())->GetNeedsUpdate()) + { + GetCaret()->Hide(); + ((wxRichTextCaret*) GetCaret())->SetNeedsUpdate(); + } +#endif + + event.Skip(); +} + +/// Set up scrollbars, e.g. after a resize +void wxRichTextCtrl::SetupScrollbars(bool atTop) +{ + if (IsFrozen()) + return; + + if (GetBuffer().IsEmpty() || !m_verticalScrollbarEnabled) + { + SetScrollbars(0, 0, 0, 0, 0, 0); + return; + } + + // TODO: reimplement scrolling so we scroll by line, not by fixed number + // of pixels. See e.g. wxVScrolledWindow for ideas. + int pixelsPerUnit = 5; + wxSize clientSize = GetClientSize(); + + int maxHeight = (int) (0.5 + GetScale() * (GetBuffer().GetCachedSize().y + GetBuffer().GetTopMargin())); + + // Round up so we have at least maxHeight pixels + int unitsY = (int) (((float)maxHeight/(float)pixelsPerUnit) + 0.5); + + int startX = 0, startY = 0; + if (!atTop) + GetViewStart(& startX, & startY); + + int maxPositionX = 0; + int maxPositionY = (int) ((((float)(wxMax((unitsY*pixelsPerUnit) - clientSize.y, 0)))/((float)pixelsPerUnit)) + 0.5); + + int newStartX = wxMin(maxPositionX, startX); + int newStartY = wxMin(maxPositionY, startY); + + int oldPPUX, oldPPUY; + int oldStartX, oldStartY; + int oldVirtualSizeX = 0, oldVirtualSizeY = 0; + GetScrollPixelsPerUnit(& oldPPUX, & oldPPUY); + GetViewStart(& oldStartX, & oldStartY); + GetVirtualSize(& oldVirtualSizeX, & oldVirtualSizeY); + if (oldPPUY > 0) + oldVirtualSizeY /= oldPPUY; + + if (oldPPUX == 0 && oldPPUY == pixelsPerUnit && oldVirtualSizeY == unitsY && oldStartX == newStartX && oldStartY == newStartY) + return; + + // Don't set scrollbars if there were none before, and there will be none now. + if (oldPPUY != 0 && (oldVirtualSizeY*oldPPUY < clientSize.y) && (unitsY*pixelsPerUnit < clientSize.y)) + return; + + // Move to previous scroll position if + // possible + SetScrollbars(0, pixelsPerUnit, 0, unitsY, newStartX, newStartY); +} + +/// Paint the background +void wxRichTextCtrl::PaintBackground(wxDC& dc) +{ + wxColour backgroundColour = GetBackgroundColour(); + if (!backgroundColour.IsOk()) + backgroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE); + + // Clear the background + dc.SetBrush(wxBrush(backgroundColour)); + dc.SetPen(*wxTRANSPARENT_PEN); + wxRect windowRect(GetClientSize()); + windowRect.x -= 2; windowRect.y -= 2; + windowRect.width += 4; windowRect.height += 4; + + // We need to shift the rectangle to take into account + // scrolling. Converting device to logical coordinates. + CalcUnscrolledPosition(windowRect.x, windowRect.y, & windowRect.x, & windowRect.y); + dc.DrawRectangle(windowRect); +} + +#if wxRICHTEXT_BUFFERED_PAINTING +/// Recreate buffer bitmap if necessary +bool wxRichTextCtrl::RecreateBuffer(const wxSize& size) +{ + wxSize sz = size; + if (sz == wxDefaultSize) + sz = GetClientSize(); + + if (sz.x < 1 || sz.y < 1) + return false; + + if (!m_bufferBitmap.IsOk() || m_bufferBitmap.GetWidth() < sz.x || m_bufferBitmap.GetHeight() < sz.y) + m_bufferBitmap = wxBitmap(sz.x, sz.y); + return m_bufferBitmap.IsOk(); +} +#endif + +// ---------------------------------------------------------------------------- +// file IO functions +// ---------------------------------------------------------------------------- + +bool wxRichTextCtrl::DoLoadFile(const wxString& filename, int fileType) +{ + SetFocusObject(& GetBuffer(), true); + + bool success = GetBuffer().LoadFile(filename, (wxRichTextFileType)fileType); + if (success) + m_filename = filename; + + DiscardEdits(); + SetInsertionPoint(0); + LayoutContent(); + PositionCaret(); + SetupScrollbars(true); + Refresh(false); + wxTextCtrl::SendTextUpdatedEvent(this); + + if (success) + return true; + else + { + wxLogError(_("File couldn't be loaded.")); + + return false; + } +} + +bool wxRichTextCtrl::DoSaveFile(const wxString& filename, int fileType) +{ + if (GetBuffer().SaveFile(filename, (wxRichTextFileType)fileType)) + { + m_filename = filename; + + DiscardEdits(); + + return true; + } + + wxLogError(_("The text couldn't be saved.")); + + return false; +} + +// ---------------------------------------------------------------------------- +// wxRichTextCtrl specific functionality +// ---------------------------------------------------------------------------- + +/// Add a new paragraph of text to the end of the buffer +wxRichTextRange wxRichTextCtrl::AddParagraph(const wxString& text) +{ + wxRichTextRange range = GetFocusObject()->AddParagraph(text); + GetBuffer().Invalidate(); + LayoutContent(); + return range; +} + +/// Add an image +wxRichTextRange wxRichTextCtrl::AddImage(const wxImage& image) +{ + wxRichTextRange range = GetFocusObject()->AddImage(image); + GetBuffer().Invalidate(); + LayoutContent(); + return range; +} + +// ---------------------------------------------------------------------------- +// selection and ranges +// ---------------------------------------------------------------------------- + +/// Select none +void wxRichTextCtrl::SelectNone() +{ + if (m_selection.IsValid()) + { + wxRichTextSelection oldSelection = m_selection; + + m_selection.Reset(); + + RefreshForSelectionChange(oldSelection, m_selection); + } + m_selectionAnchor = -2; + m_selectionAnchorObject = NULL; + m_selectionState = wxRichTextCtrlSelectionState_Normal; +} + +static bool wxIsWordDelimiter(const wxString& text) +{ + return !text.IsEmpty() && !wxIsalnum(text[0]); +} + +/// Select the word at the given character position +bool wxRichTextCtrl::SelectWord(long position) +{ + if (position < 0 || position > GetFocusObject()->GetOwnRange().GetEnd()) + return false; + + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(position); + if (!para) + return false; + + if (position == para->GetRange().GetEnd()) + position --; + + long positionStart = position; + long positionEnd = position; + + for (positionStart = position; positionStart >= para->GetRange().GetStart(); positionStart --) + { + wxString text = GetFocusObject()->GetTextForRange(wxRichTextRange(positionStart, positionStart)); + if (wxIsWordDelimiter(text)) + { + positionStart ++; + break; + } + } + if (positionStart < para->GetRange().GetStart()) + positionStart = para->GetRange().GetStart(); + + for (positionEnd = position; positionEnd < para->GetRange().GetEnd(); positionEnd ++) + { + wxString text = GetFocusObject()->GetTextForRange(wxRichTextRange(positionEnd, positionEnd)); + if (wxIsWordDelimiter(text)) + { + positionEnd --; + break; + } + } + if (positionEnd >= para->GetRange().GetEnd()) + positionEnd = para->GetRange().GetEnd(); + + if (positionEnd < positionStart) + return false; + + SetSelection(positionStart, positionEnd+1); + + if (positionStart >= 0) + { + MoveCaret(positionStart-1, true); + SetDefaultStyleToCursorStyle(); + } + + return true; +} + +wxString wxRichTextCtrl::GetStringSelection() const +{ + long from, to; + GetSelection(&from, &to); + + return GetRange(from, to); +} + +// ---------------------------------------------------------------------------- +// hit testing +// ---------------------------------------------------------------------------- + +wxTextCtrlHitTestResult +wxRichTextCtrl::HitTest(const wxPoint& pt, wxTextCoord *x, wxTextCoord *y) const +{ + // implement in terms of the other overload as the native ports typically + // can get the position and not (x, y) pair directly (although wxUniv + // directly gets x and y -- and so overrides this method as well) + long pos; + wxTextCtrlHitTestResult rc = HitTest(pt, &pos); + + if ( rc != wxTE_HT_UNKNOWN ) + { + PositionToXY(pos, x, y); + } + + return rc; +} + +wxTextCtrlHitTestResult +wxRichTextCtrl::HitTest(const wxPoint& pt, + long * pos) const +{ + wxClientDC dc((wxRichTextCtrl*) this); + ((wxRichTextCtrl*)this)->PrepareDC(dc); + + // Buffer uses logical position (relative to start of buffer) + // so convert + wxPoint pt2 = GetLogicalPoint(pt); + + wxRichTextObject* hitObj = NULL; + wxRichTextObject* contextObj = NULL; + wxRichTextDrawingContext context((wxRichTextBuffer*) & GetBuffer()); + int hit = ((wxRichTextCtrl*)this)->GetFocusObject()->HitTest(dc, context, pt2, *pos, & hitObj, & contextObj, wxRICHTEXT_HITTEST_NO_NESTED_OBJECTS); + + if ((hit & wxRICHTEXT_HITTEST_BEFORE) && (hit & wxRICHTEXT_HITTEST_OUTSIDE)) + return wxTE_HT_BEFORE; + else if ((hit & wxRICHTEXT_HITTEST_AFTER) && (hit & wxRICHTEXT_HITTEST_OUTSIDE)) + return wxTE_HT_BEYOND; + else if (hit & (wxRICHTEXT_HITTEST_BEFORE|wxRICHTEXT_HITTEST_AFTER)) + return wxTE_HT_ON_TEXT; + + return wxTE_HT_UNKNOWN; +} + +wxRichTextParagraphLayoutBox* +wxRichTextCtrl::FindContainerAtPoint(const wxPoint pt, long& position, int& hit, wxRichTextObject* hitObj, int flags/* = 0*/) +{ + wxClientDC dc(this); + PrepareDC(dc); + dc.SetFont(GetFont()); + + wxPoint logicalPt = GetLogicalPoint(pt); + + wxRichTextObject* contextObj = NULL; + wxRichTextDrawingContext context(& GetBuffer()); + hit = GetBuffer().HitTest(dc, context, GetUnscaledPoint(logicalPt), position, &hitObj, &contextObj, flags); + wxRichTextParagraphLayoutBox* container = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox); + + return container; +} + + +// ---------------------------------------------------------------------------- +// set/get the controls text +// ---------------------------------------------------------------------------- + +wxString wxRichTextCtrl::DoGetValue() const +{ + return GetBuffer().GetText(); +} + +wxString wxRichTextCtrl::GetRange(long from, long to) const +{ + // Public API for range is different from internals + return GetFocusObject()->GetTextForRange(wxRichTextRange(from, to-1)); +} + +void wxRichTextCtrl::DoSetValue(const wxString& value, int flags) +{ + // Don't call Clear here, since it always sends a text updated event + m_buffer.ResetAndClearCommands(); + m_buffer.Invalidate(wxRICHTEXT_ALL); + m_caretPosition = -1; + m_caretPositionForDefaultStyle = -2; + m_caretAtLineStart = false; + m_selection.Reset(); + m_selectionState = wxRichTextCtrlSelectionState_Normal; + + Scroll(0,0); + + if (!IsFrozen()) + { + LayoutContent(); + Refresh(false); + } + + if (!value.IsEmpty()) + { + // Remove empty paragraph + GetBuffer().Clear(); + DoWriteText(value, flags); + + // for compatibility, don't move the cursor when doing SetValue() + SetInsertionPoint(0); + } + else + { + // still send an event for consistency + if (flags & SetValue_SendEvent) + wxTextCtrl::SendTextUpdatedEvent(this); + } + DiscardEdits(); +} + +void wxRichTextCtrl::WriteText(const wxString& value) +{ + DoWriteText(value); +} + +void wxRichTextCtrl::DoWriteText(const wxString& value, int flags) +{ + wxString valueUnix = wxTextFile::Translate(value, wxTextFileType_Unix); + + GetFocusObject()->InsertTextWithUndo(& GetBuffer(), m_caretPosition+1, valueUnix, this, wxRICHTEXT_INSERT_WITH_PREVIOUS_PARAGRAPH_STYLE); + wxRichTextDrawingContext context(& GetBuffer()); + GetBuffer().Defragment(context); + + if ( flags & SetValue_SendEvent ) + wxTextCtrl::SendTextUpdatedEvent(this); +} + +void wxRichTextCtrl::AppendText(const wxString& text) +{ + SetInsertionPointEnd(); + + WriteText(text); +} + +/// Write an image at the current insertion point +bool wxRichTextCtrl::WriteImage(const wxImage& image, wxBitmapType bitmapType, const wxRichTextAttr& textAttr) +{ + wxRichTextImageBlock imageBlock; + + wxImage image2 = image; + if (imageBlock.MakeImageBlock(image2, bitmapType)) + return WriteImage(imageBlock, textAttr); + + return false; +} + +bool wxRichTextCtrl::WriteImage(const wxString& filename, wxBitmapType bitmapType, const wxRichTextAttr& textAttr) +{ + wxRichTextImageBlock imageBlock; + + wxImage image; + if (imageBlock.MakeImageBlock(filename, bitmapType, image, false)) + return WriteImage(imageBlock, textAttr); + + return false; +} + +bool wxRichTextCtrl::WriteImage(const wxRichTextImageBlock& imageBlock, const wxRichTextAttr& textAttr) +{ + return GetFocusObject()->InsertImageWithUndo(& GetBuffer(), m_caretPosition+1, imageBlock, this, 0, textAttr); +} + +bool wxRichTextCtrl::WriteImage(const wxBitmap& bitmap, wxBitmapType bitmapType, const wxRichTextAttr& textAttr) +{ + if (bitmap.IsOk()) + { + wxRichTextImageBlock imageBlock; + + wxImage image = bitmap.ConvertToImage(); + if (image.IsOk() && imageBlock.MakeImageBlock(image, bitmapType)) + return WriteImage(imageBlock, textAttr); + } + + return false; +} + +// Write a text box at the current insertion point. +wxRichTextBox* wxRichTextCtrl::WriteTextBox(const wxRichTextAttr& textAttr) +{ + wxRichTextBox* textBox = new wxRichTextBox; + textBox->SetAttributes(textAttr); + textBox->SetParent(& GetBuffer()); // set parent temporarily for AddParagraph to use correct style + textBox->AddParagraph(wxEmptyString); + textBox->SetParent(NULL); + + // The object returned is the one actually inserted into the buffer, + // while the original one is deleted. + wxRichTextObject* obj = GetFocusObject()->InsertObjectWithUndo(& GetBuffer(), m_caretPosition+1, textBox, this, wxRICHTEXT_INSERT_WITH_PREVIOUS_PARAGRAPH_STYLE); + wxRichTextBox* box = wxDynamicCast(obj, wxRichTextBox); + return box; +} + +wxRichTextField* wxRichTextCtrl::WriteField(const wxString& fieldType, const wxRichTextProperties& properties, + const wxRichTextAttr& textAttr) +{ + return GetFocusObject()->InsertFieldWithUndo(& GetBuffer(), m_caretPosition+1, fieldType, properties, + this, wxRICHTEXT_INSERT_WITH_PREVIOUS_PARAGRAPH_STYLE, textAttr); +} + +// Write a table at the current insertion point, returning the table. +wxRichTextTable* wxRichTextCtrl::WriteTable(int rows, int cols, const wxRichTextAttr& tableAttr, const wxRichTextAttr& cellAttr) +{ + wxASSERT(rows > 0 && cols > 0); + + if (rows <= 0 || cols <= 0) + return NULL; + + wxRichTextTable* table = new wxRichTextTable; + table->SetAttributes(tableAttr); + table->SetParent(& GetBuffer()); // set parent temporarily for AddParagraph to use correct style + + table->CreateTable(rows, cols); + + table->SetParent(NULL); + + int i, j; + for (j = 0; j < rows; j++) + { + for (i = 0; i < cols; i++) + { + table->GetCell(j, i)->GetAttributes() = cellAttr; + } + } + + // The object returned is the one actually inserted into the buffer, + // while the original one is deleted. + wxRichTextObject* obj = GetFocusObject()->InsertObjectWithUndo(& GetBuffer(), m_caretPosition+1, table, this, wxRICHTEXT_INSERT_WITH_PREVIOUS_PARAGRAPH_STYLE); + wxRichTextTable* tableResult = wxDynamicCast(obj, wxRichTextTable); + return tableResult; +} + + +/// Insert a newline (actually paragraph) at the current insertion point. +bool wxRichTextCtrl::Newline() +{ + return GetFocusObject()->InsertNewlineWithUndo(& GetBuffer(), m_caretPosition+1, this, wxRICHTEXT_INSERT_WITH_PREVIOUS_PARAGRAPH_STYLE); +} + +/// Insert a line break at the current insertion point. +bool wxRichTextCtrl::LineBreak() +{ + wxString text; + text = wxRichTextLineBreakChar; + return GetFocusObject()->InsertTextWithUndo(& GetBuffer(), m_caretPosition+1, text, this); +} + +// ---------------------------------------------------------------------------- +// Clipboard operations +// ---------------------------------------------------------------------------- + +void wxRichTextCtrl::Copy() +{ + if (CanCopy()) + { + wxRichTextRange range = GetInternalSelectionRange(); + GetBuffer().CopyToClipboard(range); + } +} + +void wxRichTextCtrl::Cut() +{ + if (CanCut()) + { + wxRichTextRange range = GetInternalSelectionRange(); + GetBuffer().CopyToClipboard(range); + + DeleteSelectedContent(); + LayoutContent(); + Refresh(false); + } +} + +void wxRichTextCtrl::Paste() +{ + if (CanPaste()) + { + BeginBatchUndo(_("Paste")); + + long newPos = m_caretPosition; + DeleteSelectedContent(& newPos); + + GetBuffer().PasteFromClipboard(newPos); + + EndBatchUndo(); + } +} + +void wxRichTextCtrl::DeleteSelection() +{ + if (CanDeleteSelection()) + { + DeleteSelectedContent(); + } +} + +bool wxRichTextCtrl::HasSelection() const +{ + return (m_selection.IsValid() && m_selection.GetContainer() == GetFocusObject()); +} + +bool wxRichTextCtrl::HasUnfocusedSelection() const +{ + return m_selection.IsValid(); +} + +bool wxRichTextCtrl::CanCopy() const +{ + // Can copy if there's a selection + return HasSelection(); +} + +bool wxRichTextCtrl::CanCut() const +{ + return CanDeleteSelection(); +} + +bool wxRichTextCtrl::CanPaste() const +{ + if ( !IsEditable() || !GetFocusObject() || !CanInsertContent(* GetFocusObject(), m_caretPosition+1)) + return false; + + return GetBuffer().CanPasteFromClipboard(); +} + +bool wxRichTextCtrl::CanDeleteSelection() const +{ + return HasSelection() && IsEditable() && CanDeleteRange(* GetFocusObject(), GetSelectionRange()); +} + + +// ---------------------------------------------------------------------------- +// Accessors +// ---------------------------------------------------------------------------- + +void wxRichTextCtrl::SetContextMenu(wxMenu* menu) +{ + if (m_contextMenu && m_contextMenu != menu) + delete m_contextMenu; + m_contextMenu = menu; +} + +void wxRichTextCtrl::SetEditable(bool editable) +{ + m_editable = editable; +} + +void wxRichTextCtrl::SetInsertionPoint(long pos) +{ + SelectNone(); + + m_caretPosition = pos - 1; + m_caretAtLineStart = true; + + PositionCaret(); + + SetDefaultStyleToCursorStyle(); +} + +void wxRichTextCtrl::SetInsertionPointEnd() +{ + long pos = GetLastPosition(); + SetInsertionPoint(pos); +} + +long wxRichTextCtrl::GetInsertionPoint() const +{ + return m_caretPosition+1; } -/// Move right -bool wxRichTextCtrl::MoveRight(int noPositions, int flags) +wxTextPos wxRichTextCtrl::GetLastPosition() const { - long endPos = GetBuffer().GetRange().GetEnd(); + return GetFocusObject()->GetOwnRange().GetEnd(); +} - if (m_caretPosition + noPositions < endPos) +// If the return values from and to are the same, there is no +// selection. +void wxRichTextCtrl::GetSelection(long* from, long* to) const +{ + if (m_selection.IsValid()) { - long oldPos = m_caretPosition; - long newPos = m_caretPosition + noPositions; + *from = m_selection.GetRange().GetStart(); + *to = m_selection.GetRange().GetEnd(); + (*to) ++; + } + else + { + *from = -2; + *to = -2; + } +} - bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); - if (!extendSel) - SelectNone(); +bool wxRichTextCtrl::IsEditable() const +{ + return m_editable; +} - // Determine by looking at oldPos and m_caretPosition whether - // we moved from the end of a line to the start of the next line, in which case - // we want to adjust the caret position such that it is positioned at the - // start of the next line, rather than jumping past the first character of the - // line. - if (noPositions == 1 && !extendSel) - MoveCaretForward(oldPos); - else - SetCaretPosition(newPos); +// ---------------------------------------------------------------------------- +// selection +// ---------------------------------------------------------------------------- - PositionCaret(); - SetDefaultStyleToCursorStyle(); +void wxRichTextCtrl::SetSelection(long from, long to) +{ + // if from and to are both -1, it means (in wxWidgets) that all text should + // be selected. + if ( (from == -1) && (to == -1) ) + { + from = 0; + to = GetLastPosition()+1; + } - if (extendSel) - Refresh(false); - return true; + if (from == to) + { + SelectNone(); } else - return false; + { + wxRichTextSelection oldSelection = m_selection; + + m_selectionAnchor = from-1; + m_selectionAnchorObject = NULL; + m_selection.Set(wxRichTextRange(from, to-1), GetFocusObject()); + + m_caretPosition = wxMax(-1, to-1); + + RefreshForSelectionChange(oldSelection, m_selection); + PositionCaret(); + } } -/// Move left -bool wxRichTextCtrl::MoveLeft(int noPositions, int flags) +// ---------------------------------------------------------------------------- +// Editing +// ---------------------------------------------------------------------------- + +void wxRichTextCtrl::Replace(long from, long to, + const wxString& value) { - long startPos = -1; + BeginBatchUndo(_("Replace")); - if (m_caretPosition > startPos - noPositions + 1) - { - long oldPos = m_caretPosition; - long newPos = m_caretPosition - noPositions; - bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); - if (!extendSel) - SelectNone(); + SetSelection(from, to); - if (noPositions == 1 && !extendSel) - MoveCaretBack(oldPos); - else - SetCaretPosition(newPos); + wxRichTextAttr attr(GetDefaultStyle()); - PositionCaret(); - SetDefaultStyleToCursorStyle(); + DeleteSelectedContent(); - if (extendSel) - Refresh(false); - return true; - } - else - return false; + SetDefaultStyle(attr); + + if (!value.IsEmpty()) + DoWriteText(value, SetValue_SelectionOnly); + + EndBatchUndo(); } -/// Move up -bool wxRichTextCtrl::MoveUp(int noLines, int flags) +void wxRichTextCtrl::Remove(long from, long to) { - return MoveDown(- noLines, flags); + SelectNone(); + + GetFocusObject()->DeleteRangeWithUndo(wxRichTextRange(from, to-1), this, & GetBuffer()); + + LayoutContent(); + if (!IsFrozen()) + Refresh(false); } -/// Move up -bool wxRichTextCtrl::MoveDown(int noLines, int flags) +bool wxRichTextCtrl::IsModified() const { - if (!GetCaret()) - return false; + return m_buffer.IsModified(); +} - long lineNumber = GetBuffer().GetVisibleLineNumber(m_caretPosition, true, m_caretAtLineStart); - wxPoint pt = GetCaret()->GetPosition(); - long newLine = lineNumber + noLines; +void wxRichTextCtrl::MarkDirty() +{ + m_buffer.Modify(true); +} - if (lineNumber != -1) - { - if (noLines > 0) - { - long lastLine = GetBuffer().GetVisibleLineNumber(GetBuffer().GetRange().GetEnd()); +void wxRichTextCtrl::DiscardEdits() +{ + m_caretPositionForDefaultStyle = -2; + m_buffer.Modify(false); + m_buffer.GetCommandProcessor()->ClearCommands(); +} - if (newLine > lastLine) - return false; - } - else - { - if (newLine < 0) - return false; - } - } +int wxRichTextCtrl::GetNumberOfLines() const +{ + return GetFocusObject()->GetParagraphCount(); +} - wxRichTextLine* lineObj = GetBuffer().GetLineForVisibleLineNumber(newLine); - if (lineObj) - { - pt.y = lineObj->GetAbsolutePosition().y + 2; - } - else - return false; +// ---------------------------------------------------------------------------- +// Positions <-> coords +// ---------------------------------------------------------------------------- - long newPos = 0; - wxClientDC dc(this); - PrepareDC(dc); - dc.SetFont(GetFont()); +long wxRichTextCtrl::XYToPosition(long x, long y) const +{ + return GetFocusObject()->XYToPosition(x, y); +} - int hitTest = GetBuffer().HitTest(dc, pt, newPos); +bool wxRichTextCtrl::PositionToXY(long pos, long *x, long *y) const +{ + return GetFocusObject()->PositionToXY(pos, x, y); +} - if (hitTest != wxRICHTEXT_HITTEST_NONE) - { - // If end of previous line, and hitTest is wxRICHTEXT_HITTEST_BEFORE, - // we want to be at the end of the last line but with m_caretAtLineStart set to true, - // so we view the caret at the start of the line. - bool caretLineStart = false; - if (hitTest == wxRICHTEXT_HITTEST_BEFORE) - { - wxRichTextLine* thisLine = GetBuffer().GetLineAtPosition(newPos-1); - wxRichTextRange lineRange; - if (thisLine) - lineRange = thisLine->GetAbsoluteRange(); +// ---------------------------------------------------------------------------- +// +// ---------------------------------------------------------------------------- - if (thisLine && (newPos-1) == lineRange.GetEnd()) - { - newPos --; - caretLineStart = true; - } - else - { - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(newPos); - if (para && para->GetRange().GetStart() == newPos) - newPos --; - } - } +void wxRichTextCtrl::ShowPosition(long pos) +{ + if (!IsPositionVisible(pos)) + ScrollIntoView(pos-1, WXK_DOWN); +} - long newSelEnd = newPos; +int wxRichTextCtrl::GetLineLength(long lineNo) const +{ + return GetFocusObject()->GetParagraphLength(lineNo); +} - bool extendSel = ExtendSelection(m_caretPosition, newSelEnd, flags); - if (!extendSel) - SelectNone(); +wxString wxRichTextCtrl::GetLineText(long lineNo) const +{ + return GetFocusObject()->GetParagraphText(lineNo); +} - SetCaretPosition(newPos, caretLineStart); - PositionCaret(); - SetDefaultStyleToCursorStyle(); +// ---------------------------------------------------------------------------- +// Undo/redo +// ---------------------------------------------------------------------------- - if (extendSel) - Refresh(false); - return true; +void wxRichTextCtrl::Undo() +{ + if (CanUndo()) + { + GetCommandProcessor()->Undo(); } - - return false; } -/// Move to the end of the paragraph -bool wxRichTextCtrl::MoveToParagraphEnd(int flags) +void wxRichTextCtrl::Redo() { - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(m_caretPosition, true); - if (para) + if (CanRedo()) { - long newPos = para->GetRange().GetEnd() - 1; - bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); - if (!extendSel) - SelectNone(); - - SetCaretPosition(newPos); - PositionCaret(); - SetDefaultStyleToCursorStyle(); - - if (extendSel) - Refresh(false); - return true; + GetCommandProcessor()->Redo(); } +} - return false; +bool wxRichTextCtrl::CanUndo() const +{ + return GetCommandProcessor()->CanUndo() && IsEditable(); } -/// Move to the start of the paragraph -bool wxRichTextCtrl::MoveToParagraphStart(int flags) +bool wxRichTextCtrl::CanRedo() const { - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(m_caretPosition, true); - if (para) - { - long newPos = para->GetRange().GetStart() - 1; - bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); - if (!extendSel) - SelectNone(); + return GetCommandProcessor()->CanRedo() && IsEditable(); +} - SetCaretPosition(newPos); - PositionCaret(); - SetDefaultStyleToCursorStyle(); +// ---------------------------------------------------------------------------- +// implementation details +// ---------------------------------------------------------------------------- - if (extendSel) - Refresh(false); - return true; - } +void wxRichTextCtrl::Command(wxCommandEvent& event) +{ + SetValue(event.GetString()); + GetEventHandler()->ProcessEvent(event); +} - return false; +void wxRichTextCtrl::OnDropFiles(wxDropFilesEvent& event) +{ + // By default, load the first file into the text window. + if (event.GetNumberOfFiles() > 0) + { + LoadFile(event.GetFiles()[0]); + } } -/// Move to the end of the line -bool wxRichTextCtrl::MoveToLineEnd(int flags) +wxSize wxRichTextCtrl::DoGetBestSize() const { - wxRichTextLine* line = GetVisibleLineForCaretPosition(m_caretPosition); + return wxSize(10, 10); +} - if (line) - { - wxRichTextRange lineRange = line->GetAbsoluteRange(); - long newPos = lineRange.GetEnd(); - bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); - if (!extendSel) - SelectNone(); +// ---------------------------------------------------------------------------- +// standard handlers for standard edit menu events +// ---------------------------------------------------------------------------- - SetCaretPosition(newPos); - PositionCaret(); - SetDefaultStyleToCursorStyle(); +void wxRichTextCtrl::OnCut(wxCommandEvent& WXUNUSED(event)) +{ + Cut(); +} - if (extendSel) - Refresh(false); - return true; - } +void wxRichTextCtrl::OnClear(wxCommandEvent& WXUNUSED(event)) +{ + DeleteSelection(); +} - return false; +void wxRichTextCtrl::OnCopy(wxCommandEvent& WXUNUSED(event)) +{ + Copy(); } -/// Move to the start of the line -bool wxRichTextCtrl::MoveToLineStart(int flags) +void wxRichTextCtrl::OnPaste(wxCommandEvent& WXUNUSED(event)) { - wxRichTextLine* line = GetVisibleLineForCaretPosition(m_caretPosition); - if (line) - { - wxRichTextRange lineRange = line->GetAbsoluteRange(); - long newPos = lineRange.GetStart()-1; + Paste(); +} - bool extendSel = ExtendSelection(m_caretPosition, newPos, flags); - if (!extendSel) - SelectNone(); +void wxRichTextCtrl::OnUndo(wxCommandEvent& WXUNUSED(event)) +{ + Undo(); +} - wxRichTextParagraph* para = GetBuffer().GetParagraphForLine(line); +void wxRichTextCtrl::OnRedo(wxCommandEvent& WXUNUSED(event)) +{ + Redo(); +} - SetCaretPosition(newPos, para->GetRange().GetStart() != lineRange.GetStart()); - PositionCaret(); - SetDefaultStyleToCursorStyle(); +void wxRichTextCtrl::OnUpdateCut(wxUpdateUIEvent& event) +{ + event.Enable( CanCut() ); +} - if (extendSel) - Refresh(false); - return true; - } +void wxRichTextCtrl::OnUpdateCopy(wxUpdateUIEvent& event) +{ + event.Enable( CanCopy() ); +} - return false; +void wxRichTextCtrl::OnUpdateClear(wxUpdateUIEvent& event) +{ + event.Enable( CanDeleteSelection() ); } -/// Move to the start of the buffer -bool wxRichTextCtrl::MoveHome(int flags) +void wxRichTextCtrl::OnUpdatePaste(wxUpdateUIEvent& event) { - if (m_caretPosition != -1) - { - bool extendSel = ExtendSelection(m_caretPosition, -1, flags); - if (!extendSel) - SelectNone(); + event.Enable( CanPaste() ); +} - SetCaretPosition(-1); - PositionCaret(); - SetDefaultStyleToCursorStyle(); +void wxRichTextCtrl::OnUpdateUndo(wxUpdateUIEvent& event) +{ + event.Enable( CanUndo() ); + event.SetText( GetCommandProcessor()->GetUndoMenuLabel() ); +} - if (extendSel) - Refresh(false); - return true; - } - else - return false; +void wxRichTextCtrl::OnUpdateRedo(wxUpdateUIEvent& event) +{ + event.Enable( CanRedo() ); + event.SetText( GetCommandProcessor()->GetRedoMenuLabel() ); } -/// Move to the end of the buffer -bool wxRichTextCtrl::MoveEnd(int flags) +void wxRichTextCtrl::OnSelectAll(wxCommandEvent& WXUNUSED(event)) { - long endPos = GetBuffer().GetRange().GetEnd()-1; + if (GetLastPosition() > 0) + SelectAll(); +} - if (m_caretPosition != endPos) - { - bool extendSel = ExtendSelection(m_caretPosition, endPos, flags); - if (!extendSel) - SelectNone(); +void wxRichTextCtrl::OnUpdateSelectAll(wxUpdateUIEvent& event) +{ + event.Enable(GetLastPosition() > 0); +} - SetCaretPosition(endPos); - PositionCaret(); - SetDefaultStyleToCursorStyle(); +void wxRichTextCtrl::OnProperties(wxCommandEvent& event) +{ + int idx = event.GetId() - wxID_RICHTEXT_PROPERTIES1; + if (idx >= 0 && idx < m_contextMenuPropertiesInfo.GetCount()) + { + wxRichTextObject* obj = m_contextMenuPropertiesInfo.GetObject(idx); + if (obj && CanEditProperties(obj)) + EditProperties(obj, this); - if (extendSel) - Refresh(false); - return true; + m_contextMenuPropertiesInfo.Clear(); } - else - return false; } -/// Move noPages pages up -bool wxRichTextCtrl::PageUp(int noPages, int flags) +void wxRichTextCtrl::OnUpdateProperties(wxUpdateUIEvent& event) { - return PageDown(- noPages, flags); + int idx = event.GetId() - wxID_RICHTEXT_PROPERTIES1; + event.Enable(idx >= 0 && idx < m_contextMenuPropertiesInfo.GetCount()); } -/// Move noPages pages down -bool wxRichTextCtrl::PageDown(int noPages, int flags) +void wxRichTextCtrl::OnContextMenu(wxContextMenuEvent& event) { - // Calculate which line occurs noPages * screen height further down. - wxRichTextLine* line = GetVisibleLineForCaretPosition(m_caretPosition); - if (line) + if (event.GetEventObject() != this) { - wxSize clientSize = GetClientSize(); - int newY = line->GetAbsolutePosition().y + noPages*clientSize.y; - - wxRichTextLine* newLine = GetBuffer().GetLineAtYPosition(newY); - if (newLine) - { - wxRichTextRange lineRange = newLine->GetAbsoluteRange(); - long pos = lineRange.GetStart()-1; - if (pos != m_caretPosition) - { - wxRichTextParagraph* para = GetBuffer().GetParagraphForLine(newLine); - - bool extendSel = ExtendSelection(m_caretPosition, pos, flags); - if (!extendSel) - SelectNone(); - - SetCaretPosition(pos, para->GetRange().GetStart() != lineRange.GetStart()); - PositionCaret(); - SetDefaultStyleToCursorStyle(); - - if (extendSel) - Refresh(false); - return true; - } - } + event.Skip(); + return; } - return false; + ShowContextMenu(m_contextMenu, event.GetPosition()); } -// Finds the caret position for the next word -long wxRichTextCtrl::FindNextWordPosition(int direction) const +// Prepares the context menu, adding appropriate property-editing commands. +// Returns the number of property commands added. +int wxRichTextCtrl::PrepareContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands) { - long endPos = GetBuffer().GetRange().GetEnd(); + wxClientDC dc(this); + PrepareDC(dc); + dc.SetFont(GetFont()); - if (direction > 0) + m_contextMenuPropertiesInfo.Clear(); + + long position = 0; + wxRichTextObject* hitObj = NULL; + wxRichTextObject* contextObj = NULL; + if (pt != wxDefaultPosition) { - long i = m_caretPosition+1+direction; // +1 for conversion to character pos + wxPoint logicalPt = GetLogicalPoint(ScreenToClient(pt)); + wxRichTextDrawingContext context(& GetBuffer()); + int hit = GetBuffer().HitTest(dc, context, GetUnscaledPoint(logicalPt), position, & hitObj, & contextObj); - // First skip current text to space - while (i < endPos && i > -1) + if (hit == wxRICHTEXT_HITTEST_ON || hit == wxRICHTEXT_HITTEST_BEFORE || hit == wxRICHTEXT_HITTEST_AFTER) { - // i is in character, not caret positions - wxString text = GetBuffer().GetTextForRange(wxRichTextRange(i, i)); - if (text != wxT(" ") && !text.empty()) - i += direction; - else + wxRichTextParagraphLayoutBox* actualContainer = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox); + if (hitObj && actualContainer) { - break; + if (actualContainer->AcceptsFocus()) + { + SetFocusObject(actualContainer, false /* don't set caret position yet */); + SetCaretPositionAfterClick(actualContainer, position, hit); + } + + if (addPropertyCommands) + m_contextMenuPropertiesInfo.AddItems(this, actualContainer, hitObj); } - } - while (i < endPos && i > -1) - { - // i is in character, not caret positions - wxString text = GetBuffer().GetTextForRange(wxRichTextRange(i, i)); - if (text.empty()) // End of paragraph, or maybe an image - return wxMax(-1, i - 1); - else if (text == wxT(" ") || text.empty()) - i += direction; else { - // Convert to caret position - return wxMax(-1, i - 1); + if (addPropertyCommands) + m_contextMenuPropertiesInfo.AddItems(this, GetFocusObject(), NULL); } } - if (i >= endPos) - return endPos-1; - return i-1; + else + { + if (addPropertyCommands) + m_contextMenuPropertiesInfo.AddItems(this, GetFocusObject(), NULL); + } } else { - long i = m_caretPosition; + // Invoked from the keyboard, so don't set the caret position and don't use the event + // position + hitObj = GetFocusObject()->GetLeafObjectAtPosition(m_caretPosition+1); + if (hitObj) + contextObj = hitObj->GetParentContainer(); + else + contextObj = GetFocusObject(); - // First skip white space - while (i < endPos && i > -1) + wxRichTextParagraphLayoutBox* actualContainer = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox); + if (hitObj && actualContainer) { - // i is in character, not caret positions - wxString text = GetBuffer().GetTextForRange(wxRichTextRange(i, i)); - if (text.empty()) // End of paragraph, or maybe an image - break; - else if (text == wxT(" ") || text.empty()) - i += direction; - else - break; + if (addPropertyCommands) + m_contextMenuPropertiesInfo.AddItems(this, actualContainer, hitObj); } - // Next skip current text to space - while (i < endPos && i > -1) + else { - // i is in character, not caret positions - wxString text = GetBuffer().GetTextForRange(wxRichTextRange(i, i)); - if (text != wxT(" ") /* && !text.empty() */) - i += direction; - else - { - return i; - } + if (addPropertyCommands) + m_contextMenuPropertiesInfo.AddItems(this, GetFocusObject(), NULL); } - if (i < -1) - return -1; - return i; - } -} - -/// Move n words left -bool wxRichTextCtrl::WordLeft(int WXUNUSED(n), int flags) -{ - long pos = FindNextWordPosition(-1); - if (pos != m_caretPosition) - { - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(pos, true); - - bool extendSel = ExtendSelection(m_caretPosition, pos, flags); - if (!extendSel) - SelectNone(); - - SetCaretPosition(pos, para->GetRange().GetStart() != pos); - PositionCaret(); - SetDefaultStyleToCursorStyle(); - - if (extendSel) - Refresh(false); - return true; - } - - return false; -} - -/// Move n words right -bool wxRichTextCtrl::WordRight(int WXUNUSED(n), int flags) -{ - long pos = FindNextWordPosition(1); - if (pos != m_caretPosition) - { - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(pos, true); - - bool extendSel = ExtendSelection(m_caretPosition, pos, flags); - if (!extendSel) - SelectNone(); - - SetCaretPosition(pos, para->GetRange().GetStart() != pos); - PositionCaret(); - SetDefaultStyleToCursorStyle(); - - if (extendSel) - Refresh(false); - return true; - } - - return false; -} - -/// Sizing -void wxRichTextCtrl::OnSize(wxSizeEvent& event) -{ - // Only do sizing optimization for large buffers - if (GetBuffer().GetRange().GetEnd() > m_delayedLayoutThreshold) - { - m_fullLayoutRequired = true; - m_fullLayoutTime = wxGetLocalTimeMillis(); - m_fullLayoutSavedPosition = GetFirstVisiblePosition(); - LayoutContent(true /* onlyVisibleRect */); } - else - GetBuffer().Invalidate(wxRICHTEXT_ALL); - - RecreateBuffer(); - - event.Skip(); -} - - -/// Idle-time processing -void wxRichTextCtrl::OnIdle(wxIdleEvent& event) -{ - const int layoutInterval = wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL; - if (m_fullLayoutRequired && (wxGetLocalTimeMillis() > (m_fullLayoutTime + layoutInterval))) + if (menu) { - m_fullLayoutRequired = false; - m_fullLayoutTime = 0; - GetBuffer().Invalidate(wxRICHTEXT_ALL); - ShowPosition(m_fullLayoutSavedPosition); - Refresh(false); + if (addPropertyCommands) + m_contextMenuPropertiesInfo.AddMenuItems(menu); + return m_contextMenuPropertiesInfo.GetCount(); } - event.Skip(); -} - -/// Scrolling -void wxRichTextCtrl::OnScroll(wxScrollWinEvent& event) -{ - // Not used - event.Skip(); + else + return 0; } -/// Set up scrollbars, e.g. after a resize -void wxRichTextCtrl::SetupScrollbars(bool atTop) +// Shows the context menu, adding appropriate property-editing commands +bool wxRichTextCtrl::ShowContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands) { - if (m_freezeCount) - return; - - if (GetBuffer().IsEmpty()) + if (menu) { - SetScrollbars(0, 0, 0, 0, 0, 0); - return; + PrepareContextMenu(menu, pt, addPropertyCommands); + PopupMenu(menu); + return true; } + else + return false; +} - // TODO: reimplement scrolling so we scroll by line, not by fixed number - // of pixels. See e.g. wxVScrolledWindow for ideas. - int pixelsPerUnit = 5; // 10; - wxSize clientSize = GetClientSize(); - - int maxHeight = GetBuffer().GetCachedSize().y; - - int unitsY = maxHeight/pixelsPerUnit; - - int startX = 0, startY = 0; - if (!atTop) - GetViewStart(& startX, & startY); - - int maxPositionX = 0; // wxMax(sz.x - clientSize.x, 0); - int maxPositionY = (wxMax(maxHeight - clientSize.y, 0))/pixelsPerUnit; - - // Move to previous scroll position if - // possible - SetScrollbars(0, pixelsPerUnit, - 0, unitsY, - wxMin(maxPositionX, startX), wxMin(maxPositionY, startY)); +bool wxRichTextCtrl::SetStyle(long start, long end, const wxTextAttr& style) +{ + return GetFocusObject()->SetStyle(wxRichTextRange(start, end-1), wxRichTextAttr(style)); } -/// Paint the background -void wxRichTextCtrl::PaintBackground(wxDC& dc) +bool wxRichTextCtrl::SetStyle(long start, long end, const wxRichTextAttr& style) { - wxColour backgroundColour = GetBackgroundColour(); - if (!backgroundColour.Ok()) - backgroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE); + return GetFocusObject()->SetStyle(wxRichTextRange(start, end-1), style); +} - // Clear the background - dc.SetBrush(wxBrush(backgroundColour)); - dc.SetPen(*wxTRANSPARENT_PEN); - wxRect windowRect(GetClientSize()); - windowRect.x -= 2; windowRect.y -= 2; - windowRect.width += 4; windowRect.height += 4; +bool wxRichTextCtrl::SetStyle(const wxRichTextRange& range, const wxTextAttr& style) +{ + return GetFocusObject()->SetStyle(range.ToInternal(), wxRichTextAttr(style)); +} - // We need to shift the rectangle to take into account - // scrolling. Converting device to logical coordinates. - CalcUnscrolledPosition(windowRect.x, windowRect.y, & windowRect.x, & windowRect.y); - dc.DrawRectangle(windowRect); +bool wxRichTextCtrl::SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style) +{ + return GetFocusObject()->SetStyle(range.ToInternal(), style); } -/// Recreate buffer bitmap if necessary -bool wxRichTextCtrl::RecreateBuffer(const wxSize& size) +void wxRichTextCtrl::SetStyle(wxRichTextObject *obj, const wxRichTextAttr& textAttr, int flags) { - wxSize sz = size; - if (sz == wxDefaultSize) - sz = GetClientSize(); + GetFocusObject()->SetStyle(obj, textAttr, flags); +} - if (sz.x < 1 || sz.y < 1) - return false; +// extended style setting operation with flags including: +// wxRICHTEXT_SETSTYLE_WITH_UNDO, wxRICHTEXT_SETSTYLE_OPTIMIZE, wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY. +// see richtextbuffer.h for more details. - if (!m_bufferBitmap.Ok() || m_bufferBitmap.GetWidth() < sz.x || m_bufferBitmap.GetHeight() < sz.y) - m_bufferBitmap = wxBitmap(sz.x, sz.y); - return m_bufferBitmap.Ok(); +bool wxRichTextCtrl::SetStyleEx(const wxRichTextRange& range, const wxRichTextAttr& style, int flags) +{ + return GetFocusObject()->SetStyle(range.ToInternal(), style, flags); } -// ---------------------------------------------------------------------------- -// file IO functions -// ---------------------------------------------------------------------------- +bool wxRichTextCtrl::SetDefaultStyle(const wxTextAttr& style) +{ + return GetBuffer().SetDefaultStyle(style); +} -bool wxRichTextCtrl::LoadFile(const wxString& filename, int type) +bool wxRichTextCtrl::SetDefaultStyle(const wxRichTextAttr& style) { - bool success = GetBuffer().LoadFile(filename, type); - if (success) - m_filename = filename; + wxRichTextAttr attr1(style); + attr1.GetTextBoxAttr().Reset(); + return GetBuffer().SetDefaultStyle(attr1); +} - DiscardEdits(); - SetInsertionPoint(0); - LayoutContent(); - PositionCaret(); - SetupScrollbars(true); - Refresh(false); - SendUpdateEvent(); +const wxRichTextAttr& wxRichTextCtrl::GetDefaultStyleEx() const +{ + return GetBuffer().GetDefaultStyle(); +} - if (success) +bool wxRichTextCtrl::GetStyle(long position, wxTextAttr& style) +{ + wxRichTextAttr attr; + if (GetFocusObject()->GetStyle(position, attr)) + { + style = attr; return true; + } else - { - wxLogError(_("File couldn't be loaded.")); - return false; - } } -bool wxRichTextCtrl::SaveFile(const wxString& filename, int type) +bool wxRichTextCtrl::GetStyle(long position, wxRichTextAttr& style) { - wxString filenameToUse = filename.empty() ? m_filename : filename; - if ( filenameToUse.empty() ) - { - // what kind of message to give? is it an error or a program bug? - wxLogDebug(wxT("Can't save textctrl to file without filename.")); + return GetFocusObject()->GetStyle(position, style); +} - return false; +bool wxRichTextCtrl::GetStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container) +{ + wxRichTextAttr attr; + if (container->GetStyle(position, attr)) + { + style = attr; + return true; } + else + return false; +} - if (GetBuffer().SaveFile(filenameToUse, type)) +// get the common set of styles for the range +bool wxRichTextCtrl::GetStyleForRange(const wxRichTextRange& range, wxTextAttr& style) +{ + wxRichTextAttr attr; + if (GetFocusObject()->GetStyleForRange(range.ToInternal(), attr)) { - m_filename = filenameToUse; - - DiscardEdits(); - + style = attr; return true; - } - - wxLogError(_("The text couldn't be saved.")); - - return false; + else + return false; } -// ---------------------------------------------------------------------------- -// wxRichTextCtrl specific functionality -// ---------------------------------------------------------------------------- - -/// Add a new paragraph of text to the end of the buffer -wxRichTextRange wxRichTextCtrl::AddParagraph(const wxString& text) +bool wxRichTextCtrl::GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style) { - return GetBuffer().AddParagraph(text); + return GetFocusObject()->GetStyleForRange(range.ToInternal(), style); } -/// Add an image -wxRichTextRange wxRichTextCtrl::AddImage(const wxImage& image) +bool wxRichTextCtrl::GetStyleForRange(const wxRichTextRange& range, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container) { - return GetBuffer().AddImage(image); + return container->GetStyleForRange(range.ToInternal(), style); } -// ---------------------------------------------------------------------------- -// selection and ranges -// ---------------------------------------------------------------------------- +/// Get the content (uncombined) attributes for this position. +bool wxRichTextCtrl::GetUncombinedStyle(long position, wxRichTextAttr& style) +{ + return GetFocusObject()->GetUncombinedStyle(position, style); +} -void wxRichTextCtrl::SelectAll() +/// Get the content (uncombined) attributes for this position. +bool wxRichTextCtrl::GetUncombinedStyle(long position, wxRichTextAttr& style, wxRichTextParagraphLayoutBox* container) { - SetSelection(0, GetLastPosition()); - m_selectionAnchor = -1; + return container->GetUncombinedStyle(position, style); } -/// Select none -void wxRichTextCtrl::SelectNone() +bool wxRichTextCtrl::SetProperties(const wxRichTextRange& range, const wxRichTextProperties& properties, int flags) { - if (!(GetSelectionRange() == wxRichTextRange(-2, -2))) - SetSelection(-2, -2); - m_selectionAnchor = -2; + return GetFocusObject()->SetProperties(range.ToInternal(), properties, flags); } -wxString wxRichTextCtrl::GetStringSelection() const +/// Set font, and also the buffer attributes +bool wxRichTextCtrl::SetFont(const wxFont& font) { - long from, to; - GetSelection(&from, &to); + wxControl::SetFont(font); - return GetRange(from, to); + wxRichTextAttr attr = GetBuffer().GetAttributes(); + attr.SetFont(font); + GetBuffer().SetBasicStyle(attr); + + GetBuffer().Invalidate(wxRICHTEXT_ALL); + Refresh(false); + + return true; } -// do the window-specific processing after processing the update event -#if !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE -void wxRichTextCtrl::DoUpdateWindowUI(wxUpdateUIEvent& event) +/// Transform logical to physical +wxPoint wxRichTextCtrl::GetPhysicalPoint(const wxPoint& ptLogical) const { - // call inherited - wxWindowBase::DoUpdateWindowUI(event); + wxPoint pt; + CalcScrolledPosition(ptLogical.x, ptLogical.y, & pt.x, & pt.y); - // update text - if ( event.GetSetText() ) - { - if ( event.GetText() != GetValue() ) - SetValue(event.GetText()); - } + return pt; } -#endif // !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE -// ---------------------------------------------------------------------------- -// hit testing -// ---------------------------------------------------------------------------- +/// Transform physical to logical +wxPoint wxRichTextCtrl::GetLogicalPoint(const wxPoint& ptPhysical) const +{ + wxPoint pt; + CalcUnscrolledPosition(ptPhysical.x, ptPhysical.y, & pt.x, & pt.y); -wxTextCtrlHitTestResult -wxRichTextCtrl::HitTest(const wxPoint& pt, wxTextCoord *x, wxTextCoord *y) const + return pt; +} + +/// Position the caret +void wxRichTextCtrl::PositionCaret(wxRichTextParagraphLayoutBox* container) { - // implement in terms of the other overload as the native ports typically - // can get the position and not (x, y) pair directly (although wxUniv - // directly gets x and y -- and so overrides this method as well) - long pos; - wxTextCtrlHitTestResult rc = HitTest(pt, &pos); + if (!GetCaret()) + return; - if ( rc != wxTE_HT_UNKNOWN ) + //wxLogDebug(wxT("PositionCaret")); + + wxRect caretRect; + if (GetCaretPositionForIndex(GetCaretPosition(), caretRect, container)) { - PositionToXY(pos, x, y); - } +#if !wxRICHTEXT_USE_OWN_CARET + caretRect = GetScaledRect(caretRect); +#endif + int topMargin = (int) (0.5 + GetScale()*GetBuffer().GetTopMargin()); + int bottomMargin = (int) (0.5 + GetScale()*GetBuffer().GetBottomMargin()); + wxPoint newPt = caretRect.GetPosition(); + wxSize newSz = caretRect.GetSize(); + wxPoint pt = GetPhysicalPoint(newPt); + if (GetCaret()->GetPosition() != pt || GetCaret()->GetSize() != newSz) + { + GetCaret()->Hide(); + if (GetCaret()->GetSize() != newSz) + GetCaret()->SetSize(newSz); - return rc; + // Adjust size so the caret size and position doesn't appear in the margins + if (((pt.y + newSz.y) <= topMargin) || (pt.y >= (GetClientSize().y - bottomMargin))) + { + pt.x = -200; + pt.y = -200; + } + else if (pt.y < topMargin && (pt.y + newSz.y) > topMargin) + { + newSz.y -= (topMargin - pt.y); + if (newSz.y > 0) + { + pt.y = topMargin; + GetCaret()->SetSize(newSz); + } + } + else if (pt.y < (GetClientSize().y - bottomMargin) && (pt.y + newSz.y) > (GetClientSize().y - bottomMargin)) + { + newSz.y = GetClientSize().y - bottomMargin - pt.y; + GetCaret()->SetSize(newSz); + } + + GetCaret()->Move(pt); + GetCaret()->Show(); + } + } } -wxTextCtrlHitTestResult -wxRichTextCtrl::HitTest(const wxPoint& pt, - long * pos) const +/// Get the caret height and position for the given character position +bool wxRichTextCtrl::GetCaretPositionForIndex(long position, wxRect& rect, wxRichTextParagraphLayoutBox* container) { - wxClientDC dc((wxRichTextCtrl*) this); - ((wxRichTextCtrl*)this)->PrepareDC(dc); + wxClientDC dc(this); + PrepareDC(dc); + dc.SetUserScale(GetScale(), GetScale()); + dc.SetFont(GetFont()); + + wxPoint pt; + int height = 0; - int hit = ((wxRichTextCtrl*)this)->GetBuffer().HitTest(dc, pt, *pos); + if (!container) + container = GetFocusObject(); - switch ( hit ) + wxRichTextDrawingContext context(& GetBuffer()); + if (container->FindPosition(dc, context, position, pt, & height, m_caretAtLineStart)) { - case wxRICHTEXT_HITTEST_BEFORE: - return wxTE_HT_BEFORE; + // Caret height can't be zero + if (height == 0) + height = dc.GetCharHeight(); - case wxRICHTEXT_HITTEST_AFTER: - return wxTE_HT_BEYOND; - - case wxRICHTEXT_HITTEST_ON: - return wxTE_HT_ON_TEXT; + rect = wxRect(pt, wxSize(wxRICHTEXT_DEFAULT_CARET_WIDTH, height)); + return true; } - return wxTE_HT_UNKNOWN; + return false; } -// ---------------------------------------------------------------------------- -// set/get the controls text -// ---------------------------------------------------------------------------- - -wxString wxRichTextCtrl::GetValue() const +/// 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. +wxRichTextLine* wxRichTextCtrl::GetVisibleLineForCaretPosition(long caretPosition) const { - return GetBuffer().GetText(); + wxRichTextLine* line = GetFocusObject()->GetLineAtPosition(caretPosition, true); + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(caretPosition, true); + if (line) + { + wxRichTextRange lineRange = line->GetAbsoluteRange(); + if (caretPosition == lineRange.GetStart()-1 && + (para->GetRange().GetStart() != lineRange.GetStart())) + { + if (!m_caretAtLineStart) + line = GetFocusObject()->GetLineAtPosition(caretPosition-1, true); + } + } + return line; } -wxString wxRichTextCtrl::GetRange(long from, long to) const -{ - return GetBuffer().GetTextForRange(wxRichTextRange(from, to)); -} -void wxRichTextCtrl::SetValue(const wxString& value) +/// Move the caret to the given character position +bool wxRichTextCtrl::MoveCaret(long pos, bool showAtLineStart, wxRichTextParagraphLayoutBox* container) { - Clear(); + if (GetBuffer().IsDirty()) + LayoutContent(); + + if (!container) + container = GetFocusObject(); - // if the text is long enough, it's faster to just set it instead of first - // comparing it with the old one (chances are that it will be different - // anyhow, this comparison is there to avoid flicker for small single-line - // edit controls mostly) - if ( (value.length() > 0x400) || (value != GetValue()) ) + if (pos <= container->GetOwnRange().GetEnd()) { - DoWriteText(value, false /* not selection only */); + SetCaretPosition(pos, showAtLineStart); - // for compatibility, don't move the cursor when doing SetValue() - SetInsertionPoint(0); + PositionCaret(container); + + return true; } - else // same text + else + return false; +} + +/// Layout the buffer: which we must do before certain operations, such as +/// setting the caret position. +bool wxRichTextCtrl::LayoutContent(bool onlyVisibleRect) +{ + if (GetBuffer().IsDirty() || onlyVisibleRect) { - // still send an event for consistency - SendUpdateEvent(); - } + wxRect availableSpace(GetUnscaledSize(GetClientSize())); + if (availableSpace.width == 0) + availableSpace.width = 10; + if (availableSpace.height == 0) + availableSpace.height = 10; + + int flags = wxRICHTEXT_FIXED_WIDTH|wxRICHTEXT_VARIABLE_HEIGHT; + if (onlyVisibleRect) + { + flags |= wxRICHTEXT_LAYOUT_SPECIFIED_RECT; + availableSpace.SetPosition(GetUnscaledPoint(GetLogicalPoint(wxPoint(0, 0)))); + } + + wxClientDC dc(this); + + PrepareDC(dc); + dc.SetFont(GetFont()); + dc.SetUserScale(GetScale(), GetScale()); - // we should reset the modified flag even if the value didn't really change + wxRichTextDrawingContext context(& GetBuffer()); + GetBuffer().Defragment(context); + GetBuffer().UpdateRanges(); // If items were deleted, ranges need recalculation + GetBuffer().Layout(dc, context, availableSpace, availableSpace, flags); + GetBuffer().Invalidate(wxRICHTEXT_NONE); - // mark the control as being not dirty - we changed its text, not the - // user - DiscardEdits(); -} + dc.SetUserScale(1.0, 1.0); -void wxRichTextCtrl::WriteText(const wxString& value) -{ - DoWriteText(value); -} + if (!IsFrozen() && !onlyVisibleRect) + SetupScrollbars(); + } -void wxRichTextCtrl::DoWriteText(const wxString& value, bool WXUNUSED(selectionOnly)) -{ - GetBuffer().InsertTextWithUndo(m_caretPosition+1, value, this); + return true; } -void wxRichTextCtrl::AppendText(const wxString& text) +/// Is all of the selection, or the current caret position, bold? +bool wxRichTextCtrl::IsSelectionBold() { - SetInsertionPointEnd(); + if (HasSelection()) + { + wxRichTextAttr attr; + wxRichTextRange range = GetSelectionRange(); + attr.SetFlags(wxTEXT_ATTR_FONT_WEIGHT); + attr.SetFontWeight(wxFONTWEIGHT_BOLD); - WriteText(text); + return HasCharacterAttributes(range, attr); + } + else + { + // If no selection, then we need to combine current style with default style + // to see what the effect would be if we started typing. + wxRichTextAttr attr; + attr.SetFlags(wxTEXT_ATTR_FONT_WEIGHT); + + long pos = GetAdjustedCaretPosition(GetCaretPosition()); + if (GetStyle(pos, attr)) + { + if (IsDefaultStyleShowing()) + wxRichTextApplyStyle(attr, GetDefaultStyleEx()); + return attr.GetFontWeight() == wxFONTWEIGHT_BOLD; + } + } + return false; } -/// Write an image at the current insertion point -bool wxRichTextCtrl::WriteImage(const wxImage& image, int bitmapType) +/// Is all of the selection, or the current caret position, italics? +bool wxRichTextCtrl::IsSelectionItalics() { - wxRichTextImageBlock imageBlock; + if (HasSelection()) + { + wxRichTextRange range = GetSelectionRange(); + wxRichTextAttr attr; + attr.SetFlags(wxTEXT_ATTR_FONT_ITALIC); + attr.SetFontStyle(wxFONTSTYLE_ITALIC); - wxImage image2 = image; - if (imageBlock.MakeImageBlock(image2, bitmapType)) - return WriteImage(imageBlock); + return HasCharacterAttributes(range, attr); + } + else + { + // If no selection, then we need to combine current style with default style + // to see what the effect would be if we started typing. + wxRichTextAttr attr; + attr.SetFlags(wxTEXT_ATTR_FONT_ITALIC); + long pos = GetAdjustedCaretPosition(GetCaretPosition()); + if (GetStyle(pos, attr)) + { + if (IsDefaultStyleShowing()) + wxRichTextApplyStyle(attr, GetDefaultStyleEx()); + return attr.GetFontStyle() == wxFONTSTYLE_ITALIC; + } + } return false; } -bool wxRichTextCtrl::WriteImage(const wxString& filename, int bitmapType) +/// Is all of the selection, or the current caret position, underlined? +bool wxRichTextCtrl::IsSelectionUnderlined() { - wxRichTextImageBlock imageBlock; + if (HasSelection()) + { + wxRichTextRange range = GetSelectionRange(); + wxRichTextAttr attr; + attr.SetFlags(wxTEXT_ATTR_FONT_UNDERLINE); + attr.SetFontUnderlined(true); - wxImage image; - if (imageBlock.MakeImageBlock(filename, bitmapType, image, false)) - return WriteImage(imageBlock); + return HasCharacterAttributes(range, attr); + } + else + { + // If no selection, then we need to combine current style with default style + // to see what the effect would be if we started typing. + wxRichTextAttr attr; + attr.SetFlags(wxTEXT_ATTR_FONT_UNDERLINE); + long pos = GetAdjustedCaretPosition(GetCaretPosition()); + if (GetStyle(pos, attr)) + { + if (IsDefaultStyleShowing()) + wxRichTextApplyStyle(attr, GetDefaultStyleEx()); + return attr.GetFontUnderlined(); + } + } return false; } -bool wxRichTextCtrl::WriteImage(const wxRichTextImageBlock& imageBlock) +/// Does all of the selection, or the current caret position, have this wxTextAttrEffects flag(s)? +bool wxRichTextCtrl::DoesSelectionHaveTextEffectFlag(int flag) { - return GetBuffer().InsertImageWithUndo(m_caretPosition+1, imageBlock, this); -} + wxRichTextAttr attr; + attr.SetFlags(wxTEXT_ATTR_EFFECTS); + attr.SetTextEffectFlags(flag); + attr.SetTextEffects(flag); -bool wxRichTextCtrl::WriteImage(const wxBitmap& bitmap, int bitmapType) -{ - if (bitmap.Ok()) + if (HasSelection()) { - wxRichTextImageBlock imageBlock; - - wxImage image = bitmap.ConvertToImage(); - if (image.Ok() && imageBlock.MakeImageBlock(image, bitmapType)) - return WriteImage(imageBlock); + return HasCharacterAttributes(GetSelectionRange(), attr); + } + else + { + // If no selection, then we need to combine current style with default style + // to see what the effect would be if we started typing. + long pos = GetAdjustedCaretPosition(GetCaretPosition()); + if (GetStyle(pos, attr)) + { + if (IsDefaultStyleShowing()) + wxRichTextApplyStyle(attr, GetDefaultStyleEx()); + return (attr.GetTextEffectFlags() & flag) != 0; + } } - return false; } -/// Insert a newline (actually paragraph) at the current insertion point. -bool wxRichTextCtrl::Newline() +/// Apply bold to the selection +bool wxRichTextCtrl::ApplyBoldToSelection() { - return GetBuffer().InsertNewlineWithUndo(m_caretPosition+1, this); -} - - -// ---------------------------------------------------------------------------- -// Clipboard operations -// ---------------------------------------------------------------------------- + wxRichTextAttr attr; + attr.SetFlags(wxTEXT_ATTR_FONT_WEIGHT); + attr.SetFontWeight(IsSelectionBold() ? wxFONTWEIGHT_NORMAL : wxFONTWEIGHT_BOLD); -void wxRichTextCtrl::Copy() -{ - if (CanCopy()) + if (HasSelection()) + return SetStyleEx(GetSelectionRange(), attr, wxRICHTEXT_SETSTYLE_WITH_UNDO|wxRICHTEXT_SETSTYLE_OPTIMIZE|wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY); + else { - wxRichTextRange range = GetSelectionRange(); - GetBuffer().CopyToClipboard(range); + wxRichTextAttr current = GetDefaultStyleEx(); + current.Apply(attr); + SetAndShowDefaultStyle(current); } + return true; } -void wxRichTextCtrl::Cut() +/// Apply italic to the selection +bool wxRichTextCtrl::ApplyItalicToSelection() { - if (CanCut()) - { - wxRichTextRange range = GetSelectionRange(); - GetBuffer().CopyToClipboard(range); + wxRichTextAttr attr; + attr.SetFlags(wxTEXT_ATTR_FONT_ITALIC); + attr.SetFontStyle(IsSelectionItalics() ? wxFONTSTYLE_NORMAL : wxFONTSTYLE_ITALIC); - DeleteSelectedContent(); - LayoutContent(); - Refresh(false); + if (HasSelection()) + return SetStyleEx(GetSelectionRange(), attr, wxRICHTEXT_SETSTYLE_WITH_UNDO|wxRICHTEXT_SETSTYLE_OPTIMIZE|wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY); + else + { + wxRichTextAttr current = GetDefaultStyleEx(); + current.Apply(attr); + SetAndShowDefaultStyle(current); } + return true; } -void wxRichTextCtrl::Paste() +/// Apply underline to the selection +bool wxRichTextCtrl::ApplyUnderlineToSelection() { - if (CanPaste()) - { - BeginBatchUndo(_("Paste")); - - long newPos = m_caretPosition; - DeleteSelectedContent(& newPos); - - GetBuffer().PasteFromClipboard(newPos); + wxRichTextAttr attr; + attr.SetFlags(wxTEXT_ATTR_FONT_UNDERLINE); + attr.SetFontUnderlined(!IsSelectionUnderlined()); - EndBatchUndo(); + if (HasSelection()) + return SetStyleEx(GetSelectionRange(), attr, wxRICHTEXT_SETSTYLE_WITH_UNDO|wxRICHTEXT_SETSTYLE_OPTIMIZE|wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY); + else + { + wxRichTextAttr current = GetDefaultStyleEx(); + current.Apply(attr); + SetAndShowDefaultStyle(current); } + return true; } -void wxRichTextCtrl::DeleteSelection() +/// Apply the wxTextAttrEffects flag(s) to the selection, or the current caret position if there's no selection +bool wxRichTextCtrl::ApplyTextEffectToSelection(int flags) { - if (CanDeleteSelection()) + wxRichTextAttr attr; + attr.SetFlags(wxTEXT_ATTR_EFFECTS); + attr.SetTextEffectFlags(flags); + if (!DoesSelectionHaveTextEffectFlag(flags)) + attr.SetTextEffects(flags); + else + attr.SetTextEffects(attr.GetTextEffectFlags() & ~flags); + + if (HasSelection()) + return SetStyleEx(GetSelectionRange(), attr, wxRICHTEXT_SETSTYLE_WITH_UNDO|wxRICHTEXT_SETSTYLE_OPTIMIZE|wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY); + else { - DeleteSelectedContent(); + wxRichTextAttr current = GetDefaultStyleEx(); + current.Apply(attr); + SetAndShowDefaultStyle(current); } + return true; } -bool wxRichTextCtrl::HasSelection() const +/// Is all of the selection aligned according to the specified flag? +bool wxRichTextCtrl::IsSelectionAligned(wxTextAttrAlignment alignment) { - return m_selectionRange.GetStart() != -2 && m_selectionRange.GetEnd() != -2; -} + wxRichTextRange range; + if (HasSelection()) + range = GetSelectionRange(); + else + range = wxRichTextRange(GetCaretPosition()+1, GetCaretPosition()+2); -bool wxRichTextCtrl::CanCopy() const -{ - // Can copy if there's a selection - return HasSelection(); + wxRichTextAttr attr; + attr.SetAlignment(alignment); + + return HasParagraphAttributes(range, attr); } -bool wxRichTextCtrl::CanCut() const +/// Apply alignment to the selection +bool wxRichTextCtrl::ApplyAlignmentToSelection(wxTextAttrAlignment alignment) { - return HasSelection() && IsEditable(); + wxRichTextAttr attr; + attr.SetAlignment(alignment); + if (HasSelection()) + return SetStyle(GetSelectionRange(), attr); + else + { + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(GetCaretPosition()+1); + if (para) + return SetStyleEx(para->GetRange().FromInternal(), attr, wxRICHTEXT_SETSTYLE_WITH_UNDO|wxRICHTEXT_SETSTYLE_OPTIMIZE|wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY); + } + return true; } -bool wxRichTextCtrl::CanPaste() const +/// Apply a named style to the selection +bool wxRichTextCtrl::ApplyStyle(wxRichTextStyleDefinition* def) { - if ( !IsEditable() ) - return false; + // Flags are defined within each definition, so only certain + // attributes are applied. + wxRichTextAttr attr(GetStyleSheet() ? def->GetStyleMergedWithBase(GetStyleSheet()) : def->GetStyle()); - return GetBuffer().CanPasteFromClipboard(); -} + int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO|wxRICHTEXT_SETSTYLE_OPTIMIZE|wxRICHTEXT_SETSTYLE_RESET; -bool wxRichTextCtrl::CanDeleteSelection() const -{ - return HasSelection() && IsEditable(); -} + if (wxDynamicCast(def, wxRichTextListStyleDefinition)) + { + flags |= wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY; + wxRichTextRange range; -// ---------------------------------------------------------------------------- -// Accessors -// ---------------------------------------------------------------------------- + if (HasSelection()) + range = GetSelectionRange(); + else + { + long pos = GetAdjustedCaretPosition(GetCaretPosition()); + range = wxRichTextRange(pos, pos+1); + } -void wxRichTextCtrl::SetEditable(bool editable) -{ - m_editable = editable; -} + return SetListStyle(range, (wxRichTextListStyleDefinition*) def, flags); + } -void wxRichTextCtrl::SetInsertionPoint(long pos) -{ - SelectNone(); + bool isPara = false; - m_caretPosition = pos - 1; -} + // Make sure the attr has the style name + if (wxDynamicCast(def, wxRichTextParagraphStyleDefinition)) + { + isPara = true; + attr.SetParagraphStyleName(def->GetName()); -void wxRichTextCtrl::SetInsertionPointEnd() -{ - long pos = GetLastPosition(); - SetInsertionPoint(pos); -} + // If applying a paragraph style, we only want the paragraph nodes to adopt these + // attributes, and not the leaf nodes. This will allow the content (e.g. text) + // to change its style independently. + flags |= wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY; + } + else if (wxDynamicCast(def, wxRichTextCharacterStyleDefinition)) + attr.SetCharacterStyleName(def->GetName()); + else if (wxDynamicCast(def, wxRichTextBoxStyleDefinition)) + attr.GetTextBoxAttr().SetBoxStyleName(def->GetName()); -long wxRichTextCtrl::GetInsertionPoint() const -{ - return m_caretPosition+1; -} + if (wxDynamicCast(def, wxRichTextBoxStyleDefinition)) + { + if (GetFocusObject() && (GetFocusObject() != & GetBuffer())) + { + SetStyle(GetFocusObject(), attr); + return true; + } + else + return false; + } + else if (HasSelection()) + return SetStyleEx(GetSelectionRange(), attr, flags); + else + { + wxRichTextAttr current = GetDefaultStyleEx(); + wxRichTextAttr defaultStyle(attr); + if (isPara) + { + // Don't apply extra character styles since they are already implied + // in the paragraph style + defaultStyle.SetFlags(defaultStyle.GetFlags() & ~wxTEXT_ATTR_CHARACTER); + } + current.Apply(defaultStyle); + SetAndShowDefaultStyle(current); -wxTextPos wxRichTextCtrl::GetLastPosition() const -{ - return GetBuffer().GetRange().GetEnd(); + // If it's a paragraph style, we want to apply the style to the + // current paragraph even if we didn't select any text. + if (isPara) + { + long pos = GetAdjustedCaretPosition(GetCaretPosition()); + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(pos); + if (para) + { + return SetStyleEx(para->GetRange().FromInternal(), attr, flags); + } + } + return true; + } } -// If the return values from and to are the same, there is no -// selection. -void wxRichTextCtrl::GetSelection(long* from, long* to) const +/// Apply the style sheet to the buffer, for example if the styles have changed. +bool wxRichTextCtrl::ApplyStyleSheet(wxRichTextStyleSheet* styleSheet) { - *from = m_selectionRange.GetStart(); - *to = m_selectionRange.GetEnd(); + if (!styleSheet) + styleSheet = GetBuffer().GetStyleSheet(); + if (!styleSheet) + return false; + + if (GetBuffer().ApplyStyleSheet(styleSheet)) + { + GetBuffer().Invalidate(wxRICHTEXT_ALL); + Refresh(false); + return true; + } + else + return false; } -bool wxRichTextCtrl::IsEditable() const +/// Sets the default style to the style under the cursor +bool wxRichTextCtrl::SetDefaultStyleToCursorStyle() { - return m_editable; -} + wxRichTextAttr attr; + attr.SetFlags(wxTEXT_ATTR_CHARACTER); -// ---------------------------------------------------------------------------- -// selection -// ---------------------------------------------------------------------------- + // If at the start of a paragraph, use the next position. + long pos = GetAdjustedCaretPosition(GetCaretPosition()); -void wxRichTextCtrl::SetSelection(long from, long to) -{ - // if from and to are both -1, it means (in wxWidgets) that all text should - // be selected. - if ( (from == -1) && (to == -1) ) + wxRichTextObject* obj = GetFocusObject()->GetLeafObjectAtPosition(pos); + if (obj && obj->IsTopLevel()) + { + // Don't use the attributes of a top-level object, since they might apply + // to content of the object, e.g. background colour. + SetDefaultStyle(wxRichTextAttr()); + return true; + } + else if (GetUncombinedStyle(pos, attr)) { - from = 0; - to = GetLastPosition(); + SetDefaultStyle(attr); + return true; } - DoSetSelection(from, to); + return false; } -void wxRichTextCtrl::DoSetSelection(long from, long to, bool WXUNUSED(scrollCaret)) +/// Returns the first visible position in the current view +long wxRichTextCtrl::GetFirstVisiblePosition() const { - m_selectionAnchor = from; - m_selectionRange.SetRange(from, to); - Refresh(false); - PositionCaret(); + wxRichTextLine* line = GetFocusObject()->GetLineAtYPosition(GetUnscaledPoint(GetLogicalPoint(wxPoint(0, 0))).y); + if (line) + return line->GetAbsoluteRange().GetStart(); + else + return 0; } -// ---------------------------------------------------------------------------- -// Editing -// ---------------------------------------------------------------------------- - -void wxRichTextCtrl::Replace(long WXUNUSED(from), long WXUNUSED(to), const wxString& value) +/// Get the first visible point in the window +wxPoint wxRichTextCtrl::GetFirstVisiblePoint() const { - BeginBatchUndo(_("Replace")); - - DeleteSelectedContent(); + int ppuX, ppuY; + int startXUnits, startYUnits; - DoWriteText(value, true /* selection only */); + GetScrollPixelsPerUnit(& ppuX, & ppuY); + GetViewStart(& startXUnits, & startYUnits); - EndBatchUndo(); + return wxPoint(startXUnits * ppuX, startYUnits * ppuY); } -void wxRichTextCtrl::Remove(long from, long to) +/// 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 wxRichTextCtrl::GetAdjustedCaretPosition(long caretPos) const { - SelectNone(); + wxRichTextParagraph* para = GetFocusObject()->GetParagraphAtPosition(caretPos+1); - GetBuffer().DeleteRangeWithUndo(wxRichTextRange(from, to), - m_caretPosition, // Current caret position - from, // New caret position - this); - - LayoutContent(); - if (!IsFrozen()) - Refresh(false); + if (para && (caretPos+1 == para->GetRange().GetStart())) + caretPos ++; + return caretPos; } -bool wxRichTextCtrl::IsModified() const +/// 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) +wxRichTextRange wxRichTextCtrl::GetSelectionRange() const { - return m_buffer.IsModified(); + wxRichTextRange range = GetInternalSelectionRange(); + if (range != wxRichTextRange(-2,-2) && range != wxRichTextRange(-1,-1)) + range.SetEnd(range.GetEnd() + 1); + return range; } -void wxRichTextCtrl::MarkDirty() +void wxRichTextCtrl::SetSelectionRange(const wxRichTextRange& range) { - m_buffer.Modify(true); + SetSelection(range.GetStart(), range.GetEnd()); } -void wxRichTextCtrl::DiscardEdits() +/// Set list style +bool wxRichTextCtrl::SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags, int startFrom, int specifiedLevel) { - m_buffer.Modify(false); - m_buffer.GetCommandProcessor()->ClearCommands(); + return GetFocusObject()->SetListStyle(range.ToInternal(), def, flags, startFrom, specifiedLevel); } -int wxRichTextCtrl::GetNumberOfLines() const +bool wxRichTextCtrl::SetListStyle(const wxRichTextRange& range, const wxString& defName, int flags, int startFrom, int specifiedLevel) { - return GetBuffer().GetParagraphCount(); + return GetFocusObject()->SetListStyle(range.ToInternal(), defName, flags, startFrom, specifiedLevel); } -// ---------------------------------------------------------------------------- -// Positions <-> coords -// ---------------------------------------------------------------------------- - -long wxRichTextCtrl::XYToPosition(long x, long y) const +/// Clear list for given range +bool wxRichTextCtrl::ClearListStyle(const wxRichTextRange& range, int flags) { - return GetBuffer().XYToPosition(x, y); + return GetFocusObject()->ClearListStyle(range.ToInternal(), flags); } -bool wxRichTextCtrl::PositionToXY(long pos, long *x, long *y) const +/// Number/renumber any list elements in the given range +bool wxRichTextCtrl::NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags, int startFrom, int specifiedLevel) { - return GetBuffer().PositionToXY(pos, x, y); + return GetFocusObject()->NumberList(range.ToInternal(), def, flags, startFrom, specifiedLevel); } -// ---------------------------------------------------------------------------- -// -// ---------------------------------------------------------------------------- - -void wxRichTextCtrl::ShowPosition(long pos) +bool wxRichTextCtrl::NumberList(const wxRichTextRange& range, const wxString& defName, int flags, int startFrom, int specifiedLevel) { - if (!IsPositionVisible(pos)) - ScrollIntoView(pos-1, WXK_DOWN); + return GetFocusObject()->NumberList(range.ToInternal(), defName, flags, startFrom, specifiedLevel); } -int wxRichTextCtrl::GetLineLength(long lineNo) const +/// Promote the list items within the given range. promoteBy can be a positive or negative number, e.g. 1 or -1 +bool wxRichTextCtrl::PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags, int specifiedLevel) { - return GetBuffer().GetParagraphLength(lineNo); + return GetFocusObject()->PromoteList(promoteBy, range.ToInternal(), def, flags, specifiedLevel); } -wxString wxRichTextCtrl::GetLineText(long lineNo) const +bool wxRichTextCtrl::PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags, int specifiedLevel) { - return GetBuffer().GetParagraphText(lineNo); + return GetFocusObject()->PromoteList(promoteBy, range.ToInternal(), defName, flags, specifiedLevel); } -// ---------------------------------------------------------------------------- -// Undo/redo -// ---------------------------------------------------------------------------- - -void wxRichTextCtrl::Undo() +// Given a character position at which there is a list style, find the range +// encompassing the same list style by looking backwards and forwards. +wxRichTextRange wxRichTextCtrl::FindRangeForList(long pos, bool& isNumberedList) { - if (CanUndo()) + wxRichTextParagraphLayoutBox* focusObject = GetFocusObject(); + wxRichTextRange range = wxRichTextRange(-1, -1); + wxRichTextParagraph* para = focusObject->GetParagraphAtPosition(pos); + if (!para || !para->GetAttributes().HasListStyleName()) + return range; + else { - GetCommandProcessor()->Undo(); + wxString listStyle = para->GetAttributes().GetListStyleName(); + range = para->GetRange(); + + isNumberedList = para->GetAttributes().HasBulletNumber(); + + // Search back + wxRichTextObjectList::compatibility_iterator initialNode = focusObject->GetChildren().Find(para); + if (initialNode) + { + wxRichTextObjectList::compatibility_iterator startNode = initialNode->GetPrevious(); + while (startNode) + { + wxRichTextParagraph* p = wxDynamicCast(startNode->GetData(), wxRichTextParagraph); + if (p) + { + if (!p->GetAttributes().HasListStyleName() || p->GetAttributes().GetListStyleName() != listStyle) + break; + else + range.SetStart(p->GetRange().GetStart()); + } + + startNode = startNode->GetPrevious(); + } + + // Search forward + wxRichTextObjectList::compatibility_iterator endNode = initialNode->GetNext(); + while (endNode) + { + wxRichTextParagraph* p = wxDynamicCast(endNode->GetData(), wxRichTextParagraph); + if (p) + { + if (!p->GetAttributes().HasListStyleName() || p->GetAttributes().GetListStyleName() != listStyle) + break; + else + range.SetEnd(p->GetRange().GetEnd()); + } + + endNode = endNode->GetNext(); + } + } } + return range; } -void wxRichTextCtrl::Redo() +/// Deletes the content in the given range +bool wxRichTextCtrl::Delete(const wxRichTextRange& range) { - if (CanRedo()) + return GetFocusObject()->DeleteRangeWithUndo(range.ToInternal(), this, & GetBuffer()); +} + +const wxArrayString& wxRichTextCtrl::GetAvailableFontNames() +{ + if (sm_availableFontNames.GetCount() == 0) { - GetCommandProcessor()->Redo(); + sm_availableFontNames = wxFontEnumerator::GetFacenames(); + sm_availableFontNames.Sort(); } + return sm_availableFontNames; } -bool wxRichTextCtrl::CanUndo() const +void wxRichTextCtrl::ClearAvailableFontNames() { - return GetCommandProcessor()->CanUndo(); + sm_availableFontNames.Clear(); } -bool wxRichTextCtrl::CanRedo() const +void wxRichTextCtrl::OnSysColourChanged(wxSysColourChangedEvent& WXUNUSED(event)) { - return GetCommandProcessor()->CanRedo(); -} + //wxLogDebug(wxT("wxRichTextCtrl::OnSysColourChanged")); -// ---------------------------------------------------------------------------- -// implemenation details -// ---------------------------------------------------------------------------- + wxTextAttrEx basicStyle = GetBasicStyle(); + basicStyle.SetTextColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT)); + SetBasicStyle(basicStyle); + SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW)); -void wxRichTextCtrl::Command(wxCommandEvent & event) -{ - SetValue(event.GetString()); - GetEventHandler()->ProcessEvent(event); + Refresh(); } -void wxRichTextCtrl::OnDropFiles(wxDropFilesEvent& event) +// Refresh the area affected by a selection change +bool wxRichTextCtrl::RefreshForSelectionChange(const wxRichTextSelection& oldSelection, const wxRichTextSelection& newSelection) { - // By default, load the first file into the text window. - if (event.GetNumberOfFiles() > 0) + // If the selection is not part of the focus object, or we have multiple ranges, then the chances are that + // the selection contains whole containers rather than just text, so refresh everything + // for now as it would be hard to compute the rectangle bounding all selections. + // TODO: improve on this. + if ((oldSelection.IsValid() && (oldSelection.GetContainer() != GetFocusObject() || oldSelection.GetCount() > 1)) || + (newSelection.IsValid() && (newSelection.GetContainer() != GetFocusObject() || newSelection.GetCount() > 1))) { - LoadFile(event.GetFiles()[0]); + Refresh(false); + return true; } -} - -// ---------------------------------------------------------------------------- -// text control event processing -// ---------------------------------------------------------------------------- -bool wxRichTextCtrl::SendUpdateEvent() -{ - wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId()); - InitCommandEvent(event); + wxRichTextRange oldRange, newRange; + if (oldSelection.IsValid()) + oldRange = oldSelection.GetRange(); + else + oldRange = wxRICHTEXT_NO_SELECTION; + if (newSelection.IsValid()) + newRange = newSelection.GetRange(); + else + newRange = wxRICHTEXT_NO_SELECTION; - return GetEventHandler()->ProcessEvent(event); -} + // Calculate the refresh rectangle - just the affected lines + long firstPos, lastPos; + if (oldRange.GetStart() == -2 && newRange.GetStart() != -2) + { + firstPos = newRange.GetStart(); + lastPos = newRange.GetEnd(); + } + else if (oldRange.GetStart() != -2 && newRange.GetStart() == -2) + { + firstPos = oldRange.GetStart(); + lastPos = oldRange.GetEnd(); + } + else if (oldRange.GetStart() == -2 && newRange.GetStart() == -2) + { + return false; + } + else + { + firstPos = wxMin(oldRange.GetStart(), newRange.GetStart()); + lastPos = wxMax(oldRange.GetEnd(), newRange.GetEnd()); + } -void wxRichTextCtrl::InitCommandEvent(wxCommandEvent& event) const -{ - event.SetEventObject((wxControlBase *)this); // const_cast + wxRichTextLine* firstLine = GetFocusObject()->GetLineAtPosition(firstPos); + wxRichTextLine* lastLine = GetFocusObject()->GetLineAtPosition(lastPos); - switch ( m_clientDataType ) + if (firstLine && lastLine) { - case wxClientData_Void: - event.SetClientData(GetClientData()); - break; + wxSize clientSize = GetClientSize(); + wxPoint pt1 = GetPhysicalPoint(GetScaledPoint(firstLine->GetAbsolutePosition())); + wxPoint pt2 = GetPhysicalPoint(GetScaledPoint(lastLine->GetAbsolutePosition())) + wxPoint(0, (int) (0.5 + lastLine->GetSize().y * GetScale())); - case wxClientData_Object: - event.SetClientObject(GetClientObject()); - break; + pt1.x = 0; + pt1.y = wxMax(0, pt1.y); + pt2.x = 0; + pt2.y = wxMin(clientSize.y, pt2.y); - case wxClientData_None: - // nothing to do - ; + wxRect rect(pt1, wxSize(clientSize.x, pt2.y - pt1.y)); + RefreshRect(rect, false); } -} - + else + Refresh(false); -wxSize wxRichTextCtrl::DoGetBestSize() const -{ - return wxSize(10, 10); + return true; } -// ---------------------------------------------------------------------------- -// standard handlers for standard edit menu events -// ---------------------------------------------------------------------------- - -void wxRichTextCtrl::OnCut(wxCommandEvent& WXUNUSED(event)) +// margins functions +bool wxRichTextCtrl::DoSetMargins(const wxPoint& pt) { - Cut(); -} + GetBuffer().GetAttributes().GetTextBoxAttr().GetMargins().GetLeft().SetValue(pt.x, wxTEXT_ATTR_UNITS_PIXELS); + GetBuffer().GetAttributes().GetTextBoxAttr().GetMargins().GetRight().SetValue(pt.x, wxTEXT_ATTR_UNITS_PIXELS); + GetBuffer().GetAttributes().GetTextBoxAttr().GetMargins().GetTop().SetValue(pt.y, wxTEXT_ATTR_UNITS_PIXELS); + GetBuffer().GetAttributes().GetTextBoxAttr().GetMargins().GetBottom().SetValue(pt.y, wxTEXT_ATTR_UNITS_PIXELS); -void wxRichTextCtrl::OnClear(wxCommandEvent& WXUNUSED(event)) -{ - DeleteSelection(); + return true; } -void wxRichTextCtrl::OnCopy(wxCommandEvent& WXUNUSED(event)) +wxPoint wxRichTextCtrl::DoGetMargins() const { - Copy(); + return wxPoint(GetBuffer().GetAttributes().GetTextBoxAttr().GetMargins().GetLeft().GetValue(), + GetBuffer().GetAttributes().GetTextBoxAttr().GetMargins().GetTop().GetValue()); } -void wxRichTextCtrl::OnPaste(wxCommandEvent& WXUNUSED(event)) +bool wxRichTextCtrl::SetFocusObject(wxRichTextParagraphLayoutBox* obj, bool setCaretPosition) { - Paste(); -} + if (obj && !obj->AcceptsFocus()) + return false; -void wxRichTextCtrl::OnUndo(wxCommandEvent& WXUNUSED(event)) -{ - Undo(); -} + wxRichTextParagraphLayoutBox* oldContainer = GetFocusObject(); + bool changingContainer = (m_focusObject != obj); -void wxRichTextCtrl::OnRedo(wxCommandEvent& WXUNUSED(event)) -{ - Redo(); -} + if (changingContainer && HasSelection()) + SelectNone(); -void wxRichTextCtrl::OnUpdateCut(wxUpdateUIEvent& event) -{ - event.Enable( CanCut() ); -} + m_focusObject = obj; -void wxRichTextCtrl::OnUpdateCopy(wxUpdateUIEvent& event) -{ - event.Enable( CanCopy() ); -} + if (!obj) + m_focusObject = & m_buffer; -void wxRichTextCtrl::OnUpdateClear(wxUpdateUIEvent& event) -{ - event.Enable( CanDeleteSelection() ); -} + if (setCaretPosition && changingContainer) + { + m_selection.Reset(); + m_selectionAnchor = -2; + m_selectionAnchorObject = NULL; + m_selectionState = wxRichTextCtrlSelectionState_Normal; -void wxRichTextCtrl::OnUpdatePaste(wxUpdateUIEvent& event) -{ - event.Enable( CanPaste() ); -} + long pos = -1; -void wxRichTextCtrl::OnUpdateUndo(wxUpdateUIEvent& event) -{ - event.Enable( CanUndo() ); - event.SetText( GetCommandProcessor()->GetUndoMenuLabel() ); -} + m_caretAtLineStart = false; + MoveCaret(pos, m_caretAtLineStart); + SetDefaultStyleToCursorStyle(); -void wxRichTextCtrl::OnUpdateRedo(wxUpdateUIEvent& event) -{ - event.Enable( CanRedo() ); - event.SetText( GetCommandProcessor()->GetRedoMenuLabel() ); -} + wxRichTextEvent cmdEvent( + wxEVT_RICHTEXT_FOCUS_OBJECT_CHANGED, + GetId()); + cmdEvent.SetEventObject(this); + cmdEvent.SetPosition(m_caretPosition+1); + cmdEvent.SetOldContainer(oldContainer); + cmdEvent.SetContainer(m_focusObject); -void wxRichTextCtrl::OnSelectAll(wxCommandEvent& WXUNUSED(event)) -{ - SelectAll(); + GetEventHandler()->ProcessEvent(cmdEvent); + } + return true; } -void wxRichTextCtrl::OnUpdateSelectAll(wxUpdateUIEvent& event) +#if wxUSE_DRAG_AND_DROP +void wxRichTextCtrl::OnDrop(wxCoord WXUNUSED(x), wxCoord WXUNUSED(y), wxDragResult def, wxDataObject* DataObj) { - event.Enable(GetLastPosition() > 0); -} + m_preDrag = false; -void wxRichTextCtrl::OnContextMenu(wxContextMenuEvent& WXUNUSED(event)) -{ - if (!m_contextMenu) + if ((def != wxDragCopy) && (def != wxDragMove)) { - m_contextMenu = new wxMenu; - m_contextMenu->Append(wxID_UNDO, _("&Undo")); - m_contextMenu->Append(wxID_REDO, _("&Redo")); - m_contextMenu->AppendSeparator(); - m_contextMenu->Append(wxID_CUT, _("Cu&t")); - m_contextMenu->Append(wxID_COPY, _("&Copy")); - m_contextMenu->Append(wxID_PASTE, _("&Paste")); - m_contextMenu->Append(wxID_CLEAR, _("&Delete")); - m_contextMenu->AppendSeparator(); - m_contextMenu->Append(wxID_SELECTALL, _("Select &All")); + return; } - PopupMenu(m_contextMenu); - return; -} -bool wxRichTextCtrl::SetStyle(long start, long end, const wxTextAttrEx& style) -{ - return GetBuffer().SetStyle(wxRichTextRange(start, end), style); -} + if (!GetSelection().IsValid()) + { + return; + } -bool wxRichTextCtrl::SetStyle(const wxRichTextRange& range, const wxRichTextAttr& style) -{ - return GetBuffer().SetStyle(range, style); -} + wxRichTextParagraphLayoutBox* originContainer = GetSelection().GetContainer(); + wxRichTextParagraphLayoutBox* destContainer = GetFocusObject(); // This will be the drop container, not necessarily the same as the origin one -bool wxRichTextCtrl::SetDefaultStyle(const wxTextAttrEx& style) -{ - return GetBuffer().SetDefaultStyle(style); -} + wxRichTextBuffer* richTextBuffer = ((wxRichTextBufferDataObject*)DataObj)->GetRichTextBuffer(); + if (richTextBuffer) + { + long position = GetCaretPosition(); + wxRichTextRange selectionrange = GetInternalSelectionRange(); + if (selectionrange.Contains(position) && (def == wxDragMove)) + { + // It doesn't make sense to move onto itself + return; + } -const wxTextAttrEx& wxRichTextCtrl::GetDefaultStyleEx() const -{ - return GetBuffer().GetDefaultStyle(); -} + // If we're moving, and the data is being moved forward, we need to drop first, then delete the selection + // If moving backwards, we need to delete then drop. If we're copying (or doing nothing) we don't delete anyway + bool DeleteAfter = (def == wxDragMove) && (position > selectionrange.GetEnd()); + if ((def == wxDragMove) && !DeleteAfter) + { + // We can't use e.g. DeleteSelectedContent() as it uses the focus container + originContainer->DeleteRangeWithUndo(selectionrange, this, &GetBuffer()); + } -bool wxRichTextCtrl::GetStyle(long position, wxTextAttrEx& style) const -{ - return GetBuffer().GetStyle(position, style); -} + destContainer->InsertParagraphsWithUndo(&GetBuffer(), position+1, *richTextBuffer, this, 0); + ShowPosition(position + richTextBuffer->GetOwnRange().GetEnd()); -bool wxRichTextCtrl::GetStyle(long position, wxRichTextAttr& style) const -{ - return GetBuffer().GetStyle(position, style); + delete richTextBuffer; + + if (DeleteAfter) + { + // We can't use e.g. DeleteSelectedContent() as it uses the focus container + originContainer->DeleteRangeWithUndo(selectionrange, this, &GetBuffer()); + } + + SelectNone(); + Refresh(); + } } +#endif // wxUSE_DRAG_AND_DROP -/// Set font, and also the buffer attributes -bool wxRichTextCtrl::SetFont(const wxFont& font) + +#if wxUSE_DRAG_AND_DROP +bool wxRichTextDropSource::GiveFeedback(wxDragResult WXUNUSED(effect)) { -#if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE - wxControl::SetFont(font); -#else - wxScrolledWindow::SetFont(font); -#endif + wxCHECK_MSG(m_rtc, false, wxT("NULL m_rtc")); - wxTextAttrEx attr = GetBuffer().GetAttributes(); - attr.SetFont(font); - GetBuffer().SetBasicStyle(attr); - GetBuffer().SetDefaultStyle(attr); + long position = 0; + int hit = 0; + wxRichTextObject* hitObj = NULL; + wxRichTextParagraphLayoutBox* container = m_rtc->FindContainerAtPoint(m_rtc->GetUnscaledPoint(m_rtc->ScreenToClient(wxGetMousePosition())), position, hit, hitObj); - return true; + if (!(hit & wxRICHTEXT_HITTEST_NONE) && container && container->AcceptsFocus()) + { + m_rtc->StoreFocusObject(container); + m_rtc->SetCaretPositionAfterClick(container, position, hit); + } + + return false; // so that the base-class sets a cursor } +#endif // wxUSE_DRAG_AND_DROP -/// Transform logical to physical -wxPoint wxRichTextCtrl::GetPhysicalPoint(const wxPoint& ptLogical) const +bool wxRichTextCtrl::CanDeleteRange(wxRichTextParagraphLayoutBox& WXUNUSED(container), const wxRichTextRange& WXUNUSED(range)) const { - wxPoint pt; - CalcScrolledPosition(ptLogical.x, ptLogical.y, & pt.x, & pt.y); - - return pt; + return true; } -/// Transform physical to logical -wxPoint wxRichTextCtrl::GetLogicalPoint(const wxPoint& ptPhysical) const +bool wxRichTextCtrl::CanInsertContent(wxRichTextParagraphLayoutBox& WXUNUSED(container), long WXUNUSED(pos)) const { - wxPoint pt; - CalcUnscrolledPosition(ptPhysical.x, ptPhysical.y, & pt.x, & pt.y); - - return pt; + return true; } -/// Position the caret -void wxRichTextCtrl::PositionCaret() +void wxRichTextCtrl::EnableVerticalScrollbar(bool enable) { - if (!GetCaret()) - return; - - //wxLogDebug(wxT("PositionCaret")); + m_verticalScrollbarEnabled = enable; + SetupScrollbars(); +} - wxRect caretRect; - if (GetCaretPositionForIndex(GetCaretPosition(), caretRect)) +void wxRichTextCtrl::SetFontScale(double fontScale, bool refresh) +{ + GetBuffer().SetFontScale(fontScale); + if (refresh) { - wxPoint originalPt = caretRect.GetPosition(); - wxPoint pt = GetPhysicalPoint(originalPt); - if (GetCaret()->GetPosition() != pt) - { - GetCaret()->Move(pt); - GetCaret()->SetSize(caretRect.GetSize()); - } + GetBuffer().Invalidate(wxRICHTEXT_ALL); + Refresh(); } } -/// Get the caret height and position for the given character position -bool wxRichTextCtrl::GetCaretPositionForIndex(long position, wxRect& rect) +void wxRichTextCtrl::SetDimensionScale(double dimScale, bool refresh) { - wxClientDC dc(this); - dc.SetFont(GetFont()); - - PrepareDC(dc); - - wxPoint pt; - int height = 0; - - if (GetBuffer().FindPosition(dc, position, pt, & height, m_caretAtLineStart)) + GetBuffer().SetDimensionScale(dimScale); + if (refresh) { - rect = wxRect(pt, wxSize(wxRICHTEXT_DEFAULT_CARET_WIDTH, height)); - return true; + GetBuffer().Invalidate(wxRICHTEXT_ALL); + Refresh(); } - - return false; } -/// 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. -wxRichTextLine* wxRichTextCtrl::GetVisibleLineForCaretPosition(long caretPosition) const +// Sets an overall scale factor for displaying and editing the content. +void wxRichTextCtrl::SetScale(double scale, bool refresh) { - wxRichTextLine* line = GetBuffer().GetLineAtPosition(caretPosition, true); - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(caretPosition, true); - if (line) + m_scale = scale; + if (refresh) { - wxRichTextRange lineRange = line->GetAbsoluteRange(); - if (caretPosition == lineRange.GetStart()-1 && - (para->GetRange().GetStart() != lineRange.GetStart())) - { - if (!m_caretAtLineStart) - line = GetBuffer().GetLineAtPosition(caretPosition-1, true); - } + GetBuffer().Invalidate(wxRICHTEXT_ALL); + Refresh(); } - return line; } +// Get an unscaled point +wxPoint wxRichTextCtrl::GetUnscaledPoint(const wxPoint& pt) const +{ + if (GetScale() == 1.0) + return pt; + else + return wxPoint((int) (0.5 + double(pt.x) / GetScale()), (int) (0.5 + double(pt.y) / GetScale())); +} -/// Move the caret to the given character position -bool wxRichTextCtrl::MoveCaret(long pos, bool showAtLineStart) +// Get a scaled point +wxPoint wxRichTextCtrl::GetScaledPoint(const wxPoint& pt) const { - if (GetBuffer().GetDirty()) - LayoutContent(); + if (GetScale() == 1.0) + return pt; + else + return wxPoint((int) (0.5 + double(pt.x) * GetScale()), (int) (0.5 + double(pt.y) * GetScale())); +} - if (pos <= GetBuffer().GetRange().GetEnd()) - { - SetCaretPosition(pos, showAtLineStart); +// Get an unscaled size +wxSize wxRichTextCtrl::GetUnscaledSize(const wxSize& sz) const +{ + if (GetScale() == 1.0) + return sz; + else + return wxSize((int) (0.5 + double(sz.x) / GetScale()), (int) (0.5 + double(sz.y) / GetScale())); +} - PositionCaret(); +// Get a scaled size +wxSize wxRichTextCtrl::GetScaledSize(const wxSize& sz) const +{ + if (GetScale() == 1.0) + return sz; + else + return wxSize((int) (0.5 + double(sz.x) * GetScale()), (int) (0.5 + double(sz.y) * GetScale())); +} - return true; - } +// Get an unscaled rect +wxRect wxRichTextCtrl::GetUnscaledRect(const wxRect& rect) const +{ + if (GetScale() == 1.0) + return rect; else - return false; + return wxRect((int) (0.5 + double(rect.x) / GetScale()), (int) (0.5 + double(rect.y) / GetScale()), + (int) (0.5 + double(rect.width) / GetScale()), (int) (0.5 + double(rect.height) / GetScale())); } -/// Layout the buffer: which we must do before certain operations, such as -/// setting the caret position. -bool wxRichTextCtrl::LayoutContent(bool onlyVisibleRect) +// Get a scaled rect +wxRect wxRichTextCtrl::GetScaledRect(const wxRect& rect) const { - if (GetBuffer().GetDirty() || onlyVisibleRect) - { - wxRect availableSpace(GetClientSize()); - if (availableSpace.width == 0) - availableSpace.width = 10; - if (availableSpace.height == 0) - availableSpace.height = 10; + if (GetScale() == 1.0) + return rect; + else + return wxRect((int) (0.5 + double(rect.x) * GetScale()), (int) (0.5 + double(rect.y) * GetScale()), + (int) (0.5 + double(rect.width) * GetScale()), (int) (0.5 + double(rect.height) * GetScale())); +} - int flags = wxRICHTEXT_FIXED_WIDTH|wxRICHTEXT_VARIABLE_HEIGHT; - if (onlyVisibleRect) - { - flags |= wxRICHTEXT_LAYOUT_SPECIFIED_RECT; - availableSpace.SetPosition(GetLogicalPoint(wxPoint(0, 0))); - } +#if wxRICHTEXT_USE_OWN_CARET - wxClientDC dc(this); - dc.SetFont(GetFont()); +// ---------------------------------------------------------------------------- +// initialization and destruction +// ---------------------------------------------------------------------------- - PrepareDC(dc); +void wxRichTextCaret::Init() +{ + m_hasFocus = true; + m_refreshEnabled = true; - GetBuffer().Defragment(); - GetBuffer().UpdateRanges(); // If items were deleted, ranges need recalculation - GetBuffer().Layout(dc, availableSpace, flags); - GetBuffer().SetDirty(false); + m_xOld = + m_yOld = -1; + m_richTextCtrl = NULL; + m_needsUpdate = false; + m_flashOn = true; +} - if (!IsFrozen()) - SetupScrollbars(); - } +wxRichTextCaret::~wxRichTextCaret() +{ + if (m_timer.IsRunning()) + m_timer.Stop(); +} - return true; +// ---------------------------------------------------------------------------- +// showing/hiding/moving the caret (base class interface) +// ---------------------------------------------------------------------------- + +void wxRichTextCaret::DoShow() +{ + m_flashOn = true; + + if (!m_timer.IsRunning()) + m_timer.Start(GetBlinkTime()); + + Refresh(); } -/// Is all of the selection bold? -bool wxRichTextCtrl::IsSelectionBold() const +void wxRichTextCaret::DoHide() { - if (HasSelection()) - { - wxRichTextAttr attr; - wxRichTextRange range = GetSelectionRange(); - attr.SetFlags(wxTEXT_ATTR_FONT_WEIGHT); - attr.SetFontWeight(wxBOLD); + if (m_timer.IsRunning()) + m_timer.Stop(); - return HasCharacterAttributes(range, attr); - } - else - { - // If no selection, then we need to combine current style with default style - // to see what the effect would be if we started typing. - wxRichTextAttr attr; - attr.SetFlags(wxTEXT_ATTR_FONT_WEIGHT); - if (GetStyle(GetCaretPosition()+1, attr)) - { - wxRichTextApplyStyle(attr, GetDefaultStyleEx()); - return attr.GetFontWeight() == wxBOLD; - } - } - return false; + Refresh(); } -/// Is all of the selection italics? -bool wxRichTextCtrl::IsSelectionItalics() const +void wxRichTextCaret::DoMove() { - if (HasSelection()) + if (IsVisible()) { - wxRichTextRange range = GetSelectionRange(); - wxRichTextAttr attr; - attr.SetFlags(wxTEXT_ATTR_FONT_ITALIC); - attr.SetFontStyle(wxITALIC); + Refresh(); - return HasCharacterAttributes(range, attr); - } - else - { - // If no selection, then we need to combine current style with default style - // to see what the effect would be if we started typing. - wxRichTextAttr attr; - attr.SetFlags(wxTEXT_ATTR_FONT_ITALIC); - if (GetStyle(GetCaretPosition()+1, attr)) + if (m_xOld != -1 && m_yOld != -1) { - wxRichTextApplyStyle(attr, GetDefaultStyleEx()); - return attr.GetFontStyle() == wxITALIC; + if (m_richTextCtrl && m_refreshEnabled) + { + wxRect rect(wxPoint(m_xOld, m_yOld), GetSize()); + wxRect scaledRect = m_richTextCtrl->GetScaledRect(rect); + m_richTextCtrl->RefreshRect(scaledRect, false); + } } } - return false; + + m_xOld = m_x; + m_yOld = m_y; } -/// Is all of the selection underlined? -bool wxRichTextCtrl::IsSelectionUnderlined() const +void wxRichTextCaret::DoSize() { - if (HasSelection()) + int countVisible = m_countVisible; + if (countVisible > 0) { - wxRichTextRange range = GetSelectionRange(); - wxRichTextAttr attr; - attr.SetFlags(wxTEXT_ATTR_FONT_UNDERLINE); - attr.SetFontUnderlined(true); - - return HasCharacterAttributes(range, attr); + m_countVisible = 0; + DoHide(); } - else + + if (countVisible > 0) { - // If no selection, then we need to combine current style with default style - // to see what the effect would be if we started typing. - wxRichTextAttr attr; - attr.SetFlags(wxTEXT_ATTR_FONT_UNDERLINE); - if (GetStyle(GetCaretPosition()+1, attr)) - { - wxRichTextApplyStyle(attr, GetDefaultStyleEx()); - return attr.GetFontUnderlined(); - } + m_countVisible = countVisible; + DoShow(); } - return false; } -/// Apply bold to the selection -bool wxRichTextCtrl::ApplyBoldToSelection() +// ---------------------------------------------------------------------------- +// handling the focus +// ---------------------------------------------------------------------------- + +void wxRichTextCaret::OnSetFocus() { - wxRichTextAttr attr; - attr.SetFlags(wxTEXT_ATTR_FONT_WEIGHT); - attr.SetFontWeight(IsSelectionBold() ? wxNORMAL : wxBOLD); + m_hasFocus = true; - if (HasSelection()) - return SetStyle(GetSelectionRange(), attr); - else - SetDefaultStyle(attr); - return true; + if ( IsVisible() ) + Refresh(); } -/// Apply italic to the selection -bool wxRichTextCtrl::ApplyItalicToSelection() +void wxRichTextCaret::OnKillFocus() { - wxRichTextAttr attr; - attr.SetFlags(wxTEXT_ATTR_FONT_ITALIC); - attr.SetFontStyle(IsSelectionItalics() ? wxNORMAL : wxITALIC); - - if (HasSelection()) - return SetStyle(GetSelectionRange(), attr); - else - SetDefaultStyle(attr); - return true; + m_hasFocus = false; } -/// Apply underline to the selection -bool wxRichTextCtrl::ApplyUnderlineToSelection() -{ - wxRichTextAttr attr; - attr.SetFlags(wxTEXT_ATTR_FONT_UNDERLINE); - attr.SetFontUnderlined(!IsSelectionUnderlined()); +// ---------------------------------------------------------------------------- +// drawing the caret +// ---------------------------------------------------------------------------- - if (HasSelection()) - return SetStyle(GetSelectionRange(), attr); - else - SetDefaultStyle(attr); - return true; +void wxRichTextCaret::Refresh() +{ + if (m_richTextCtrl && m_refreshEnabled) + { + wxRect rect(GetPosition(), GetSize()); + wxRect rectScaled = m_richTextCtrl->GetScaledRect(rect); + m_richTextCtrl->RefreshRect(rectScaled, false); + } } -/// Is all of the selection aligned according to the specified flag? -bool wxRichTextCtrl::IsSelectionAligned(wxTextAttrAlignment alignment) const +void wxRichTextCaret::DoDraw(wxDC *dc) { - if (HasSelection()) - { - wxRichTextRange range = GetSelectionRange(); - wxRichTextAttr attr; - attr.SetAlignment(alignment); + dc->SetPen( *wxBLACK_PEN ); - return HasParagraphAttributes(range, attr); - } - else + dc->SetBrush(*(m_hasFocus ? wxBLACK_BRUSH : wxTRANSPARENT_BRUSH)); + dc->SetPen(*wxBLACK_PEN); + + wxPoint pt(m_x, m_y); + + if (m_richTextCtrl) { - // If no selection, then we need to get information from the current paragraph. - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(GetCaretPosition()+1); - if (para) - return para->GetAttributes().GetAlignment() == alignment; + pt = m_richTextCtrl->GetLogicalPoint(pt); } - return false; + if (IsVisible() && m_flashOn) + dc->DrawRectangle(pt.x, pt.y, m_width, m_height); } -/// Apply alignment to the selection -bool wxRichTextCtrl::ApplyAlignmentToSelection(wxTextAttrAlignment alignment) +void wxRichTextCaret::Notify() { - wxRichTextAttr attr; - attr.SetAlignment(alignment); - if (HasSelection()) - return SetStyle(GetSelectionRange(), attr); - else + m_flashOn = !m_flashOn; + Refresh(); +} + +void wxRichTextCaretTimer::Notify() +{ + m_caret->Notify(); +} +#endif + // wxRICHTEXT_USE_OWN_CARET + +// Add an item +bool wxRichTextContextMenuPropertiesInfo::AddItem(const wxString& label, wxRichTextObject* obj) +{ + if (GetCount() < 3) { - wxRichTextParagraph* para = GetBuffer().GetParagraphAtPosition(GetCaretPosition()+1); - if (para) - return SetStyle(para->GetRange(), attr); + m_labels.Add(label); + m_objects.Add(obj); + return true; } - return true; + else + return false; } -/// Sets the default style to the style under the cursor -bool wxRichTextCtrl::SetDefaultStyleToCursorStyle() +// Returns number of menu items were added. +int wxRichTextContextMenuPropertiesInfo::AddMenuItems(wxMenu* menu, int startCmd) const { - wxTextAttrEx attr; - attr.SetFlags(wxTEXT_ATTR_CHARACTER); + wxMenuItem* item = menu->FindItem(startCmd); + // If none of the standard properties identifiers are in the menu, add them if necessary. + // If no items to add, just set the text to something generic + if (GetCount() == 0) + { + if (item) + { + menu->SetLabel(startCmd, _("&Properties")); - if (GetStyle(GetCaretPosition(), attr)) + // Delete the others if necessary + int i; + for (i = startCmd+1; i < startCmd+3; i++) + { + if (menu->FindItem(i)) + { + menu->Delete(i); + } + } + } + } + else { - SetDefaultStyle(attr); - return true; + int i; + int pos = -1; + // Find the position of the first properties item + for (i = 0; i < (int) menu->GetMenuItemCount(); i++) + { + wxMenuItem* item = menu->FindItemByPosition(i); + if (item && item->GetId() == startCmd) + { + pos = i; + break; + } + } + + if (pos != -1) + { + int insertBefore = pos+1; + for (i = startCmd; i < startCmd+GetCount(); i++) + { + if (menu->FindItem(i)) + { + menu->SetLabel(i, m_labels[i - startCmd]); + } + else + { + if (insertBefore >= (int) menu->GetMenuItemCount()) + menu->Append(i, m_labels[i - startCmd]); + else + menu->Insert(insertBefore, i, m_labels[i - startCmd]); + } + insertBefore ++; + } + + // Delete any old items still left on the menu + for (i = startCmd + GetCount(); i < startCmd+3; i++) + { + if (menu->FindItem(i)) + { + menu->Delete(i); + } + } + } + else + { + // No existing property identifiers were found, so append to the end of the menu. + menu->AppendSeparator(); + for (i = startCmd; i < startCmd+GetCount(); i++) + { + menu->Append(i, m_labels[i - startCmd]); + } + } } - return false; + return GetCount(); } -/// Returns the first visible position in the current view -long wxRichTextCtrl::GetFirstVisiblePosition() const +// Add appropriate menu items for the current container and clicked on object +// (and container's parent, if appropriate). +int wxRichTextContextMenuPropertiesInfo::AddItems(wxRichTextCtrl* ctrl, wxRichTextObject* container, wxRichTextObject* obj) { - wxRichTextLine* line = GetBuffer().GetLineAtYPosition(GetLogicalPoint(wxPoint(0, 0)).y); - if (line) - return line->GetAbsoluteRange().GetStart(); - else - return 0; + Clear(); + if (obj && ctrl->CanEditProperties(obj)) + AddItem(ctrl->GetPropertiesMenuLabel(obj), obj); + + if (container && container != obj && ctrl->CanEditProperties(container) && m_labels.Index(ctrl->GetPropertiesMenuLabel(container)) == wxNOT_FOUND) + AddItem(ctrl->GetPropertiesMenuLabel(container), container); + + if (container && container->GetParent() && ctrl->CanEditProperties(container->GetParent()) && m_labels.Index(ctrl->GetPropertiesMenuLabel(container->GetParent())) == wxNOT_FOUND) + AddItem(ctrl->GetPropertiesMenuLabel(container->GetParent()), container->GetParent()); + + return GetCount(); } #endif