1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/richtext/richtextctrl.h
3 // Purpose: A rich edit control
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_RICHTEXTCTRL_H_
13 #define _WX_RICHTEXTCTRL_H_
15 #include "wx/richtext/richtextbuffer.h"
19 #include "wx/scrolwin.h"
22 #if wxCHECK_VERSION(2,7,0)
23 #define wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE 1
25 #define wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE 0
28 #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
29 #include "wx/textctrl.h"
32 class WXDLLIMPEXP_RICHTEXT wxRichTextStyleDefinition
;
41 #define wxRE_READONLY 0x0010
42 #define wxRE_MULTILINE 0x0020
47 #define wxRICHTEXT_SHIFT_DOWN 0x01
48 #define wxRICHTEXT_CTRL_DOWN 0x02
49 #define wxRICHTEXT_ALT_DOWN 0x04
54 #define wxRICHTEXT_DEFAULT_OVERALL_SIZE wxSize(-1, -1)
55 #define wxRICHTEXT_DEFAULT_IMAGE_SIZE wxSize(80, 80)
56 #define wxRICHTEXT_DEFAULT_SPACING 3
57 #define wxRICHTEXT_DEFAULT_MARGIN 3
58 #define wxRICHTEXT_DEFAULT_UNFOCUSSED_BACKGROUND wxColour(175, 175, 175)
59 #define wxRICHTEXT_DEFAULT_FOCUSSED_BACKGROUND wxColour(140, 140, 140)
60 #define wxRICHTEXT_DEFAULT_UNSELECTED_BACKGROUND wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE)
61 #define wxRICHTEXT_DEFAULT_TYPE_COLOUR wxColour(0, 0, 200)
62 #define wxRICHTEXT_DEFAULT_FOCUS_RECT_COLOUR wxColour(100, 80, 80)
63 #define wxRICHTEXT_DEFAULT_CARET_WIDTH 2
64 // Minimum buffer size before delayed layout kicks in
65 #define wxRICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD 20000
66 // Milliseconds before layout occurs after resize
67 #define wxRICHTEXT_DEFAULT_LAYOUT_INTERVAL 50
70 * Forward declarations
74 * wxRichTextItem class declaration
77 // Drawing styles/states
78 #define wxRICHTEXT_SELECTED 0x01
79 #define wxRICHTEXT_TAGGED 0x02
80 // The control is focussed
81 #define wxRICHTEXT_FOCUSSED 0x04
82 // The item itself has the focus
83 #define wxRICHTEXT_IS_FOCUS 0x08
86 * wxRichTextCtrl class declaration
89 class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl
:
90 #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
91 public wxTextCtrlBase
, public wxScrollHelper
93 public wxScrolledWindow
96 DECLARE_CLASS( wxRichTextCtrl
)
103 wxRichTextCtrl( wxWindow
* parent
, wxWindowID id
= -1, const wxString
& value
= wxEmptyString
, const wxPoint
& pos
= wxDefaultPosition
, const wxSize
& size
= wxDefaultSize
,
104 long style
= wxRE_MULTILINE
);
105 virtual ~wxRichTextCtrl( );
110 bool Create( wxWindow
* parent
, wxWindowID id
= -1, const wxString
& value
= wxEmptyString
, const wxPoint
& pos
= wxDefaultPosition
, const wxSize
& size
= wxDefaultSize
,
111 long style
= wxRE_MULTILINE
);
113 /// Member initialisation
116 ///// wxTextCtrl compatibility
120 virtual wxString
GetValue() const;
121 virtual void SetValue(const wxString
& value
);
123 virtual wxString
GetRange(long from
, long to
) const;
125 virtual int GetLineLength(long lineNo
) const ;
126 virtual wxString
GetLineText(long lineNo
) const ;
127 virtual int GetNumberOfLines() const ;
129 virtual bool IsModified() const ;
130 virtual bool IsEditable() const ;
132 // more readable flag testing methods
133 bool IsSingleLine() const { return !HasFlag(wxRE_MULTILINE
); }
134 bool IsMultiLine() const { return !IsSingleLine(); }
136 // If the return values from and to are the same, there is no selection.
137 virtual void GetSelection(long* from
, long* to
) const;
139 virtual wxString
GetStringSelection() const;
142 wxString
GetFilename() const { return m_filename
; }
145 void SetFilename(const wxString
& filename
) { m_filename
= filename
; }
147 /// Set the threshold in character positions for doing layout optimization during sizing
148 void SetDelayedLayoutThreshold(long threshold
) { m_delayedLayoutThreshold
= threshold
; }
150 /// Get the threshold in character positions for doing layout optimization during sizing
151 long GetDelayedLayoutThreshold() const { return m_delayedLayoutThreshold
; }
156 virtual void Clear();
157 virtual void Replace(long from
, long to
, const wxString
& value
);
158 virtual void Remove(long from
, long to
);
160 #if !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
161 bool LoadFile(const wxString
& file
, int fileType
= wxRICHTEXT_TYPE_ANY
);
162 bool SaveFile(const wxString
& file
= wxEmptyString
, int fileType
= wxRICHTEXT_TYPE_ANY
);
165 // load/save the controls contents from/to the file
166 virtual bool DoLoadFile(const wxString
& file
, int fileType
);
167 virtual bool DoSaveFile(const wxString
& file
= wxEmptyString
, int fileType
= wxRICHTEXT_TYPE_ANY
);
169 // sets/clears the dirty flag
170 virtual void MarkDirty();
171 virtual void DiscardEdits();
173 // set the max number of characters which may be entered in a single line
175 virtual void SetMaxLength(unsigned long WXUNUSED(len
)) { }
177 // writing text inserts it at the current position, appending always
178 // inserts it at the end
179 virtual void WriteText(const wxString
& text
);
180 virtual void AppendText(const wxString
& text
);
182 // text control under some platforms supports the text styles: these
183 // methods allow to apply the given text style to the given selection or to
184 // set/get the style which will be used for all appended text
185 virtual bool SetStyle(long start
, long end
, const wxTextAttr
& style
);
186 virtual bool SetStyle(long start
, long end
, const wxTextAttrEx
& style
);
187 virtual bool SetStyle(const wxRichTextRange
& range
, const wxRichTextAttr
& style
);
188 virtual bool GetStyle(long position
, wxTextAttr
& style
);
189 virtual bool GetStyle(long position
, wxTextAttrEx
& style
);
190 virtual bool GetStyle(long position
, wxRichTextAttr
& style
);
191 virtual bool SetDefaultStyle(const wxTextAttrEx
& style
);
192 virtual bool SetDefaultStyle(const wxTextAttr
& style
);
194 // TODO: change to GetDefaultStyle if we merge wxTextAttr and wxTextAttrEx
195 virtual const wxTextAttrEx
& GetDefaultStyleEx() const;
196 virtual const wxTextAttr
& GetDefaultStyle() const;
198 // translate between the position (which is just an index in the text ctrl
199 // considering all its contents as a single strings) and (x, y) coordinates
200 // which represent column and line.
201 virtual long XYToPosition(long x
, long y
) const;
202 virtual bool PositionToXY(long pos
, long *x
, long *y
) const;
204 virtual void ShowPosition(long pos
);
206 // find the character at position given in pixels
208 // NB: pt is in device coords (not adjusted for the client area origin nor
210 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
, long *pos
) const;
211 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
,
213 wxTextCoord
*row
) const;
215 // Clipboard operations
218 virtual void Paste();
219 virtual void DeleteSelection();
221 virtual bool CanCopy() const;
222 virtual bool CanCut() const;
223 virtual bool CanPaste() const;
224 virtual bool CanDeleteSelection() const;
230 virtual bool CanUndo() const;
231 virtual bool CanRedo() const;
234 virtual void SetInsertionPoint(long pos
);
235 virtual void SetInsertionPointEnd();
236 virtual long GetInsertionPoint() const;
237 virtual wxTextPos
GetLastPosition() const;
239 virtual void SetSelection(long from
, long to
);
240 virtual void SelectAll();
241 virtual void SetEditable(bool editable
);
243 /// Call Freeze to prevent refresh
244 virtual void Freeze();
246 /// Call Thaw to refresh
249 /// Call Thaw to refresh
250 virtual bool IsFrozen() const { return m_freezeCount
> 0; }
252 virtual bool HasSelection() const;
254 ///// Functionality specific to wxRichTextCtrl
256 /// Write an image at the current insertion point. Supply optional type to use
257 /// for internal and file storage of the raw data.
258 virtual bool WriteImage(const wxImage
& image
, int bitmapType
= wxBITMAP_TYPE_PNG
);
260 /// Write a bitmap at the current insertion point. Supply optional type to use
261 /// for internal and file storage of the raw data.
262 virtual bool WriteImage(const wxBitmap
& bitmap
, int bitmapType
= wxBITMAP_TYPE_PNG
);
264 /// Load an image from file and write at the current insertion point.
265 virtual bool WriteImage(const wxString
& filename
, int bitmapType
);
267 /// Write an image block at the current insertion point.
268 virtual bool WriteImage(const wxRichTextImageBlock
& imageBlock
);
270 /// Insert a newline (actually paragraph) at the current insertion point.
271 virtual bool Newline();
273 /// Set basic (overall) style
274 virtual void SetBasicStyle(const wxTextAttrEx
& style
) { GetBuffer().SetBasicStyle(style
); }
275 virtual void SetBasicStyle(const wxRichTextAttr
& style
) { GetBuffer().SetBasicStyle(style
); }
277 /// Get basic (overall) style
278 virtual const wxTextAttrEx
& GetBasicStyle() const { return GetBuffer().GetBasicStyle(); }
280 /// Begin using a style
281 virtual bool BeginStyle(const wxTextAttrEx
& style
) { return GetBuffer().BeginStyle(style
); }
284 virtual bool EndStyle() { return GetBuffer().EndStyle(); }
287 virtual bool EndAllStyles() { return GetBuffer().EndAllStyles(); }
290 bool BeginBold() { return GetBuffer().BeginBold(); }
293 bool EndBold() { return GetBuffer().EndBold(); }
295 /// Begin using italic
296 bool BeginItalic() { return GetBuffer().BeginItalic(); }
299 bool EndItalic() { return GetBuffer().EndItalic(); }
301 /// Begin using underline
302 bool BeginUnderline() { return GetBuffer().BeginUnderline(); }
304 /// End using underline
305 bool EndUnderline() { return GetBuffer().EndUnderline(); }
307 /// Begin using point size
308 bool BeginFontSize(int pointSize
) { return GetBuffer().BeginFontSize(pointSize
); }
310 /// End using point size
311 bool EndFontSize() { return GetBuffer().EndFontSize(); }
313 /// Begin using this font
314 bool BeginFont(const wxFont
& font
) { return GetBuffer().BeginFont(font
); }
317 bool EndFont() { return GetBuffer().EndFont(); }
319 /// Begin using this colour
320 bool BeginTextColour(const wxColour
& colour
) { return GetBuffer().BeginTextColour(colour
); }
322 /// End using a colour
323 bool EndTextColour() { return GetBuffer().EndTextColour(); }
325 /// Begin using alignment
326 bool BeginAlignment(wxTextAttrAlignment alignment
) { return GetBuffer().BeginAlignment(alignment
); }
329 bool EndAlignment() { return GetBuffer().EndAlignment(); }
331 /// Begin left indent
332 bool BeginLeftIndent(int leftIndent
, int leftSubIndent
= 0) { return GetBuffer().BeginLeftIndent(leftIndent
, leftSubIndent
); }
335 bool EndLeftIndent() { return GetBuffer().EndLeftIndent(); }
337 /// Begin right indent
338 bool BeginRightIndent(int rightIndent
) { return GetBuffer().BeginRightIndent(rightIndent
); }
341 bool EndRightIndent() { return GetBuffer().EndRightIndent(); }
343 /// Begin paragraph spacing
344 bool BeginParagraphSpacing(int before
, int after
) { return GetBuffer().BeginParagraphSpacing(before
, after
); }
346 /// End paragraph spacing
347 bool EndParagraphSpacing() { return GetBuffer().EndParagraphSpacing(); }
349 /// Begin line spacing
350 bool BeginLineSpacing(int lineSpacing
) { return GetBuffer().BeginLineSpacing(lineSpacing
); }
353 bool EndLineSpacing() { return GetBuffer().EndLineSpacing(); }
355 /// Begin numbered bullet
356 bool BeginNumberedBullet(int bulletNumber
, int leftIndent
, int leftSubIndent
, int bulletStyle
= wxTEXT_ATTR_BULLET_STYLE_ARABIC
|wxTEXT_ATTR_BULLET_STYLE_PERIOD
)
357 { return GetBuffer().BeginNumberedBullet(bulletNumber
, leftIndent
, leftSubIndent
, bulletStyle
); }
359 /// End numbered bullet
360 bool EndNumberedBullet() { return GetBuffer().EndNumberedBullet(); }
362 /// Begin symbol bullet
363 bool BeginSymbolBullet(wxChar symbol
, int leftIndent
, int leftSubIndent
, int bulletStyle
= wxTEXT_ATTR_BULLET_STYLE_SYMBOL
)
364 { return GetBuffer().BeginSymbolBullet(symbol
, leftIndent
, leftSubIndent
, bulletStyle
); }
366 /// End symbol bullet
367 bool EndSymbolBullet() { return GetBuffer().EndSymbolBullet(); }
369 /// Begin named character style
370 bool BeginCharacterStyle(const wxString
& characterStyle
) { return GetBuffer().BeginCharacterStyle(characterStyle
); }
372 /// End named character style
373 bool EndCharacterStyle() { return GetBuffer().EndCharacterStyle(); }
375 /// Begin named paragraph style
376 bool BeginParagraphStyle(const wxString
& paragraphStyle
) { return GetBuffer().BeginParagraphStyle(paragraphStyle
); }
378 /// End named character style
379 bool EndParagraphStyle() { return GetBuffer().EndParagraphStyle(); }
381 /// Sets the default style to the style under the cursor
382 bool SetDefaultStyleToCursorStyle();
384 /// Clear the selection
385 virtual void SelectNone();
387 /// Get/set the selection range in character positions. -1, -1 means no selection.
388 /// The range is in API convention, i.e. a single character selection is denoted
390 wxRichTextRange
GetSelectionRange() const;
391 void SetSelectionRange(const wxRichTextRange
& range
);
393 /// Get/set the selection range in character positions. -1, -1 means no selection.
394 /// The range is in internal format, i.e. a single character selection is denoted
396 const wxRichTextRange
& GetInternalSelectionRange() const { return m_selectionRange
; }
397 void SetInternalSelectionRange(const wxRichTextRange
& range
) { m_selectionRange
= range
; }
399 /// Add a new paragraph of text to the end of the buffer
400 virtual wxRichTextRange
AddParagraph(const wxString
& text
);
403 virtual wxRichTextRange
AddImage(const wxImage
& image
);
405 /// Layout the buffer: which we must do before certain operations, such as
406 /// setting the caret position.
407 virtual bool LayoutContent(bool onlyVisibleRect
= false);
409 /// Move the caret to the given character position
410 virtual bool MoveCaret(long pos
, bool showAtLineStart
= false);
413 virtual bool MoveRight(int noPositions
= 1, int flags
= 0);
416 virtual bool MoveLeft(int noPositions
= 1, int flags
= 0);
419 virtual bool MoveUp(int noLines
= 1, int flags
= 0);
422 virtual bool MoveDown(int noLines
= 1, int flags
= 0);
424 /// Move to the end of the line
425 virtual bool MoveToLineEnd(int flags
= 0);
427 /// Move to the start of the line
428 virtual bool MoveToLineStart(int flags
= 0);
430 /// Move to the end of the paragraph
431 virtual bool MoveToParagraphEnd(int flags
= 0);
433 /// Move to the start of the paragraph
434 virtual bool MoveToParagraphStart(int flags
= 0);
436 /// Move to the start of the buffer
437 virtual bool MoveHome(int flags
= 0);
439 /// Move to the end of the buffer
440 virtual bool MoveEnd(int flags
= 0);
443 virtual bool PageUp(int noPages
= 1, int flags
= 0);
445 /// Move n pages down
446 virtual bool PageDown(int noPages
= 1, int flags
= 0);
448 /// Move n words left
449 virtual bool WordLeft(int noPages
= 1, int flags
= 0);
451 /// Move n words right
452 virtual bool WordRight(int noPages
= 1, int flags
= 0);
454 /// Returns the buffer associated with the control.
455 wxRichTextBuffer
& GetBuffer() { return m_buffer
; }
456 const wxRichTextBuffer
& GetBuffer() const { return m_buffer
; }
458 /// Start batching undo history for commands.
459 virtual bool BeginBatchUndo(const wxString
& cmdName
) { return m_buffer
.BeginBatchUndo(cmdName
); }
461 /// End batching undo history for commands.
462 virtual bool EndBatchUndo() { return m_buffer
.EndBatchUndo(); }
464 /// Are we batching undo history for commands?
465 virtual bool BatchingUndo() const { return m_buffer
.BatchingUndo(); }
467 /// Start suppressing undo history for commands.
468 virtual bool BeginSuppressUndo() { return m_buffer
.BeginSuppressUndo(); }
470 /// End suppressing undo history for commands.
471 virtual bool EndSuppressUndo() { return m_buffer
.EndSuppressUndo(); }
473 /// Are we suppressing undo history for commands?
474 virtual bool SuppressingUndo() const { return m_buffer
.SuppressingUndo(); }
476 /// Test if this whole range has character attributes of the specified kind. If any
477 /// of the attributes are different within the range, the test fails. You
478 /// can use this to implement, for example, bold button updating. style must have
479 /// flags indicating which attributes are of interest.
480 virtual bool HasCharacterAttributes(const wxRichTextRange
& range
, const wxTextAttrEx
& style
) const
482 return GetBuffer().HasCharacterAttributes(range
, style
);
484 virtual bool HasCharacterAttributes(const wxRichTextRange
& range
, const wxRichTextAttr
& style
) const
486 return GetBuffer().HasCharacterAttributes(range
, style
);
489 /// Test if this whole range has paragraph attributes of the specified kind. If any
490 /// of the attributes are different within the range, the test fails. You
491 /// can use this to implement, for example, centering button updating. style must have
492 /// flags indicating which attributes are of interest.
493 virtual bool HasParagraphAttributes(const wxRichTextRange
& range
, const wxTextAttrEx
& style
) const
495 return GetBuffer().HasParagraphAttributes(range
, style
);
497 virtual bool HasParagraphAttributes(const wxRichTextRange
& range
, const wxRichTextAttr
& style
) const
499 return GetBuffer().HasParagraphAttributes(range
, style
);
502 /// Is all of the selection bold?
503 virtual bool IsSelectionBold();
505 /// Is all of the selection italics?
506 virtual bool IsSelectionItalics();
508 /// Is all of the selection underlined?
509 virtual bool IsSelectionUnderlined();
511 /// Is all of the selection aligned according to the specified flag?
512 virtual bool IsSelectionAligned(wxTextAttrAlignment alignment
);
514 /// Apply bold to the selection
515 virtual bool ApplyBoldToSelection();
517 /// Apply italic to the selection
518 virtual bool ApplyItalicToSelection();
520 /// Apply underline to the selection
521 virtual bool ApplyUnderlineToSelection();
523 /// Apply alignment to the selection
524 virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment
);
526 /// Apply a named style to the selection
527 virtual void ApplyStyle(wxRichTextStyleDefinition
* def
);
529 /// Set style sheet, if any.
530 void SetStyleSheet(wxRichTextStyleSheet
* styleSheet
) { GetBuffer().SetStyleSheet(styleSheet
); }
531 wxRichTextStyleSheet
* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); }
535 void Command(wxCommandEvent
& event
);
536 void OnDropFiles(wxDropFilesEvent
& event
);
538 void OnCut(wxCommandEvent
& event
);
539 void OnCopy(wxCommandEvent
& event
);
540 void OnPaste(wxCommandEvent
& event
);
541 void OnUndo(wxCommandEvent
& event
);
542 void OnRedo(wxCommandEvent
& event
);
543 void OnSelectAll(wxCommandEvent
& event
);
544 void OnClear(wxCommandEvent
& event
);
546 void OnUpdateCut(wxUpdateUIEvent
& event
);
547 void OnUpdateCopy(wxUpdateUIEvent
& event
);
548 void OnUpdatePaste(wxUpdateUIEvent
& event
);
549 void OnUpdateUndo(wxUpdateUIEvent
& event
);
550 void OnUpdateRedo(wxUpdateUIEvent
& event
);
551 void OnUpdateSelectAll(wxUpdateUIEvent
& event
);
552 void OnUpdateClear(wxUpdateUIEvent
& event
);
554 // Show a context menu for Rich Edit controls (the standard
555 // EDIT control has one already)
556 void OnContextMenu(wxContextMenuEvent
& event
);
561 void OnPaint(wxPaintEvent
& event
);
562 void OnEraseBackground(wxEraseEvent
& event
);
565 void OnLeftClick(wxMouseEvent
& event
);
568 void OnLeftUp(wxMouseEvent
& event
);
571 void OnMoveMouse(wxMouseEvent
& event
);
573 /// Left-double-click
574 void OnLeftDClick(wxMouseEvent
& event
);
577 void OnMiddleClick(wxMouseEvent
& event
);
580 void OnRightClick(wxMouseEvent
& event
);
583 void OnChar(wxKeyEvent
& event
);
586 void OnSize(wxSizeEvent
& event
);
588 /// Setting/losing focus
589 void OnSetFocus(wxFocusEvent
& event
);
590 void OnKillFocus(wxFocusEvent
& event
);
592 /// Idle-time processing
593 void OnIdle(wxIdleEvent
& event
);
596 void OnScroll(wxScrollWinEvent
& event
);
600 /// Set font, and also default attributes
601 virtual bool SetFont(const wxFont
& font
);
603 /// Set up scrollbars, e.g. after a resize
604 virtual void SetupScrollbars(bool atTop
= false);
606 /// Keyboard navigation
607 virtual bool KeyboardNavigate(int keyCode
, int flags
);
609 /// Paint the background
610 virtual void PaintBackground(wxDC
& dc
);
612 /// Recreate buffer bitmap if necessary
613 virtual bool RecreateBuffer(const wxSize
& size
= wxDefaultSize
);
615 /// Set the selection
616 virtual void DoSetSelection(long from
, long to
, bool scrollCaret
= true);
619 virtual void DoWriteText(const wxString
& value
, bool selectionOnly
= true);
621 /// Send an update event
622 virtual bool SendUpdateEvent();
624 /// Init command event
625 void InitCommandEvent(wxCommandEvent
& event
) const;
627 /// do the window-specific processing after processing the update event
628 // (duplicated code from wxTextCtrlBase)
629 #if !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
630 virtual void DoUpdateWindowUI(wxUpdateUIEvent
& event
);
633 /// Should we inherit colours?
634 virtual bool ShouldInheritColours() const { return false; }
636 /// Position the caret
637 virtual void PositionCaret();
639 /// Extend the selection, returning true if the selection was
640 /// changed. Selections are in caret positions.
641 virtual bool ExtendSelection(long oldPosition
, long newPosition
, int flags
);
643 /// Scroll into view. This takes a _caret_ position.
644 virtual bool ScrollIntoView(long position
, int keyCode
);
646 /// The caret position is the character position just before the caret.
647 /// A value of -1 means the caret is at the start of the buffer.
648 void SetCaretPosition(long position
, bool showAtLineStart
= false) ;
649 long GetCaretPosition() const { return m_caretPosition
; }
651 /// The adjusted caret position is the character position adjusted to take
652 /// into account whether we're at the start of a paragraph, in which case
653 /// style information should be taken from the next position, not current one.
654 long GetAdjustedCaretPosition(long caretPos
) const;
656 /// Move caret one visual step forward: this may mean setting a flag
657 /// and keeping the same position if we're going from the end of one line
658 /// to the start of the next, which may be the exact same caret position.
659 void MoveCaretForward(long oldPosition
) ;
661 /// Move caret one visual step forward: this may mean setting a flag
662 /// and keeping the same position if we're going from the end of one line
663 /// to the start of the next, which may be the exact same caret position.
664 void MoveCaretBack(long oldPosition
) ;
666 /// Get the caret height and position for the given character position
667 bool GetCaretPositionForIndex(long position
, wxRect
& rect
);
669 /// Gets the line for the visible caret position. If the caret is
670 /// shown at the very end of the line, it means the next character is actually
671 /// on the following line. So let's get the line we're expecting to find
672 /// if this is the case.
673 wxRichTextLine
* GetVisibleLineForCaretPosition(long caretPosition
) const;
675 /// Gets the command processor
676 wxCommandProcessor
* GetCommandProcessor() const { return GetBuffer().GetCommandProcessor(); }
678 /// Delete content if there is a selection, e.g. when pressing a key.
679 /// Returns the new caret position in newPos, or leaves it if there
681 bool DeleteSelectedContent(long* newPos
= NULL
);
683 /// Transform logical to physical
684 wxPoint
GetPhysicalPoint(const wxPoint
& ptLogical
) const;
686 /// Transform physical to logical
687 wxPoint
GetLogicalPoint(const wxPoint
& ptPhysical
) const;
689 /// Finds the caret position for the next word. Direction
690 /// is 1 (forward) or -1 (backwards).
691 virtual long FindNextWordPosition(int direction
= 1) const;
693 /// Is the given position visible on the screen?
694 bool IsPositionVisible(long pos
) const;
696 /// Returns the first visible position in the current view
697 long GetFirstVisiblePosition() const;
699 /// Returns the caret position since the default formatting was changed. As
700 /// soon as this position changes, we no longer reflect the default style
701 /// in the UI. A value of -2 means that we should only reflect the style of the
702 /// content under the caret.
703 long GetCaretPositionForDefaultStyle() const { return m_caretPositionForDefaultStyle
; }
705 /// Set the caret position for the default style that the user is selecting.
706 void SetCaretPositionForDefaultStyle(long pos
) { m_caretPositionForDefaultStyle
= pos
; }
708 /// Should the UI reflect the default style chosen by the user, rather than the style under
710 bool IsDefaultStyleShowing() const { return m_caretPositionForDefaultStyle
!= -2; }
712 /// Convenience function that tells the control to start reflecting the default
713 /// style, since the user is changing it.
714 void SetAndShowDefaultStyle(const wxRichTextAttr
& attr
)
716 SetDefaultStyle(attr
);
717 SetCaretPositionForDefaultStyle(GetCaretPosition());
720 #if wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
721 WX_FORWARD_TO_SCROLL_HELPER()
727 virtual wxSize
DoGetBestSize() const ;
732 /// Allows nested Freeze/Thaw
736 wxBitmap m_bufferBitmap
;
739 wxRichTextBuffer m_buffer
;
741 #if !wxRICHTEXT_DERIVES_FROM_TEXTCTRLBASE
746 wxMenu
* m_contextMenu
;
748 /// Caret position (1 less than the character position, so -1 is the
749 /// first caret position).
750 long m_caretPosition
;
752 /// Caret position when the default formatting has been changed. As
753 /// soon as this position changes, we no longer reflect the default style
755 long m_caretPositionForDefaultStyle
;
757 /// Selection range in character positions. -2, -2 means no selection.
758 wxRichTextRange m_selectionRange
;
760 /// Anchor so we know how to extend the selection
761 /// It's a caret position since it's between two characters.
762 long m_selectionAnchor
;
767 /// Are we showing the caret position at the start of a line
768 /// instead of at the end of the previous one?
769 bool m_caretAtLineStart
;
771 /// Are we dragging a selection?
774 /// Start position for drag
777 /// Do we need full layout in idle?
778 bool m_fullLayoutRequired
;
779 wxLongLong m_fullLayoutTime
;
780 long m_fullLayoutSavedPosition
;
782 /// Threshold for doing delayed layout
783 long m_delayedLayoutThreshold
;
787 * wxRichTextEvent - the event class for wxRichTextCtrl notifications
790 class WXDLLIMPEXP_RICHTEXT wxRichTextEvent
: public wxNotifyEvent
793 wxRichTextEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
794 : wxNotifyEvent(commandType
, winid
),
795 m_itemIndex(-1), m_flags(0)
798 wxRichTextEvent(const wxRichTextEvent
& event
)
799 : wxNotifyEvent(event
),
800 m_itemIndex(event
.m_itemIndex
), m_flags(event
.m_flags
)
803 int GetIndex() const { return m_itemIndex
; }
804 void SetIndex(int n
) { m_itemIndex
= n
; }
806 int GetFlags() const { return m_flags
; }
807 void SetFlags(int flags
) { m_flags
= flags
; }
809 virtual wxEvent
*Clone() const { return new wxRichTextEvent(*this); }
816 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRichTextEvent
)
820 * wxRichTextCtrl event macros
823 BEGIN_DECLARE_EVENT_TYPES()
824 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_ITEM_SELECTED
, 2600)
825 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_ITEM_DESELECTED
, 2601)
826 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_LEFT_CLICK
, 2602)
827 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK
, 2603)
828 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK
, 2604)
829 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK
, 2605)
830 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_RETURN
, 2606)
831 END_DECLARE_EVENT_TYPES()
833 typedef void (wxEvtHandler::*wxRichTextEventFunction
)(wxRichTextEvent
&);
835 #define EVT_RICHTEXT_ITEM_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
836 #define EVT_RICHTEXT_ITEM_DESELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
837 #define EVT_RICHTEXT_LEFT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
838 #define EVT_RICHTEXT_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
839 #define EVT_RICHTEXT_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
840 #define EVT_RICHTEXT_LEFT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
841 #define EVT_RICHTEXT_RETURN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RETURN, id, -1, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxRichTextEventFunction, & fn ), NULL ),
847 // _WX_RICHTEXTCTRL_H_