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 #include "wx/textctrl.h"
24 #if !defined(__WXGTK__) && !defined(__WXMAC__)
25 #define wxRICHTEXT_BUFFERED_PAINTING 1
27 #define wxRICHTEXT_BUFFERED_PAINTING 0
30 class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextStyleDefinition
;
39 #define wxRE_READONLY 0x0010
40 #define wxRE_MULTILINE 0x0020
41 #define wxRE_CENTRE_CARET 0x8000
42 #define wxRE_CENTER_CARET wxRE_CENTRE_CARET
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
: public wxTextCtrlBase
,
92 DECLARE_CLASS( wxRichTextCtrl
)
99 wxRichTextCtrl( wxWindow
* parent
, wxWindowID id
= -1, const wxString
& value
= wxEmptyString
, const wxPoint
& pos
= wxDefaultPosition
, const wxSize
& size
= wxDefaultSize
,
100 long style
= wxRE_MULTILINE
, const wxValidator
& validator
= wxDefaultValidator
, const wxString
& name
= wxTextCtrlNameStr
);
102 virtual ~wxRichTextCtrl( );
107 bool Create( wxWindow
* parent
, wxWindowID id
= -1, const wxString
& value
= wxEmptyString
, const wxPoint
& pos
= wxDefaultPosition
, const wxSize
& size
= wxDefaultSize
,
108 long style
= wxRE_MULTILINE
, const wxValidator
& validator
= wxDefaultValidator
, const wxString
& name
= wxTextCtrlNameStr
);
110 /// Member initialisation
113 ///// wxTextCtrl compatibility
117 virtual wxString
GetRange(long from
, long to
) const;
119 virtual int GetLineLength(long lineNo
) const ;
120 virtual wxString
GetLineText(long lineNo
) const ;
121 virtual int GetNumberOfLines() const ;
123 virtual bool IsModified() const ;
124 virtual bool IsEditable() const ;
126 // more readable flag testing methods
127 bool IsSingleLine() const { return !HasFlag(wxRE_MULTILINE
); }
128 bool IsMultiLine() const { return !IsSingleLine(); }
130 // If the return values from and to are the same, there is no selection.
131 virtual void GetSelection(long* from
, long* to
) const;
133 virtual wxString
GetStringSelection() const;
136 wxString
GetFilename() const { return m_filename
; }
139 void SetFilename(const wxString
& filename
) { m_filename
= filename
; }
141 /// Set the threshold in character positions for doing layout optimization during sizing
142 void SetDelayedLayoutThreshold(long threshold
) { m_delayedLayoutThreshold
= threshold
; }
144 /// Get the threshold in character positions for doing layout optimization during sizing
145 long GetDelayedLayoutThreshold() const { return m_delayedLayoutThreshold
; }
148 void SetTextCursor(const wxCursor
& cursor
) { m_textCursor
= cursor
; }
151 wxCursor
GetTextCursor() const { return m_textCursor
; }
154 void SetURLCursor(const wxCursor
& cursor
) { m_urlCursor
= cursor
; }
157 wxCursor
GetURLCursor() const { return m_urlCursor
; }
159 /// Are we showing the caret position at the start of a line
160 /// instead of at the end of the previous one?
161 bool GetCaretAtLineStart() const { return m_caretAtLineStart
; }
162 void SetCaretAtLineStart(bool atStart
) { m_caretAtLineStart
= atStart
; }
164 /// Are we dragging a selection?
165 bool GetDragging() const { return m_dragging
; }
166 void SetDragging(bool dragging
) { m_dragging
= dragging
; }
168 /// Get/set drag start position
169 const wxPoint
& GetDragStart() const { return m_dragStart
; }
170 void SetDragStart(const wxPoint
& pt
) { m_dragStart
= pt
; }
172 /// Get the buffer bitmap
173 const wxBitmap
& GetBufferBitmap() const { return m_bufferBitmap
; }
174 wxBitmap
& GetBufferBitmap() { return m_bufferBitmap
; }
176 /// Get/set context menu
177 wxMenu
* GetContextMenu() const { return m_contextMenu
; }
178 void SetContextMenu(wxMenu
* menu
) { m_contextMenu
= menu
; }
180 /// Anchor so we know how to extend the selection
181 /// It's a caret position since it's between two characters.
182 long GetSelectionAnchor() const { return m_selectionAnchor
; }
183 void SetSelectionAnchor(long anchor
) { m_selectionAnchor
= anchor
; }
188 virtual void Clear();
189 virtual void Replace(long from
, long to
, const wxString
& value
);
190 virtual void Remove(long from
, long to
);
192 // load/save the controls contents from/to the file
193 virtual bool DoLoadFile(const wxString
& file
, int fileType
);
194 virtual bool DoSaveFile(const wxString
& file
= wxEmptyString
,
195 int fileType
= wxRICHTEXT_TYPE_ANY
);
197 /// Set the handler flags, controlling loading and saving
198 void SetHandlerFlags(int flags
) { GetBuffer().SetHandlerFlags(flags
); }
200 /// Get the handler flags, controlling loading and saving
201 int GetHandlerFlags() const { return GetBuffer().GetHandlerFlags(); }
203 // sets/clears the dirty flag
204 virtual void MarkDirty();
205 virtual void DiscardEdits();
207 // set the max number of characters which may be entered in a single line
209 virtual void SetMaxLength(unsigned long WXUNUSED(len
)) { }
211 // writing text inserts it at the current position, appending always
212 // inserts it at the end
213 virtual void WriteText(const wxString
& text
);
214 virtual void AppendText(const wxString
& text
);
216 // text control under some platforms supports the text styles: these
217 // methods allow to apply the given text style to the given selection or to
218 // set/get the style which will be used for all appended text
219 virtual bool SetStyle(long start
, long end
, const wxTextAttr
& style
);
220 virtual bool SetStyle(const wxRichTextRange
& range
, const wxTextAttr
& style
);
221 virtual bool GetStyle(long position
, wxTextAttr
& style
);
223 // get the common set of styles for the range
224 virtual bool GetStyleForRange(const wxRichTextRange
& range
, wxTextAttr
& style
);
225 // extended style setting operation with flags including:
226 // wxRICHTEXT_SETSTYLE_WITH_UNDO, wxRICHTEXT_SETSTYLE_OPTIMIZE, wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY, wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY
227 // see richtextbuffer.h for more details.
228 virtual bool SetStyleEx(const wxRichTextRange
& range
, const wxTextAttr
& style
, int flags
= wxRICHTEXT_SETSTYLE_WITH_UNDO
);
230 /// Get the content (uncombined) attributes for this position.
231 virtual bool GetUncombinedStyle(long position
, wxTextAttr
& style
);
233 virtual bool SetDefaultStyle(const wxTextAttr
& style
);
235 virtual const wxTextAttr
& GetDefaultStyleEx() const { return GetDefaultStyle(); }
237 virtual const wxTextAttr
& GetDefaultStyle() const;
240 virtual bool SetListStyle(const wxRichTextRange
& range
, wxRichTextListStyleDefinition
* def
, int flags
= wxRICHTEXT_SETSTYLE_WITH_UNDO
, int startFrom
= 1, int specifiedLevel
= -1);
241 virtual bool SetListStyle(const wxRichTextRange
& range
, const wxString
& defName
, int flags
= wxRICHTEXT_SETSTYLE_WITH_UNDO
, int startFrom
= 1, int specifiedLevel
= -1);
243 /// Clear list for given range
244 virtual bool ClearListStyle(const wxRichTextRange
& range
, int flags
= wxRICHTEXT_SETSTYLE_WITH_UNDO
);
246 /// Number/renumber any list elements in the given range
247 /// def/defName can be NULL/empty to indicate that the existing list style should be used.
248 virtual bool NumberList(const wxRichTextRange
& range
, wxRichTextListStyleDefinition
* def
= NULL
, int flags
= wxRICHTEXT_SETSTYLE_WITH_UNDO
, int startFrom
= 1, int specifiedLevel
= -1);
249 virtual bool NumberList(const wxRichTextRange
& range
, const wxString
& defName
, int flags
= wxRICHTEXT_SETSTYLE_WITH_UNDO
, int startFrom
= 1, int specifiedLevel
= -1);
251 /// Promote the list items within the given range. promoteBy can be a positive or negative number, e.g. 1 or -1
252 /// def/defName can be NULL/empty to indicate that the existing list style should be used.
253 virtual bool PromoteList(int promoteBy
, const wxRichTextRange
& range
, wxRichTextListStyleDefinition
* def
= NULL
, int flags
= wxRICHTEXT_SETSTYLE_WITH_UNDO
, int specifiedLevel
= -1);
254 virtual bool PromoteList(int promoteBy
, const wxRichTextRange
& range
, const wxString
& defName
, int flags
= wxRICHTEXT_SETSTYLE_WITH_UNDO
, int specifiedLevel
= -1);
256 /// Deletes the content in the given range
257 virtual bool Delete(const wxRichTextRange
& range
);
259 // translate between the position (which is just an index in the text ctrl
260 // considering all its contents as a single strings) and (x, y) coordinates
261 // which represent column and line.
262 virtual long XYToPosition(long x
, long y
) const;
263 virtual bool PositionToXY(long pos
, long *x
, long *y
) const;
265 virtual void ShowPosition(long pos
);
267 // find the character at position given in pixels
269 // NB: pt is in device coords (not adjusted for the client area origin nor
271 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
, long *pos
) const;
272 virtual wxTextCtrlHitTestResult
HitTest(const wxPoint
& pt
,
274 wxTextCoord
*row
) const;
276 // Clipboard operations
279 virtual void Paste();
280 virtual void DeleteSelection();
282 virtual bool CanCopy() const;
283 virtual bool CanCut() const;
284 virtual bool CanPaste() const;
285 virtual bool CanDeleteSelection() const;
291 virtual bool CanUndo() const;
292 virtual bool CanRedo() const;
295 virtual void SetInsertionPoint(long pos
);
296 virtual void SetInsertionPointEnd();
297 virtual long GetInsertionPoint() const;
298 virtual wxTextPos
GetLastPosition() const;
300 virtual void SetSelection(long from
, long to
);
301 virtual void SelectAll();
302 virtual void SetEditable(bool editable
);
304 virtual bool HasSelection() const;
306 ///// Functionality specific to wxRichTextCtrl
308 /// Write an image at the current insertion point. Supply optional type to use
309 /// for internal and file storage of the raw data.
310 virtual bool WriteImage(const wxImage
& image
, wxBitmapType bitmapType
= wxBITMAP_TYPE_PNG
);
312 /// Write a bitmap at the current insertion point. Supply optional type to use
313 /// for internal and file storage of the raw data.
314 virtual bool WriteImage(const wxBitmap
& bitmap
, wxBitmapType bitmapType
= wxBITMAP_TYPE_PNG
);
316 /// Load an image from file and write at the current insertion point.
317 virtual bool WriteImage(const wxString
& filename
, wxBitmapType bitmapType
);
319 /// Write an image block at the current insertion point.
320 virtual bool WriteImage(const wxRichTextImageBlock
& imageBlock
);
322 /// Insert a newline (actually paragraph) at the current insertion point.
323 virtual bool Newline();
325 /// Insert a line break at the current insertion point.
326 virtual bool LineBreak();
328 /// Set basic (overall) style
329 virtual void SetBasicStyle(const wxTextAttr
& style
) { GetBuffer().SetBasicStyle(style
); }
331 /// Get basic (overall) style
332 virtual const wxTextAttr
& GetBasicStyle() const { return GetBuffer().GetBasicStyle(); }
334 virtual bool BeginStyle(const wxTextAttr
& style
) { return GetBuffer().BeginStyle(style
); }
337 virtual bool EndStyle() { return GetBuffer().EndStyle(); }
340 virtual bool EndAllStyles() { return GetBuffer().EndAllStyles(); }
343 bool BeginBold() { return GetBuffer().BeginBold(); }
346 bool EndBold() { return GetBuffer().EndBold(); }
348 /// Begin using italic
349 bool BeginItalic() { return GetBuffer().BeginItalic(); }
352 bool EndItalic() { return GetBuffer().EndItalic(); }
354 /// Begin using underline
355 bool BeginUnderline() { return GetBuffer().BeginUnderline(); }
357 /// End using underline
358 bool EndUnderline() { return GetBuffer().EndUnderline(); }
360 /// Begin using point size
361 bool BeginFontSize(int pointSize
) { return GetBuffer().BeginFontSize(pointSize
); }
363 /// End using point size
364 bool EndFontSize() { return GetBuffer().EndFontSize(); }
366 /// Begin using this font
367 bool BeginFont(const wxFont
& font
) { return GetBuffer().BeginFont(font
); }
370 bool EndFont() { return GetBuffer().EndFont(); }
372 /// Begin using this colour
373 bool BeginTextColour(const wxColour
& colour
) { return GetBuffer().BeginTextColour(colour
); }
375 /// End using a colour
376 bool EndTextColour() { return GetBuffer().EndTextColour(); }
378 /// Begin using alignment
379 bool BeginAlignment(wxTextAttrAlignment alignment
) { return GetBuffer().BeginAlignment(alignment
); }
382 bool EndAlignment() { return GetBuffer().EndAlignment(); }
384 /// Begin left indent
385 bool BeginLeftIndent(int leftIndent
, int leftSubIndent
= 0) { return GetBuffer().BeginLeftIndent(leftIndent
, leftSubIndent
); }
388 bool EndLeftIndent() { return GetBuffer().EndLeftIndent(); }
390 /// Begin right indent
391 bool BeginRightIndent(int rightIndent
) { return GetBuffer().BeginRightIndent(rightIndent
); }
394 bool EndRightIndent() { return GetBuffer().EndRightIndent(); }
396 /// Begin paragraph spacing
397 bool BeginParagraphSpacing(int before
, int after
) { return GetBuffer().BeginParagraphSpacing(before
, after
); }
399 /// End paragraph spacing
400 bool EndParagraphSpacing() { return GetBuffer().EndParagraphSpacing(); }
402 /// Begin line spacing
403 bool BeginLineSpacing(int lineSpacing
) { return GetBuffer().BeginLineSpacing(lineSpacing
); }
406 bool EndLineSpacing() { return GetBuffer().EndLineSpacing(); }
408 /// Begin numbered bullet
409 bool BeginNumberedBullet(int bulletNumber
, int leftIndent
, int leftSubIndent
, int bulletStyle
= wxTEXT_ATTR_BULLET_STYLE_ARABIC
|wxTEXT_ATTR_BULLET_STYLE_PERIOD
)
410 { return GetBuffer().BeginNumberedBullet(bulletNumber
, leftIndent
, leftSubIndent
, bulletStyle
); }
412 /// End numbered bullet
413 bool EndNumberedBullet() { return GetBuffer().EndNumberedBullet(); }
415 /// Begin symbol bullet
416 bool BeginSymbolBullet(const wxString
& symbol
, int leftIndent
, int leftSubIndent
, int bulletStyle
= wxTEXT_ATTR_BULLET_STYLE_SYMBOL
)
417 { return GetBuffer().BeginSymbolBullet(symbol
, leftIndent
, leftSubIndent
, bulletStyle
); }
419 /// End symbol bullet
420 bool EndSymbolBullet() { return GetBuffer().EndSymbolBullet(); }
422 /// Begin standard bullet
423 bool BeginStandardBullet(const wxString
& bulletName
, int leftIndent
, int leftSubIndent
, int bulletStyle
= wxTEXT_ATTR_BULLET_STYLE_STANDARD
)
424 { return GetBuffer().BeginStandardBullet(bulletName
, leftIndent
, leftSubIndent
, bulletStyle
); }
426 /// End standard bullet
427 bool EndStandardBullet() { return GetBuffer().EndStandardBullet(); }
429 /// Begin named character style
430 bool BeginCharacterStyle(const wxString
& characterStyle
) { return GetBuffer().BeginCharacterStyle(characterStyle
); }
432 /// End named character style
433 bool EndCharacterStyle() { return GetBuffer().EndCharacterStyle(); }
435 /// Begin named paragraph style
436 bool BeginParagraphStyle(const wxString
& paragraphStyle
) { return GetBuffer().BeginParagraphStyle(paragraphStyle
); }
438 /// End named character style
439 bool EndParagraphStyle() { return GetBuffer().EndParagraphStyle(); }
441 /// Begin named list style
442 bool BeginListStyle(const wxString
& listStyle
, int level
= 1, int number
= 1) { return GetBuffer().BeginListStyle(listStyle
, level
, number
); }
444 /// End named character style
445 bool EndListStyle() { return GetBuffer().EndListStyle(); }
448 bool BeginURL(const wxString
& url
, const wxString
& characterStyle
= wxEmptyString
) { return GetBuffer().BeginURL(url
, characterStyle
); }
451 bool EndURL() { return GetBuffer().EndURL(); }
453 /// Sets the default style to the style under the cursor
454 bool SetDefaultStyleToCursorStyle();
456 /// Clear the selection
457 virtual void SelectNone();
459 /// Select the word at the given character position
460 virtual bool SelectWord(long position
);
462 /// Get/set the selection range in character positions. -1, -1 means no selection.
463 /// The range is in API convention, i.e. a single character selection is denoted
465 wxRichTextRange
GetSelectionRange() const;
466 void SetSelectionRange(const wxRichTextRange
& range
);
468 /// Get/set the selection range in character positions. -1, -1 means no selection.
469 /// The range is in internal format, i.e. a single character selection is denoted
471 const wxRichTextRange
& GetInternalSelectionRange() const { return m_selectionRange
; }
472 void SetInternalSelectionRange(const wxRichTextRange
& range
) { m_selectionRange
= range
; }
474 /// Add a new paragraph of text to the end of the buffer
475 virtual wxRichTextRange
AddParagraph(const wxString
& text
);
478 virtual wxRichTextRange
AddImage(const wxImage
& image
);
480 /// Layout the buffer: which we must do before certain operations, such as
481 /// setting the caret position.
482 virtual bool LayoutContent(bool onlyVisibleRect
= false);
484 /// Move the caret to the given character position
485 virtual bool MoveCaret(long pos
, bool showAtLineStart
= false);
488 virtual bool MoveRight(int noPositions
= 1, int flags
= 0);
491 virtual bool MoveLeft(int noPositions
= 1, int flags
= 0);
494 virtual bool MoveUp(int noLines
= 1, int flags
= 0);
497 virtual bool MoveDown(int noLines
= 1, int flags
= 0);
499 /// Move to the end of the line
500 virtual bool MoveToLineEnd(int flags
= 0);
502 /// Move to the start of the line
503 virtual bool MoveToLineStart(int flags
= 0);
505 /// Move to the end of the paragraph
506 virtual bool MoveToParagraphEnd(int flags
= 0);
508 /// Move to the start of the paragraph
509 virtual bool MoveToParagraphStart(int flags
= 0);
511 /// Move to the start of the buffer
512 virtual bool MoveHome(int flags
= 0);
514 /// Move to the end of the buffer
515 virtual bool MoveEnd(int flags
= 0);
518 virtual bool PageUp(int noPages
= 1, int flags
= 0);
520 /// Move n pages down
521 virtual bool PageDown(int noPages
= 1, int flags
= 0);
523 /// Move n words left
524 virtual bool WordLeft(int noPages
= 1, int flags
= 0);
526 /// Move n words right
527 virtual bool WordRight(int noPages
= 1, int flags
= 0);
529 /// Returns the buffer associated with the control.
530 wxRichTextBuffer
& GetBuffer() { return m_buffer
; }
531 const wxRichTextBuffer
& GetBuffer() const { return m_buffer
; }
533 /// Start batching undo history for commands.
534 virtual bool BeginBatchUndo(const wxString
& cmdName
) { return m_buffer
.BeginBatchUndo(cmdName
); }
536 /// End batching undo history for commands.
537 virtual bool EndBatchUndo() { return m_buffer
.EndBatchUndo(); }
539 /// Are we batching undo history for commands?
540 virtual bool BatchingUndo() const { return m_buffer
.BatchingUndo(); }
542 /// Start suppressing undo history for commands.
543 virtual bool BeginSuppressUndo() { return m_buffer
.BeginSuppressUndo(); }
545 /// End suppressing undo history for commands.
546 virtual bool EndSuppressUndo() { return m_buffer
.EndSuppressUndo(); }
548 /// Are we suppressing undo history for commands?
549 virtual bool SuppressingUndo() const { return m_buffer
.SuppressingUndo(); }
551 /// Test if this whole range has character attributes of the specified kind. If any
552 /// of the attributes are different within the range, the test fails. You
553 /// can use this to implement, for example, bold button updating. style must have
554 /// flags indicating which attributes are of interest.
555 virtual bool HasCharacterAttributes(const wxRichTextRange
& range
, const wxTextAttr
& style
) const
557 return GetBuffer().HasCharacterAttributes(range
.ToInternal(), style
);
560 /// Test if this whole range has paragraph attributes of the specified kind. If any
561 /// of the attributes are different within the range, the test fails. You
562 /// can use this to implement, for example, centering button updating. style must have
563 /// flags indicating which attributes are of interest.
564 virtual bool HasParagraphAttributes(const wxRichTextRange
& range
, const wxTextAttr
& style
) const
566 return GetBuffer().HasParagraphAttributes(range
.ToInternal(), style
);
569 /// Is all of the selection bold?
570 virtual bool IsSelectionBold();
572 /// Is all of the selection italics?
573 virtual bool IsSelectionItalics();
575 /// Is all of the selection underlined?
576 virtual bool IsSelectionUnderlined();
578 /// Is all of the selection aligned according to the specified flag?
579 virtual bool IsSelectionAligned(wxTextAttrAlignment alignment
);
581 /// Apply bold to the selection
582 virtual bool ApplyBoldToSelection();
584 /// Apply italic to the selection
585 virtual bool ApplyItalicToSelection();
587 /// Apply underline to the selection
588 virtual bool ApplyUnderlineToSelection();
590 /// Apply alignment to the selection
591 virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment
);
593 /// Apply a named style to the selection
594 virtual bool ApplyStyle(wxRichTextStyleDefinition
* def
);
596 /// Set style sheet, if any
597 void SetStyleSheet(wxRichTextStyleSheet
* styleSheet
) { GetBuffer().SetStyleSheet(styleSheet
); }
598 wxRichTextStyleSheet
* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); }
600 /// Push style sheet to top of stack
601 bool PushStyleSheet(wxRichTextStyleSheet
* styleSheet
) { return GetBuffer().PushStyleSheet(styleSheet
); }
603 /// Pop style sheet from top of stack
604 wxRichTextStyleSheet
* PopStyleSheet() { return GetBuffer().PopStyleSheet(); }
606 /// Apply the style sheet to the buffer, for example if the styles have changed.
607 bool ApplyStyleSheet(wxRichTextStyleSheet
* styleSheet
= NULL
);
611 void Command(wxCommandEvent
& event
);
612 void OnDropFiles(wxDropFilesEvent
& event
);
613 void OnCaptureLost(wxMouseCaptureLostEvent
& event
);
614 void OnSysColourChanged(wxSysColourChangedEvent
& event
);
616 void OnCut(wxCommandEvent
& event
);
617 void OnCopy(wxCommandEvent
& event
);
618 void OnPaste(wxCommandEvent
& event
);
619 void OnUndo(wxCommandEvent
& event
);
620 void OnRedo(wxCommandEvent
& event
);
621 void OnSelectAll(wxCommandEvent
& event
);
622 void OnClear(wxCommandEvent
& event
);
624 void OnUpdateCut(wxUpdateUIEvent
& event
);
625 void OnUpdateCopy(wxUpdateUIEvent
& event
);
626 void OnUpdatePaste(wxUpdateUIEvent
& event
);
627 void OnUpdateUndo(wxUpdateUIEvent
& event
);
628 void OnUpdateRedo(wxUpdateUIEvent
& event
);
629 void OnUpdateSelectAll(wxUpdateUIEvent
& event
);
630 void OnUpdateClear(wxUpdateUIEvent
& event
);
632 // Show a context menu for Rich Edit controls (the standard
633 // EDIT control has one already)
634 void OnContextMenu(wxContextMenuEvent
& event
);
639 void OnPaint(wxPaintEvent
& event
);
640 void OnEraseBackground(wxEraseEvent
& event
);
643 void OnLeftClick(wxMouseEvent
& event
);
646 void OnLeftUp(wxMouseEvent
& event
);
649 void OnMoveMouse(wxMouseEvent
& event
);
651 /// Left-double-click
652 void OnLeftDClick(wxMouseEvent
& event
);
655 void OnMiddleClick(wxMouseEvent
& event
);
658 void OnRightClick(wxMouseEvent
& event
);
661 void OnChar(wxKeyEvent
& event
);
664 void OnSize(wxSizeEvent
& event
);
666 /// Setting/losing focus
667 void OnSetFocus(wxFocusEvent
& event
);
668 void OnKillFocus(wxFocusEvent
& event
);
670 /// Idle-time processing
671 void OnIdle(wxIdleEvent
& event
);
674 void OnScroll(wxScrollWinEvent
& event
);
676 /// Set font, and also default attributes
677 virtual bool SetFont(const wxFont
& font
);
679 /// Set up scrollbars, e.g. after a resize
680 virtual void SetupScrollbars(bool atTop
= false);
682 /// Keyboard navigation
683 virtual bool KeyboardNavigate(int keyCode
, int flags
);
685 /// Paint the background
686 virtual void PaintBackground(wxDC
& dc
);
688 #if wxRICHTEXT_BUFFERED_PAINTING
689 /// Recreate buffer bitmap if necessary
690 virtual bool RecreateBuffer(const wxSize
& size
= wxDefaultSize
);
694 virtual void DoWriteText(const wxString
& value
, int flags
= 0);
696 /// Should we inherit colours?
697 virtual bool ShouldInheritColours() const { return false; }
699 /// Position the caret
700 virtual void PositionCaret();
702 /// Extend the selection, returning true if the selection was
703 /// changed. Selections are in caret positions.
704 virtual bool ExtendSelection(long oldPosition
, long newPosition
, int flags
);
706 /// Scroll into view. This takes a _caret_ position.
707 virtual bool ScrollIntoView(long position
, int keyCode
);
709 /// Refresh the area affected by a selection change
710 bool RefreshForSelectionChange(const wxRichTextRange
& oldSelection
, const wxRichTextRange
& newSelection
);
712 /// The caret position is the character position just before the caret.
713 /// A value of -1 means the caret is at the start of the buffer.
714 void SetCaretPosition(long position
, bool showAtLineStart
= false) ;
715 long GetCaretPosition() const { return m_caretPosition
; }
717 /// The adjusted caret position is the character position adjusted to take
718 /// into account whether we're at the start of a paragraph, in which case
719 /// style information should be taken from the next position, not current one.
720 long GetAdjustedCaretPosition(long caretPos
) const;
722 /// Move caret one visual step forward: this may mean setting a flag
723 /// and keeping the same position if we're going from the end of one line
724 /// to the start of the next, which may be the exact same caret position.
725 void MoveCaretForward(long oldPosition
) ;
727 /// Move caret one visual step forward: this may mean setting a flag
728 /// and keeping the same position if we're going from the end of one line
729 /// to the start of the next, which may be the exact same caret position.
730 void MoveCaretBack(long oldPosition
) ;
732 /// Get the caret height and position for the given character position
733 bool GetCaretPositionForIndex(long position
, wxRect
& rect
);
735 /// Gets the line for the visible caret position. If the caret is
736 /// shown at the very end of the line, it means the next character is actually
737 /// on the following line. So let's get the line we're expecting to find
738 /// if this is the case.
739 wxRichTextLine
* GetVisibleLineForCaretPosition(long caretPosition
) const;
741 /// Gets the command processor
742 wxCommandProcessor
* GetCommandProcessor() const { return GetBuffer().GetCommandProcessor(); }
744 /// Delete content if there is a selection, e.g. when pressing a key.
745 /// Returns the new caret position in newPos, or leaves it if there
747 bool DeleteSelectedContent(long* newPos
= NULL
);
749 /// Transform logical to physical
750 wxPoint
GetPhysicalPoint(const wxPoint
& ptLogical
) const;
752 /// Transform physical to logical
753 wxPoint
GetLogicalPoint(const wxPoint
& ptPhysical
) const;
755 /// Finds the caret position for the next word. Direction
756 /// is 1 (forward) or -1 (backwards).
757 virtual long FindNextWordPosition(int direction
= 1) const;
759 /// Is the given position visible on the screen?
760 bool IsPositionVisible(long pos
) const;
762 /// Returns the first visible position in the current view
763 long GetFirstVisiblePosition() const;
765 /// Returns the caret position since the default formatting was changed. As
766 /// soon as this position changes, we no longer reflect the default style
767 /// in the UI. A value of -2 means that we should only reflect the style of the
768 /// content under the caret.
769 long GetCaretPositionForDefaultStyle() const { return m_caretPositionForDefaultStyle
; }
771 /// Set the caret position for the default style that the user is selecting.
772 void SetCaretPositionForDefaultStyle(long pos
) { m_caretPositionForDefaultStyle
= pos
; }
774 /// Should the UI reflect the default style chosen by the user, rather than the style under
776 bool IsDefaultStyleShowing() const { return m_caretPositionForDefaultStyle
!= -2; }
778 /// Convenience function that tells the control to start reflecting the default
779 /// style, since the user is changing it.
780 void SetAndShowDefaultStyle(const wxTextAttr
& attr
)
782 SetDefaultStyle(attr
);
783 SetCaretPositionForDefaultStyle(GetCaretPosition());
786 /// Get the first visible point in the window
787 wxPoint
GetFirstVisiblePoint() const;
791 /// Font names take a long time to retrieve, so cache them (on demand)
792 static const wxArrayString
& GetAvailableFontNames();
793 static void ClearAvailableFontNames();
795 WX_FORWARD_TO_SCROLL_HELPER()
797 // implement wxTextEntry methods
798 virtual wxString
DoGetValue() const;
801 // FIXME: this does not work, it allows this code to compile but will fail
804 virtual WXHWND
GetEditHWND() const { return GetHWND(); }
807 virtual WXWidget
GetTextWidget() const { return NULL
; }
810 virtual wxWindow
*GetEditableWindow() { return this; }
811 virtual GtkEditable
*GetEditable() const { return NULL
; }
812 virtual GtkEntry
*GetEntry() const { return NULL
; }
818 virtual wxSize
DoGetBestSize() const ;
820 virtual void DoSetValue(const wxString
& value
, int flags
= 0);
822 virtual void DoThaw();
827 #if wxRICHTEXT_BUFFERED_PAINTING
829 wxBitmap m_bufferBitmap
;
833 wxRichTextBuffer m_buffer
;
835 wxMenu
* m_contextMenu
;
837 /// Caret position (1 less than the character position, so -1 is the
838 /// first caret position).
839 long m_caretPosition
;
841 /// Caret position when the default formatting has been changed. As
842 /// soon as this position changes, we no longer reflect the default style
844 long m_caretPositionForDefaultStyle
;
846 /// Selection range in character positions. -2, -2 means no selection.
847 wxRichTextRange m_selectionRange
;
849 /// Anchor so we know how to extend the selection
850 /// It's a caret position since it's between two characters.
851 long m_selectionAnchor
;
856 /// Are we showing the caret position at the start of a line
857 /// instead of at the end of the previous one?
858 bool m_caretAtLineStart
;
860 /// Are we dragging a selection?
863 /// Start position for drag
866 /// Do we need full layout in idle?
867 bool m_fullLayoutRequired
;
868 wxLongLong m_fullLayoutTime
;
869 long m_fullLayoutSavedPosition
;
871 /// Threshold for doing delayed layout
872 long m_delayedLayoutThreshold
;
875 wxCursor m_textCursor
;
876 wxCursor m_urlCursor
;
878 static wxArrayString sm_availableFontNames
;
882 * wxRichTextEvent - the event class for wxRichTextCtrl notifications
885 class WXDLLIMPEXP_RICHTEXT wxRichTextEvent
: public wxNotifyEvent
888 wxRichTextEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
889 : wxNotifyEvent(commandType
, winid
),
890 m_flags(0), m_position(-1), m_oldStyleSheet(NULL
), m_newStyleSheet(NULL
),
894 wxRichTextEvent(const wxRichTextEvent
& event
)
895 : wxNotifyEvent(event
),
896 m_flags(event
.m_flags
), m_position(-1),
897 m_oldStyleSheet(event
.m_oldStyleSheet
), m_newStyleSheet(event
.m_newStyleSheet
),
901 long GetPosition() const { return m_position
; }
902 void SetPosition(long pos
) { m_position
= pos
; }
904 int GetFlags() const { return m_flags
; }
905 void SetFlags(int flags
) { m_flags
= flags
; }
907 wxRichTextStyleSheet
* GetOldStyleSheet() const { return m_oldStyleSheet
; }
908 void SetOldStyleSheet(wxRichTextStyleSheet
* sheet
) { m_oldStyleSheet
= sheet
; }
910 wxRichTextStyleSheet
* GetNewStyleSheet() const { return m_newStyleSheet
; }
911 void SetNewStyleSheet(wxRichTextStyleSheet
* sheet
) { m_newStyleSheet
= sheet
; }
913 const wxRichTextRange
& GetRange() const { return m_range
; }
914 void SetRange(const wxRichTextRange
& range
) { m_range
= range
; }
916 wxChar
GetCharacter() const { return m_char
; }
917 void SetCharacter(wxChar ch
) { m_char
= ch
; }
919 virtual wxEvent
*Clone() const { return new wxRichTextEvent(*this); }
924 wxRichTextStyleSheet
* m_oldStyleSheet
;
925 wxRichTextStyleSheet
* m_newStyleSheet
;
926 wxRichTextRange m_range
;
930 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRichTextEvent
)
934 * wxRichTextCtrl events
936 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_LEFT_CLICK
, wxRichTextEvent
);
937 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK
, wxRichTextEvent
);
938 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK
, wxRichTextEvent
);
939 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK
, wxRichTextEvent
);
940 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_RETURN
, wxRichTextEvent
);
941 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_CHARACTER
, wxRichTextEvent
);
942 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_DELETE
, wxRichTextEvent
);
944 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING
, wxRichTextEvent
);
945 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED
, wxRichTextEvent
);
946 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING
, wxRichTextEvent
);
947 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED
, wxRichTextEvent
);
949 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED
, wxRichTextEvent
);
950 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED
, wxRichTextEvent
);
951 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED
, wxRichTextEvent
);
952 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED
, wxRichTextEvent
);
953 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT
, wxEVT_COMMAND_RICHTEXT_BUFFER_RESET
, wxRichTextEvent
);
955 typedef void (wxEvtHandler
::*wxRichTextEventFunction
)(wxRichTextEvent
&);
957 #define wxRichTextEventHandler(func) \
958 wxEVENT_HANDLER_CAST(wxRichTextEventFunction, func)
960 #define EVT_RICHTEXT_LEFT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
961 #define EVT_RICHTEXT_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
962 #define EVT_RICHTEXT_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
963 #define EVT_RICHTEXT_LEFT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
964 #define EVT_RICHTEXT_RETURN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RETURN, id, -1, wxRichTextEventHandler( fn ), NULL ),
965 #define EVT_RICHTEXT_CHARACTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CHARACTER, id, -1, wxRichTextEventHandler( fn ), NULL ),
966 #define EVT_RICHTEXT_DELETE(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_DELETE, id, -1, wxRichTextEventHandler( fn ), NULL ),
968 #define EVT_RICHTEXT_STYLESHEET_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING, id, -1, wxRichTextEventHandler( fn ), NULL ),
969 #define EVT_RICHTEXT_STYLESHEET_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
970 #define EVT_RICHTEXT_STYLESHEET_REPLACING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING, id, -1, wxRichTextEventHandler( fn ), NULL ),
971 #define EVT_RICHTEXT_STYLESHEET_REPLACED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED, id, -1, wxRichTextEventHandler( fn ), NULL ),
973 #define EVT_RICHTEXT_CONTENT_INSERTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, id, -1, wxRichTextEventHandler( fn ), NULL ),
974 #define EVT_RICHTEXT_CONTENT_DELETED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, id, -1, wxRichTextEventHandler( fn ), NULL ),
975 #define EVT_RICHTEXT_STYLE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
976 #define EVT_RICHTEXT_SELECTION_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
977 #define EVT_RICHTEXT_BUFFER_RESET(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, id, -1, wxRichTextEventHandler( fn ), NULL ),
983 // _WX_RICHTEXTCTRL_H_