]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/richtext/richtextctrl.h
don't draw borders for bitmap buttons with wxBORDER_NONE style
[wxWidgets.git] / include / wx / richtext / richtextctrl.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/richtext/richtextctrl.h
3// Purpose: A rich edit control
4// Author: Julian Smart
5// Modified by:
6// Created: 2005-09-30
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_RICHTEXTCTRL_H_
13#define _WX_RICHTEXTCTRL_H_
14
15#include "wx/richtext/richtextbuffer.h"
16
17#if wxUSE_RICHTEXT
18
19#include "wx/scrolwin.h"
20#include "wx/caret.h"
21
22#include "wx/textctrl.h"
23
24#if !defined(__WXGTK__) && !defined(__WXMAC__)
25#define wxRICHTEXT_BUFFERED_PAINTING 1
26#else
27#define wxRICHTEXT_BUFFERED_PAINTING 0
28#endif
29
30class WXDLLIMPEXP_FWD_RICHTEXT wxRichTextStyleDefinition;
31
32/*!
33 * Styles and flags
34 */
35
36/* Styles
37 */
38
39#define wxRE_READONLY 0x0010
40#define wxRE_MULTILINE 0x0020
41#define wxRE_CENTRE_CARET 0x8000
42#define wxRE_CENTER_CARET wxRE_CENTRE_CARET
43
44/* Flags
45 */
46
47#define wxRICHTEXT_SHIFT_DOWN 0x01
48#define wxRICHTEXT_CTRL_DOWN 0x02
49#define wxRICHTEXT_ALT_DOWN 0x04
50
51/* Defaults
52 */
53
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
68
69/*!
70 * Forward declarations
71 */
72
73/*!
74 * wxRichTextItem class declaration
75 */
76
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
84
85/*!
86 * wxRichTextCtrl class declaration
87 */
88
89class WXDLLIMPEXP_RICHTEXT wxRichTextCtrl : public wxTextCtrlBase,
90 public wxScrollHelper
91{
92 DECLARE_CLASS( wxRichTextCtrl )
93 DECLARE_EVENT_TABLE()
94
95public:
96// Constructors
97
98 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);
101
102 virtual ~wxRichTextCtrl( );
103
104// Operations
105
106 /// Creation
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 );
109
110 /// Member initialisation
111 void Init();
112
113///// wxTextCtrl compatibility
114
115// Accessors
116
117 virtual wxString GetRange(long from, long to) const;
118
119 virtual int GetLineLength(long lineNo) const ;
120 virtual wxString GetLineText(long lineNo) const ;
121 virtual int GetNumberOfLines() const ;
122
123 virtual bool IsModified() const ;
124 virtual bool IsEditable() const ;
125
126 // more readable flag testing methods
127 bool IsSingleLine() const { return !HasFlag(wxRE_MULTILINE); }
128 bool IsMultiLine() const { return !IsSingleLine(); }
129
130 // If the return values from and to are the same, there is no selection.
131 virtual void GetSelection(long* from, long* to) const;
132
133 virtual wxString GetStringSelection() const;
134
135 /// Get filename
136 wxString GetFilename() const { return m_filename; }
137
138 /// Set filename
139 void SetFilename(const wxString& filename) { m_filename = filename; }
140
141 /// Set the threshold in character positions for doing layout optimization during sizing
142 void SetDelayedLayoutThreshold(long threshold) { m_delayedLayoutThreshold = threshold; }
143
144 /// Get the threshold in character positions for doing layout optimization during sizing
145 long GetDelayedLayoutThreshold() const { return m_delayedLayoutThreshold; }
146
147 /// Set text cursor
148 void SetTextCursor(const wxCursor& cursor ) { m_textCursor = cursor; }
149
150 /// Get text cursor
151 wxCursor GetTextCursor() const { return m_textCursor; }
152
153 /// Set URL cursor
154 void SetURLCursor(const wxCursor& cursor ) { m_urlCursor = cursor; }
155
156 /// Get URL cursor
157 wxCursor GetURLCursor() const { return m_urlCursor; }
158
159// Operations
160
161 // editing
162 virtual void Clear();
163 virtual void Replace(long from, long to, const wxString& value);
164 virtual void Remove(long from, long to);
165
166 // load/save the controls contents from/to the file
167 virtual bool DoLoadFile(const wxString& file, int fileType);
168 virtual bool DoSaveFile(const wxString& file = wxEmptyString,
169 int fileType = wxRICHTEXT_TYPE_ANY);
170
171 /// Set the handler flags, controlling loading and saving
172 void SetHandlerFlags(int flags) { GetBuffer().SetHandlerFlags(flags); }
173
174 /// Get the handler flags, controlling loading and saving
175 int GetHandlerFlags() const { return GetBuffer().GetHandlerFlags(); }
176
177 // sets/clears the dirty flag
178 virtual void MarkDirty();
179 virtual void DiscardEdits();
180
181 // set the max number of characters which may be entered in a single line
182 // text control
183 virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
184
185 // writing text inserts it at the current position, appending always
186 // inserts it at the end
187 virtual void WriteText(const wxString& text);
188 virtual void AppendText(const wxString& text);
189
190 // text control under some platforms supports the text styles: these
191 // methods allow to apply the given text style to the given selection or to
192 // set/get the style which will be used for all appended text
193 virtual bool SetStyle(long start, long end, const wxTextAttr& style);
194 virtual bool SetStyle(const wxRichTextRange& range, const wxTextAttr& style);
195 virtual bool GetStyle(long position, wxTextAttr& style);
196
197 // get the common set of styles for the range
198 virtual bool GetStyleForRange(const wxRichTextRange& range, wxTextAttr& style);
199 // extended style setting operation with flags including:
200 // wxRICHTEXT_SETSTYLE_WITH_UNDO, wxRICHTEXT_SETSTYLE_OPTIMIZE, wxRICHTEXT_SETSTYLE_PARAGRAPHS_ONLY, wxRICHTEXT_SETSTYLE_CHARACTERS_ONLY
201 // see richtextbuffer.h for more details.
202 virtual bool SetStyleEx(const wxRichTextRange& range, const wxTextAttr& style, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
203
204 /// Get the content (uncombined) attributes for this position.
205 virtual bool GetUncombinedStyle(long position, wxTextAttr& style);
206
207 virtual bool SetDefaultStyle(const wxTextAttr& style);
208
209 virtual const wxTextAttr& GetDefaultStyleEx() const { return GetDefaultStyle(); }
210
211 virtual const wxTextAttr& GetDefaultStyle() const;
212
213 /// Set list style
214 virtual bool SetListStyle(const wxRichTextRange& range, wxRichTextListStyleDefinition* def, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
215 virtual bool SetListStyle(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
216
217 /// Clear list for given range
218 virtual bool ClearListStyle(const wxRichTextRange& range, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO);
219
220 /// Number/renumber any list elements in the given range
221 /// def/defName can be NULL/empty to indicate that the existing list style should be used.
222 virtual bool NumberList(const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
223 virtual bool NumberList(const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int startFrom = 1, int specifiedLevel = -1);
224
225 /// Promote the list items within the given range. promoteBy can be a positive or negative number, e.g. 1 or -1
226 /// def/defName can be NULL/empty to indicate that the existing list style should be used.
227 virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, wxRichTextListStyleDefinition* def = NULL, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1);
228 virtual bool PromoteList(int promoteBy, const wxRichTextRange& range, const wxString& defName, int flags = wxRICHTEXT_SETSTYLE_WITH_UNDO, int specifiedLevel = -1);
229
230 /// Deletes the content in the given range
231 virtual bool Delete(const wxRichTextRange& range);
232
233 // translate between the position (which is just an index in the text ctrl
234 // considering all its contents as a single strings) and (x, y) coordinates
235 // which represent column and line.
236 virtual long XYToPosition(long x, long y) const;
237 virtual bool PositionToXY(long pos, long *x, long *y) const;
238
239 virtual void ShowPosition(long pos);
240
241 // find the character at position given in pixels
242 //
243 // NB: pt is in device coords (not adjusted for the client area origin nor
244 // scrolling)
245 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
246 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
247 wxTextCoord *col,
248 wxTextCoord *row) const;
249
250 // Clipboard operations
251 virtual void Copy();
252 virtual void Cut();
253 virtual void Paste();
254 virtual void DeleteSelection();
255
256 virtual bool CanCopy() const;
257 virtual bool CanCut() const;
258 virtual bool CanPaste() const;
259 virtual bool CanDeleteSelection() const;
260
261 // Undo/redo
262 virtual void Undo();
263 virtual void Redo();
264
265 virtual bool CanUndo() const;
266 virtual bool CanRedo() const;
267
268 // Insertion point
269 virtual void SetInsertionPoint(long pos);
270 virtual void SetInsertionPointEnd();
271 virtual long GetInsertionPoint() const;
272 virtual wxTextPos GetLastPosition() const;
273
274 virtual void SetSelection(long from, long to);
275 virtual void SelectAll();
276 virtual void SetEditable(bool editable);
277
278 virtual bool HasSelection() const;
279
280///// Functionality specific to wxRichTextCtrl
281
282 /// Write an image at the current insertion point. Supply optional type to use
283 /// for internal and file storage of the raw data.
284 virtual bool WriteImage(const wxImage& image, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG);
285
286 /// Write a bitmap at the current insertion point. Supply optional type to use
287 /// for internal and file storage of the raw data.
288 virtual bool WriteImage(const wxBitmap& bitmap, wxBitmapType bitmapType = wxBITMAP_TYPE_PNG);
289
290 /// Load an image from file and write at the current insertion point.
291 virtual bool WriteImage(const wxString& filename, wxBitmapType bitmapType);
292
293 /// Write an image block at the current insertion point.
294 virtual bool WriteImage(const wxRichTextImageBlock& imageBlock);
295
296 /// Insert a newline (actually paragraph) at the current insertion point.
297 virtual bool Newline();
298
299 /// Insert a line break at the current insertion point.
300 virtual bool LineBreak();
301
302 /// Set basic (overall) style
303 virtual void SetBasicStyle(const wxTextAttr& style) { GetBuffer().SetBasicStyle(style); }
304
305 /// Get basic (overall) style
306 virtual const wxTextAttr& GetBasicStyle() const { return GetBuffer().GetBasicStyle(); }
307
308 virtual bool BeginStyle(const wxTextAttr& style) { return GetBuffer().BeginStyle(style); }
309
310 /// End the style
311 virtual bool EndStyle() { return GetBuffer().EndStyle(); }
312
313 /// End all styles
314 virtual bool EndAllStyles() { return GetBuffer().EndAllStyles(); }
315
316 /// Begin using bold
317 bool BeginBold() { return GetBuffer().BeginBold(); }
318
319 /// End using bold
320 bool EndBold() { return GetBuffer().EndBold(); }
321
322 /// Begin using italic
323 bool BeginItalic() { return GetBuffer().BeginItalic(); }
324
325 /// End using italic
326 bool EndItalic() { return GetBuffer().EndItalic(); }
327
328 /// Begin using underline
329 bool BeginUnderline() { return GetBuffer().BeginUnderline(); }
330
331 /// End using underline
332 bool EndUnderline() { return GetBuffer().EndUnderline(); }
333
334 /// Begin using point size
335 bool BeginFontSize(int pointSize) { return GetBuffer().BeginFontSize(pointSize); }
336
337 /// End using point size
338 bool EndFontSize() { return GetBuffer().EndFontSize(); }
339
340 /// Begin using this font
341 bool BeginFont(const wxFont& font) { return GetBuffer().BeginFont(font); }
342
343 /// End using a font
344 bool EndFont() { return GetBuffer().EndFont(); }
345
346 /// Begin using this colour
347 bool BeginTextColour(const wxColour& colour) { return GetBuffer().BeginTextColour(colour); }
348
349 /// End using a colour
350 bool EndTextColour() { return GetBuffer().EndTextColour(); }
351
352 /// Begin using alignment
353 bool BeginAlignment(wxTextAttrAlignment alignment) { return GetBuffer().BeginAlignment(alignment); }
354
355 /// End alignment
356 bool EndAlignment() { return GetBuffer().EndAlignment(); }
357
358 /// Begin left indent
359 bool BeginLeftIndent(int leftIndent, int leftSubIndent = 0) { return GetBuffer().BeginLeftIndent(leftIndent, leftSubIndent); }
360
361 /// End left indent
362 bool EndLeftIndent() { return GetBuffer().EndLeftIndent(); }
363
364 /// Begin right indent
365 bool BeginRightIndent(int rightIndent) { return GetBuffer().BeginRightIndent(rightIndent); }
366
367 /// End right indent
368 bool EndRightIndent() { return GetBuffer().EndRightIndent(); }
369
370 /// Begin paragraph spacing
371 bool BeginParagraphSpacing(int before, int after) { return GetBuffer().BeginParagraphSpacing(before, after); }
372
373 /// End paragraph spacing
374 bool EndParagraphSpacing() { return GetBuffer().EndParagraphSpacing(); }
375
376 /// Begin line spacing
377 bool BeginLineSpacing(int lineSpacing) { return GetBuffer().BeginLineSpacing(lineSpacing); }
378
379 /// End line spacing
380 bool EndLineSpacing() { return GetBuffer().EndLineSpacing(); }
381
382 /// Begin numbered bullet
383 bool BeginNumberedBullet(int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD)
384 { return GetBuffer().BeginNumberedBullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle); }
385
386 /// End numbered bullet
387 bool EndNumberedBullet() { return GetBuffer().EndNumberedBullet(); }
388
389 /// Begin symbol bullet
390 bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL)
391 { return GetBuffer().BeginSymbolBullet(symbol, leftIndent, leftSubIndent, bulletStyle); }
392
393 /// End symbol bullet
394 bool EndSymbolBullet() { return GetBuffer().EndSymbolBullet(); }
395
396 /// Begin standard bullet
397 bool BeginStandardBullet(const wxString& bulletName, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_STANDARD)
398 { return GetBuffer().BeginStandardBullet(bulletName, leftIndent, leftSubIndent, bulletStyle); }
399
400 /// End standard bullet
401 bool EndStandardBullet() { return GetBuffer().EndStandardBullet(); }
402
403 /// Begin named character style
404 bool BeginCharacterStyle(const wxString& characterStyle) { return GetBuffer().BeginCharacterStyle(characterStyle); }
405
406 /// End named character style
407 bool EndCharacterStyle() { return GetBuffer().EndCharacterStyle(); }
408
409 /// Begin named paragraph style
410 bool BeginParagraphStyle(const wxString& paragraphStyle) { return GetBuffer().BeginParagraphStyle(paragraphStyle); }
411
412 /// End named character style
413 bool EndParagraphStyle() { return GetBuffer().EndParagraphStyle(); }
414
415 /// Begin named list style
416 bool BeginListStyle(const wxString& listStyle, int level = 1, int number = 1) { return GetBuffer().BeginListStyle(listStyle, level, number); }
417
418 /// End named character style
419 bool EndListStyle() { return GetBuffer().EndListStyle(); }
420
421 /// Begin URL
422 bool BeginURL(const wxString& url, const wxString& characterStyle = wxEmptyString) { return GetBuffer().BeginURL(url, characterStyle); }
423
424 /// End URL
425 bool EndURL() { return GetBuffer().EndURL(); }
426
427 /// Sets the default style to the style under the cursor
428 bool SetDefaultStyleToCursorStyle();
429
430 /// Clear the selection
431 virtual void SelectNone();
432
433 /// Select the word at the given character position
434 virtual bool SelectWord(long position);
435
436 /// Get/set the selection range in character positions. -1, -1 means no selection.
437 /// The range is in API convention, i.e. a single character selection is denoted
438 /// by (n, n+1)
439 wxRichTextRange GetSelectionRange() const;
440 void SetSelectionRange(const wxRichTextRange& range);
441
442 /// Get/set the selection range in character positions. -1, -1 means no selection.
443 /// The range is in internal format, i.e. a single character selection is denoted
444 /// by (n, n)
445 const wxRichTextRange& GetInternalSelectionRange() const { return m_selectionRange; }
446 void SetInternalSelectionRange(const wxRichTextRange& range) { m_selectionRange = range; }
447
448 /// Add a new paragraph of text to the end of the buffer
449 virtual wxRichTextRange AddParagraph(const wxString& text);
450
451 /// Add an image
452 virtual wxRichTextRange AddImage(const wxImage& image);
453
454 /// Layout the buffer: which we must do before certain operations, such as
455 /// setting the caret position.
456 virtual bool LayoutContent(bool onlyVisibleRect = false);
457
458 /// Move the caret to the given character position
459 virtual bool MoveCaret(long pos, bool showAtLineStart = false);
460
461 /// Move right
462 virtual bool MoveRight(int noPositions = 1, int flags = 0);
463
464 /// Move left
465 virtual bool MoveLeft(int noPositions = 1, int flags = 0);
466
467 /// Move up
468 virtual bool MoveUp(int noLines = 1, int flags = 0);
469
470 /// Move up
471 virtual bool MoveDown(int noLines = 1, int flags = 0);
472
473 /// Move to the end of the line
474 virtual bool MoveToLineEnd(int flags = 0);
475
476 /// Move to the start of the line
477 virtual bool MoveToLineStart(int flags = 0);
478
479 /// Move to the end of the paragraph
480 virtual bool MoveToParagraphEnd(int flags = 0);
481
482 /// Move to the start of the paragraph
483 virtual bool MoveToParagraphStart(int flags = 0);
484
485 /// Move to the start of the buffer
486 virtual bool MoveHome(int flags = 0);
487
488 /// Move to the end of the buffer
489 virtual bool MoveEnd(int flags = 0);
490
491 /// Move n pages up
492 virtual bool PageUp(int noPages = 1, int flags = 0);
493
494 /// Move n pages down
495 virtual bool PageDown(int noPages = 1, int flags = 0);
496
497 /// Move n words left
498 virtual bool WordLeft(int noPages = 1, int flags = 0);
499
500 /// Move n words right
501 virtual bool WordRight(int noPages = 1, int flags = 0);
502
503 /// Returns the buffer associated with the control.
504 wxRichTextBuffer& GetBuffer() { return m_buffer; }
505 const wxRichTextBuffer& GetBuffer() const { return m_buffer; }
506
507 /// Start batching undo history for commands.
508 virtual bool BeginBatchUndo(const wxString& cmdName) { return m_buffer.BeginBatchUndo(cmdName); }
509
510 /// End batching undo history for commands.
511 virtual bool EndBatchUndo() { return m_buffer.EndBatchUndo(); }
512
513 /// Are we batching undo history for commands?
514 virtual bool BatchingUndo() const { return m_buffer.BatchingUndo(); }
515
516 /// Start suppressing undo history for commands.
517 virtual bool BeginSuppressUndo() { return m_buffer.BeginSuppressUndo(); }
518
519 /// End suppressing undo history for commands.
520 virtual bool EndSuppressUndo() { return m_buffer.EndSuppressUndo(); }
521
522 /// Are we suppressing undo history for commands?
523 virtual bool SuppressingUndo() const { return m_buffer.SuppressingUndo(); }
524
525 /// Test if this whole range has character attributes of the specified kind. If any
526 /// of the attributes are different within the range, the test fails. You
527 /// can use this to implement, for example, bold button updating. style must have
528 /// flags indicating which attributes are of interest.
529 virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxTextAttr& style) const
530 {
531 return GetBuffer().HasCharacterAttributes(range.ToInternal(), style);
532 }
533
534 /// Test if this whole range has paragraph attributes of the specified kind. If any
535 /// of the attributes are different within the range, the test fails. You
536 /// can use this to implement, for example, centering button updating. style must have
537 /// flags indicating which attributes are of interest.
538 virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxTextAttr& style) const
539 {
540 return GetBuffer().HasParagraphAttributes(range.ToInternal(), style);
541 }
542
543 /// Is all of the selection bold?
544 virtual bool IsSelectionBold();
545
546 /// Is all of the selection italics?
547 virtual bool IsSelectionItalics();
548
549 /// Is all of the selection underlined?
550 virtual bool IsSelectionUnderlined();
551
552 /// Is all of the selection aligned according to the specified flag?
553 virtual bool IsSelectionAligned(wxTextAttrAlignment alignment);
554
555 /// Apply bold to the selection
556 virtual bool ApplyBoldToSelection();
557
558 /// Apply italic to the selection
559 virtual bool ApplyItalicToSelection();
560
561 /// Apply underline to the selection
562 virtual bool ApplyUnderlineToSelection();
563
564 /// Apply alignment to the selection
565 virtual bool ApplyAlignmentToSelection(wxTextAttrAlignment alignment);
566
567 /// Apply a named style to the selection
568 virtual bool ApplyStyle(wxRichTextStyleDefinition* def);
569
570 /// Set style sheet, if any
571 void SetStyleSheet(wxRichTextStyleSheet* styleSheet) { GetBuffer().SetStyleSheet(styleSheet); }
572 wxRichTextStyleSheet* GetStyleSheet() const { return GetBuffer().GetStyleSheet(); }
573
574 /// Push style sheet to top of stack
575 bool PushStyleSheet(wxRichTextStyleSheet* styleSheet) { return GetBuffer().PushStyleSheet(styleSheet); }
576
577 /// Pop style sheet from top of stack
578 wxRichTextStyleSheet* PopStyleSheet() { return GetBuffer().PopStyleSheet(); }
579
580 /// Apply the style sheet to the buffer, for example if the styles have changed.
581 bool ApplyStyleSheet(wxRichTextStyleSheet* styleSheet = NULL);
582
583// Command handlers
584
585 void Command(wxCommandEvent& event);
586 void OnDropFiles(wxDropFilesEvent& event);
587 void OnCaptureLost(wxMouseCaptureLostEvent& event);
588 void OnSysColourChanged(wxSysColourChangedEvent& event);
589
590 void OnCut(wxCommandEvent& event);
591 void OnCopy(wxCommandEvent& event);
592 void OnPaste(wxCommandEvent& event);
593 void OnUndo(wxCommandEvent& event);
594 void OnRedo(wxCommandEvent& event);
595 void OnSelectAll(wxCommandEvent& event);
596 void OnClear(wxCommandEvent& event);
597
598 void OnUpdateCut(wxUpdateUIEvent& event);
599 void OnUpdateCopy(wxUpdateUIEvent& event);
600 void OnUpdatePaste(wxUpdateUIEvent& event);
601 void OnUpdateUndo(wxUpdateUIEvent& event);
602 void OnUpdateRedo(wxUpdateUIEvent& event);
603 void OnUpdateSelectAll(wxUpdateUIEvent& event);
604 void OnUpdateClear(wxUpdateUIEvent& event);
605
606 // Show a context menu for Rich Edit controls (the standard
607 // EDIT control has one already)
608 void OnContextMenu(wxContextMenuEvent& event);
609
610// Event handlers
611
612 /// Painting
613 void OnPaint(wxPaintEvent& event);
614 void OnEraseBackground(wxEraseEvent& event);
615
616 /// Left-click
617 void OnLeftClick(wxMouseEvent& event);
618
619 /// Left-up
620 void OnLeftUp(wxMouseEvent& event);
621
622 /// Motion
623 void OnMoveMouse(wxMouseEvent& event);
624
625 /// Left-double-click
626 void OnLeftDClick(wxMouseEvent& event);
627
628 /// Middle-click
629 void OnMiddleClick(wxMouseEvent& event);
630
631 /// Right-click
632 void OnRightClick(wxMouseEvent& event);
633
634 /// Key press
635 void OnChar(wxKeyEvent& event);
636
637 /// Sizing
638 void OnSize(wxSizeEvent& event);
639
640 /// Setting/losing focus
641 void OnSetFocus(wxFocusEvent& event);
642 void OnKillFocus(wxFocusEvent& event);
643
644 /// Idle-time processing
645 void OnIdle(wxIdleEvent& event);
646
647 /// Scrolling
648 void OnScroll(wxScrollWinEvent& event);
649
650 /// Set font, and also default attributes
651 virtual bool SetFont(const wxFont& font);
652
653 /// Set up scrollbars, e.g. after a resize
654 virtual void SetupScrollbars(bool atTop = false);
655
656 /// Keyboard navigation
657 virtual bool KeyboardNavigate(int keyCode, int flags);
658
659 /// Paint the background
660 virtual void PaintBackground(wxDC& dc);
661
662#if wxRICHTEXT_BUFFERED_PAINTING
663 /// Recreate buffer bitmap if necessary
664 virtual bool RecreateBuffer(const wxSize& size = wxDefaultSize);
665#endif
666
667 /// Write text
668 virtual void DoWriteText(const wxString& value, int flags = 0);
669
670 /// Should we inherit colours?
671 virtual bool ShouldInheritColours() const { return false; }
672
673 /// Position the caret
674 virtual void PositionCaret();
675
676 /// Extend the selection, returning true if the selection was
677 /// changed. Selections are in caret positions.
678 virtual bool ExtendSelection(long oldPosition, long newPosition, int flags);
679
680 /// Scroll into view. This takes a _caret_ position.
681 virtual bool ScrollIntoView(long position, int keyCode);
682
683 /// Refresh the area affected by a selection change
684 bool RefreshForSelectionChange(const wxRichTextRange& oldSelection, const wxRichTextRange& newSelection);
685
686 /// The caret position is the character position just before the caret.
687 /// A value of -1 means the caret is at the start of the buffer.
688 void SetCaretPosition(long position, bool showAtLineStart = false) ;
689 long GetCaretPosition() const { return m_caretPosition; }
690
691 /// The adjusted caret position is the character position adjusted to take
692 /// into account whether we're at the start of a paragraph, in which case
693 /// style information should be taken from the next position, not current one.
694 long GetAdjustedCaretPosition(long caretPos) const;
695
696 /// Move caret one visual step forward: this may mean setting a flag
697 /// and keeping the same position if we're going from the end of one line
698 /// to the start of the next, which may be the exact same caret position.
699 void MoveCaretForward(long oldPosition) ;
700
701 /// Move caret one visual step forward: this may mean setting a flag
702 /// and keeping the same position if we're going from the end of one line
703 /// to the start of the next, which may be the exact same caret position.
704 void MoveCaretBack(long oldPosition) ;
705
706 /// Get the caret height and position for the given character position
707 bool GetCaretPositionForIndex(long position, wxRect& rect);
708
709 /// Gets the line for the visible caret position. If the caret is
710 /// shown at the very end of the line, it means the next character is actually
711 /// on the following line. So let's get the line we're expecting to find
712 /// if this is the case.
713 wxRichTextLine* GetVisibleLineForCaretPosition(long caretPosition) const;
714
715 /// Gets the command processor
716 wxCommandProcessor* GetCommandProcessor() const { return GetBuffer().GetCommandProcessor(); }
717
718 /// Delete content if there is a selection, e.g. when pressing a key.
719 /// Returns the new caret position in newPos, or leaves it if there
720 /// was no action.
721 bool DeleteSelectedContent(long* newPos= NULL);
722
723 /// Transform logical to physical
724 wxPoint GetPhysicalPoint(const wxPoint& ptLogical) const;
725
726 /// Transform physical to logical
727 wxPoint GetLogicalPoint(const wxPoint& ptPhysical) const;
728
729 /// Finds the caret position for the next word. Direction
730 /// is 1 (forward) or -1 (backwards).
731 virtual long FindNextWordPosition(int direction = 1) const;
732
733 /// Is the given position visible on the screen?
734 bool IsPositionVisible(long pos) const;
735
736 /// Returns the first visible position in the current view
737 long GetFirstVisiblePosition() const;
738
739 /// Returns the caret position since the default formatting was changed. As
740 /// soon as this position changes, we no longer reflect the default style
741 /// in the UI. A value of -2 means that we should only reflect the style of the
742 /// content under the caret.
743 long GetCaretPositionForDefaultStyle() const { return m_caretPositionForDefaultStyle; }
744
745 /// Set the caret position for the default style that the user is selecting.
746 void SetCaretPositionForDefaultStyle(long pos) { m_caretPositionForDefaultStyle = pos; }
747
748 /// Should the UI reflect the default style chosen by the user, rather than the style under
749 /// the caret?
750 bool IsDefaultStyleShowing() const { return m_caretPositionForDefaultStyle != -2; }
751
752 /// Convenience function that tells the control to start reflecting the default
753 /// style, since the user is changing it.
754 void SetAndShowDefaultStyle(const wxTextAttr& attr)
755 {
756 SetDefaultStyle(attr);
757 SetCaretPositionForDefaultStyle(GetCaretPosition());
758 }
759
760 /// Get the first visible point in the window
761 wxPoint GetFirstVisiblePoint() const;
762
763// Implementation
764
765 /// Font names take a long time to retrieve, so cache them (on demand)
766 static const wxArrayString& GetAvailableFontNames();
767 static void ClearAvailableFontNames();
768
769 WX_FORWARD_TO_SCROLL_HELPER()
770
771 // implement wxTextEntry methods
772 virtual wxString DoGetValue() const;
773
774protected:
775 // FIXME: this does not work, it allows this code to compile but will fail
776 // during run-time
777#ifdef __WXMSW__
778 virtual WXHWND GetEditHWND() const { return GetHWND(); }
779#endif
780#ifdef __WXMOTIF__
781 virtual WXWidget GetTextWidget() const { return NULL; }
782#endif
783#ifdef __WXGTK20__
784 virtual wxWindow *GetEditableWindow() { return this; }
785 virtual GtkEditable *GetEditable() const { return NULL; }
786#endif
787
788// Overrides
789protected:
790
791 virtual wxSize DoGetBestSize() const ;
792
793 virtual void DoSetValue(const wxString& value, int flags = 0);
794
795 virtual void DoThaw();
796
797
798// Data members
799private:
800#if wxRICHTEXT_BUFFERED_PAINTING
801 /// Buffer bitmap
802 wxBitmap m_bufferBitmap;
803#endif
804
805 /// Text buffer
806 wxRichTextBuffer m_buffer;
807
808 wxMenu* m_contextMenu;
809
810 /// Caret position (1 less than the character position, so -1 is the
811 /// first caret position).
812 long m_caretPosition;
813
814 /// Caret position when the default formatting has been changed. As
815 /// soon as this position changes, we no longer reflect the default style
816 /// in the UI.
817 long m_caretPositionForDefaultStyle;
818
819 /// Selection range in character positions. -2, -2 means no selection.
820 wxRichTextRange m_selectionRange;
821
822 /// Anchor so we know how to extend the selection
823 /// It's a caret position since it's between two characters.
824 long m_selectionAnchor;
825
826 /// Are we editable?
827 bool m_editable;
828
829 /// Are we showing the caret position at the start of a line
830 /// instead of at the end of the previous one?
831 bool m_caretAtLineStart;
832
833 /// Are we dragging a selection?
834 bool m_dragging;
835
836 /// Start position for drag
837 wxPoint m_dragStart;
838
839 /// Do we need full layout in idle?
840 bool m_fullLayoutRequired;
841 wxLongLong m_fullLayoutTime;
842 long m_fullLayoutSavedPosition;
843
844 /// Threshold for doing delayed layout
845 long m_delayedLayoutThreshold;
846
847 /// Cursors
848 wxCursor m_textCursor;
849 wxCursor m_urlCursor;
850
851 static wxArrayString sm_availableFontNames;
852};
853
854/*!
855 * wxRichTextEvent - the event class for wxRichTextCtrl notifications
856 */
857
858class WXDLLIMPEXP_RICHTEXT wxRichTextEvent : public wxNotifyEvent
859{
860public:
861 wxRichTextEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
862 : wxNotifyEvent(commandType, winid),
863 m_flags(0), m_position(-1), m_oldStyleSheet(NULL), m_newStyleSheet(NULL),
864 m_char((wxChar) 0)
865 { }
866
867 wxRichTextEvent(const wxRichTextEvent& event)
868 : wxNotifyEvent(event),
869 m_flags(event.m_flags), m_position(-1),
870 m_oldStyleSheet(event.m_oldStyleSheet), m_newStyleSheet(event.m_newStyleSheet),
871 m_char((wxChar) 0)
872 { }
873
874 long GetPosition() const { return m_position; }
875 void SetPosition(long pos) { m_position = pos; }
876
877 int GetFlags() const { return m_flags; }
878 void SetFlags(int flags) { m_flags = flags; }
879
880 wxRichTextStyleSheet* GetOldStyleSheet() const { return m_oldStyleSheet; }
881 void SetOldStyleSheet(wxRichTextStyleSheet* sheet) { m_oldStyleSheet = sheet; }
882
883 wxRichTextStyleSheet* GetNewStyleSheet() const { return m_newStyleSheet; }
884 void SetNewStyleSheet(wxRichTextStyleSheet* sheet) { m_newStyleSheet = sheet; }
885
886 const wxRichTextRange& GetRange() const { return m_range; }
887 void SetRange(const wxRichTextRange& range) { m_range = range; }
888
889 wxChar GetCharacter() const { return m_char; }
890 void SetCharacter(wxChar ch) { m_char = ch; }
891
892 virtual wxEvent *Clone() const { return new wxRichTextEvent(*this); }
893
894protected:
895 int m_flags;
896 long m_position;
897 wxRichTextStyleSheet* m_oldStyleSheet;
898 wxRichTextStyleSheet* m_newStyleSheet;
899 wxRichTextRange m_range;
900 wxChar m_char;
901
902private:
903 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRichTextEvent)
904};
905
906/*!
907 * wxRichTextCtrl events
908 */
909wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, wxRichTextEvent );
910wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, wxRichTextEvent );
911wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, wxRichTextEvent );
912wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, wxRichTextEvent );
913wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_RETURN, wxRichTextEvent );
914wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CHARACTER, wxRichTextEvent );
915wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_DELETE, wxRichTextEvent );
916
917wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING, wxRichTextEvent );
918wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED, wxRichTextEvent );
919wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING, wxRichTextEvent );
920wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED, wxRichTextEvent );
921
922wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, wxRichTextEvent );
923wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, wxRichTextEvent );
924wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, wxRichTextEvent );
925wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, wxRichTextEvent );
926wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_RICHTEXT, wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, wxRichTextEvent );
927
928typedef void (wxEvtHandler::*wxRichTextEventFunction)(wxRichTextEvent&);
929
930#define wxRichTextEventHandler(func) \
931 wxEVENT_HANDLER_CAST(wxRichTextEventFunction, func)
932
933#define EVT_RICHTEXT_LEFT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
934#define EVT_RICHTEXT_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RIGHT_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
935#define EVT_RICHTEXT_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_MIDDLE_CLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
936#define EVT_RICHTEXT_LEFT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_LEFT_DCLICK, id, -1, wxRichTextEventHandler( fn ), NULL ),
937#define EVT_RICHTEXT_RETURN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_RETURN, id, -1, wxRichTextEventHandler( fn ), NULL ),
938#define EVT_RICHTEXT_CHARACTER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CHARACTER, id, -1, wxRichTextEventHandler( fn ), NULL ),
939#define EVT_RICHTEXT_DELETE(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_DELETE, id, -1, wxRichTextEventHandler( fn ), NULL ),
940
941#define EVT_RICHTEXT_STYLESHEET_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGING, id, -1, wxRichTextEventHandler( fn ), NULL ),
942#define EVT_RICHTEXT_STYLESHEET_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
943#define EVT_RICHTEXT_STYLESHEET_REPLACING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACING, id, -1, wxRichTextEventHandler( fn ), NULL ),
944#define EVT_RICHTEXT_STYLESHEET_REPLACED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLESHEET_REPLACED, id, -1, wxRichTextEventHandler( fn ), NULL ),
945
946#define EVT_RICHTEXT_CONTENT_INSERTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_INSERTED, id, -1, wxRichTextEventHandler( fn ), NULL ),
947#define EVT_RICHTEXT_CONTENT_DELETED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_CONTENT_DELETED, id, -1, wxRichTextEventHandler( fn ), NULL ),
948#define EVT_RICHTEXT_STYLE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_STYLE_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
949#define EVT_RICHTEXT_SELECTION_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_SELECTION_CHANGED, id, -1, wxRichTextEventHandler( fn ), NULL ),
950#define EVT_RICHTEXT_BUFFER_RESET(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_RICHTEXT_BUFFER_RESET, id, -1, wxRichTextEventHandler( fn ), NULL ),
951
952#endif
953 // wxUSE_RICHTEXT
954
955#endif
956 // _WX_RICHTEXTCTRL_H_