#include "wx/textctrl.h"
+#if wxUSE_DRAG_AND_DROP
+#include "wx/dnd.h"
+#endif
+
#if !defined(__WXGTK__) && !defined(__WXMAC__)
#define wxRICHTEXT_BUFFERED_PAINTING 1
#else
Adds appropriate menu items for the current container and clicked on object
(and container's parent, if appropriate).
*/
- int AddItems(wxRichTextObject* container, wxRichTextObject* obj);
+ int AddItems(wxRichTextCtrl* ctrl, wxRichTextObject* container, wxRichTextObject* obj);
/**
Clears the items.
public wxTextCtrlIface,
public wxScrollHelper
{
- DECLARE_CLASS( wxRichTextCtrl )
+ DECLARE_DYNAMIC_CLASS( wxRichTextCtrl )
DECLARE_EVENT_TABLE()
public:
long GetDelayedLayoutThreshold() const { return m_delayedLayoutThreshold; }
/**
+ Gets the flag indicating that full layout is required.
*/
bool GetFullLayoutRequired() const { return m_fullLayoutRequired; }
/**
+ Sets the flag indicating that full layout is required.
*/
void SetFullLayoutRequired(bool b) { m_fullLayoutRequired = b; }
/**
+ Returns the last time full layout was performed.
*/
wxLongLong GetFullLayoutTime() const { return m_fullLayoutTime; }
/**
+ Sets the last time full layout was performed.
*/
void SetFullLayoutTime(wxLongLong t) { m_fullLayoutTime = t; }
/**
+ Returns the position that should be shown when full (delayed) layout is performed.
*/
long GetFullLayoutSavedPosition() const { return m_fullLayoutSavedPosition; }
/**
+ Sets the position that should be shown when full (delayed) layout is performed.
*/
void SetFullLayoutSavedPosition(long p) { m_fullLayoutSavedPosition = p; }
- // Force any pending layout due to large buffer
/**
+ Forces any pending layout due to delayed, partial layout when the control
+ was resized.
*/
void ForceDelayedLayout();
*/
void SetDragging(bool dragging) { m_dragging = dragging; }
+#if wxUSE_DRAG_AND_DROP
+ /**
+ Are we trying to start Drag'n'Drop?
+ */
+ bool GetPreDrag() const { return m_preDrag; }
+
/**
- Returns the drag start position.
+ Set if we're trying to start Drag'n'Drop
*/
- const wxPoint& GetDragStart() const { return m_dragStart; }
+ void SetPreDrag(bool pd) { m_preDrag = pd; }
/**
- Sets the drag start position.
+ Get the possible Drag'n'Drop start point
*/
- void SetDragStart(const wxPoint& pt) { m_dragStart = pt; }
+ const wxPoint GetDragStartPoint() const { return m_dragStartPoint; }
+
+ /**
+ Set the possible Drag'n'Drop start point
+ */
+ void SetDragStartPoint(wxPoint sp) { m_dragStartPoint = sp; }
+
+#if wxUSE_DATETIME
+ /**
+ Get the possible Drag'n'Drop start time
+ */
+ const wxDateTime GetDragStartTime() const { return m_dragStartTime; }
+
+ /**
+ Set the possible Drag'n'Drop start time
+ */
+ void SetDragStartTime(wxDateTime st) { m_dragStartTime = st; }
+#endif // wxUSE_DATETIME
+
+#endif // wxUSE_DRAG_AND_DROP
#if wxRICHTEXT_BUFFERED_PAINTING
//@{
*/
wxRichTextParagraphLayoutBox* GetFocusObject() const { return m_focusObject; }
+ /**
+ Sets m_focusObject without making any alterations.
+ */
+ void StoreFocusObject(wxRichTextParagraphLayoutBox* obj) { m_focusObject = obj; }
+
/**
Sets the wxRichTextObject object that currently has the editing focus.
*/
/**
Sets the attributes for a single object
*/
- virtual void SetStyle(wxRichTextObject *obj, const wxRichTextAttr& textAttr);
+ virtual void SetStyle(wxRichTextObject *obj, const wxRichTextAttr& textAttr, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
//@{
/**
virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1);
//@}
+ /**
+ Sets the properties for the given range, passing flags to determine how the
+ attributes are set. You can merge properties or replace them.
+
+ The end point of range is specified as the last character position of the span
+ of text, plus one. So, for example, to set the properties for a character at
+ position 5, use the range (5,6).
+
+ @a flags may contain a bit list of the following values:
+ - wxRICHTEXT_SETSPROPERTIES_NONE: no flag.
+ - wxRICHTEXT_SETPROPERTIES_WITH_UNDO: specifies that this operation should be
+ undoable.
+ - wxRICHTEXT_SETPROPERTIES_PARAGRAPHS_ONLY: specifies that the properties should only be
+ applied to paragraphs, and not the content.
+ - wxRICHTEXT_SETPROPERTIES_CHARACTERS_ONLY: specifies that the properties should only be
+ applied to characters, and not the paragraph.
+ - wxRICHTEXT_SETPROPERTIES_RESET: resets (clears) the existing properties before applying
+ the new properties.
+ - wxRICHTEXT_SETPROPERTIES_REMOVE: removes the specified properties.
+ */
+ virtual bool SetProperties(const wxRichTextRange& range, const wxRichTextProperties& properties, int flags = wxRICHTEXT_SETPROPERTIES_WITH_UNDO);
+
/**
Deletes the content within the given range.
*/
virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
wxTextCoord *col,
wxTextCoord *row) const;
+
+ /**
+ Finds the container at the given point, which is in screen coordinates.
+ */
+ wxRichTextParagraphLayoutBox* FindContainerAtPoint(const wxPoint pt, long& position, int& hit, wxRichTextObject* hitObj, int flags = 0);
//@}
+#if wxUSE_DRAG_AND_DROP
+ /**
+ Does the 'drop' of Drag'n'Drop.
+ */
+ void OnDrop(wxCoord WXUNUSED(x), wxCoord WXUNUSED(y), wxDragResult def, wxDataObject* DataObj);
+#endif
+
// Clipboard operations
/**
void SetSelection(const wxRichTextSelection& sel) { m_selection = sel; }
//@}
-
- /**
- Selects all the text in the buffer.
- */
- virtual void SelectAll();
-
/**
Makes the control editable, or not.
*/
*/
virtual wxRichTextBox* WriteTextBox(const wxRichTextAttr& textAttr = wxRichTextAttr());
+ /**
+ Writes a field at the current insertion point.
+
+ @param fieldType
+ The field type, matching an existing field type definition.
+ @param properties
+ Extra data for the field.
+ @param textAttr
+ Optional attributes.
+
+ @see wxRichTextField, wxRichTextFieldType, wxRichTextFieldTypeStandard
+ */
+ virtual wxRichTextField* WriteField(const wxString& fieldType, const wxRichTextProperties& properties,
+ const wxRichTextAttr& textAttr = wxRichTextAttr());
+
/**
Write a table at the current insertion point, returning the table.
You can then call SetFocusObject() to set the focus to the new object.
}
/**
- Returns @true if all of the selection is bold.
+ Returns @true if all of the selection, or the content at the caret position, is bold.
*/
virtual bool IsSelectionBold();
/**
- Returns @true if all of the selection is italic.
+ Returns @true if all of the selection, or the content at the caret position, is italic.
*/
virtual bool IsSelectionItalics();
/**
- Returns @true if all of the selection is underlined.
+ Returns @true if all of the selection, or the content at the caret position, is underlined.
*/
virtual bool IsSelectionUnderlined();
/**
- Returns @true if all of the selection is aligned according to the specified flag.
+ Returns @true if all of the selection, or the content at the current caret position, has the supplied wxTextAttrEffects flag(s).
+ */
+ virtual bool DoesSelectionHaveTextEffectFlag(int flag);
+
+ /**
+ Returns @true if all of the selection, or the content at the caret position, is aligned according to the specified flag.
*/
virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
/**
- Apples bold to the selection (undoable).
+ Apples bold to the selection or default style (undoable).
*/
virtual bool ApplyBoldToSelection();
/**
- Applies italic to the selection (undoable).
+ Applies italic to the selection or default style (undoable).
*/
virtual bool ApplyItalicToSelection();
/**
- Applies underline to the selection (undoable).
+ Applies underline to the selection or default style (undoable).
*/
virtual bool ApplyUnderlineToSelection();
/**
- Applies the given alignment to the selection (undoable).
+ Applies one or more wxTextAttrEffects flags to the selection (undoable).
+ If there is no selection, it is applied to the default style.
+ */
+ virtual bool ApplyTextEffectToSelection(int flags);
+
+ /**
+ Applies the given alignment to the selection or the default style (undoable).
For alignment values, see wxTextAttr.
*/
virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
*/
bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL);
+ /**
+ Shows the given context menu, optionally adding appropriate property-editing commands for the current position in the object hierarchy.
+ */
+ virtual bool ShowContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands = true);
+
+ /**
+ Prepares the context menu, optionally adding appropriate property-editing commands.
+ Returns the number of property commands added.
+ */
+ virtual int PrepareContextMenu(wxMenu* menu, const wxPoint& pt, bool addPropertyCommands = true);
+
+ /**
+ Returns @true if we can edit the object's properties via a GUI.
+ */
+ virtual bool CanEditProperties(wxRichTextObject* obj) const { return obj->CanEditProperties(); }
+
+ /**
+ Edits the object's properties via a GUI.
+ */
+ virtual bool EditProperties(wxRichTextObject* obj, wxWindow* parent) { return obj->EditProperties(parent, & GetBuffer()); }
+
+ /**
+ Gets the object's properties menu label.
+ */
+ virtual wxString GetPropertiesMenuLabel(wxRichTextObject* obj) { return obj->GetPropertiesMenuLabel(); }
+
+ /**
+ Prepares the content just before insertion (or after buffer reset). Called by the same function in wxRichTextBuffer.
+ Currently is only called if undo mode is on.
+ */
+ virtual void PrepareContent(wxRichTextParagraphLayoutBox& WXUNUSED(container)) {}
+
+ /**
+ Can we delete this range?
+ Sends an event to the control.
+ */
+ virtual bool CanDeleteRange(wxRichTextParagraphLayoutBox& container, const wxRichTextRange& range) const;
+
+ /**
+ Can we insert content at this position?
+ Sends an event to the control.
+ */
+ virtual bool CanInsertContent(wxRichTextParagraphLayoutBox& container, long pos) const;
+
+ /**
+ Enable or disable the vertical scrollbar.
+ */
+ virtual void EnableVerticalScrollbar(bool enable);
+
+ /**
+ Returns @true if the vertical scrollbar is enabled.
+ */
+ virtual bool GetVerticalScrollbarEnabled() const { return m_verticalScrollbarEnabled; }
+
+ /**
+ Sets the scale factor for displaying fonts, for example for more comfortable
+ editing.
+ */
+ void SetFontScale(double fontScale, bool refresh = false);
+
+ /**
+ Returns the scale factor for displaying fonts, for example for more comfortable
+ editing.
+ */
+ double GetFontScale() const { return GetBuffer().GetFontScale(); }
+
+ /**
+ Sets the scale factor for displaying certain dimensions such as indentation and
+ inter-paragraph spacing. This can be useful when editing in a small control
+ where you still want legible text, but a minimum of wasted white space.
+ */
+ void SetDimensionScale(double dimScale, bool refresh = false);
+
+ /**
+ Returns the scale factor for displaying certain dimensions such as indentation
+ and inter-paragraph spacing.
+ */
+ double GetDimensionScale() const { return GetBuffer().GetDimensionScale(); }
+
+ /**
+ Sets an overall scale factor for displaying and editing the content.
+ */
+ void SetScale(double scale, bool refresh = false);
+
+ /**
+ Returns an overall scale factor for displaying and editing the content.
+ */
+ double GetScale() const { return m_scale; }
+
+ /**
+ Returns an unscaled point.
+ */
+ wxPoint GetUnscaledPoint(const wxPoint& pt) const;
+
+ /**
+ Returns a scaled point.
+ */
+ wxPoint GetScaledPoint(const wxPoint& pt) const;
+
+ /**
+ Returns an unscaled size.
+ */
+ wxSize GetUnscaledSize(const wxSize& sz) const;
+
+ /**
+ Returns a scaled size.
+ */
+ wxSize GetScaledSize(const wxSize& sz) const;
+
+ /**
+ Returns an unscaled rectangle.
+ */
+ wxRect GetUnscaledRect(const wxRect& rect) const;
+
+ /**
+ Returns a scaled rectangle.
+ */
+ wxRect GetScaledRect(const wxRect& rect) const;
+
// Command handlers
/**
// Implementation
+ /**
+ Processes the back key.
+ */
+ virtual bool ProcessBackKey(wxKeyEvent& event, int flags);
+
+ /**
+ Given a character position at which there is a list style, find the range
+ encompassing the same list style by looking backwards and forwards.
+ */
+ virtual wxRichTextRange FindRangeForList(long pos, bool& isNumberedList);
+
/**
Sets up the caret for the given position and container, after a mouse click.
*/
long FindCaretPositionForCharacterPosition(long position, int hitTestFlags, wxRichTextParagraphLayoutBox* container,
bool& caretLineStart);
+ /**
+ Processes mouse movement in order to change the cursor
+ */
+ virtual bool ProcessMouseMovement(wxRichTextParagraphLayoutBox* container, wxRichTextObject* obj, long position, const wxPoint& pos);
+
/**
Font names take a long time to retrieve, so cache them (on demand).
*/
// Data members
-private:
+protected:
#if wxRICHTEXT_BUFFERED_PAINTING
/// Buffer bitmap
wxBitmap m_bufferBitmap;
/// Are we editable?
bool m_editable;
+ /// Is the vertical scrollbar enabled?
+ bool m_verticalScrollbarEnabled;
+
/// Are we showing the caret position at the start of a line
/// instead of at the end of the previous one?
bool m_caretAtLineStart;
- /// Are we dragging a selection?
+ /// Are we dragging (i.e. extending) a selection?
bool m_dragging;
- /// Start position for drag
- wxPoint m_dragStart;
+#if wxUSE_DRAG_AND_DROP
+ /// Are we trying to start Drag'n'Drop?
+ bool m_preDrag;
+
+ /// Initial position when starting Drag'n'Drop
+ wxPoint m_dragStartPoint;
+
+#if wxUSE_DATETIME
+ /// Initial time when starting Drag'n'Drop
+ wxDateTime m_dragStartTime;
+#endif // wxUSE_DATETIME
+#endif // wxUSE_DRAG_AND_DROP
/// Do we need full layout in idle?
bool m_fullLayoutRequired;
/// The object that currently has the editing focus
wxRichTextParagraphLayoutBox* m_focusObject;
+
+ /// An overall scale factor
+ double m_scale;
+};
+
+#if wxUSE_DRAG_AND_DROP
+class WXDLLIMPEXP_RICHTEXT wxRichTextDropSource : public wxDropSource
+{
+public:
+ wxRichTextDropSource(wxDataObject& data, wxRichTextCtrl* tc)
+ : wxDropSource(data, tc), m_rtc(tc) {}
+
+protected:
+ bool GiveFeedback(wxDragResult effect);
+
+ wxRichTextCtrl* m_rtc;
+};
+
+class WXDLLIMPEXP_RICHTEXT wxRichTextDropTarget : public wxDropTarget
+{
+public:
+ wxRichTextDropTarget(wxRichTextCtrl* tc)
+ : wxDropTarget(new wxRichTextBufferDataObject(new wxRichTextBuffer)), m_rtc(tc) {}
+
+ virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def)
+ {
+ if ( !GetData() )
+ return wxDragNone;
+ m_rtc->OnDrop(x, y, def, m_dataObject);
+ return def;
+ }
+
+protected:
+ wxRichTextCtrl* m_rtc;
};
+#endif // wxUSE_DRAG_AND_DROP
/**
@class wxRichTextEvent
Process a @c wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK event, generated when the user
releases the middle mouse button over an object.
@event{EVT_RICHTEXT_LEFT_DCLICK(id, func)}
- Process a @c wxEVT_COMMAND_RICHTEXT_DLEFT_CLICK event, generated when the user
+ Process a @c wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK event, generated when the user
double-clicks an object.
@event{EVT_RICHTEXT_RETURN(id, func)}
Process a @c wxEVT_COMMAND_RICHTEXT_RETURN event, generated when the user
when the control's stylesheet has been replaced, for example when a file
is loaded into the control.
Valid event functions: GetOldStyleSheet, GetNewStyleSheet.
+ @event{EVT_RICHTEXT_PROPERTIES_CHANGED(id, func)}
+ Process a @c wxEVT_COMMAND_RICHTEXT_PROPERTIES_CHANGED event, generated when
+ properties have been applied to the control. Valid event functions: GetPosition, GetRange.
@event{EVT_RICHTEXT_CONTENT_INSERTED(id, func)}
Process a @c wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED event, generated when
content has been inserted into the control.
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, wxRichTextEvent );
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, wxRichTextEvent );
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, wxRichTextEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_PROPERTIES_CHANGED, wxRichTextEvent );
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, wxRichTextEvent );
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, wxRichTextEvent );
wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_FOCUS_OBJECT_CHANGED, wxRichTextEvent );
#define EVT_RICHTEXT_CONTENT_INSERTED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, id, -1, wxRichTextEventHandler( fn ), NULL ),
#define EVT_RICHTEXT_CONTENT_DELETED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, id, -1, wxRichTextEventHandler( fn ), NULL ),
#define EVT_RICHTEXT_STYLE_CHANGED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_PROPERTIES_CHANGED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_PROPERTIES_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
#define EVT_RICHTEXT_SELECTION_CHANGED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
#define EVT_RICHTEXT_BUFFER_RESET(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, id, -1, wxRichTextEventHandler( fn ), NULL ),
+#define EVT_RICHTEXT_FOCUS_OBJECT_CHANGED(id, fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_FOCUS_OBJECT_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
#endif
// wxUSE_RICHTEXT
projects / wxWidgets.git / blobdiff