#include "wx/fontenum.h"
#include "wx/accel.h"
+#if defined (__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__)
+#define wxHAVE_PRIMARY_SELECTION 1
+#else
+#define wxHAVE_PRIMARY_SELECTION 0
+#endif
+
+#if wxUSE_CLIPBOARD && wxHAVE_PRIMARY_SELECTION
+#include "wx/clipbrd.h"
+#endif
+
// DLL options compatibility check:
#include "wx/app.h"
WX_CHECK_BUILD_OPTIONS("wxRichTextCtrl")
void Notify();
+ bool GetRefreshEnabled() const { return m_refreshEnabled; }
+ void EnableRefresh(bool b) { m_refreshEnabled = b; }
+
protected:
virtual void DoShow();
virtual void DoHide();
bool m_flashOn;
wxRichTextCaretTimer m_timer;
wxRichTextCtrl* m_richTextCtrl;
+ bool m_refreshEnabled;
};
#endif
{
Init();
Create(parent, id, value, pos, size, style, validator, name);
+
+ SetDropTarget(new wxRichTextDropTarget(this));
}
/// Creation
m_editable = true;
m_caretAtLineStart = false;
m_dragging = false;
+ m_preDrag = false;
m_fullLayoutRequired = false;
m_fullLayoutTime = 0;
m_fullLayoutSavedPosition = 0;
#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_USE_OWN_CARET
if (GetCaret()->IsVisible())
{
+ PositionCaret();
((wxRichTextCaret*) GetCaret())->DoDraw(& dc);
}
#endif
GetCaret()->Show();
PositionCaret();
#else
-#if !defined(__WXMAC__)
- // Causes caret dropouts on Mac
- PositionCaret();
-#endif
+ if (GetCaret())
+ ((wxRichTextCaret*) GetCaret())->EnableRefresh(true);
#endif
}
wxRichTextObject* contextObj = NULL;
int hit = GetBuffer().HitTest(dc, event.GetLogicalPosition(dc), position, & hitObj, & contextObj);
+#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))
+ {
+ // 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
+
+#if wxUSE_DATETIME
+ m_dragStartTime = wxDateTime::UNow();
+#endif // wxUSE_DATETIME
+
+ // Preserve behaviour of clicking on an object within the selection
+ if (hit != wxRICHTEXT_HITTEST_NONE && hitObj)
+ m_dragging = true;
+
+ return; // Don't skip the event, else the selection will be lost
+ }
+#endif // wxUSE_DRAG_AND_DROP
+
if (hit != wxRICHTEXT_HITTEST_NONE && hitObj)
{
wxRichTextParagraphLayoutBox* oldFocusObject = GetFocusObject();
SetFocusObject(container, false /* don't set caret position yet */);
}
- m_dragStart = event.GetLogicalPosition(dc);
m_dragging = true;
CaptureMouse();
// Only get objects at this level, not nested, because otherwise we couldn't swipe text at a single level.
int hit = GetFocusObject()->HitTest(dc, logicalPt, position, & hitObj, & contextObj, wxRICHTEXT_HITTEST_NO_NESTED_OBJECTS);
+#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, event.GetLogicalPosition(dc), position, & hitObj, & contextObj);
+ wxRichTextParagraphLayoutBox* oldFocusObject = GetFocusObject();
+ wxRichTextParagraphLayoutBox* container = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox);
+ if (container && container != GetFocusObject() && container->AcceptsFocus())
+ {
+ SetFocusObject(container, false /* don't set caret position yet */);
+ }
+
+ long oldCaretPos = m_caretPosition;
+
+ 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();
+ }
+#endif
+
if ((hit != wxRICHTEXT_HITTEST_NONE) && !(hit & wxRICHTEXT_HITTEST_OUTSIDE))
{
wxRichTextEvent cmdEvent(
}
}
}
+
+#if wxUSE_DRAG_AND_DROP
+ m_preDrag = false;
+#endif // wxUSE_DRAG_AND_DROP
+
+#if wxUSE_CLIPBOARD && wxUSE_DATAOBJ && wxHAVE_PRIMARY_SELECTION
+ if (HasSelection() && GetFocusObject() && GetFocusObject()->GetBuffer())
+ {
+ // Put the selection in PRIMARY, if it exists
+ wxTheClipboard->UsePrimarySelection(true);
+
+ wxRichTextRange range = GetInternalSelectionRange();
+ GetFocusObject()->GetBuffer()->CopyToClipboard(range);
+
+ wxTheClipboard->UsePrimarySelection(false);
+ }
+#endif
}
-/// Left-click
+/// Mouse-movements
void wxRichTextCtrl::OnMoveMouse(wxMouseEvent& event)
{
+#if wxUSE_DRAG_AND_DROP
+ // See if we're starting Drag'n'Drop
+ if (m_preDrag)
+ {
+ int x = m_dragStartPoint.x - event.GetPosition().x;
+ int y = m_dragStartPoint.y - event.GetPosition().y;
+ size_t distance = abs(x) + abs(y);
+#if wxUSE_DATETIME
+ wxTimeSpan diff = wxDateTime::UNow() - m_dragStartTime;
+#endif
+ if ((distance > 10)
+#if wxUSE_DATETIME
+ && (diff.GetMilliseconds() > 100)
+#endif
+ )
+ {
+ m_dragging = false;
+
+ // Start drag'n'drop
+ wxRichTextRange range = GetInternalSelectionRange();
+ if (range == wxRICHTEXT_NONE)
+ {
+ // Don't try to drag an empty range
+ m_preDrag = false;
+ return;
+ }
+
+ // Cache the current situation, to be restored if Drag'n'Drop is cancelled
+ long oldPos = GetCaretPosition();
+ wxRichTextParagraphLayoutBox* oldFocus = GetFocusObject();
+
+ 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 */);
+
+ wxRichTextBuffer* richTextBuf = new wxRichTextBuffer;
+ GetFocusObject()->CopyFragment(range, *richTextBuf);
+ compositeObject->Add(new wxRichTextBufferDataObject(richTextBuf), true /* preferred */);
+
+ 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();
+
+ m_preDrag = false;
+ return;
+ }
+ }
+#endif // wxUSE_DRAG_AND_DROP
+
wxClientDC dc(this);
PrepareDC(dc);
dc.SetFont(GetFont());
return;
}
- if (m_dragging)
+ if (m_dragging
+#if wxUSE_DRAG_AND_DROP
+ && !m_preDrag
+#endif
+ )
{
wxRichTextParagraphLayoutBox* commonAncestor = NULL;
wxRichTextParagraphLayoutBox* otherContainer = NULL;
}
}
- if (hitObj && m_dragging && hit != wxRICHTEXT_HITTEST_NONE && m_selectionState == wxRichTextCtrlSelectionState_Normal)
+ if (hitObj && m_dragging && hit != wxRICHTEXT_HITTEST_NONE && m_selectionState == wxRichTextCtrlSelectionState_Normal
+#if wxUSE_DRAG_AND_DROP
+ && !m_preDrag
+#endif
+ )
{
// TODO: test closeness
SetCaretPositionAfterClick(container, position, hit, true /* extend selection */);
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
}
/// Key press
SetDefaultStyleToCursorStyle();
}
+ ScrollIntoView(m_caretPosition, WXK_LEFT);
+
wxRichTextEvent cmdEvent(
wxEVT_COMMAND_RICHTEXT_DELETE,
GetId());
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;
+ hit = GetBuffer().HitTest(dc, logicalPt, position, &hitObj, &contextObj, flags);
+ wxRichTextParagraphLayoutBox* container = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox);
+
+ return container;
+}
+
+
// ----------------------------------------------------------------------------
// set/get the controls text
// ----------------------------------------------------------------------------
return;
}
+ ShowContextMenu(m_contextMenu, event.GetPosition());
+}
+
+// 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)
+{
wxClientDC dc(this);
PrepareDC(dc);
dc.SetFont(GetFont());
+ m_contextMenuPropertiesInfo.Clear();
+
long position = 0;
- wxPoint pt = event.GetPosition();
- wxPoint logicalPt = GetLogicalPoint(ScreenToClient(pt));
wxRichTextObject* hitObj = NULL;
wxRichTextObject* contextObj = NULL;
- int hit = GetFocusObject()->HitTest(dc, logicalPt, position, & hitObj, & contextObj);
+ if (pt != wxDefaultPosition)
+ {
+ wxPoint logicalPt = GetLogicalPoint(ScreenToClient(pt));
+ int hit = GetBuffer().HitTest(dc, logicalPt, position, & hitObj, & contextObj);
- m_contextMenuPropertiesInfo.Clear();
+ if (hit == wxRICHTEXT_HITTEST_ON || hit == wxRICHTEXT_HITTEST_BEFORE || hit == wxRICHTEXT_HITTEST_AFTER)
+ {
+ wxRichTextParagraphLayoutBox* actualContainer = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox);
+ if (hitObj && actualContainer)
+ {
+ if (actualContainer->AcceptsFocus())
+ {
+ SetFocusObject(actualContainer, false /* don't set caret position yet */);
+ SetCaretPositionAfterClick(actualContainer, position, hit);
+ }
- if (hit == wxRICHTEXT_HITTEST_ON || hit == wxRICHTEXT_HITTEST_BEFORE || hit == wxRICHTEXT_HITTEST_AFTER)
+ if (addPropertyCommands)
+ m_contextMenuPropertiesInfo.AddItems(actualContainer, hitObj);
+ }
+ else
+ {
+ if (addPropertyCommands)
+ m_contextMenuPropertiesInfo.AddItems(GetFocusObject(), NULL);
+ }
+ }
+ else
+ {
+ if (addPropertyCommands)
+ m_contextMenuPropertiesInfo.AddItems(GetFocusObject(), NULL);
+ }
+ }
+ else
{
+ // 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();
+
wxRichTextParagraphLayoutBox* actualContainer = wxDynamicCast(contextObj, wxRichTextParagraphLayoutBox);
if (hitObj && actualContainer)
{
- if (actualContainer->AcceptsFocus())
- {
- SetFocusObject(actualContainer, false /* don't set caret position yet */);
- SetCaretPositionAfterClick(actualContainer, position, hit);
- }
-
- m_contextMenuPropertiesInfo.AddItems(actualContainer, hitObj);
+ if (addPropertyCommands)
+ m_contextMenuPropertiesInfo.AddItems(actualContainer, hitObj);
}
else
- m_contextMenuPropertiesInfo.AddItems(GetFocusObject(), NULL);
+ {
+ if (addPropertyCommands)
+ m_contextMenuPropertiesInfo.AddItems(GetFocusObject(), NULL);
+ }
}
- else
+
+ if (menu)
{
- m_contextMenuPropertiesInfo.AddItems(GetFocusObject(), NULL);
+ if (addPropertyCommands)
+ m_contextMenuPropertiesInfo.AddMenuItems(menu);
+ return m_contextMenuPropertiesInfo.GetCount();
}
+ else
+ return 0;
+}
- if (m_contextMenu)
+// Shows the context menu, adding appropriate property-editing commands
+bool wxRichTextCtrl::ShowContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands)
+{
+ if (menu)
{
- m_contextMenuPropertiesInfo.AddMenuItems(m_contextMenu);
- PopupMenu(m_contextMenu);
+ PrepareContextMenu(menu, pt, addPropertyCommands);
+ PopupMenu(menu);
+ return true;
}
+ else
+ return false;
}
bool wxRichTextCtrl::SetStyle(long start, long end, const wxTextAttr& style)
{
if (IsDefaultStyleShowing())
wxRichTextApplyStyle(attr, GetDefaultStyleEx());
- return (attr.GetTextEffectFlags() & flag);
+ return (attr.GetTextEffectFlags() & flag) != 0;
}
}
return false;
wxRichTextParagraphLayoutBox* oldContainer = GetFocusObject();
bool changingContainer = (m_focusObject != obj);
+ if (changingContainer && HasSelection())
+ SelectNone();
+
m_focusObject = obj;
if (!obj)
return true;
}
+#if wxUSE_DRAG_AND_DROP
+void wxRichTextCtrl::OnDrop(wxCoord WXUNUSED(x), wxCoord WXUNUSED(y), wxDragResult def, wxDataObject* DataObj)
+{
+ m_preDrag = false;
+
+ if ((def != wxDragCopy) && (def != wxDragMove))
+ {
+ return;
+ }
+
+ if (!GetSelection().IsValid())
+ {
+ return;
+ }
+
+ wxRichTextParagraphLayoutBox* originContainer = GetSelection().GetContainer();
+ wxRichTextParagraphLayoutBox* destContainer = GetFocusObject(); // This will be the drop container, not necessarily the same as the origin one
+
+
+ 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;
+ }
+
+ // 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());
+ }
+
+ destContainer->InsertParagraphsWithUndo(position+1, *richTextBuffer, this, &GetBuffer(), 0);
+ ShowPosition(position + richTextBuffer->GetOwnRange().GetEnd());
+
+ 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
+
+
+#if wxUSE_DRAG_AND_DROP
+bool wxRichTextDropSource::GiveFeedback(wxDragResult WXUNUSED(effect))
+{
+ wxCHECK_MSG(m_rtc, false, wxT("NULL m_rtc"));
+
+ long position = 0;
+ int hit = 0;
+ wxRichTextObject* hitObj = NULL;
+ wxRichTextParagraphLayoutBox* container = m_rtc->FindContainerAtPoint(m_rtc->ScreenToClient(wxGetMousePosition()), position, hit, hitObj);
+
+ 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
+
+
#if wxRICHTEXT_USE_OWN_CARET
// ----------------------------------------------------------------------------
void wxRichTextCaret::Init()
{
m_hasFocus = true;
+ m_refreshEnabled = true;
m_xOld =
m_yOld = -1;
if (m_xOld != -1 && m_yOld != -1)
{
- if (m_richTextCtrl)
+ if (m_richTextCtrl && m_refreshEnabled)
{
wxRect rect(GetPosition(), GetSize());
m_richTextCtrl->RefreshRect(rect, false);
void wxRichTextCaret::Refresh()
{
- if (m_richTextCtrl)
+ if (m_richTextCtrl && m_refreshEnabled)
{
wxRect rect(GetPosition(), GetSize());
m_richTextCtrl->RefreshRect(rect, false);
int wxRichTextContextMenuPropertiesInfo::AddMenuItems(wxMenu* menu, int startCmd) const
{
wxMenuItem* item = menu->FindItem(startCmd);
- // If none of the standard properties identifiers are in the menu, assume it's
- // a custom menu without properties commands, and don't add them.
- if (item)
+ // 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 no items, to add just set the text to something generic
- if (GetCount() == 0)
+ if (item)
{
menu->SetLabel(startCmd, _("&Properties"));
}
}
}
- else
+ }
+ else
+ {
+ int i;
+ int pos = -1;
+ // Find the position of the first properties item
+ for (i = 0; i < (int) menu->GetMenuItemCount(); i++)
{
- 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)
{
- wxMenuItem* item = menu->FindItemByPosition(i);
- if (item && item->GetId() == startCmd)
- {
- pos = i;
- break;
- }
+ pos = i;
+ break;
}
+ }
- if (pos != -1)
+ if (pos != -1)
+ {
+ int insertBefore = pos+1;
+ for (i = startCmd; i < startCmd+GetCount(); i++)
{
- int insertBefore = pos+1;
- for (i = startCmd; i < startCmd+GetCount(); i++)
+ if (menu->FindItem(i))
{
- if (menu->FindItem(i))
- {
- menu->SetLabel(i, m_labels[i - startCmd]);
- }
+ menu->SetLabel(i, m_labels[i - startCmd]);
+ }
+ else
+ {
+ if (insertBefore >= (int) menu->GetMenuItemCount())
+ menu->Append(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 ++;
+ 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++)
+ // Delete any old items still left on the menu
+ for (i = startCmd + GetCount(); i < startCmd+3; i++)
+ {
+ if (menu->FindItem(i))
{
- if (menu->FindItem(i))
- {
- menu->Delete(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 GetCount();