]> git.saurik.com Git - wxWidgets.git/blob - src/univ/textctrl.cpp
reverted wxMGL-specific code (didn't mean to commit this...)
[wxWidgets.git] / src / univ / textctrl.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: univ/textctrl.cpp
3 // Purpose: wxTextCtrl
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 15.09.00
7 // RCS-ID: $Id$
8 // Copyright: (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 /*
13 TODO
14
15 + 1. update vert scrollbar when any line length changes for WrapLines()
16 + 2. cursor movement ("Hello,^" -> "^verse!" on Arrow Down)?
17 -> maybe save the x position and use it instead of current in handling
18 DOWN/UP actions (this would make up/down always return the cursor to
19 the same location)?
20 3. split file into chunks
21 +? 4. rewrite Replace() refresh logic to deal with wrapping lines
22 +? 5. cache info found by GetPartOfWrappedLine() - performance must be horrible
23 with lots of text
24
25 6. backspace refreshes too much (until end of line)
26 */
27
28 /*
29 Optimisation hints from PureQuantify:
30
31 +1. wxStringTokenize is the slowest part of Replace
32 2. GetDC/ReleaseDC are very slow, avoid calling them several times
33 +3. GetCharHeight() should be cached too
34 4. wxClientDC construction/destruction in HitTestLine is horribly expensive
35
36 For line wrapping controls HitTest2 takes 50% of program time. The results
37 of GetRowsPerLine and GetPartOfWrappedLine *MUST* be cached.
38
39 Search for "OPT!" for things which must be optimized.
40 */
41
42 /*
43 Some terminology:
44
45 Everywhere in this file LINE refers to a logical line of text, and ROW to a
46 physical line of text on the display. They are the same unless WrapLines()
47 is TRUE in which case a single LINE may correspond to multiple ROWs.
48
49 A text position is an unsigned int (which for reasons of compatibility is
50 still a long) from 0 to GetLastPosition() inclusive. The positions
51 correspond to the gaps between the letters so the position 0 is just
52 before the first character and the last position is the one beyond the last
53 character. For an empty text control GetLastPosition() returns 0.
54
55 Lines and columns returned/accepted by XYToPosition() and PositionToXY()
56 start from 0. The y coordinate is a LINE, not a ROW. Columns correspond to
57 the characters, the first column of a line is the first character in it,
58 the last one is length(line text). For compatibility, again, lines and
59 columns are also longs.
60
61 When translating lines/column coordinates to/from positions, the line and
62 column give the character after the given position. Thus, GetLastPosition()
63 doesn't have any corresponding column.
64
65 An example of positions and lines/columns for a control without wrapping
66 containing the text "Hello, Universe!\nGoodbye"
67
68 1 1 1 1 1 1 1
69 pos: 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
70 H e l l o , U n i v e r s e ! line 0
71 col: 0 1 2 3 4 5 6 7 8 9 1 1 1 1 1 1
72 0 1 2 3 4 5
73
74 pos: 1 1 1 2 2 2 2 2
75 7 8 9 0 1 2 3 4
76 G o o d b y e line 1
77 col: 0 1 2 3 4 5 6
78
79
80 The same example for a control with line wrap assuming "Universe" is too
81 long to fit on the same line with "Hello,":
82
83 pos: 0 1 2 3 4 5
84 H e l l o , line 0 (row 0)
85 col: 0 1 2 3 4 5
86
87 1 1 1 1 1 1 1
88 pos: 6 7 8 9 0 1 2 3 4 5 6
89 U n i v e r s e ! line 0 (row 1)
90 col: 6 7 8 9 1 1 1 1 1 1
91 0 1 2 3 4 5
92
93 (line 1 == row 2 same as above)
94
95 Note that there is still the same number of columns and positions and that
96 there is no (logical) position at the end of the first ROW. This position
97 is identified with the preceding one (which is not how Windows does it: it
98 identifies it with the next one, i.e. the first position of the next line,
99 but much more logical IMHO).
100 */
101
102 /*
103 Search for "OPT" for possible optimizations
104
105 A possible global optimization would be to always store the coords in the
106 text in triplets (pos, col, line) and update them simultaneously instead of
107 recalculating col and line from pos each time it is needed. Currently we
108 only do it for the current position but we might also do it for the
109 selection start and end.
110 */
111
112 // ============================================================================
113 // declarations
114 // ============================================================================
115
116 // ----------------------------------------------------------------------------
117 // headers
118 // ----------------------------------------------------------------------------
119
120 #ifdef __GNUG__
121 #pragma implementation "univtextctrl.h"
122 #endif
123
124 #include "wx/wxprec.h"
125
126 #ifdef __BORLANDC__
127 #pragma hdrstop
128 #endif
129
130 #if wxUSE_TEXTCTRL
131
132 #ifndef WX_PRECOMP
133 #include "wx/log.h"
134
135 #include "wx/dcclient.h"
136 #include "wx/validate.h"
137 #include "wx/textctrl.h"
138 #endif
139
140 #include "wx/clipbrd.h"
141
142 #include "wx/textfile.h"
143
144 #include "wx/caret.h"
145
146 #include "wx/univ/inphand.h"
147 #include "wx/univ/renderer.h"
148 #include "wx/univ/colschem.h"
149 #include "wx/univ/theme.h"
150
151 #include "wx/cmdproc.h"
152
153 #if wxUSE_CLIPBOARD
154 #include "wx/dataobj.h"
155 #endif
156
157 // turn extra wxTextCtrl-specific debugging on/off
158 #define WXDEBUG_TEXT
159
160 // turn wxTextCtrl::Replace() debugging on (slows down code a *lot*!)
161 #define WXDEBUG_TEXT_REPLACE
162
163 #ifndef __WXDEBUG__
164 #undef WXDEBUG_TEXT
165 #undef WXDEBUG_TEXT_REPLACE
166 #endif
167
168 // wxStringTokenize only needed for debug checks
169 #ifdef WXDEBUG_TEXT_REPLACE
170 #include "wx/tokenzr.h"
171 #endif // WXDEBUG_TEXT_REPLACE
172
173 // ----------------------------------------------------------------------------
174 // private functions
175 // ----------------------------------------------------------------------------
176
177 // exchange two positions so that from is always less than or equal to to
178 static inline void OrderPositions(wxTextPos& from, wxTextPos& to)
179 {
180 if ( from > to )
181 {
182 wxTextPos tmp = from;
183 from = to;
184 to = tmp;
185 }
186 }
187
188 // ----------------------------------------------------------------------------
189 // constants
190 // ----------------------------------------------------------------------------
191
192 // names of text ctrl commands
193 #define wxTEXT_COMMAND_INSERT _T("insert")
194 #define wxTEXT_COMMAND_REMOVE _T("remove")
195
196 // the value which is never used for text position, even not -1 which is
197 // sometimes used for some special meaning
198 static const wxTextPos INVALID_POS_VALUE = -2;
199
200 // overlap between pages (when using PageUp/Dn) in lines
201 static const size_t PAGE_OVERLAP_IN_LINES = 1;
202
203 // ----------------------------------------------------------------------------
204 // private data of wxTextCtrl
205 // ----------------------------------------------------------------------------
206
207 // the data only used by single line text controls
208 struct WXDLLEXPORT wxTextSingleLineData
209 {
210 // the position of the first visible pixel and the first visible column
211 wxCoord m_ofsHorz;
212 wxTextCoord m_colStart;
213
214 // and the last ones (m_posLastVisible is the width but m_colLastVisible
215 // is an absolute value)
216 wxCoord m_posLastVisible;
217 wxTextCoord m_colLastVisible;
218
219 // def ctor
220 wxTextSingleLineData()
221 {
222 m_colStart = 0;
223 m_ofsHorz = 0;
224
225 m_colLastVisible = -1;
226 m_posLastVisible = -1;
227 }
228
229 };
230
231 // the data only used by multi line text controls
232 struct WXDLLEXPORT wxTextMultiLineData
233 {
234 // the lines of text
235 wxArrayString m_lines;
236
237 // the current ranges of the scrollbars
238 int m_scrollRangeX,
239 m_scrollRangeY;
240
241 // should we adjust the horz/vert scrollbar?
242 bool m_updateScrollbarX,
243 m_updateScrollbarY;
244
245 // the max line length in pixels
246 wxCoord m_widthMax;
247
248 // the index of the line which has the length of m_widthMax
249 wxTextCoord m_lineLongest;
250
251 // the rect in which text appears: it is even less than m_rectText because
252 // only the last _complete_ line is shown, hence there is an unoccupied
253 // horizontal band at the bottom of it
254 wxRect m_rectTextReal;
255
256 // the x-coordinate of the caret before we started moving it vertically:
257 // this is used to ensure that moving the caret up and then down will
258 // return it to the same position as if we always round it in one direction
259 // we would shift it in that direction
260 //
261 // when m_xCaret == -1, we don't have any remembered position
262 wxCoord m_xCaret;
263
264 // the def ctor
265 wxTextMultiLineData()
266 {
267 m_scrollRangeX =
268 m_scrollRangeY = 0;
269
270 m_updateScrollbarX =
271 m_updateScrollbarY = FALSE;
272
273 m_widthMax = -1;
274 m_lineLongest = 0;
275
276 m_xCaret = -1;
277 }
278 };
279
280 // the data only used by multi line text controls in line wrap mode
281 class WXDLLEXPORT wxWrappedLineData
282 {
283 // these functions set all our values, so give them access to them
284 friend void wxTextCtrl::LayoutLine(wxTextCoord line,
285 wxWrappedLineData& lineData) const;
286 friend void wxTextCtrl::LayoutLines(wxTextCoord) const;
287
288 public:
289 // def ctor
290 wxWrappedLineData()
291 {
292 m_rowFirst = -1;
293 }
294
295 // get the start of any row (remember that accessing m_rowsStart doesn't work
296 // for the first one)
297 wxTextCoord GetRowStart(wxTextCoord row) const
298 {
299 wxASSERT_MSG( IsValid(), _T("this line hadn't been laid out") );
300
301 return row ? m_rowsStart[row - 1] : 0;
302 }
303
304 // get the length of the row (using the total line length which we don't
305 // have here but need to calculate the length of the last row, so it must
306 // be given to us)
307 wxTextCoord GetRowLength(wxTextCoord row, wxTextCoord lenLine) const
308 {
309 wxASSERT_MSG( IsValid(), _T("this line hadn't been laid out") );
310
311 // note that m_rowsStart[row] is the same as GetRowStart(row + 1) (but
312 // slightly more efficient) and lenLine is the same as the start of the
313 // first row of the next line
314 return ((size_t)row == m_rowsStart.GetCount() ? lenLine : m_rowsStart[row])
315 - GetRowStart(row);
316 }
317
318 // return the width of the row in pixels
319 wxCoord GetRowWidth(wxTextCoord row) const
320 {
321 wxASSERT_MSG( IsValid(), _T("this line hadn't been laid out") );
322
323 return m_rowsWidth[row];
324 }
325
326 // return the number of rows
327 size_t GetRowCount() const
328 {
329 wxASSERT_MSG( IsValid(), _T("this line hadn't been laid out") );
330
331 return m_rowsStart.GetCount() + 1;
332 }
333
334 // return the number of additional (i.e. after the first one) rows
335 size_t GetExtraRowCount() const
336 {
337 wxASSERT_MSG( IsValid(), _T("this line hadn't been laid out") );
338
339 return m_rowsStart.GetCount();
340 }
341
342 // return the first row of this line
343 wxTextCoord GetFirstRow() const
344 {
345 wxASSERT_MSG( IsValid(), _T("this line hadn't been laid out") );
346
347 return m_rowFirst;
348 }
349
350 // return the first row of the next line
351 wxTextCoord GetNextRow() const
352 {
353 wxASSERT_MSG( IsValid(), _T("this line hadn't been laid out") );
354
355 return m_rowFirst + m_rowsStart.GetCount() + 1;
356 }
357
358 // this just provides direct access to m_rowsStart aerray for efficiency
359 wxTextCoord GetExtraRowStart(wxTextCoord row) const
360 {
361 wxASSERT_MSG( IsValid(), _T("this line hadn't been laid out") );
362
363 return m_rowsStart[row];
364 }
365
366 // this code is unused any longer
367 #if 0
368 // return TRUE if the column is in the start of the last row (hence the row
369 // it is in is not wrapped)
370 bool IsLastRow(wxTextCoord colRowStart) const
371 {
372 return colRowStart == GetRowStart(m_rowsStart.GetCount());
373 }
374
375 // return TRUE if the column is the last column of the row starting in
376 // colRowStart
377 bool IsLastColInRow(wxTextCoord colRowStart,
378 wxTextCoord colRowEnd,
379 wxTextCoord lenLine) const
380 {
381 // find the row which starts with colRowStart
382 size_t nRows = GetRowCount();
383 for ( size_t n = 0; n < nRows; n++ )
384 {
385 if ( GetRowStart(n) == colRowStart )
386 {
387 wxTextCoord colNextRowStart = n == nRows - 1
388 ? lenLine
389 : GetRowStart(n + 1);
390
391 wxASSERT_MSG( colRowEnd < colNextRowStart,
392 _T("this column is not in this row at all!") );
393
394 return colRowEnd == colNextRowStart - 1;
395 }
396 }
397
398 // caller got it wrong
399 wxFAIL_MSG( _T("this column is not in the start of the row!") );
400
401 return FALSE;
402 }
403 #endif // 0
404
405 // is this row the last one in its line?
406 bool IsLastRow(wxTextCoord row) const
407 {
408 return (size_t)row == GetExtraRowCount();
409 }
410
411 // the line is valid if it had been laid out correctly: note that just
412 // shiwting the line (because one of previous lines changed) doesn't make
413 // it invalid
414 bool IsValid() const { return !m_rowsWidth.IsEmpty(); }
415
416 // invalidating line will relayout it
417 void Invalidate() { m_rowsWidth.Empty(); }
418
419 private:
420 // for each line we remember the starting columns of all its rows after the
421 // first one (which always starts at 0), i.e. if a line is wrapped twice
422 // (== takes 3 rows) its m_rowsStart[0] may be 10 and m_rowsStart[1] == 15
423 wxArrayLong m_rowsStart;
424
425 // and the width of each row in pixels (this array starts from 0, as usual)
426 wxArrayInt m_rowsWidth;
427
428 // and also its starting row (0 for the first line, first lines'
429 // m_rowsStart.GetCount() + 1 for the second &c): it is set to -1 initially
430 // and this means that the struct hadn't yet been initialized
431 wxTextCoord m_rowFirst;
432
433 // the last modification "time"-stamp used by LayoutLines()
434 size_t m_timestamp;
435 };
436
437 WX_DECLARE_OBJARRAY(wxWrappedLineData, wxArrayWrappedLinesData);
438 #include "wx/arrimpl.cpp"
439 WX_DEFINE_OBJARRAY(wxArrayWrappedLinesData);
440
441 struct WXDLLEXPORT wxTextWrappedData : public wxTextMultiLineData
442 {
443 // the width of the column to the right of the text rect used for the
444 // indicator mark display for the wrapped lines
445 wxCoord m_widthMark;
446
447 // the data for each line
448 wxArrayWrappedLinesData m_linesData;
449
450 // flag telling us to recalculate all starting rows starting from this line
451 // (if it is -1, we don't have to recalculate anything) - it is set when
452 // the number of the rows in the middle of the control changes
453 wxTextCoord m_rowFirstInvalid;
454
455 // the current timestamp used by LayoutLines()
456 size_t m_timestamp;
457
458 // invalidate starting rows of all lines (NOT rows!) after this one
459 void InvalidateLinesBelow(wxTextCoord line)
460 {
461 if ( m_rowFirstInvalid == -1 || m_rowFirstInvalid > line )
462 {
463 m_rowFirstInvalid = line;
464 }
465 }
466
467 // check if this line is valid: i.e. before the first invalid one
468 bool IsValidLine(wxTextCoord line) const
469 {
470 return ((m_rowFirstInvalid == -1) || (line < m_rowFirstInvalid)) &&
471 m_linesData[line].IsValid();
472 }
473
474 // def ctor
475 wxTextWrappedData()
476 {
477 m_widthMark = 0;
478 m_rowFirstInvalid = -1;
479 m_timestamp = 0;
480 }
481 };
482
483 // ----------------------------------------------------------------------------
484 // private classes for undo/redo management
485 // ----------------------------------------------------------------------------
486
487 /*
488 We use custom versions of wxWindows command processor to implement undo/redo
489 as we want to avoid storing the backpointer to wxTextCtrl in wxCommand
490 itself: this is a waste of memory as all commands in the given command
491 processor always have the same associated wxTextCtrl and so it makes sense
492 to store the backpointer there.
493
494 As for the rest of the implementation, it's fairly standard: we have 2
495 command classes corresponding to adding and removing text.
496 */
497
498 // a command corresponding to a wxTextCtrl action
499 class wxTextCtrlCommand : public wxCommand
500 {
501 public:
502 wxTextCtrlCommand(const wxString& name) : wxCommand(TRUE, name) { }
503
504 // we don't use these methods as they don't make sense for us as we need a
505 // wxTextCtrl to be applied
506 virtual bool Do() { wxFAIL_MSG(_T("shouldn't be called")); return FALSE; }
507 virtual bool Undo() { wxFAIL_MSG(_T("shouldn't be called")); return FALSE; }
508
509 // instead, our command processor uses these methods
510 virtual bool Do(wxTextCtrl *text) = 0;
511 virtual bool Undo(wxTextCtrl *text) = 0;
512 };
513
514 // insert text command
515 class wxTextCtrlInsertCommand : public wxTextCtrlCommand
516 {
517 public:
518 wxTextCtrlInsertCommand(const wxString& textToInsert)
519 : wxTextCtrlCommand(wxTEXT_COMMAND_INSERT), m_text(textToInsert)
520 {
521 m_from = -1;
522 }
523
524 // combine the 2 commands together
525 void Append(wxTextCtrlInsertCommand *other);
526
527 virtual bool CanUndo() const;
528 virtual bool Do(wxTextCtrl *text);
529 virtual bool Undo(wxTextCtrl *text);
530
531 private:
532 // the text we insert
533 wxString m_text;
534
535 // the position where we inserted the text
536 wxTextPos m_from;
537 };
538
539 // remove text command
540 class wxTextCtrlRemoveCommand : public wxTextCtrlCommand
541 {
542 public:
543 wxTextCtrlRemoveCommand(wxTextPos from, wxTextPos to)
544 : wxTextCtrlCommand(wxTEXT_COMMAND_REMOVE)
545 {
546 m_from = from;
547 m_to = to;
548 }
549
550 virtual bool CanUndo() const;
551 virtual bool Do(wxTextCtrl *text);
552 virtual bool Undo(wxTextCtrl *text);
553
554 private:
555 // the range of text to delete
556 wxTextPos m_from,
557 m_to;
558
559 // the text which was deleted when this command was Do()ne
560 wxString m_textDeleted;
561 };
562
563 // a command processor for a wxTextCtrl
564 class wxTextCtrlCommandProcessor : public wxCommandProcessor
565 {
566 public:
567 wxTextCtrlCommandProcessor(wxTextCtrl *text)
568 {
569 m_compressInserts = FALSE;
570
571 m_text = text;
572 }
573
574 // override Store() to compress multiple wxTextCtrlInsertCommand into one
575 virtual void Store(wxCommand *command);
576
577 // stop compressing insert commands when this is called
578 void StopCompressing() { m_compressInserts = FALSE; }
579
580 // accessors
581 wxTextCtrl *GetTextCtrl() const { return m_text; }
582 bool IsCompressing() const { return m_compressInserts; }
583
584 protected:
585 virtual bool DoCommand(wxCommand& cmd)
586 { return ((wxTextCtrlCommand &)cmd).Do(m_text); }
587 virtual bool UndoCommand(wxCommand& cmd)
588 { return ((wxTextCtrlCommand &)cmd).Undo(m_text); }
589
590 // check if this command is a wxTextCtrlInsertCommand and return it casted
591 // to the right type if it is or NULL otherwise
592 wxTextCtrlInsertCommand *IsInsertCommand(wxCommand *cmd);
593
594 private:
595 // the control we're associated with
596 wxTextCtrl *m_text;
597
598 // if the flag is TRUE we're compressing subsequent insert commands into
599 // one so that the entire typing could be undone in one call to Undo()
600 bool m_compressInserts;
601 };
602
603 // ============================================================================
604 // implementation
605 // ============================================================================
606
607 BEGIN_EVENT_TABLE(wxTextCtrl, wxControl)
608 EVT_CHAR(wxTextCtrl::OnChar)
609
610 EVT_SIZE(wxTextCtrl::OnSize)
611
612 EVT_IDLE(wxTextCtrl::OnIdle)
613 END_EVENT_TABLE()
614
615 IMPLEMENT_DYNAMIC_CLASS(wxTextCtrl, wxControl)
616
617 // ----------------------------------------------------------------------------
618 // creation
619 // ----------------------------------------------------------------------------
620
621 void wxTextCtrl::Init()
622 {
623 m_selAnchor =
624 m_selStart =
625 m_selEnd = -1;
626
627 m_isModified = FALSE;
628 m_isEditable = TRUE;
629
630 m_posLast =
631 m_curPos =
632 m_curCol =
633 m_curRow = 0;
634
635 m_heightLine =
636 m_widthAvg = -1;
637
638 // init wxScrollHelper
639 SetWindow(this);
640
641 // init the undo manager
642 m_cmdProcessor = new wxTextCtrlCommandProcessor(this);
643
644 // no data yet
645 m_data.data = NULL;
646 }
647
648 bool wxTextCtrl::Create(wxWindow *parent,
649 wxWindowID id,
650 const wxString& value,
651 const wxPoint& pos,
652 const wxSize& size,
653 long style,
654 const wxValidator& validator,
655 const wxString &name)
656 {
657 if ( style & wxTE_MULTILINE )
658 {
659 // for compatibility with wxMSW we create the controls with vertical
660 // scrollbar always shown unless they have wxTE_RICH style (because
661 // Windows text controls always has vert scrollbar but richedit one
662 // doesn't)
663 if ( !(style & wxTE_RICH) )
664 {
665 style |= wxALWAYS_SHOW_SB;
666 }
667
668 if ( style & wxTE_WORDWRAP )
669 {
670 // wrapping words means wrapping, hence no horz scrollbar
671 style &= ~wxHSCROLL;
672 }
673
674 // TODO: support wxTE_NO_VSCROLL (?)
675
676 // create data object for normal multiline or for controls with line
677 // wrap as needed
678 if ( style & wxHSCROLL )
679 m_data.mdata = new wxTextMultiLineData;
680 else
681 m_data.wdata = new wxTextWrappedData;
682 }
683 else
684 {
685 // this doesn't make sense for single line controls
686 style &= ~wxHSCROLL;
687
688 // create data object for single line controls
689 m_data.sdata = new wxTextSingleLineData;
690 }
691
692 if ( !wxControl::Create(parent, id, pos, size, style,
693 validator, name) )
694 {
695 return FALSE;
696 }
697
698 SetCursor(wxCURSOR_IBEAM);
699
700 if ( style & wxTE_MULTILINE )
701 {
702 // we should always have at least one line in a multiline control
703 MData().m_lines.Add(wxEmptyString);
704
705 if ( !(style & wxHSCROLL) )
706 {
707 WData().m_linesData.Add(new wxWrappedLineData);
708 WData().InvalidateLinesBelow(0);
709 }
710
711 // we might support it but it's quite useless and other ports don't
712 // support it anyhow
713 wxASSERT_MSG( !(style & wxTE_PASSWORD),
714 _T("wxTE_PASSWORD can't be used with multiline ctrls") );
715 }
716
717 RecalcFontMetrics();
718 SetValue(value);
719 SetBestSize(size);
720
721 m_isEditable = !(style & wxTE_READONLY);
722
723 CreateCaret();
724 InitInsertionPoint();
725
726 // we can't show caret right now as we're not shown yet and so it would
727 // result in garbage on the screen - we'll do it after first OnPaint()
728 m_hasCaret = FALSE;
729
730 CreateInputHandler(wxINP_HANDLER_TEXTCTRL);
731
732 return TRUE;
733 }
734
735 wxTextCtrl::~wxTextCtrl()
736 {
737 delete m_cmdProcessor;
738
739 if ( m_data.data )
740 {
741 if ( IsSingleLine() )
742 delete m_data.sdata;
743 else if ( WrapLines() )
744 delete m_data.wdata;
745 else
746 delete m_data.mdata;
747 }
748 }
749
750 // ----------------------------------------------------------------------------
751 // set/get the value
752 // ----------------------------------------------------------------------------
753
754 void wxTextCtrl::SetValue(const wxString& value)
755 {
756 if ( IsSingleLine() && (value == GetValue()) )
757 {
758 // nothing changed
759 return;
760 }
761
762 Replace(0, GetLastPosition(), value);
763
764 if ( IsSingleLine() )
765 {
766 SetInsertionPoint(0);
767 }
768
769 // TODO: should we generate the event or not, finally?
770 }
771
772 const wxArrayString& wxTextCtrl::GetLines() const
773 {
774 return MData().m_lines;
775 }
776
777 size_t wxTextCtrl::GetLineCount() const
778 {
779 return MData().m_lines.GetCount();
780 }
781
782 wxString wxTextCtrl::GetValue() const
783 {
784 // for multiline controls we don't always store the total value but only
785 // recompute it when asked - and to invalidate it we just empty it in
786 // Replace()
787 if ( !IsSingleLine() && m_value.empty() )
788 {
789 // recalculate: note that we always do it for empty multilien control,
790 // but then it's so quick that it's not important
791
792 // the first line is special as there is no \n before it, so it's
793 // outside the loop
794 const wxArrayString& lines = GetLines();
795 wxTextCtrl *self = wxConstCast(this, wxTextCtrl);
796 self->m_value << lines[0u];
797 size_t count = lines.GetCount();
798 for ( size_t n = 1; n < count; n++ )
799 {
800 self->m_value << _T('\n') << lines[n];
801 }
802 }
803
804 return m_value;
805 }
806
807 void wxTextCtrl::Clear()
808 {
809 SetValue(_T(""));
810 }
811
812 bool wxTextCtrl::ReplaceLine(wxTextCoord line,
813 const wxString& text)
814 {
815 if ( WrapLines() )
816 {
817 // first, we have to relayout the line entirely
818 //
819 // OPT: we might try not to recalc the unchanged part of line
820
821 wxWrappedLineData& lineData = WData().m_linesData[line];
822
823 // if we had some number of rows before, use this number, otherwise
824 // just make sure that the test below (rowsNew != rowsOld) will be true
825 int rowsOld;
826 if ( lineData.IsValid() )
827 {
828 rowsOld = lineData.GetExtraRowCount();
829 }
830 else // line wasn't laid out yet
831 {
832 // assume it changed entirely as we can't do anything better
833 rowsOld = -1;
834 }
835
836 // now change the line
837 MData().m_lines[line] = text;
838
839 // OPT: we choose to lay it our immediately instead of delaying it
840 // until it is needed because it allows us to avoid invalidating
841 // lines further down if the number of rows didn't chnage, but
842 // maybe we can imporve this even further?
843 LayoutLine(line, lineData);
844
845 int rowsNew = lineData.GetExtraRowCount();
846
847 if ( rowsNew != rowsOld )
848 {
849 // we have to update the line wrap marks as this is normally done
850 // by LayoutLines() which we bypassed by calling LayoutLine()
851 // directly
852 wxTextCoord rowFirst = lineData.GetFirstRow(),
853 rowCount = wxMax(rowsOld, rowsNew);
854 RefreshLineWrapMarks(rowFirst, rowFirst + rowCount);
855
856 // next, if this is not the last line, as the number of rows in it
857 // changed, we need to shift all the lines below it
858 if ( (size_t)line < WData().m_linesData.GetCount() )
859 {
860 // number of rows changed shifting all lines below
861 WData().InvalidateLinesBelow(line + 1);
862 }
863
864 // the number of rows changed
865 return TRUE;
866 }
867 }
868 else // no line wrap
869 {
870 MData().m_lines[line] = text;
871 }
872
873 // the number of rows didn't change
874 return FALSE;
875 }
876
877 void wxTextCtrl::RemoveLine(wxTextCoord line)
878 {
879 MData().m_lines.RemoveAt(line);
880 if ( WrapLines() )
881 {
882 // we need to recalculate all the starting rows from this line, but we
883 // can avoid doing it if this line was never calculated: this means
884 // that we will recalculate all lines below it anyhow later if needed
885 if ( WData().IsValidLine(line) )
886 {
887 WData().InvalidateLinesBelow(line);
888 }
889
890 WData().m_linesData.RemoveAt(line);
891 }
892 }
893
894 void wxTextCtrl::InsertLine(wxTextCoord line, const wxString& text)
895 {
896 MData().m_lines.Insert(text, line);
897 if ( WrapLines() )
898 {
899 WData().m_linesData.Insert(new wxWrappedLineData, line);
900
901 // invalidate everything below it
902 WData().InvalidateLinesBelow(line);
903 }
904 }
905
906 void wxTextCtrl::Replace(wxTextPos from, wxTextPos to, const wxString& text)
907 {
908 wxTextCoord colStart, colEnd,
909 lineStart, lineEnd;
910
911 if ( (from > to) ||
912 !PositionToXY(from, &colStart, &lineStart) ||
913 !PositionToXY(to, &colEnd, &lineEnd) )
914 {
915 wxFAIL_MSG(_T("invalid range in wxTextCtrl::Replace"));
916
917 return;
918 }
919
920 #ifdef WXDEBUG_TEXT_REPLACE
921 // a straighforward (but very inefficient) way of calculating what the new
922 // value should be
923 wxString textTotal = GetValue();
924 wxString textTotalNew(textTotal, (size_t)from);
925 textTotalNew += text;
926 if ( (size_t)to < textTotal.length() )
927 textTotalNew += textTotal.c_str() + (size_t)to;
928 #endif // WXDEBUG_TEXT_REPLACE
929
930 // remember the old selection and reset it immediately: we must do it
931 // before calling Refresh(anything) as, at least under GTK, this leads to
932 // an _immediate_ repaint (under MSW it is delayed) and hence parts of
933 // text would be redrawn as selected if we didn't reset the selection
934 int selStartOld = m_selStart,
935 selEndOld = m_selEnd;
936
937 m_selStart =
938 m_selEnd = -1;
939
940 if ( IsSingleLine() )
941 {
942 // replace the part of the text with the new value
943 wxString valueNew(m_value, (size_t)from);
944
945 // remember it for later use
946 wxCoord startNewText = GetTextWidth(valueNew);
947
948 valueNew += text;
949 if ( (size_t)to < m_value.length() )
950 {
951 valueNew += m_value.c_str() + (size_t)to;
952 }
953
954 // we usually refresh till the end of line except of the most common case
955 // when some text is appended to the end of the string in which case we
956 // refresh just it
957 wxCoord widthNewText;
958
959 if ( (size_t)from < m_value.length() )
960 {
961 // refresh till the end of line
962 widthNewText = 0;
963 }
964 else // text appended, not replaced
965 {
966 // refresh only the new text
967 widthNewText = GetTextWidth(text);
968 }
969
970 m_value = valueNew;
971
972 // force SData().m_colLastVisible update
973 SData().m_colLastVisible = -1;
974
975 // repaint
976 RefreshPixelRange(0, startNewText, widthNewText);
977 }
978 else // multiline
979 {
980 //OPT: special case for replacements inside single line?
981
982 /*
983 Join all the lines in the replacement range into one string, then
984 replace a part of it with the new text and break it into lines again.
985 */
986
987 // (0) we want to know if this replacement changes the number of rows
988 // as if it does we need to refresh everything below the changed
989 // text (it will be shifted...) and we can avoid it if there is no
990 // row relayout
991 bool rowsNumberChanged = FALSE;
992
993 // (1) join lines
994 const wxArrayString& linesOld = GetLines();
995 wxString textOrig;
996 wxTextCoord line;
997 for ( line = lineStart; line <= lineEnd; line++ )
998 {
999 if ( line > lineStart )
1000 {
1001 // from the previous line
1002 textOrig += _T('\n');
1003 }
1004
1005 textOrig += linesOld[line];
1006 }
1007
1008 // we need to append the '\n' for the last line unless there is no
1009 // following line
1010 size_t countOld = linesOld.GetCount();
1011
1012 // (2) replace text in the combined string
1013
1014 // (2a) leave the part before replaced area unchanged
1015 wxString textNew(textOrig, colStart);
1016
1017 // these values will be used to refresh the changed area below
1018 wxCoord widthNewText,
1019 startNewText = GetTextWidth(textNew);
1020 if ( (size_t)colStart == linesOld[lineStart].length() )
1021 {
1022 // text appended, refresh just enough to show the new text
1023 widthNewText = GetTextWidth(text.BeforeFirst(_T('\n')));
1024 }
1025 else // text inserted, refresh till the end of line
1026 {
1027 widthNewText = 0;
1028 }
1029
1030 // (2b) insert new text
1031 textNew += text;
1032
1033 // (2c) and append the end of the old text
1034
1035 // adjust for index shift: to is relative to colStart, not 0
1036 size_t toRel = (size_t)((to - from) + colStart);
1037 if ( toRel < textOrig.length() )
1038 {
1039 textNew += textOrig.c_str() + toRel;
1040 }
1041
1042 // (3) break it into lines
1043
1044 wxArrayString lines;
1045 const wxChar *curLineStart = textNew.c_str();
1046 for ( const wxChar *p = textNew.c_str(); ; p++ )
1047 {
1048 // end of line/text?
1049 if ( !*p || *p == _T('\n') )
1050 {
1051 lines.Add(wxString(curLineStart, p));
1052 if ( !*p )
1053 break;
1054
1055 curLineStart = p + 1;
1056 }
1057 }
1058
1059 #ifdef WXDEBUG_TEXT_REPLACE
1060 // (3a) all empty tokens should be counted as replacing with "foo" and
1061 // with "foo\n" should have different effects
1062 wxArrayString lines2 = wxStringTokenize(textNew, _T("\n"),
1063 wxTOKEN_RET_EMPTY_ALL);
1064
1065 if ( lines2.IsEmpty() )
1066 {
1067 lines2.Add(wxEmptyString);
1068 }
1069
1070 wxASSERT_MSG( lines.GetCount() == lines2.GetCount(),
1071 _T("Replace() broken") );
1072 for ( size_t n = 0; n < lines.GetCount(); n++ )
1073 {
1074 wxASSERT_MSG( lines[n] == lines2[n], _T("Replace() broken") );
1075 }
1076 #endif // WXDEBUG_TEXT_REPLACE
1077
1078 // (3b) special case: if we replace everything till the end we need to
1079 // keep an empty line or the lines would disappear completely
1080 // (this also takes care of never leaving m_lines empty)
1081 if ( ((size_t)lineEnd == countOld - 1) && lines.IsEmpty() )
1082 {
1083 lines.Add(wxEmptyString);
1084 }
1085
1086 size_t nReplaceCount = lines.GetCount(),
1087 nReplaceLine = 0;
1088
1089 // (4) merge into the array
1090
1091 // (4a) replace
1092 for ( line = lineStart; line <= lineEnd; line++, nReplaceLine++ )
1093 {
1094 if ( nReplaceLine < nReplaceCount )
1095 {
1096 // we have the replacement line for this one
1097 if ( ReplaceLine(line, lines[nReplaceLine]) )
1098 {
1099 rowsNumberChanged = TRUE;
1100 }
1101
1102 UpdateMaxWidth(line);
1103 }
1104 else // no more replacement lines
1105 {
1106 // (4b) delete all extra lines (note that we need to delete
1107 // them backwards because indices shift while we do it)
1108 bool deletedLongestLine = FALSE;
1109 for ( wxTextCoord lineDel = lineEnd; lineDel >= line; lineDel-- )
1110 {
1111 if ( lineDel == MData().m_lineLongest )
1112 {
1113 // we will need to recalc the max line width
1114 deletedLongestLine = TRUE;
1115 }
1116
1117 RemoveLine(lineDel);
1118 }
1119
1120 if ( deletedLongestLine )
1121 {
1122 RecalcMaxWidth();
1123 }
1124
1125 // even the line number changed
1126 rowsNumberChanged = TRUE;
1127
1128 // update line to exit the loop
1129 line = lineEnd + 1;
1130 }
1131 }
1132
1133 // (4c) insert the new lines
1134 if ( nReplaceLine < nReplaceCount )
1135 {
1136 // even the line number changed
1137 rowsNumberChanged = TRUE;
1138
1139 do
1140 {
1141 InsertLine(++lineEnd, lines[nReplaceLine++]);
1142
1143 UpdateMaxWidth(lineEnd);
1144 }
1145 while ( nReplaceLine < nReplaceCount );
1146 }
1147
1148 // (5) now refresh the changed area
1149
1150 // update the (cached) last position first as refresh functions use it
1151 m_posLast += text.length() - to + from;
1152
1153 // we may optimize refresh if the number of rows didn't change - but if
1154 // it did we have to refresh everything below the part we chanegd as
1155 // well as it might have moved
1156 if ( !rowsNumberChanged )
1157 {
1158 // refresh the line we changed
1159 if ( !WrapLines() )
1160 {
1161 RefreshPixelRange(lineStart++, startNewText, widthNewText);
1162 }
1163 else
1164 {
1165 //OPT: we shouldn't refresh the unchanged part of the line in
1166 // this case, but instead just refresh the tail of it - the
1167 // trouble is that we don't know here where does this tail
1168 // start
1169 }
1170
1171 // number of rows didn't change, refresh the updated rows and the
1172 // last one
1173 if ( lineStart <= lineEnd )
1174 RefreshLineRange(lineStart, lineEnd);
1175 }
1176 else // rows number did change
1177 {
1178 if ( !WrapLines() )
1179 {
1180 // refresh only part of the first line
1181 RefreshPixelRange(lineStart++, startNewText, widthNewText);
1182 }
1183 //else: we have to refresh everything as some part of the text
1184 // could be in the previous row before but moved to the next
1185 // one now (due to word wrap)
1186
1187 wxTextCoord lineEnd = GetLines().GetCount() - 1;
1188 if ( lineStart <= lineEnd )
1189 RefreshLineRange(lineStart, lineEnd);
1190
1191 // refresh text rect left below
1192 RefreshLineRange(lineEnd + 1, 0);
1193
1194 // the vert scrollbar might [dis]appear
1195 MData().m_updateScrollbarY = TRUE;
1196 }
1197
1198 // must recalculate it - will do later
1199 m_value.clear();
1200 }
1201
1202 #ifdef WXDEBUG_TEXT_REPLACE
1203 // optimized code above should give the same result as straightforward
1204 // computation in the beginning
1205 wxASSERT_MSG( GetValue() == textTotalNew, _T("error in Replace()") );
1206 #endif // WXDEBUG_TEXT_REPLACE
1207
1208 // update the current position: note that we always put the cursor at the
1209 // end of the replacement text
1210 DoSetInsertionPoint(from + text.length());
1211
1212 // and the selection: this is complicated by the fact that selection coords
1213 // must be first updated to reflect change in text coords, i.e. if we had
1214 // selection from 17 to 19 and we just removed this range, we don't have to
1215 // refresh anything, so we can't just use ClearSelection() here
1216 if ( selStartOld != -1 )
1217 {
1218 // refresh the parst of the selection outside the changed text (which
1219 // we already refreshed)
1220 if ( selStartOld < from )
1221 RefreshTextRange(selStartOld, from);
1222 if ( to < selEndOld )
1223 RefreshTextRange(to, selEndOld);
1224
1225 }
1226
1227 // now call it to do the rest (not related to refreshing)
1228 ClearSelection();
1229 }
1230
1231 void wxTextCtrl::Remove(wxTextPos from, wxTextPos to)
1232 {
1233 // Replace() only works with correctly ordered arguments, so exchange them
1234 // if necessary
1235 OrderPositions(from, to);
1236
1237 Replace(from, to, _T(""));
1238 }
1239
1240 void wxTextCtrl::WriteText(const wxString& text)
1241 {
1242 // replace the selection with the new text
1243 RemoveSelection();
1244
1245 Replace(m_curPos, m_curPos, text);
1246 }
1247
1248 void wxTextCtrl::AppendText(const wxString& text)
1249 {
1250 SetInsertionPointEnd();
1251 WriteText(text);
1252 }
1253
1254 // ----------------------------------------------------------------------------
1255 // current position
1256 // ----------------------------------------------------------------------------
1257
1258 void wxTextCtrl::SetInsertionPoint(wxTextPos pos)
1259 {
1260 wxCHECK_RET( pos >= 0 && pos <= GetLastPosition(),
1261 _T("insertion point position out of range") );
1262
1263 // don't do anything if it didn't change
1264 if ( pos != m_curPos )
1265 {
1266 DoSetInsertionPoint(pos);
1267 }
1268
1269 if ( !IsSingleLine() )
1270 {
1271 // moving cursor should reset the stored abscissa (even if the cursor
1272 // position didn't actually change!)
1273 MData().m_xCaret = -1;
1274 }
1275
1276 ClearSelection();
1277 }
1278
1279 void wxTextCtrl::InitInsertionPoint()
1280 {
1281 // so far always put it in the beginning
1282 DoSetInsertionPoint(0);
1283
1284 // this will also set the selection anchor correctly
1285 ClearSelection();
1286 }
1287
1288 void wxTextCtrl::MoveInsertionPoint(wxTextPos pos)
1289 {
1290 wxASSERT_MSG( pos >= 0 && pos <= GetLastPosition(),
1291 _T("DoSetInsertionPoint() can only be called with valid pos") );
1292
1293 m_curPos = pos;
1294 PositionToXY(m_curPos, &m_curCol, &m_curRow);
1295 }
1296
1297 void wxTextCtrl::DoSetInsertionPoint(wxTextPos pos)
1298 {
1299 MoveInsertionPoint(pos);
1300
1301 ShowPosition(pos);
1302 }
1303
1304 void wxTextCtrl::SetInsertionPointEnd()
1305 {
1306 SetInsertionPoint(GetLastPosition());
1307 }
1308
1309 wxTextPos wxTextCtrl::GetInsertionPoint() const
1310 {
1311 return m_curPos;
1312 }
1313
1314 wxTextPos wxTextCtrl::GetLastPosition() const
1315 {
1316 wxTextPos pos;
1317 if ( IsSingleLine() )
1318 {
1319 pos = m_value.length();
1320 }
1321 else // multiline
1322 {
1323 #ifdef WXDEBUG_TEXT
1324 pos = 0;
1325 size_t nLineCount = GetLineCount();
1326 for ( size_t nLine = 0; nLine < nLineCount; nLine++ )
1327 {
1328 // +1 is because the positions at the end of this line and of the
1329 // start of the next one are different
1330 pos += GetLines()[nLine].length() + 1;
1331 }
1332
1333 if ( pos > 0 )
1334 {
1335 // the last position is at the end of the last line, not in the
1336 // beginning of the next line after it
1337 pos--;
1338 }
1339
1340 // more probable reason of this would be to forget to update m_posLast
1341 wxASSERT_MSG( pos == m_posLast, _T("bug in GetLastPosition()") );
1342 #endif // WXDEBUG_TEXT
1343
1344 pos = m_posLast;
1345 }
1346
1347 return pos;
1348 }
1349
1350 // ----------------------------------------------------------------------------
1351 // selection
1352 // ----------------------------------------------------------------------------
1353
1354 void wxTextCtrl::GetSelection(wxTextPos* from, wxTextPos* to) const
1355 {
1356 if ( from )
1357 *from = m_selStart;
1358 if ( to )
1359 *to = m_selEnd;
1360 }
1361
1362 wxString wxTextCtrl::GetSelectionText() const
1363 {
1364 wxString sel;
1365
1366 if ( HasSelection() )
1367 {
1368 if ( IsSingleLine() )
1369 {
1370 sel = m_value.Mid(m_selStart, m_selEnd - m_selStart);
1371 }
1372 else // multiline
1373 {
1374 wxTextCoord colStart, lineStart,
1375 colEnd, lineEnd;
1376 PositionToXY(m_selStart, &colStart, &lineStart);
1377 PositionToXY(m_selEnd, &colEnd, &lineEnd);
1378
1379 // as always, we need to check for the special case when the start
1380 // and end line are the same
1381 if ( lineEnd == lineStart )
1382 {
1383 sel = GetLines()[lineStart].Mid(colStart, colEnd - colStart);
1384 }
1385 else // sel on multiple lines
1386 {
1387 // take the end of the first line
1388 sel = GetLines()[lineStart].c_str() + colStart;
1389 sel += _T('\n');
1390
1391 // all intermediate ones
1392 for ( wxTextCoord line = lineStart + 1; line < lineEnd; line++ )
1393 {
1394 sel << GetLines()[line] << _T('\n');
1395 }
1396
1397 // and the start of the last one
1398 sel += GetLines()[lineEnd].Left(colEnd);
1399 }
1400 }
1401 }
1402
1403 return sel;
1404 }
1405
1406 void wxTextCtrl::SetSelection(wxTextPos from, wxTextPos to)
1407 {
1408 // selecting till -1 is the same as selecting to the end
1409 if ( to == -1 && from != -1 )
1410 {
1411 to = GetLastPosition();
1412 }
1413
1414 if ( from == -1 || to == from )
1415 {
1416 ClearSelection();
1417 }
1418 else // valid sel range
1419 {
1420 // remember the 'to' position as the current position, used to move the
1421 // caret there later
1422 wxTextPos toOrig = to;
1423
1424 OrderPositions(from, to);
1425
1426 wxCHECK_RET( to <= GetLastPosition(),
1427 _T("invalid range in wxTextCtrl::SetSelection") );
1428
1429 if ( from != m_selStart || to != m_selEnd )
1430 {
1431 // we need to use temp vars as RefreshTextRange() may call DoDraw()
1432 // directly and so m_selStart/End must be reset by then
1433 wxTextPos selStartOld = m_selStart,
1434 selEndOld = m_selEnd;
1435
1436 m_selStart = from;
1437 m_selEnd = to;
1438
1439 wxLogTrace(_T("text"), _T("Selection range is %ld-%ld"),
1440 m_selStart, m_selEnd);
1441
1442 // refresh only the part of text which became (un)selected if
1443 // possible
1444 if ( selStartOld == m_selStart )
1445 {
1446 RefreshTextRange(selEndOld, m_selEnd);
1447 }
1448 else if ( selEndOld == m_selEnd )
1449 {
1450 RefreshTextRange(m_selStart, selStartOld);
1451 }
1452 else
1453 {
1454 // OPT: could check for other cases too but it is probably not
1455 // worth it as the two above are the most common ones
1456 if ( selStartOld != -1 )
1457 RefreshTextRange(selStartOld, selEndOld);
1458 if ( m_selStart != -1 )
1459 RefreshTextRange(m_selStart, m_selEnd);
1460 }
1461
1462 // we need to fully repaint the invalidated areas of the window
1463 // before scrolling it (from DoSetInsertionPoint which is typically
1464 // called after SetSelection()), otherwise they may stay unpainted
1465 m_targetWindow->Update();
1466 }
1467 //else: nothing to do
1468
1469 // the insertion point is put at the location where the caret was moved
1470 DoSetInsertionPoint(toOrig);
1471 }
1472 }
1473
1474 void wxTextCtrl::ClearSelection()
1475 {
1476 if ( HasSelection() )
1477 {
1478 // we need to use temp vars as RefreshTextRange() may call DoDraw()
1479 // directly (see above as well)
1480 wxTextPos selStart = m_selStart,
1481 selEnd = m_selEnd;
1482
1483 // no selection any more
1484 m_selStart =
1485 m_selEnd = -1;
1486
1487 // refresh the old selection
1488 RefreshTextRange(selStart, selEnd);
1489 }
1490
1491 // the anchor should be moved even if there was no selection previously
1492 m_selAnchor = m_curPos;
1493 }
1494
1495 void wxTextCtrl::RemoveSelection()
1496 {
1497 if ( !HasSelection() )
1498 return;
1499
1500 Remove(m_selStart, m_selEnd);
1501 }
1502
1503 bool wxTextCtrl::GetSelectedPartOfLine(wxTextCoord line,
1504 wxTextPos *start, wxTextPos *end) const
1505 {
1506 if ( start )
1507 *start = -1;
1508 if ( end )
1509 *end = -1;
1510
1511 if ( !HasSelection() )
1512 {
1513 // no selection at all, hence no selection in this line
1514 return FALSE;
1515 }
1516
1517 wxTextCoord lineStart, colStart;
1518 PositionToXY(m_selStart, &colStart, &lineStart);
1519 if ( lineStart > line )
1520 {
1521 // this line is entirely above the selection
1522 return FALSE;
1523 }
1524
1525 wxTextCoord lineEnd, colEnd;
1526 PositionToXY(m_selEnd, &colEnd, &lineEnd);
1527 if ( lineEnd < line )
1528 {
1529 // this line is entirely below the selection
1530 return FALSE;
1531 }
1532
1533 if ( line == lineStart )
1534 {
1535 if ( start )
1536 *start = colStart;
1537 if ( end )
1538 *end = lineEnd == lineStart ? colEnd : GetLineLength(line);
1539 }
1540 else if ( line == lineEnd )
1541 {
1542 if ( start )
1543 *start = lineEnd == lineStart ? colStart : 0;
1544 if ( end )
1545 *end = colEnd;
1546 }
1547 else // the line is entirely inside the selection
1548 {
1549 if ( start )
1550 *start = 0;
1551 if ( end )
1552 *end = GetLineLength(line);
1553 }
1554
1555 return TRUE;
1556 }
1557
1558 // ----------------------------------------------------------------------------
1559 // flags
1560 // ----------------------------------------------------------------------------
1561
1562 bool wxTextCtrl::IsModified() const
1563 {
1564 return m_isModified;
1565 }
1566
1567 bool wxTextCtrl::IsEditable() const
1568 {
1569 // disabled control can never be edited
1570 return m_isEditable && IsEnabled();
1571 }
1572
1573 void wxTextCtrl::DiscardEdits()
1574 {
1575 m_isModified = FALSE;
1576 }
1577
1578 void wxTextCtrl::SetEditable(bool editable)
1579 {
1580 if ( editable != m_isEditable )
1581 {
1582 m_isEditable = editable;
1583
1584 // the caret (dis)appears
1585 CreateCaret();
1586
1587 // the appearance of the control might have changed
1588 Refresh();
1589 }
1590 }
1591
1592 // ----------------------------------------------------------------------------
1593 // col/lines <-> position correspondence
1594 // ----------------------------------------------------------------------------
1595
1596 /*
1597 A few remarks about this stuff:
1598
1599 o The numbering of the text control columns/rows starts from 0.
1600 o Start of first line is position 0, its last position is line.length()
1601 o Start of the next line is the last position of the previous line + 1
1602 */
1603
1604 int wxTextCtrl::GetLineLength(wxTextCoord line) const
1605 {
1606 if ( IsSingleLine() )
1607 {
1608 wxASSERT_MSG( line == 0, _T("invalid GetLineLength() parameter") );
1609
1610 return m_value.length();
1611 }
1612 else // multiline
1613 {
1614 wxCHECK_MSG( (size_t)line < GetLineCount(), -1,
1615 _T("line index out of range") );
1616
1617 return GetLines()[line].length();
1618 }
1619 }
1620
1621 wxString wxTextCtrl::GetLineText(wxTextCoord line) const
1622 {
1623 if ( IsSingleLine() )
1624 {
1625 wxASSERT_MSG( line == 0, _T("invalid GetLineLength() parameter") );
1626
1627 return m_value;
1628 }
1629 else // multiline
1630 {
1631 wxCHECK_MSG( (size_t)line < GetLineCount(), _T(""),
1632 _T("line index out of range") );
1633
1634 return GetLines()[line];
1635 }
1636 }
1637
1638 int wxTextCtrl::GetNumberOfLines() const
1639 {
1640 // there is always 1 line, even if the text is empty
1641 return IsSingleLine() ? 1 : GetLineCount();
1642 }
1643
1644 wxTextPos wxTextCtrl::XYToPosition(wxTextCoord x, wxTextCoord y) const
1645 {
1646 // note that this method should accept any values of x and y and return -1
1647 // if they are out of range
1648 if ( IsSingleLine() )
1649 {
1650 return x > GetLastPosition() || y > 0 ? -1 : x;
1651 }
1652 else // multiline
1653 {
1654 if ( (size_t)y >= GetLineCount() )
1655 {
1656 // this position is below the text
1657 return GetLastPosition();
1658 }
1659
1660 wxTextPos pos = 0;
1661 for ( size_t nLine = 0; nLine < (size_t)y; nLine++ )
1662 {
1663 // +1 is because the positions at the end of this line and of the
1664 // start of the next one are different
1665 pos += GetLines()[nLine].length() + 1;
1666 }
1667
1668 // take into account also the position in line
1669 if ( (size_t)x > GetLines()[y].length() )
1670 {
1671 // don't return position in the next line
1672 x = GetLines()[y].length();
1673 }
1674
1675 return pos + x;
1676 }
1677 }
1678
1679 bool wxTextCtrl::PositionToXY(wxTextPos pos,
1680 wxTextCoord *x, wxTextCoord *y) const
1681 {
1682 if ( IsSingleLine() )
1683 {
1684 if ( (size_t)pos > m_value.length() )
1685 return FALSE;
1686
1687 if ( x )
1688 *x = pos;
1689 if ( y )
1690 *y = 0;
1691
1692 return TRUE;
1693 }
1694 else // multiline
1695 {
1696 wxTextPos posCur = 0;
1697 size_t nLineCount = GetLineCount();
1698 for ( size_t nLine = 0; nLine < nLineCount; nLine++ )
1699 {
1700 // +1 is because the start the start of the next line is one
1701 // position after the end of this one
1702 wxTextPos posNew = posCur + GetLines()[nLine].length() + 1;
1703 if ( posNew > pos )
1704 {
1705 // we've found the line, now just calc the column
1706 if ( x )
1707 *x = pos - posCur;
1708
1709 if ( y )
1710 *y = nLine;
1711
1712 #ifdef WXDEBUG_TEXT
1713 wxASSERT_MSG( XYToPosition(pos - posCur, nLine) == pos,
1714 _T("XYToPosition() or PositionToXY() broken") );
1715 #endif // WXDEBUG_TEXT
1716
1717 return TRUE;
1718 }
1719 else // go further down
1720 {
1721 posCur = posNew;
1722 }
1723 }
1724
1725 // beyond the last line
1726 return FALSE;
1727 }
1728 }
1729
1730 wxTextCoord wxTextCtrl::GetRowsPerLine(wxTextCoord line) const
1731 {
1732 // a normal line has one row
1733 wxTextCoord numRows = 1;
1734
1735 if ( WrapLines() )
1736 {
1737 // add the number of additional rows
1738 numRows += WData().m_linesData[line].GetExtraRowCount();
1739 }
1740
1741 return numRows;
1742 }
1743
1744 wxTextCoord wxTextCtrl::GetRowCount() const
1745 {
1746 wxTextCoord count = GetLineCount();
1747 if (count == 0)
1748 return 0;
1749 if ( WrapLines() )
1750 {
1751 count = GetFirstRowOfLine(count - 1) +
1752 WData().m_linesData[count - 1].GetRowCount();
1753 }
1754
1755 return count;
1756 }
1757
1758 wxTextCoord wxTextCtrl::GetRowAfterLine(wxTextCoord line) const
1759 {
1760 if ( !WrapLines() )
1761 return line + 1;
1762
1763 if ( !WData().IsValidLine(line) )
1764 {
1765 LayoutLines(line);
1766 }
1767
1768 return WData().m_linesData[line].GetNextRow();
1769 }
1770
1771 wxTextCoord wxTextCtrl::GetFirstRowOfLine(wxTextCoord line) const
1772 {
1773 if ( !WrapLines() )
1774 return line;
1775
1776 if ( !WData().IsValidLine(line) )
1777 {
1778 LayoutLines(line);
1779 }
1780
1781 return WData().m_linesData[line].GetFirstRow();
1782 }
1783
1784 bool wxTextCtrl::PositionToLogicalXY(wxTextPos pos,
1785 wxCoord *xOut,
1786 wxCoord *yOut) const
1787 {
1788 wxTextCoord col, line;
1789
1790 // optimization for special (but common) case when we already have the col
1791 // and line
1792 if ( pos == m_curPos )
1793 {
1794 col = m_curCol;
1795 line = m_curRow;
1796 }
1797 else // must really calculate col/line from pos
1798 {
1799 if ( !PositionToXY(pos, &col, &line) )
1800 return FALSE;
1801 }
1802
1803 int hLine = GetLineHeight();
1804 wxCoord x, y;
1805 wxString textLine = GetLineText(line);
1806 if ( IsSingleLine() || !WrapLines() )
1807 {
1808 x = GetTextWidth(textLine.Left(col));
1809 y = line*hLine;
1810 }
1811 else // difficult case: multline control with line wrap
1812 {
1813 y = GetFirstRowOfLine(line);
1814
1815 wxTextCoord colRowStart;
1816 y += GetRowInLine(line, col, &colRowStart);
1817
1818 y *= hLine;
1819
1820 // x is the width of the text before this position in this row
1821 x = GetTextWidth(textLine.Mid(colRowStart, col - colRowStart));
1822 }
1823
1824 if ( xOut )
1825 *xOut = x;
1826 if ( yOut )
1827 *yOut = y;
1828
1829 return TRUE;
1830 }
1831
1832 bool wxTextCtrl::PositionToDeviceXY(wxTextPos pos,
1833 wxCoord *xOut,
1834 wxCoord *yOut) const
1835 {
1836 wxCoord x, y;
1837 if ( !PositionToLogicalXY(pos, &x, &y) )
1838 return FALSE;
1839
1840 // finally translate the logical text rect coords into physical client
1841 // coords
1842 CalcScrolledPosition(m_rectText.x + x, m_rectText.y + y, xOut, yOut);
1843
1844 return TRUE;
1845 }
1846
1847 wxPoint wxTextCtrl::GetCaretPosition() const
1848 {
1849 wxCoord xCaret, yCaret;
1850 if ( !PositionToDeviceXY(m_curPos, &xCaret, &yCaret) )
1851 {
1852 wxFAIL_MSG( _T("Caret can't be beyond the text!") );
1853 }
1854
1855 return wxPoint(xCaret, yCaret);
1856 }
1857
1858 // pos may be -1 to show the current position
1859 void wxTextCtrl::ShowPosition(wxTextPos pos)
1860 {
1861 HideCaret();
1862
1863 if ( IsSingleLine() )
1864 {
1865 ShowHorzPosition(GetTextWidth(m_value.Left(pos)));
1866 }
1867 else if ( MData().m_scrollRangeX || MData().m_scrollRangeY ) // multiline with scrollbars
1868 {
1869 int xStart, yStart;
1870 GetViewStart(&xStart, &yStart);
1871
1872 if ( pos == -1 )
1873 pos = m_curPos;
1874
1875 wxCoord x, y;
1876 PositionToLogicalXY(pos, &x, &y);
1877
1878 wxRect rectText = GetRealTextArea();
1879
1880 // scroll the position vertically into view: if it is currently above
1881 // it, make it the first one, otherwise the last one
1882 if ( MData().m_scrollRangeY )
1883 {
1884 y /= GetLineHeight();
1885
1886 if ( y < yStart )
1887 {
1888 Scroll(0, y);
1889 }
1890 else // we are currently in or below the view area
1891 {
1892 // find the last row currently shown
1893 wxTextCoord yEnd;
1894
1895 if ( WrapLines() )
1896 {
1897 // to find the last row we need to use the generic HitTest
1898 wxTextCoord col;
1899
1900 // OPT this is a bit silly: we undo this in HitTest(), so
1901 // it would be better to factor out the common
1902 // functionality into a separate function (OTOH it
1903 // won't probably save us that much)
1904 wxPoint pt(0, rectText.height - 1);
1905 pt += GetClientAreaOrigin();
1906 pt += m_rectText.GetPosition();
1907 HitTest(pt, &col, &yEnd);
1908
1909 // find the row inside the line
1910 yEnd = GetFirstRowOfLine(yEnd) + GetRowInLine(yEnd, col);
1911 }
1912 else
1913 {
1914 // finding the last line is easy if each line has exactly
1915 // one row
1916 yEnd = yStart + rectText.height / GetLineHeight() - 1;
1917 }
1918
1919 if ( yEnd < y )
1920 {
1921 // scroll down: the current item should appear at the
1922 // bottom of the view
1923 Scroll(0, y - (yEnd - yStart));
1924 }
1925 }
1926 }
1927
1928 // scroll the position horizontally into view
1929 //
1930 // we follow what I believe to be Windows behaviour here, that is if
1931 // the position is already entirely in the view we do nothing, but if
1932 // we do have to scroll the window to bring it into view, we scroll it
1933 // not just enough to show the position but slightly more so that this
1934 // position is at 1/3 of the window width from the closest border to it
1935 // (I'm not sure that Windows does exactly this but it looks like this)
1936 if ( MData().m_scrollRangeX )
1937 {
1938 // unlike for the rows, xStart doesn't correspond to the starting
1939 // column as they all have different widths, so we need to
1940 // translate everything to pixels
1941
1942 // we want the text between x and x2 be entirely inside the view
1943 // (i.e. the current character)
1944
1945 // make xStart the first visible pixel (and not position)
1946 int wChar = GetAverageWidth();
1947 xStart *= wChar;
1948
1949 if ( x < xStart )
1950 {
1951 // we want the position of this column be 1/3 to the right of
1952 // the left edge
1953 x -= rectText.width / 3;
1954 if ( x < 0 )
1955 x = 0;
1956 Scroll(x / wChar, y);
1957 }
1958 else // maybe we're beyond the right border of the view?
1959 {
1960 wxTextCoord col, row;
1961 if ( PositionToXY(pos, &col, &row) )
1962 {
1963 wxString lineText = GetLineText(row);
1964 wxCoord x2 = x + GetTextWidth(lineText[(size_t)col]);
1965 if ( x2 > xStart + rectText.width )
1966 {
1967 // we want the position of this column be 1/3 to the
1968 // left of the right edge, i.e. 2/3 right of the left
1969 // one
1970 x2 -= (2*rectText.width)/3;
1971 if ( x2 < 0 )
1972 x2 = 0;
1973 Scroll(x2 / wChar, row);
1974 }
1975 }
1976 }
1977 }
1978 }
1979 //else: multiline but no scrollbars, hence nothing to do
1980
1981 ShowCaret();
1982 }
1983
1984 // ----------------------------------------------------------------------------
1985 // word stuff
1986 // ----------------------------------------------------------------------------
1987
1988 /*
1989 TODO: we could have (easy to do) vi-like options for word movement, i.e.
1990 distinguish between inlusive/exclusive words and between words and
1991 WORDS (in vim sense) and also, finally, make the set of characters
1992 which make up a word configurable - currently we use the exclusive
1993 WORDS only (coincidentally, this is what Windows edit control does)
1994
1995 For future references, here is what vim help says:
1996
1997 A word consists of a sequence of letters, digits and underscores, or
1998 a sequence of other non-blank characters, separated with white space
1999 (spaces, tabs, <EOL>). This can be changed with the 'iskeyword'
2000 option.
2001
2002 A WORD consists of a sequence of non-blank characters, separated with
2003 white space. An empty line is also considered to be a word and a
2004 WORD.
2005 */
2006
2007 static inline bool IsWordChar(wxChar ch)
2008 {
2009 return !wxIsspace(ch);
2010 }
2011
2012 wxTextPos wxTextCtrl::GetWordStart() const
2013 {
2014 if ( m_curPos == -1 || m_curPos == 0 )
2015 return 0;
2016
2017 if ( m_curCol == 0 )
2018 {
2019 // go to the end of the previous line
2020 return m_curPos - 1;
2021 }
2022
2023 // it shouldn't be possible to learn where the word starts in the password
2024 // text entry zone
2025 if ( IsPassword() )
2026 return 0;
2027
2028 // start at the previous position
2029 const wxChar *p0 = GetLineText(m_curRow).c_str();
2030 const wxChar *p = p0 + m_curCol - 1;
2031
2032 // find the end of the previous word
2033 while ( (p > p0) && !IsWordChar(*p) )
2034 p--;
2035
2036 // now find the beginning of this word
2037 while ( (p > p0) && IsWordChar(*p) )
2038 p--;
2039
2040 // we might have gone too far
2041 if ( !IsWordChar(*p) )
2042 p++;
2043
2044 return (m_curPos - m_curCol) + p - p0;
2045 }
2046
2047 wxTextPos wxTextCtrl::GetWordEnd() const
2048 {
2049 if ( m_curPos == -1 )
2050 return 0;
2051
2052 wxString line = GetLineText(m_curRow);
2053 if ( (size_t)m_curCol == line.length() )
2054 {
2055 // if we're on the last position in the line, go to the next one - if
2056 // it exists
2057 wxTextPos pos = m_curPos;
2058 if ( pos < GetLastPosition() )
2059 pos++;
2060
2061 return pos;
2062 }
2063
2064 // it shouldn't be possible to learn where the word ends in the password
2065 // text entry zone
2066 if ( IsPassword() )
2067 return GetLastPosition();
2068
2069 // start at the current position
2070 const wxChar *p0 = line.c_str();
2071 const wxChar *p = p0 + m_curCol;
2072
2073 // find the start of the next word
2074 while ( *p && !IsWordChar(*p) )
2075 p++;
2076
2077 // now find the end of it
2078 while ( *p && IsWordChar(*p) )
2079 p++;
2080
2081 // and find the start of the next word
2082 while ( *p && !IsWordChar(*p) )
2083 p++;
2084
2085 return (m_curPos - m_curCol) + p - p0;
2086 }
2087
2088 // ----------------------------------------------------------------------------
2089 // clipboard stuff
2090 // ----------------------------------------------------------------------------
2091
2092 void wxTextCtrl::Copy()
2093 {
2094 #if wxUSE_CLIPBOARD
2095 if ( HasSelection() )
2096 {
2097 wxClipboardLocker clipLock;
2098
2099 // wxTextFile::Translate() is needed to transform all '\n' into "\r\n"
2100 wxString text = wxTextFile::Translate(GetTextToShow(GetSelectionText()));
2101 wxTextDataObject *data = new wxTextDataObject(text);
2102 wxTheClipboard->SetData(data);
2103 }
2104 #endif // wxUSE_CLIPBOARD
2105 }
2106
2107 void wxTextCtrl::Cut()
2108 {
2109 (void)DoCut();
2110 }
2111
2112 bool wxTextCtrl::DoCut()
2113 {
2114 if ( !HasSelection() )
2115 return FALSE;
2116
2117 Copy();
2118
2119 RemoveSelection();
2120
2121 return TRUE;
2122 }
2123
2124 void wxTextCtrl::Paste()
2125 {
2126 (void)DoPaste();
2127 }
2128
2129 bool wxTextCtrl::DoPaste()
2130 {
2131 #if wxUSE_CLIPBOARD
2132 wxClipboardLocker clipLock;
2133
2134 wxTextDataObject data;
2135 if ( wxTheClipboard->IsSupported(data.GetFormat())
2136 && wxTheClipboard->GetData(data) )
2137 {
2138 // reverse transformation: '\r\n\" -> '\n'
2139 wxString text = wxTextFile::Translate(data.GetText(),
2140 wxTextFileType_Unix);
2141 if ( !text.empty() )
2142 {
2143 WriteText(text);
2144
2145 return TRUE;
2146 }
2147 }
2148 #endif // wxUSE_CLIPBOARD
2149
2150 return FALSE;
2151 }
2152
2153 // ----------------------------------------------------------------------------
2154 // Undo and redo
2155 // ----------------------------------------------------------------------------
2156
2157 wxTextCtrlInsertCommand *
2158 wxTextCtrlCommandProcessor::IsInsertCommand(wxCommand *command)
2159 {
2160 return (wxTextCtrlInsertCommand *)
2161 (command && (command->GetName() == wxTEXT_COMMAND_INSERT)
2162 ? command : NULL);
2163 }
2164
2165 void wxTextCtrlCommandProcessor::Store(wxCommand *command)
2166 {
2167 wxTextCtrlInsertCommand *cmdIns = IsInsertCommand(command);
2168 if ( cmdIns )
2169 {
2170 if ( IsCompressing() )
2171 {
2172 wxTextCtrlInsertCommand *
2173 cmdInsLast = IsInsertCommand(GetCurrentCommand());
2174
2175 // it is possible that we don't have any last command at all if,
2176 // for example, it was undone since the last Store(), so deal with
2177 // this case too
2178 if ( cmdInsLast )
2179 {
2180 cmdInsLast->Append(cmdIns);
2181
2182 delete cmdIns;
2183
2184 // don't need to call the base class version
2185 return;
2186 }
2187 }
2188
2189 // append the following insert commands to this one
2190 m_compressInserts = TRUE;
2191
2192 // let the base class version will do the job normally
2193 }
2194 else // not an insert command
2195 {
2196 // stop compressing insert commands - this won't work with the last
2197 // command not being an insert one anyhow
2198 StopCompressing();
2199
2200 // let the base class version will do the job normally
2201 }
2202
2203 wxCommandProcessor::Store(command);
2204 }
2205
2206 void wxTextCtrlInsertCommand::Append(wxTextCtrlInsertCommand *other)
2207 {
2208 m_text += other->m_text;
2209 }
2210
2211 bool wxTextCtrlInsertCommand::CanUndo() const
2212 {
2213 return m_from != -1;
2214 }
2215
2216 bool wxTextCtrlInsertCommand::Do(wxTextCtrl *text)
2217 {
2218 // the text is going to be inserted at the current position, remember where
2219 // exactly it is
2220 m_from = text->GetInsertionPoint();
2221
2222 // and now do insert it
2223 text->WriteText(m_text);
2224
2225 return TRUE;
2226 }
2227
2228 bool wxTextCtrlInsertCommand::Undo(wxTextCtrl *text)
2229 {
2230 wxCHECK_MSG( CanUndo(), FALSE, _T("impossible to undo insert cmd") );
2231
2232 // remove the text from where we inserted it
2233 text->Remove(m_from, m_from + m_text.length());
2234
2235 return TRUE;
2236 }
2237
2238 bool wxTextCtrlRemoveCommand::CanUndo() const
2239 {
2240 // if we were executed, we should have the text we removed
2241 return !m_textDeleted.empty();
2242 }
2243
2244 bool wxTextCtrlRemoveCommand::Do(wxTextCtrl *text)
2245 {
2246 text->SetSelection(m_from, m_to);
2247 m_textDeleted = text->GetSelectionText();
2248 text->RemoveSelection();
2249
2250 return TRUE;
2251 }
2252
2253 bool wxTextCtrlRemoveCommand::Undo(wxTextCtrl *text)
2254 {
2255 // it is possible that the text was deleted and that we can't restore text
2256 // at the same position we removed it any more
2257 wxTextPos posLast = text->GetLastPosition();
2258 text->SetInsertionPoint(m_from > posLast ? posLast : m_from);
2259 text->WriteText(m_textDeleted);
2260
2261 return TRUE;
2262 }
2263
2264 void wxTextCtrl::Undo()
2265 {
2266 // the caller must check it
2267 wxASSERT_MSG( CanUndo(), _T("can't call Undo() if !CanUndo()") );
2268
2269 m_cmdProcessor->Undo();
2270 }
2271
2272 void wxTextCtrl::Redo()
2273 {
2274 // the caller must check it
2275 wxASSERT_MSG( CanRedo(), _T("can't call Undo() if !CanUndo()") );
2276
2277 m_cmdProcessor->Redo();
2278 }
2279
2280 bool wxTextCtrl::CanUndo() const
2281 {
2282 return IsEditable() && m_cmdProcessor->CanUndo();
2283 }
2284
2285 bool wxTextCtrl::CanRedo() const
2286 {
2287 return IsEditable() && m_cmdProcessor->CanRedo();
2288 }
2289
2290 // ----------------------------------------------------------------------------
2291 // geometry
2292 // ----------------------------------------------------------------------------
2293
2294 wxSize wxTextCtrl::DoGetBestClientSize() const
2295 {
2296 // when we're called for the very first time from Create() we must
2297 // calculate the font metrics here because we can't do it before calling
2298 // Create() (there is no window yet and wxGTK crashes) but we need them
2299 // here
2300 if ( m_heightLine == -1 )
2301 {
2302 wxConstCast(this, wxTextCtrl)->RecalcFontMetrics();
2303 }
2304
2305 wxCoord w, h;
2306 GetTextExtent(GetTextToShow(GetLineText(0)), &w, &h);
2307
2308 int wChar = GetAverageWidth(),
2309 hChar = GetLineHeight();
2310
2311 int widthMin = wxMax(10*wChar, 100);
2312 if ( w < widthMin )
2313 w = widthMin;
2314 if ( h < hChar )
2315 h = hChar;
2316
2317 if ( !IsSingleLine() )
2318 {
2319 // let the control have a reasonable number of lines
2320 int lines = GetNumberOfLines();
2321 if ( lines < 5 )
2322 lines = 5;
2323 else if ( lines > 10 )
2324 lines = 10;
2325 h *= 10;
2326 }
2327
2328 wxRect rectText;
2329 rectText.width = w;
2330 rectText.height = h;
2331 wxRect rectTotal = GetRenderer()->GetTextTotalArea(this, rectText);
2332 return wxSize(rectTotal.width, rectTotal.height);
2333 }
2334
2335 void wxTextCtrl::UpdateTextRect()
2336 {
2337 wxRect rectTotal(wxPoint(0, 0), GetClientSize());
2338 wxCoord *extraSpace = WrapLines() ? &WData().m_widthMark : NULL;
2339 m_rectText = GetRenderer()->GetTextClientArea(this, rectTotal, extraSpace);
2340
2341 // code elsewhere is confused by negative rect size
2342 if ( m_rectText.width <= 0 )
2343 m_rectText.width = 1;
2344 if ( m_rectText.height <= 0 )
2345 m_rectText.height = 1;
2346
2347 if ( !IsSingleLine() )
2348 {
2349 // invalidate it so that GetRealTextArea() will recalc it
2350 MData().m_rectTextReal.width = 0;
2351
2352 // only scroll this rect when the window is scrolled: note that we have
2353 // to scroll not only the text but the line wrap marks too if we show
2354 // them
2355 wxRect rectText = GetRealTextArea();
2356 if ( extraSpace && *extraSpace )
2357 {
2358 rectText.width += *extraSpace;
2359 }
2360 SetTargetRect(rectText);
2361
2362 // relayout all lines
2363 if ( WrapLines() )
2364 {
2365 WData().m_rowFirstInvalid = 0;
2366
2367 // increase timestamp: this means that the lines which had been
2368 // laid out before will be relayd out the next time LayoutLines()
2369 // is called because their timestamp will be smaller than the
2370 // current one
2371 WData().m_timestamp++;
2372 }
2373 }
2374
2375 UpdateLastVisible();
2376 }
2377
2378 void wxTextCtrl::UpdateLastVisible()
2379 {
2380 // this method is only used for horizontal "scrollbarless" scrolling which
2381 // is used only with single line controls
2382 if ( !IsSingleLine() )
2383 return;
2384
2385 // use (efficient) HitTestLine to find the last visible character
2386 wxString text = m_value.Mid((size_t)SData().m_colStart /* to the end */);
2387 wxTextCoord col;
2388 switch ( HitTestLine(text, m_rectText.width, &col) )
2389 {
2390 case wxTE_HT_BEYOND:
2391 // everything is visible
2392 SData().m_colLastVisible = text.length();
2393
2394 // calc it below
2395 SData().m_posLastVisible = -1;
2396 break;
2397
2398 /*
2399 case wxTE_HT_BEFORE:
2400 case wxTE_HT_BELOW:
2401 */
2402 default:
2403 wxFAIL_MSG(_T("unexpected HitTestLine() return value"));
2404 // fall through
2405
2406 case wxTE_HT_ON_TEXT:
2407 if ( col > 0 )
2408 {
2409 // the last entirely seen character is the previous one because
2410 // this one is only partly visible - unless the width of the
2411 // string is exactly the max width
2412 SData().m_posLastVisible = GetTextWidth(text.Truncate(col + 1));
2413 if ( SData().m_posLastVisible > m_rectText.width )
2414 {
2415 // this character is not entirely visible, take the
2416 // previous one
2417 col--;
2418
2419 // recalc it
2420 SData().m_posLastVisible = -1;
2421 }
2422 //else: we can just see it
2423
2424 SData().m_colLastVisible = col;
2425 }
2426 break;
2427 }
2428
2429 // calculate the width of the text really shown
2430 if ( SData().m_posLastVisible == -1 )
2431 {
2432 SData().m_posLastVisible = GetTextWidth(text.Truncate(SData().m_colLastVisible + 1));
2433 }
2434
2435 // current value is relative the start of the string text which starts at
2436 // SData().m_colStart, we need an absolute offset into string
2437 SData().m_colLastVisible += SData().m_colStart;
2438
2439 wxLogTrace(_T("text"), _T("Last visible column/position is %d/%ld"),
2440 SData().m_colLastVisible, SData().m_posLastVisible);
2441 }
2442
2443 void wxTextCtrl::OnSize(wxSizeEvent& event)
2444 {
2445 UpdateTextRect();
2446
2447 if ( !IsSingleLine() )
2448 {
2449 #if 0
2450 // update them immediately because if we are called for the first time,
2451 // we need to create them in order for the base class version to
2452 // position the scrollbars correctly - if we don't do it now, it won't
2453 // happen at all if we don't get more size events
2454 UpdateScrollbars();
2455 #endif // 0
2456
2457 MData().m_updateScrollbarX =
2458 MData().m_updateScrollbarY = TRUE;
2459 }
2460
2461 event.Skip();
2462 }
2463
2464 wxCoord wxTextCtrl::GetTotalWidth() const
2465 {
2466 wxCoord w;
2467 CalcUnscrolledPosition(m_rectText.width, 0, &w, NULL);
2468 return w;
2469 }
2470
2471 wxCoord wxTextCtrl::GetTextWidth(const wxString& text) const
2472 {
2473 wxCoord w;
2474 GetTextExtent(GetTextToShow(text), &w, NULL);
2475 return w;
2476 }
2477
2478 wxRect wxTextCtrl::GetRealTextArea() const
2479 {
2480 // for single line text control it's just the same as text rect
2481 if ( IsSingleLine() )
2482 return m_rectText;
2483
2484 // the real text area always holds an entire number of lines, so the only
2485 // difference with the text area is a narrow strip along the bottom border
2486 wxRect rectText = MData().m_rectTextReal;
2487 if ( !rectText.width )
2488 {
2489 // recalculate it
2490 rectText = m_rectText;
2491
2492 // when we're called for the very first time, the line height might not
2493 // had been calculated yet, so do get it now
2494 wxTextCtrl *self = wxConstCast(this, wxTextCtrl);
2495 self->RecalcFontMetrics();
2496
2497 int hLine = GetLineHeight();
2498 rectText.height = (m_rectText.height / hLine) * hLine;
2499
2500 // cache the result
2501 self->MData().m_rectTextReal = rectText;
2502 }
2503
2504 return rectText;
2505 }
2506
2507 wxTextCoord wxTextCtrl::GetRowInLine(wxTextCoord line,
2508 wxTextCoord col,
2509 wxTextCoord *colRowStart) const
2510 {
2511 wxASSERT_MSG( WrapLines(), _T("shouldn't be called") );
2512
2513 const wxWrappedLineData& lineData = WData().m_linesData[line];
2514
2515 if ( !WData().IsValidLine(line) )
2516 LayoutLines(line);
2517
2518 // row is here counted a bit specially: 0 is the 2nd row of the line (1st
2519 // extra row)
2520 size_t row = 0,
2521 rowMax = lineData.GetExtraRowCount();
2522 if ( rowMax )
2523 {
2524 row = 0;
2525 while ( (row < rowMax) && (col >= lineData.GetExtraRowStart(row)) )
2526 row++;
2527
2528 // it's ok here that row is 1 greater than needed: like this, it is
2529 // counted as a normal (and not extra) row
2530 }
2531 //else: only one row anyhow
2532
2533 if ( colRowStart )
2534 {
2535 // +1 because we need a real row number, not the extra row one
2536 *colRowStart = lineData.GetRowStart(row);
2537
2538 // this can't happen, of course
2539 wxASSERT_MSG( *colRowStart <= col, _T("GetRowInLine() is broken") );
2540 }
2541
2542 return row;
2543 }
2544
2545 void wxTextCtrl::LayoutLine(wxTextCoord line, wxWrappedLineData& lineData) const
2546 {
2547 // FIXME: this uses old GetPartOfWrappedLine() which is not used anywhere
2548 // else now and has rather awkward interface for our needs here
2549
2550 lineData.m_rowsStart.Empty();
2551 lineData.m_rowsWidth.Empty();
2552
2553 const wxString& text = GetLineText(line);
2554 wxCoord widthRow;
2555 size_t colRowStart = 0;
2556 do
2557 {
2558 size_t lenRow = GetPartOfWrappedLine
2559 (
2560 text.c_str() + colRowStart,
2561 &widthRow
2562 );
2563
2564 // remember the start of this row (not for the first one as
2565 // it's always 0) and its width
2566 if ( colRowStart )
2567 lineData.m_rowsStart.Add(colRowStart);
2568 lineData.m_rowsWidth.Add(widthRow);
2569
2570 colRowStart += lenRow;
2571 }
2572 while ( colRowStart < text.length() );
2573
2574 // put the current timestamp on it
2575 lineData.m_timestamp = WData().m_timestamp;
2576 }
2577
2578 void wxTextCtrl::LayoutLines(wxTextCoord lineLast) const
2579 {
2580 wxASSERT_MSG( WrapLines(), _T("should only be used for line wrapping") );
2581
2582 // if we were called, some line was dirty and if it was dirty we must have
2583 // had m_rowFirstInvalid set to something too
2584 wxTextCoord lineFirst = WData().m_rowFirstInvalid;
2585 wxASSERT_MSG( lineFirst != -1, _T("nothing to layout?") );
2586
2587 wxTextCoord rowFirst, rowCur;
2588 if ( lineFirst )
2589 {
2590 // start after the last known valid line
2591 const wxWrappedLineData& lineData = WData().m_linesData[lineFirst - 1];
2592 rowFirst = lineData.GetFirstRow() + lineData.GetRowCount();
2593 }
2594 else // no valid lines, start at row 0
2595 {
2596 rowFirst = 0;
2597 }
2598
2599 rowCur = rowFirst;
2600 for ( wxTextCoord line = lineFirst; line <= lineLast; line++ )
2601 {
2602 // set the starting row for this line
2603 wxWrappedLineData& lineData = WData().m_linesData[line];
2604 lineData.m_rowFirst = rowCur;
2605
2606 // had the line been already broken into rows?
2607 //
2608 // if so, compare its timestamp with the current one: if nothing has
2609 // been changed, don't relayout it
2610 if ( !lineData.IsValid() ||
2611 (lineData.m_timestamp < WData().m_timestamp) )
2612 {
2613 // now do break it in rows
2614 LayoutLine(line, lineData);
2615 }
2616
2617 rowCur += lineData.GetRowCount();
2618 }
2619
2620 // we are now valid at least up to this line, but if it is the last one we
2621 // just don't have any more invalid rows at all
2622 if ( (size_t)lineLast == WData().m_linesData.GetCount() -1 )
2623 {
2624 lineLast = -1;
2625 }
2626
2627 wxTextCtrl *self = wxConstCast(this, wxTextCtrl);
2628 self->WData().m_rowFirstInvalid = lineLast;
2629
2630 // also refresh the line end indicators (FIXME shouldn't do it always!)
2631 self->RefreshLineWrapMarks(rowFirst, rowCur);
2632 }
2633
2634 size_t wxTextCtrl::GetPartOfWrappedLine(const wxChar* text,
2635 wxCoord *widthReal) const
2636 {
2637 // this function is slow, it shouldn't be called unless really needed
2638 wxASSERT_MSG( WrapLines(), _T("shouldn't be called") );
2639
2640 wxString s(text);
2641 wxTextCoord col;
2642 wxCoord wReal = -1;
2643 switch ( HitTestLine(s, m_rectText.width, &col) )
2644 {
2645 /*
2646 case wxTE_HT_BEFORE:
2647 case wxTE_HT_BELOW:
2648 */
2649 default:
2650 wxFAIL_MSG(_T("unexpected HitTestLine() return value"));
2651 // fall through
2652
2653 case wxTE_HT_ON_TEXT:
2654 if ( col > 0 )
2655 {
2656 // the last entirely seen character is the previous one because
2657 // this one is only partly visible - unless the width of the
2658 // string is exactly the max width
2659 wReal = GetTextWidth(s.Truncate(col + 1));
2660 if ( wReal > m_rectText.width )
2661 {
2662 // this character is not entirely visible, take the
2663 // previous one
2664 col--;
2665
2666 // recalc the width
2667 wReal = -1;
2668 }
2669 //else: we can just see it
2670
2671 // wrap at any character or only at words boundaries?
2672 if ( !(GetWindowStyle() & wxTE_LINEWRAP) )
2673 {
2674 // find the (last) not word char before this word
2675 wxTextCoord colWordStart;
2676 for ( colWordStart = col;
2677 colWordStart && IsWordChar(s[(size_t)colWordStart]);
2678 colWordStart-- )
2679 ;
2680
2681 if ( colWordStart > 0 )
2682 {
2683 if ( colWordStart != col )
2684 {
2685 // will have to recalc the real width
2686 wReal = -1;
2687
2688 col = colWordStart;
2689 }
2690 }
2691 //else: only a single word, have to wrap it here
2692 }
2693 }
2694 break;
2695
2696 case wxTE_HT_BEYOND:
2697 break;
2698 }
2699
2700 // we return the number of characters, not the index of the last one
2701 if ( (size_t)col < s.length() )
2702 {
2703 // but don't return more than this (empty) string has
2704 col++;
2705 }
2706
2707 if ( widthReal )
2708 {
2709 if ( wReal == -1 )
2710 {
2711 // calc it if not done yet
2712 wReal = GetTextWidth(s.Truncate(col));
2713 }
2714
2715 *widthReal = wReal;
2716 }
2717
2718 // VZ: old, horribly inefficient code which can still be used for checking
2719 // the result (in line, not word, wrap mode only) - to be removed later
2720 #if 0
2721 wxTextCtrl *self = wxConstCast(this, wxTextCtrl);
2722 wxClientDC dc(self);
2723 dc.SetFont(GetFont());
2724 self->DoPrepareDC(dc);
2725
2726 wxCoord widthMax = m_rectText.width;
2727
2728 // the text which we can keep in this ROW
2729 wxString str;
2730 wxCoord w, wOld;
2731 for ( wOld = w = 0; *text && (w <= widthMax); )
2732 {
2733 wOld = w;
2734 str += *text++;
2735 dc.GetTextExtent(str, &w, NULL);
2736 }
2737
2738 if ( w > widthMax )
2739 {
2740 // if we wrapped, the last letter was one too much
2741 if ( str.length() > 1 )
2742 {
2743 // remove it
2744 str.erase(str.length() - 1, 1);
2745 }
2746 else // but always keep at least one letter in each row
2747 {
2748 // the real width then is the last value of w and not teh one
2749 // before last
2750 wOld = w;
2751 }
2752 }
2753 else // we didn't wrap
2754 {
2755 wOld = w;
2756 }
2757
2758 wxASSERT( col == str.length() );
2759
2760 if ( widthReal )
2761 {
2762 wxASSERT( *widthReal == wOld );
2763
2764 *widthReal = wOld;
2765 }
2766
2767 //return str.length();
2768 #endif
2769
2770 return col;
2771 }
2772
2773 // OPT: this function is called a lot - would be nice to optimize it but I
2774 // don't really know how yet
2775 wxTextCtrlHitTestResult wxTextCtrl::HitTestLine(const wxString& line,
2776 wxCoord x,
2777 wxTextCoord *colOut) const
2778 {
2779 wxTextCtrlHitTestResult res = wxTE_HT_ON_TEXT;
2780
2781 int col;
2782 wxTextCtrl *self = wxConstCast(this, wxTextCtrl);
2783 wxClientDC dc(self);
2784 dc.SetFont(GetFont());
2785 self->DoPrepareDC(dc);
2786
2787 wxCoord width;
2788 dc.GetTextExtent(line, &width, NULL);
2789 if ( x >= width )
2790 {
2791 // clicking beyond the end of line is equivalent to clicking at
2792 // the end of it, so return the last line column
2793 col = line.length();
2794 if ( col )
2795 {
2796 // unless the line is empty and so doesn't have any column at all -
2797 // in this case return 0, what else can we do?
2798 col--;
2799 }
2800
2801 res = wxTE_HT_BEYOND;
2802 }
2803 else if ( x < 0 )
2804 {
2805 col = 0;
2806
2807 res = wxTE_HT_BEFORE;
2808 }
2809 else // we're inside the line
2810 {
2811 // now calculate the column: first, approximate it with fixed-width
2812 // value and then calculate the correct value iteratively: note that
2813 // we use the first character of the line instead of (average)
2814 // GetCharWidth(): it is common to have lines of dashes, for example,
2815 // and this should give us much better approximation in such case
2816 //
2817 // OPT: maybe using (cache) m_widthAvg would be still faster? profile!
2818 dc.GetTextExtent(line[0], &width, NULL);
2819
2820 col = x / width;
2821 if ( col < 0 )
2822 {
2823 col = 0;
2824 }
2825 else if ( (size_t)col > line.length() )
2826 {
2827 col = line.length();
2828 }
2829
2830 // matchDir is the direction in which we should move to reach the
2831 // character containing the given position
2832 enum
2833 {
2834 Match_Left = -1,
2835 Match_None = 0,
2836 Match_Right = 1
2837 } matchDir = Match_None;
2838 for ( ;; )
2839 {
2840 // check that we didn't go beyond the line boundary
2841 if ( col < 0 )
2842 {
2843 col = 0;
2844 break;
2845 }
2846 if ( (size_t)col > line.length() )
2847 {
2848 col = line.length();
2849 break;
2850 }
2851
2852 wxString strBefore(line, (size_t)col);
2853 dc.GetTextExtent(strBefore, &width, NULL);
2854 if ( width > x )
2855 {
2856 if ( matchDir == Match_Right )
2857 {
2858 // we were going to the right and, finally, moved beyond
2859 // the original position - stop on the previous one
2860 col--;
2861
2862 break;
2863 }
2864
2865 if ( matchDir == Match_None )
2866 {
2867 // we just started iterating, now we know that we should
2868 // move to the left
2869 matchDir = Match_Left;
2870 }
2871 //else: we are still to the right of the target, continue
2872 }
2873 else // width < x
2874 {
2875 // invert the logic above
2876 if ( matchDir == Match_Left )
2877 {
2878 // with the exception that we don't need to backtrack here
2879 break;
2880 }
2881
2882 if ( matchDir == Match_None )
2883 {
2884 // go to the right
2885 matchDir = Match_Right;
2886 }
2887 }
2888
2889 // this is not supposed to happen
2890 wxASSERT_MSG( matchDir, _T("logic error in wxTextCtrl::HitTest") );
2891
2892 if ( matchDir == Match_Right )
2893 col++;
2894 else
2895 col--;
2896 }
2897 }
2898
2899 // check that we calculated it correctly
2900 #ifdef WXDEBUG_TEXT
2901 if ( res == wxTE_HT_ON_TEXT )
2902 {
2903 wxCoord width1;
2904 wxString text = line.Left(col);
2905 dc.GetTextExtent(text, &width1, NULL);
2906 if ( (size_t)col < line.length() )
2907 {
2908 wxCoord width2;
2909
2910 text += line[col];
2911 dc.GetTextExtent(text, &width2, NULL);
2912
2913 wxASSERT_MSG( (width1 <= x) && (x < width2),
2914 _T("incorrect HitTestLine() result") );
2915 }
2916 else // we return last char
2917 {
2918 wxASSERT_MSG( x >= width1, _T("incorrect HitTestLine() result") );
2919 }
2920 }
2921 #endif // WXDEBUG_TEXT
2922
2923 if ( colOut )
2924 *colOut = col;
2925
2926 return res;
2927 }
2928
2929 wxTextCtrlHitTestResult wxTextCtrl::HitTest(const wxPoint& pos,
2930 wxTextCoord *colOut,
2931 wxTextCoord *rowOut) const
2932 {
2933 return HitTest2(pos.y, pos.x, 0, rowOut, colOut, NULL, NULL);
2934 }
2935
2936 wxTextCtrlHitTestResult wxTextCtrl::HitTestLogical(const wxPoint& pos,
2937 wxTextCoord *colOut,
2938 wxTextCoord *rowOut) const
2939 {
2940 return HitTest2(pos.y, pos.x, 0, rowOut, colOut, NULL, NULL, FALSE);
2941 }
2942
2943 wxTextCtrlHitTestResult wxTextCtrl::HitTest2(wxCoord y0,
2944 wxCoord x10,
2945 wxCoord x20,
2946 wxTextCoord *rowOut,
2947 wxTextCoord *colStart,
2948 wxTextCoord *colEnd,
2949 wxTextCoord *colRowStartOut,
2950 bool deviceCoords) const
2951 {
2952 // is the point in the text area or to the right or below it?
2953 wxTextCtrlHitTestResult res = wxTE_HT_ON_TEXT;
2954
2955 // translate the window coords x0 and y0 into the client coords in the text
2956 // area by adjusting for both the client and text area offsets (unless this
2957 // was already done)
2958 int x1, y;
2959 if ( deviceCoords )
2960 {
2961 wxPoint pt = GetClientAreaOrigin() + m_rectText.GetPosition();
2962 CalcUnscrolledPosition(x10 - pt.x, y0 - pt.y, &x1, &y);
2963 }
2964 else
2965 {
2966 y = y0;
2967 x1 = x10;
2968 }
2969
2970 // calculate the row (it is really a LINE, not a ROW)
2971 wxTextCoord row;
2972
2973 // these vars are used only for WrapLines() case
2974 wxTextCoord colRowStart = 0;
2975 size_t rowLen = 0;
2976
2977 if ( colRowStartOut )
2978 *colRowStartOut = 0;
2979
2980 int hLine = GetLineHeight();
2981 if ( y < 0 )
2982 {
2983 // and clicking before it is the same as clicking on the first one
2984 row = 0;
2985
2986 res = wxTE_HT_BEFORE;
2987 }
2988 else // y >= 0
2989 {
2990 wxTextCoord rowLast = GetNumberOfLines() - 1;
2991 row = y / hLine;
2992 if ( IsSingleLine() || !WrapLines() )
2993 {
2994 // in this case row calculation is simple as all lines have the
2995 // same height and so row is the same as line
2996 if ( row > rowLast )
2997 {
2998 // clicking below the text is the same as clicking on the last
2999 // line
3000 row = rowLast;
3001
3002 res = wxTE_HT_BELOW;
3003 }
3004 }
3005 else // multline control with line wrap
3006 {
3007 // use binary search to find the line containing this row
3008 const wxArrayWrappedLinesData& linesData = WData().m_linesData;
3009 size_t lo = 0,
3010 hi = linesData.GetCount(),
3011 cur;
3012 while ( lo < hi )
3013 {
3014 cur = (lo + hi)/2;
3015 const wxWrappedLineData& lineData = linesData[cur];
3016 if ( !WData().IsValidLine(cur) )
3017 LayoutLines(cur);
3018 wxTextCoord rowFirst = lineData.GetFirstRow();
3019
3020 if ( row < rowFirst )
3021 {
3022 hi = cur;
3023 }
3024 else
3025 {
3026 // our row is after the first row of the cur line:
3027 // obviously, if cur is the last line, it contains this
3028 // row, otherwise we have to test that it is before the
3029 // first row of the next line
3030 bool found = cur == linesData.GetCount() - 1;
3031 if ( found )
3032 {
3033 // if the row is beyond the end of text, adjust it to
3034 // be the last one and set res accordingly
3035 if ( (size_t)(row - rowFirst) >= lineData.GetRowCount() )
3036 {
3037 res = wxTE_HT_BELOW;
3038
3039 row = lineData.GetRowCount() + rowFirst - 1;
3040 }
3041 }
3042 else // not the last row
3043 {
3044 const wxWrappedLineData&
3045 lineNextData = linesData[cur + 1];
3046 if ( !WData().IsValidLine(cur + 1) )
3047 LayoutLines(cur + 1);
3048 found = row < lineNextData.GetFirstRow();
3049 }
3050
3051 if ( found )
3052 {
3053 colRowStart = lineData.GetRowStart(row - rowFirst);
3054 rowLen = lineData.GetRowLength(row - rowFirst,
3055 GetLines()[cur].length());
3056 row = cur;
3057
3058 break;
3059 }
3060 else
3061 {
3062 lo = cur;
3063 }
3064 }
3065 }
3066 }
3067 }
3068
3069 if ( res == wxTE_HT_ON_TEXT )
3070 {
3071 // now find the position in the line
3072 wxString lineText = GetLineText(row),
3073 rowText;
3074
3075 if ( colRowStart || rowLen )
3076 {
3077 // look in this row only, not in whole line
3078 rowText = lineText.Mid(colRowStart, rowLen);
3079 }
3080 else
3081 {
3082 // just take the whole string
3083 rowText = lineText;
3084 }
3085
3086 if ( colStart )
3087 {
3088 res = HitTestLine(GetTextToShow(rowText), x1, colStart);
3089
3090 if ( colRowStart )
3091 {
3092 if ( colRowStartOut )
3093 {
3094 // give them the column offset in this ROW in pixels
3095 *colRowStartOut = colRowStart;
3096 }
3097
3098 // take into account that the ROW doesn't start in the
3099 // beginning of the LINE
3100 *colStart += colRowStart;
3101 }
3102
3103 if ( colEnd )
3104 {
3105 // the hit test result we return is for x1, so throw out
3106 // the result for x2 here
3107 int x2 = x1 + x20 - x10;
3108 (void)HitTestLine(GetTextToShow(rowText), x2, colEnd);
3109
3110 *colEnd += colRowStart;
3111 }
3112 }
3113 }
3114 else // before/after vertical text span
3115 {
3116 if ( colStart )
3117 {
3118 // fill the column with the first/last position in the
3119 // corresponding line
3120 if ( res == wxTE_HT_BEFORE )
3121 *colStart = 0;
3122 else // res == wxTE_HT_BELOW
3123 *colStart = GetLineText(GetNumberOfLines() - 1).length();
3124 }
3125 }
3126
3127 if ( rowOut )
3128 {
3129 // give them the row in text coords (as is)
3130 *rowOut = row;
3131 }
3132
3133 return res;
3134 }
3135
3136 bool wxTextCtrl::GetLineAndRow(wxTextCoord row,
3137 wxTextCoord *lineOut,
3138 wxTextCoord *rowInLineOut) const
3139 {
3140 wxTextCoord line,
3141 rowInLine = 0;
3142
3143 if ( row < 0 )
3144 return FALSE;
3145
3146 int nLines = GetNumberOfLines();
3147 if ( WrapLines() )
3148 {
3149 const wxArrayWrappedLinesData& linesData = WData().m_linesData;
3150 for ( line = 0; line < nLines; line++ )
3151 {
3152 if ( !WData().IsValidLine(line) )
3153 LayoutLines(line);
3154
3155 if ( row < linesData[line].GetNextRow() )
3156 {
3157 // we found the right line
3158 rowInLine = row - linesData[line].GetFirstRow();
3159
3160 break;
3161 }
3162 }
3163
3164 if ( line == nLines )
3165 {
3166 // the row is out of range
3167 return FALSE;
3168 }
3169 }
3170 else // no line wrapping, everything is easy
3171 {
3172 if ( row >= nLines )
3173 return FALSE;
3174
3175 line = row;
3176 }
3177
3178 if ( lineOut )
3179 *lineOut = line;
3180 if ( rowInLineOut )
3181 *rowInLineOut = rowInLine;
3182
3183 return TRUE;
3184 }
3185
3186 // ----------------------------------------------------------------------------
3187 // scrolling
3188 // ----------------------------------------------------------------------------
3189
3190 /*
3191 wxTextCtrl has not one but two scrolling mechanisms: one is semi-automatic
3192 scrolling in both horizontal and vertical direction implemented using
3193 wxScrollHelper and the second one is manual scrolling implemented using
3194 SData().m_ofsHorz and used by the single line controls without scroll bar.
3195
3196 The first version (the standard one) always scrolls by fixed amount which is
3197 fine for vertical scrolling as all lines have the same height but is rather
3198 ugly for horizontal scrolling if proportional font is used. This is why we
3199 manually update and use SData().m_ofsHorz which contains the length of the string
3200 which is hidden beyond the left borde. An important property of text
3201 controls using this kind of scrolling is that an entire number of characters
3202 is always shown and that parts of characters never appear on display -
3203 neither in the leftmost nor rightmost positions.
3204
3205 Once again, for multi line controls SData().m_ofsHorz is always 0 and scrolling is
3206 done as usual for wxScrollWindow.
3207 */
3208
3209 void wxTextCtrl::ShowHorzPosition(wxCoord pos)
3210 {
3211 wxASSERT_MSG( IsSingleLine(), _T("doesn't work for multiline") );
3212
3213 // pos is the logical position to show
3214
3215 // SData().m_ofsHorz is the fisrt logical position shown
3216 if ( pos < SData().m_ofsHorz )
3217 {
3218 // scroll backwards
3219 wxTextCoord col;
3220 HitTestLine(m_value, pos, &col);
3221 ScrollText(col);
3222 }
3223 else
3224 {
3225 wxCoord width = m_rectText.width;
3226 if ( !width )
3227 {
3228 // if we are called from the ctor, m_rectText is not initialized
3229 // yet, so do it now
3230 UpdateTextRect();
3231 width = m_rectText.width;
3232 }
3233
3234 // SData().m_ofsHorz + width is the last logical position shown
3235 if ( pos > SData().m_ofsHorz + width)
3236 {
3237 // scroll forward
3238 wxTextCoord col;
3239 HitTestLine(m_value, pos - width, &col);
3240 ScrollText(col + 1);
3241 }
3242 }
3243 }
3244
3245 // scroll the window horizontally so that the first visible character becomes
3246 // the one at this position
3247 void wxTextCtrl::ScrollText(wxTextCoord col)
3248 {
3249 wxASSERT_MSG( IsSingleLine(),
3250 _T("ScrollText() is for single line controls only") );
3251
3252 // never scroll beyond the left border
3253 if ( col < 0 )
3254 col = 0;
3255
3256 // OPT: could only get the extent of the part of the string between col
3257 // and SData().m_colStart
3258 wxCoord ofsHorz = GetTextWidth(GetLineText(0).Left(col));
3259
3260 if ( ofsHorz != SData().m_ofsHorz )
3261 {
3262 // remember the last currently used pixel
3263 int posLastVisible = SData().m_posLastVisible;
3264 if ( posLastVisible == -1 )
3265 {
3266 // this may happen when we're called very early, during the
3267 // controls construction
3268 UpdateLastVisible();
3269
3270 posLastVisible = SData().m_posLastVisible;
3271 }
3272
3273 // NB1: to scroll to the right, offset must be negative, hence the
3274 // order of operands
3275 int dx = SData().m_ofsHorz - ofsHorz;
3276
3277 // NB2: we call Refresh() below which results in a call to
3278 // DoDraw(), so we must update SData().m_ofsHorz before calling it
3279 SData().m_ofsHorz = ofsHorz;
3280 SData().m_colStart = col;
3281
3282 // after changing m_colStart, recalc the last visible position: we need
3283 // to recalc the last visible position beore scrolling in order to make
3284 // it appear exactly at the right edge of the text area after scrolling
3285 UpdateLastVisible();
3286
3287 #if 0 // do we?
3288 if ( dx < 0 )
3289 {
3290 // we want to force the update of it after scrolling
3291 SData().m_colLastVisible = -1;
3292 }
3293 #endif
3294
3295 // scroll only the rectangle inside which there is the text
3296 wxRect rect = m_rectText;
3297 rect.width = posLastVisible;
3298
3299 rect = ScrollNoRefresh(dx, 0, &rect);
3300
3301 /*
3302 we need to manually refresh the part which ScrollWindow() doesn't
3303 refresh (with new API this means the part outside the rect returned
3304 by ScrollNoRefresh): indeed, if we had this:
3305
3306 ********o
3307
3308 where '*' is text and 'o' is blank area at the end (too small to
3309 hold the next char) then after scrolling by 2 positions to the left
3310 we're going to have
3311
3312 ******RRo
3313
3314 where 'R' is the area refreshed by ScrollWindow() - but we still
3315 need to refresh the 'o' at the end as it may be now big enough to
3316 hold the new character shifted into view.
3317
3318 when we are scrolling to the right, we need to update this rect as
3319 well because it might have contained something before but doesn't
3320 contain anything any more
3321 */
3322
3323 // we can combine both rectangles into one when scrolling to the left,
3324 // but we need two separate Refreshes() otherwise
3325 if ( dx > 0 )
3326 {
3327 // refresh the uncovered part on the left
3328 Refresh(TRUE, &rect);
3329
3330 // and now the area on the right
3331 rect.x = m_rectText.x + posLastVisible;
3332 rect.width = m_rectText.width - posLastVisible;
3333 }
3334 else // scrolling to the left
3335 {
3336 // just extend the rect covering the uncovered area to the edge of
3337 // the text rect
3338 rect.width += m_rectText.width - posLastVisible;
3339 }
3340
3341 Refresh(TRUE, &rect);
3342
3343 // I don't know exactly why is this needed here but without it we may
3344 // scroll the window again (from the same method) before the previously
3345 // invalidated area is repainted when typing *very* quickly - and this
3346 // may lead to the display corruption
3347 Update();
3348 }
3349 }
3350
3351 void wxTextCtrl::CalcUnscrolledPosition(int x, int y, int *xx, int *yy) const
3352 {
3353 if ( IsSingleLine() )
3354 {
3355 // we don't use wxScrollHelper
3356 if ( xx )
3357 *xx = x + SData().m_ofsHorz;
3358 if ( yy )
3359 *yy = y;
3360 }
3361 else
3362 {
3363 // let the base class do it
3364 wxScrollHelper::CalcUnscrolledPosition(x, y, xx, yy);
3365 }
3366 }
3367
3368 void wxTextCtrl::CalcScrolledPosition(int x, int y, int *xx, int *yy) const
3369 {
3370 if ( IsSingleLine() )
3371 {
3372 // we don't use wxScrollHelper
3373 if ( xx )
3374 *xx = x - SData().m_ofsHorz;
3375 if ( yy )
3376 *yy = y;
3377 }
3378 else
3379 {
3380 // let the base class do it
3381 wxScrollHelper::CalcScrolledPosition(x, y, xx, yy);
3382 }
3383 }
3384
3385 void wxTextCtrl::DoPrepareDC(wxDC& dc)
3386 {
3387 // for single line controls we only have to deal with SData().m_ofsHorz and it's
3388 // useless to call base class version as they don't use normal scrolling
3389 if ( IsSingleLine() && SData().m_ofsHorz )
3390 {
3391 // adjust the DC origin if the text is shifted
3392 wxPoint pt = dc.GetDeviceOrigin();
3393 dc.SetDeviceOrigin(pt.x - SData().m_ofsHorz, pt.y);
3394 }
3395 else
3396 {
3397 wxScrollHelper::DoPrepareDC(dc);
3398 }
3399 }
3400
3401 void wxTextCtrl::UpdateMaxWidth(wxTextCoord line)
3402 {
3403 // OPT!
3404
3405 // check if the max width changes after this line was modified
3406 wxCoord widthMaxOld = MData().m_widthMax,
3407 width;
3408 GetTextExtent(GetLineText(line), &width, NULL);
3409
3410 if ( line == MData().m_lineLongest )
3411 {
3412 // this line was the longest one, is it still?
3413 if ( width > MData().m_widthMax )
3414 {
3415 MData().m_widthMax = width;
3416 }
3417 else if ( width < MData().m_widthMax )
3418 {
3419 // we need to find the new longest line
3420 RecalcMaxWidth();
3421 }
3422 //else: its length didn't change, nothing to do
3423 }
3424 else // it wasn't the longest line, but maybe it became it?
3425 {
3426 // GetMaxWidth() and not MData().m_widthMax as it might be not calculated yet
3427 if ( width > GetMaxWidth() )
3428 {
3429 MData().m_widthMax = width;
3430 MData().m_lineLongest = line;
3431 }
3432 }
3433
3434 MData().m_updateScrollbarX = MData().m_widthMax != widthMaxOld;
3435 }
3436
3437 void wxTextCtrl::RecalcFontMetrics()
3438 {
3439 m_heightLine = GetCharHeight();
3440 m_widthAvg = GetCharWidth();
3441 }
3442
3443 void wxTextCtrl::RecalcMaxWidth()
3444 {
3445 wxASSERT_MSG( !IsSingleLine(), _T("only used for multiline") );
3446
3447 MData().m_widthMax = -1;
3448 (void)GetMaxWidth();
3449 }
3450
3451 wxCoord wxTextCtrl::GetMaxWidth() const
3452 {
3453 if ( MData().m_widthMax == -1 )
3454 {
3455 // recalculate it
3456
3457 // OPT: should we remember the widths of all the lines?
3458
3459 wxTextCtrl *self = wxConstCast(this, wxTextCtrl);
3460 wxClientDC dc(self);
3461 dc.SetFont(GetFont());
3462
3463 self->MData().m_widthMax = 0;
3464
3465 size_t count = GetLineCount();
3466 for ( size_t n = 0; n < count; n++ )
3467 {
3468 wxCoord width;
3469 dc.GetTextExtent(GetLines()[n], &width, NULL);
3470 if ( width > MData().m_widthMax )
3471 {
3472 // remember the width and the line which has it
3473 self->MData().m_widthMax = width;
3474 self->MData().m_lineLongest = n;
3475 }
3476 }
3477 }
3478
3479 wxASSERT_MSG( MData().m_widthMax != -1, _T("should have at least 1 line") );
3480
3481 return MData().m_widthMax;
3482 }
3483
3484 void wxTextCtrl::UpdateScrollbars()
3485 {
3486 wxASSERT_MSG( !IsSingleLine(), _T("only used for multiline") );
3487
3488 wxSize size = GetRealTextArea().GetSize();
3489
3490 // is our height enough to show all items?
3491 wxTextCoord nRows = GetRowCount();
3492 wxCoord lineHeight = GetLineHeight();
3493 bool showScrollbarY = nRows*lineHeight > size.y;
3494
3495 // is our width enough to show the longest line?
3496 wxCoord charWidth, maxWidth;
3497 bool showScrollbarX;
3498 if ( !WrapLines() )
3499 {
3500 charWidth = GetAverageWidth();
3501 maxWidth = GetMaxWidth();
3502 showScrollbarX = maxWidth > size.x;
3503 }
3504 else // never show the horz scrollbar
3505 {
3506 // just to suppress compiler warnings about using uninit vars below
3507 charWidth = maxWidth = 0;
3508
3509 showScrollbarX = FALSE;
3510 }
3511
3512 // calc the scrollbars ranges
3513 int scrollRangeX = showScrollbarX
3514 ? (maxWidth + 2*charWidth - 1) / charWidth
3515 : 0;
3516 int scrollRangeY = showScrollbarY ? nRows : 0;
3517
3518 int scrollRangeXOld = MData().m_scrollRangeX,
3519 scrollRangeYOld = MData().m_scrollRangeY;
3520 if ( (scrollRangeY != scrollRangeYOld) || (scrollRangeX != scrollRangeXOld) )
3521 {
3522 int x, y;
3523 GetViewStart(&x, &y);
3524
3525 #if 0
3526 // we want to leave the scrollbars at the same position which means
3527 // that x and y have to be adjusted as the number of positions may have
3528 // changed
3529 //
3530 // the number of positions is calculated from knowing that last
3531 // position = range - thumbSize and thumbSize == pageSize which is
3532 // equal to the window width / pixelsPerLine
3533 if ( scrollRangeXOld )
3534 {
3535 x *= scrollRangeX - m_rectText.width / charWidth;
3536 x /= scrollRangeXOld - m_rectText.width / charWidth;
3537 }
3538
3539 if ( scrollRangeYOld )
3540 y *= scrollRangeY / scrollRangeYOld;
3541 #endif // 0
3542
3543 SetScrollbars(charWidth, lineHeight,
3544 scrollRangeX, scrollRangeY,
3545 x, y,
3546 TRUE /* no refresh */);
3547
3548 if ( scrollRangeXOld )
3549 {
3550 x *= scrollRangeX - m_rectText.width / charWidth;
3551 x /= scrollRangeXOld - m_rectText.width / charWidth;
3552 Scroll(x, y);
3553 }
3554
3555 MData().m_scrollRangeX = scrollRangeX;
3556 MData().m_scrollRangeY = scrollRangeY;
3557
3558 // bring the current position in view
3559 ShowPosition(-1);
3560 }
3561
3562 MData().m_updateScrollbarX =
3563 MData().m_updateScrollbarY = FALSE;
3564 }
3565
3566 void wxTextCtrl::OnIdle(wxIdleEvent& event)
3567 {
3568 // notice that single line text control never has scrollbars
3569 if ( !IsSingleLine() &&
3570 (MData().m_updateScrollbarX || MData().m_updateScrollbarY) )
3571 {
3572 UpdateScrollbars();
3573 }
3574
3575 event.Skip();
3576 }
3577
3578 bool wxTextCtrl::SendAutoScrollEvents(wxScrollWinEvent& event) const
3579 {
3580 bool forward = event.GetEventType() == wxEVT_SCROLLWIN_LINEDOWN;
3581 if ( event.GetOrientation() == wxHORIZONTAL )
3582 {
3583 return forward ? m_curCol <= GetLineLength(m_curRow) : m_curCol > 0;
3584 }
3585 else // wxVERTICAL
3586 {
3587 return forward ? m_curRow < GetNumberOfLines() : m_curRow > 0;
3588 }
3589 }
3590
3591 // ----------------------------------------------------------------------------
3592 // refresh
3593 // ----------------------------------------------------------------------------
3594
3595 void wxTextCtrl::RefreshSelection()
3596 {
3597 if ( HasSelection() )
3598 {
3599 RefreshTextRange(m_selStart, m_selEnd);
3600 }
3601 }
3602
3603 void wxTextCtrl::RefreshLineRange(wxTextCoord lineFirst, wxTextCoord lineLast)
3604 {
3605 wxASSERT_MSG( lineFirst <= lineLast || !lineLast,
3606 _T("no lines to refresh") );
3607
3608 wxRect rect;
3609 // rect.x is already 0
3610 rect.width = m_rectText.width;
3611 wxCoord h = GetLineHeight();
3612
3613 wxTextCoord rowFirst;
3614 if ( lineFirst < GetNumberOfLines() )
3615 {
3616 rowFirst = GetFirstRowOfLine(lineFirst);
3617 }
3618 else // lineFirst == GetNumberOfLines()
3619 {
3620 // lineFirst may be beyond the last line only if we refresh till
3621 // the end, otherwise it's illegal
3622 wxASSERT_MSG( lineFirst == GetNumberOfLines() && !lineLast,
3623 _T("invalid line range") );
3624
3625 rowFirst = GetRowAfterLine(lineFirst - 1);
3626 }
3627
3628 rect.y = rowFirst*h;
3629
3630 if ( lineLast )
3631 {
3632 // refresh till this line (inclusive)
3633 wxTextCoord rowLast = GetRowAfterLine(lineLast);
3634
3635 rect.height = (rowLast - rowFirst + 1)*h;
3636 }
3637 else // lineLast == 0 means to refresh till the end
3638 {
3639 // FIXME: calc it exactly
3640 rect.height = 32000;
3641 }
3642
3643 RefreshTextRect(rect);
3644 }
3645
3646 void wxTextCtrl::RefreshTextRange(wxTextPos start, wxTextPos end)
3647 {
3648 wxCHECK_RET( start != -1 && end != -1,
3649 _T("invalid RefreshTextRange() arguments") );
3650
3651 // accept arguments in any order as it is more conenient for the caller
3652 OrderPositions(start, end);
3653
3654 // this is acceptable but we don't do anything in this case
3655 if ( start == end )
3656 return;
3657
3658 wxTextPos colStart, lineStart;
3659 if ( !PositionToXY(start, &colStart, &lineStart) )
3660 {
3661 // the range is entirely beyond the end of the text, nothing to do
3662 return;
3663 }
3664
3665 wxTextCoord colEnd, lineEnd;
3666 if ( !PositionToXY(end, &colEnd, &lineEnd) )
3667 {
3668 // the range spans beyond the end of text, refresh to the end
3669 colEnd = -1;
3670 lineEnd = GetNumberOfLines() - 1;
3671 }
3672
3673 // refresh all lines one by one
3674 for ( wxTextCoord line = lineStart; line <= lineEnd; line++ )
3675 {
3676 // refresh the first line from the start of the range to the end, the
3677 // intermediate ones entirely and the last one from the beginning to
3678 // the end of the range
3679 wxTextPos posStart = line == lineStart ? colStart : 0;
3680 size_t posCount;
3681 if ( (line != lineEnd) || (colEnd == -1) )
3682 {
3683 // intermediate line or the last one but we need to refresh it
3684 // until the end anyhow - do it
3685 posCount = wxSTRING_MAXLEN;
3686 }
3687 else // last line
3688 {
3689 // refresh just the positions in between the start and the end one
3690 posCount = colEnd - posStart;
3691 }
3692
3693 if ( posCount )
3694 RefreshColRange(line, posStart, posCount);
3695 }
3696 }
3697
3698 void wxTextCtrl::RefreshColRange(wxTextCoord line,
3699 wxTextPos start,
3700 size_t count)
3701 {
3702 wxString text = GetLineText(line);
3703
3704 wxASSERT_MSG( (size_t)start <= text.length() && count,
3705 _T("invalid RefreshColRange() parameter") );
3706
3707 RefreshPixelRange(line,
3708 GetTextWidth(text.Left((size_t)start)),
3709 GetTextWidth(text.Mid((size_t)start, (size_t)count)));
3710 }
3711
3712 // this method accepts "logical" coords in the sense that they are coordinates
3713 // in a logical line but it can span several rows if we wrap lines and
3714 // RefreshPixelRange() will then refresh several rows
3715 void wxTextCtrl::RefreshPixelRange(wxTextCoord line,
3716 wxCoord start,
3717 wxCoord width)
3718 {
3719 // we will use line text only in line wrap case
3720 wxString text;
3721 if ( WrapLines() )
3722 {
3723 text = GetLineText(line);
3724 }
3725
3726 // special case: width == 0 means to refresh till the end of line
3727 if ( width == 0 )
3728 {
3729 // refresh till the end of visible line
3730 width = GetTotalWidth();
3731
3732 if ( WrapLines() )
3733 {
3734 // refresh till the end of text
3735 wxCoord widthAll = GetTextWidth(text);
3736
3737 // extend width to the end of ROW
3738 width = widthAll - widthAll % width + width;
3739 }
3740
3741 // no need to refresh beyond the end of line
3742 width -= start;
3743 }
3744 //else: just refresh the specified part
3745
3746 wxCoord h = GetLineHeight();
3747 wxRect rect;
3748 rect.x = start;
3749 rect.y = GetFirstRowOfLine(line)*h;
3750 rect.height = h;
3751
3752 if ( WrapLines() )
3753 {
3754 // (1) skip all rows which we don't touch at all
3755 const wxWrappedLineData& lineData = WData().m_linesData[line];
3756 if ( !WData().IsValidLine(line) )
3757 LayoutLines(line);
3758
3759 wxCoord wLine = 0; // suppress compiler warning about uninit var
3760 size_t rowLast = lineData.GetRowCount(),
3761 row = 0;
3762 while ( (row < rowLast) &&
3763 (rect.x > (wLine = lineData.GetRowWidth(row++))) )
3764 {
3765 rect.x -= wLine;
3766 rect.y += h;
3767 }
3768
3769 // (2) now refresh all lines except the last one: note that the first
3770 // line is refreshed from the given start to the end, all the next
3771 // ones - entirely
3772 while ( (row < rowLast) && (width > wLine - rect.x) )
3773 {
3774 rect.width = GetTotalWidth() - rect.x;
3775 RefreshTextRect(rect);
3776
3777 width -= wLine - rect.x;
3778 rect.x = 0;
3779 rect.y += h;
3780
3781 wLine = lineData.GetRowWidth(row++);
3782 }
3783
3784 // (3) the code below will refresh the last line
3785 }
3786
3787 rect.width = width;
3788
3789 RefreshTextRect(rect);
3790 }
3791
3792 void wxTextCtrl::RefreshTextRect(const wxRect& rectClient, bool textOnly)
3793 {
3794 wxRect rect;
3795 CalcScrolledPosition(rectClient.x, rectClient.y, &rect.x, &rect.y);
3796 rect.width = rectClient.width;
3797 rect.height = rectClient.height;
3798
3799 // account for the text area offset
3800 rect.Offset(m_rectText.GetPosition());
3801
3802 // don't refresh beyond the text area unless we're refreshing the line wrap
3803 // marks in which case textOnly is FALSE
3804 if ( textOnly )
3805 {
3806 if ( rect.GetRight() > m_rectText.GetRight() )
3807 {
3808 rect.SetRight(m_rectText.GetRight());
3809
3810 if ( rect.width <= 0 )
3811 {
3812 // nothing to refresh
3813 return;
3814 }
3815 }
3816 }
3817
3818 // check the bottom boundary always, even for the line wrap marks
3819 if ( rect.GetBottom() > m_rectText.GetBottom() )
3820 {
3821 rect.SetBottom(m_rectText.GetBottom());
3822
3823 if ( rect.height <= 0 )
3824 {
3825 // nothing to refresh
3826 return;
3827 }
3828 }
3829
3830 // never refresh before the visible rect
3831 if ( rect.x < m_rectText.x )
3832 rect.x = m_rectText.x;
3833
3834 if ( rect.y < m_rectText.y )
3835 rect.y = m_rectText.y;
3836
3837 wxLogTrace(_T("text"), _T("Refreshing (%d, %d)-(%d, %d)"),
3838 rect.x, rect.y, rect.x + rect.width, rect.y + rect.height);
3839
3840 Refresh(TRUE, &rect);
3841 }
3842
3843 void wxTextCtrl::RefreshLineWrapMarks(wxTextCoord rowFirst,
3844 wxTextCoord rowLast)
3845 {
3846 if ( WData().m_widthMark )
3847 {
3848 wxRect rectMarks;
3849 rectMarks.x = m_rectText.width;
3850 rectMarks.width = WData().m_widthMark;
3851 rectMarks.y = rowFirst*GetLineHeight();
3852 rectMarks.height = (rowLast - rowFirst)*GetLineHeight();
3853
3854 RefreshTextRect(rectMarks, FALSE /* don't limit to text area */);
3855 }
3856 }
3857
3858 // ----------------------------------------------------------------------------
3859 // border drawing
3860 // ----------------------------------------------------------------------------
3861
3862 void wxTextCtrl::DoDrawBorder(wxDC& dc, const wxRect& rect)
3863 {
3864 m_renderer->DrawTextBorder(dc, GetBorder(), rect, GetStateFlags());
3865 }
3866
3867 // ----------------------------------------------------------------------------
3868 // client area drawing
3869 // ----------------------------------------------------------------------------
3870
3871 /*
3872 Several remarks about wxTextCtrl redraw logic:
3873
3874 1. only the regions which must be updated are redrawn, this means that we
3875 never Refresh() the entire window but use RefreshPixelRange() and
3876 ScrollWindow() which only refresh small parts of it and iterate over the
3877 update region in our DoDraw()
3878
3879 2. the text displayed on the screen is obtained using GetTextToShow(): it
3880 should be used for all drawing/measuring
3881 */
3882
3883 wxString wxTextCtrl::GetTextToShow(const wxString& text) const
3884 {
3885 wxString textShown;
3886 if ( IsPassword() )
3887 textShown = wxString(_T('*'), text.length());
3888 else
3889 textShown = text;
3890
3891 return textShown;
3892 }
3893
3894 void wxTextCtrl::DoDrawTextInRect(wxDC& dc, const wxRect& rectUpdate)
3895 {
3896 // debugging trick to see the update rect visually
3897 #ifdef WXDEBUG_TEXT
3898 static int s_countUpdates = -1;
3899 if ( s_countUpdates != -1 )
3900 {
3901 wxWindowDC dc(this);
3902 dc.SetBrush(*(++s_countUpdates % 2 ? wxRED_BRUSH : wxGREEN_BRUSH));
3903 dc.SetPen(*wxTRANSPARENT_PEN);
3904 dc.DrawRectangle(rectUpdate);
3905 }
3906 #endif // WXDEBUG_TEXT
3907
3908 // calculate the range lineStart..lineEnd of lines to redraw
3909 wxTextCoord lineStart, lineEnd;
3910 if ( IsSingleLine() )
3911 {
3912 lineStart =
3913 lineEnd = 0;
3914 }
3915 else // multiline
3916 {
3917 wxPoint pt = rectUpdate.GetPosition();
3918 (void)HitTest(pt, NULL, &lineStart);
3919
3920 pt.y += rectUpdate.height;
3921 (void)HitTest(pt, NULL, &lineEnd);
3922 }
3923
3924 // prepare for drawing
3925 wxCoord hLine = GetLineHeight();
3926
3927 // these vars will be used for hit testing of the current row
3928 wxCoord y = rectUpdate.y;
3929 const wxCoord x1 = rectUpdate.x;
3930 const wxCoord x2 = rectUpdate.x + rectUpdate.width;
3931
3932 wxRect rectText;
3933 rectText.height = hLine;
3934 wxCoord yClient = y - GetClientAreaOrigin().y;
3935
3936 // we want to always start at the top of the line, otherwise if we redraw a
3937 // rect whose top is in the middle of a line, we'd draw this line shifted
3938 yClient -= (yClient - m_rectText.y) % hLine;
3939
3940 if ( IsSingleLine() )
3941 {
3942 rectText.y = yClient;
3943 }
3944 else // multiline, adjust for scrolling
3945 {
3946 CalcUnscrolledPosition(0, yClient, NULL, &rectText.y);
3947 }
3948
3949 wxRenderer *renderer = GetRenderer();
3950
3951 // do draw the invalidated parts of each line: note that we iterate here
3952 // over ROWs, not over LINEs
3953 for ( wxTextCoord line = lineStart;
3954 y < rectUpdate.y + rectUpdate.height;
3955 y += hLine,
3956 rectText.y += hLine )
3957 {
3958 // calculate the update rect in text positions for this line
3959 wxTextCoord colStart, colEnd, colRowStart;
3960 wxTextCtrlHitTestResult ht = HitTest2(y, x1, x2,
3961 &line, &colStart, &colEnd,
3962 &colRowStart);
3963
3964 if ( (ht == wxTE_HT_BEYOND) || (ht == wxTE_HT_BELOW) )
3965 {
3966 wxASSERT_MSG( line <= lineEnd, _T("how did we get that far?") );
3967
3968 if ( line == lineEnd )
3969 {
3970 // we redrew everything
3971 break;
3972 }
3973
3974 // the update rect is beyond the end of line, no need to redraw
3975 // anything on this line - but continue with the remaining ones
3976 continue;
3977 }
3978
3979 // for single line controls we may additionally cut off everything
3980 // which is to the right of the last visible position
3981 if ( IsSingleLine() )
3982 {
3983 // don't show the columns which are scrolled out to the left
3984 if ( colStart < SData().m_colStart )
3985 colStart = SData().m_colStart;
3986
3987 // colEnd may be less than colStart if colStart was changed by the
3988 // assignment above
3989 if ( colEnd < colStart )
3990 colEnd = colStart;
3991
3992 // don't draw the chars beyond the rightmost one
3993 if ( SData().m_colLastVisible == -1 )
3994 {
3995 // recalculate this rightmost column
3996 UpdateLastVisible();
3997 }
3998
3999 if ( colStart > SData().m_colLastVisible )
4000 {
4001 // don't bother redrawing something that is beyond the last
4002 // visible position
4003 continue;
4004 }
4005
4006 if ( colEnd > SData().m_colLastVisible )
4007 {
4008 colEnd = SData().m_colLastVisible;
4009 }
4010 }
4011
4012 // extract the part of line we need to redraw
4013 wxString textLine = GetTextToShow(GetLineText(line));
4014 wxString text = textLine.Mid(colStart, colEnd - colStart + 1);
4015
4016 // now deal with the selection: only do something if at least part of
4017 // the line is selected
4018 wxTextPos selStart, selEnd;
4019 if ( GetSelectedPartOfLine(line, &selStart, &selEnd) )
4020 {
4021 // and if this part is (at least partly) in the current row
4022 if ( (selStart <= colEnd) &&
4023 (selEnd >= wxMax(colStart, colRowStart)) )
4024 {
4025 // these values are relative to the start of the line while the
4026 // string passed to DrawTextLine() is only part of it, so
4027 // adjust the selection range accordingly
4028 selStart -= colStart;
4029 selEnd -= colStart;
4030
4031 if ( selStart < 0 )
4032 selStart = 0;
4033
4034 if ( (size_t)selEnd >= text.length() )
4035 selEnd = text.length();
4036 }
4037 else
4038 {
4039 // reset selStart and selEnd to avoid passing them to
4040 // DrawTextLine() below
4041 selStart =
4042 selEnd = -1;
4043 }
4044 }
4045
4046 // calculate the text coords on screen
4047 wxASSERT_MSG( colStart >= colRowStart, _T("invalid string part") );
4048 wxCoord ofsStart = GetTextWidth(
4049 textLine.Mid(colRowStart,
4050 colStart - colRowStart));
4051 rectText.x = m_rectText.x + ofsStart;
4052 rectText.width = GetTextWidth(text);
4053
4054 // do draw the text
4055 renderer->DrawTextLine(dc, text, rectText, selStart, selEnd,
4056 GetStateFlags());
4057 wxLogTrace(_T("text"), _T("Line %ld: positions %ld-%ld redrawn."),
4058 line, colStart, colEnd);
4059 }
4060 }
4061
4062 void wxTextCtrl::DoDrawLineWrapMarks(wxDC& dc, const wxRect& rectUpdate)
4063 {
4064 wxASSERT_MSG( WrapLines() && WData().m_widthMark,
4065 _T("shouldn't be called at all") );
4066
4067 wxRenderer *renderer = GetRenderer();
4068
4069 wxRect rectMark;
4070 rectMark.x = rectUpdate.x;
4071 rectMark.width = rectUpdate.width;
4072 wxCoord yTop = GetClientAreaOrigin().y;
4073 CalcUnscrolledPosition(0, rectUpdate.y - yTop, NULL, &rectMark.y);
4074 wxCoord hLine = GetLineHeight();
4075 rectMark.height = hLine;
4076
4077 wxTextCoord line, rowInLine;
4078
4079 wxCoord yBottom;
4080 CalcUnscrolledPosition(0, rectUpdate.GetBottom() - yTop, NULL, &yBottom);
4081 for ( ; rectMark.y < yBottom; rectMark.y += hLine )
4082 {
4083 if ( !GetLineAndRow(rectMark.y / hLine, &line, &rowInLine) )
4084 {
4085 // we went beyond the end of text
4086 break;
4087 }
4088
4089 // is this row continued on the next one?
4090 if ( !WData().m_linesData[line].IsLastRow(rowInLine) )
4091 {
4092 renderer->DrawLineWrapMark(dc, rectMark);
4093 }
4094 }
4095 }
4096
4097 void wxTextCtrl::DoDraw(wxControlRenderer *renderer)
4098 {
4099 // hide the caret while we're redrawing the window and show it after we are
4100 // done with it
4101 wxCaretSuspend cs(this);
4102
4103 // prepare the DC
4104 wxDC& dc = renderer->GetDC();
4105 dc.SetFont(GetFont());
4106 dc.SetTextForeground(GetForegroundColour());
4107
4108 // get the intersection of the update region with the text area: note that
4109 // the update region is in window coords and text area is in the client
4110 // ones, so it must be shifted before computing intersection
4111 wxRegion rgnUpdate = GetUpdateRegion();
4112 wxRect rectTextArea = GetRealTextArea();
4113 wxPoint pt = GetClientAreaOrigin();
4114 wxRect rectTextAreaAdjusted = rectTextArea;
4115 rectTextAreaAdjusted.x += pt.x;
4116 rectTextAreaAdjusted.y += pt.y;
4117 rgnUpdate.Intersect(rectTextAreaAdjusted);
4118
4119 // even though the drawing is already clipped to the update region, we must
4120 // explicitly clip it to the rect we will use as otherwise parts of letters
4121 // might be drawn outside of it (if even a small part of a charater is
4122 // inside, HitTest() will return its column and DrawText() can't draw only
4123 // the part of the character, of course)
4124 #ifdef __WXMSW__
4125 // FIXME: is this really a bug in wxMSW?
4126 rectTextArea.width--;
4127 #endif // __WXMSW__
4128 dc.SetClippingRegion(rectTextArea);
4129
4130 // adjust for scrolling
4131 DoPrepareDC(dc);
4132
4133 // and now refresh the invalidated parts of the window
4134 wxRegionIterator iter(rgnUpdate);
4135 for ( ; iter.HaveRects(); iter++ )
4136 {
4137 wxRect r = iter.GetRect();
4138
4139 // this is a workaround for wxGTK::wxRegion bug
4140 #ifdef __WXGTK__
4141 if ( !r.width || !r.height )
4142 {
4143 // ignore invalid rect
4144 continue;
4145 }
4146 #endif // __WXGTK__
4147
4148 DoDrawTextInRect(dc, r);
4149 }
4150
4151 // now redraw the line wrap marks (if we draw them)
4152 if ( WrapLines() && WData().m_widthMark )
4153 {
4154 // this is the rect inside which line wrap marks are drawn
4155 wxRect rectMarks;
4156 rectMarks.x = rectTextAreaAdjusted.GetRight() + 1;
4157 rectMarks.y = rectTextAreaAdjusted.y;
4158 rectMarks.width = WData().m_widthMark;
4159 rectMarks.height = rectTextAreaAdjusted.height;
4160
4161 rgnUpdate = GetUpdateRegion();
4162 rgnUpdate.Intersect(rectMarks);
4163
4164 wxRect rectUpdate = rgnUpdate.GetBox();
4165 if ( rectUpdate.width && rectUpdate.height )
4166 {
4167 // the marks are outside previously set clipping region
4168 dc.DestroyClippingRegion();
4169
4170 DoDrawLineWrapMarks(dc, rectUpdate);
4171 }
4172 }
4173
4174 // show caret first time only: we must show it after drawing the text or
4175 // the display can be corrupted when it's hidden
4176 if ( !m_hasCaret && GetCaret() )
4177 {
4178 ShowCaret();
4179
4180 m_hasCaret = TRUE;
4181 }
4182 }
4183
4184 // ----------------------------------------------------------------------------
4185 // caret
4186 // ----------------------------------------------------------------------------
4187
4188 bool wxTextCtrl::SetFont(const wxFont& font)
4189 {
4190 if ( !wxControl::SetFont(font) )
4191 return FALSE;
4192
4193 // and refresh everything, of course
4194 InitInsertionPoint();
4195 ClearSelection();
4196
4197 // update geometry parameters
4198 UpdateTextRect();
4199 RecalcFontMetrics();
4200 if ( !IsSingleLine() )
4201 {
4202 UpdateScrollbars();
4203 RecalcMaxWidth();
4204 }
4205
4206 // recreate it, in fact
4207 CreateCaret();
4208
4209 Refresh();
4210
4211 return TRUE;
4212 }
4213
4214 bool wxTextCtrl::Enable(bool enable)
4215 {
4216 if ( !wxTextCtrlBase::Enable(enable) )
4217 return FALSE;
4218
4219 ShowCaret(enable);
4220
4221 return TRUE;
4222 }
4223
4224 void wxTextCtrl::CreateCaret()
4225 {
4226 wxCaret *caret;
4227
4228 if ( IsEditable() )
4229 {
4230 // FIXME use renderer
4231 caret = new wxCaret(this, 1, GetLineHeight());
4232 #ifndef __WXMSW__
4233 caret->SetBlinkTime(0);
4234 #endif // __WXMSW__
4235 }
4236 else
4237 {
4238 // read only controls don't have the caret
4239 caret = (wxCaret *)NULL;
4240 }
4241
4242 // SetCaret() will delete the old caret if any
4243 SetCaret(caret);
4244 }
4245
4246 void wxTextCtrl::ShowCaret(bool show)
4247 {
4248 wxCaret *caret = GetCaret();
4249 if ( caret )
4250 {
4251 // (re)position caret correctly
4252 caret->Move(GetCaretPosition());
4253
4254 // and show it there
4255 caret->Show(show);
4256 }
4257 }
4258
4259 // ----------------------------------------------------------------------------
4260 // vertical scrolling (multiline only)
4261 // ----------------------------------------------------------------------------
4262
4263 size_t wxTextCtrl::GetLinesPerPage() const
4264 {
4265 if ( IsSingleLine() )
4266 return 1;
4267
4268 return GetRealTextArea().height / GetLineHeight();
4269 }
4270
4271 wxTextPos wxTextCtrl::GetPositionAbove()
4272 {
4273 wxCHECK_MSG( !IsSingleLine(), INVALID_POS_VALUE,
4274 _T("can't move cursor vertically in a single line control") );
4275
4276 // move the cursor up by one ROW not by one LINE: this means that
4277 // we should really use HitTest() and not just go to the same
4278 // position in the previous line
4279 wxPoint pt = GetCaretPosition() - m_rectText.GetPosition();
4280 if ( MData().m_xCaret == -1 )
4281 {
4282 // remember the initial cursor abscissa
4283 MData().m_xCaret = pt.x;
4284 }
4285 else
4286 {
4287 // use the remembered abscissa
4288 pt.x = MData().m_xCaret;
4289 }
4290
4291 CalcUnscrolledPosition(pt.x, pt.y, &pt.x, &pt.y);
4292 pt.y -= GetLineHeight();
4293
4294 wxTextCoord col, row;
4295 if ( HitTestLogical(pt, &col, &row) == wxTE_HT_BEFORE )
4296 {
4297 // can't move further
4298 return INVALID_POS_VALUE;
4299 }
4300
4301 return XYToPosition(col, row);
4302 }
4303
4304 wxTextPos wxTextCtrl::GetPositionBelow()
4305 {
4306 wxCHECK_MSG( !IsSingleLine(), INVALID_POS_VALUE,
4307 _T("can't move cursor vertically in a single line control") );
4308
4309 // see comments for wxACTION_TEXT_UP
4310 wxPoint pt = GetCaretPosition() - m_rectText.GetPosition();
4311 if ( MData().m_xCaret == -1 )
4312 {
4313 // remember the initial cursor abscissa
4314 MData().m_xCaret = pt.x;
4315 }
4316 else
4317 {
4318 // use the remembered abscissa
4319 pt.x = MData().m_xCaret;
4320 }
4321
4322 CalcUnscrolledPosition(pt.x, pt.y, &pt.x, &pt.y);
4323 pt.y += GetLineHeight();
4324
4325 wxTextCoord col, row;
4326 if ( HitTestLogical(pt, &col, &row) == wxTE_HT_BELOW )
4327 {
4328 // can't go further down
4329 return INVALID_POS_VALUE;
4330 }
4331
4332 // note that wxTE_HT_BEYOND is ok: it happens when we go down
4333 // from a longer line to a shorter one, for example (OTOH
4334 // wxTE_HT_BEFORE can never happen)
4335 return XYToPosition(col, row);
4336 }
4337
4338 // ----------------------------------------------------------------------------
4339 // input
4340 // ----------------------------------------------------------------------------
4341
4342 bool wxTextCtrl::PerformAction(const wxControlAction& actionOrig,
4343 long numArg,
4344 const wxString& strArg)
4345 {
4346 // has the text changed as result of this action?
4347 bool textChanged = FALSE;
4348
4349 // the remembered cursor abscissa for multiline text controls is usually
4350 // reset after each user action but for ones which do use it (UP and DOWN
4351 // for example) we shouldn't do it - as indicated by this flag
4352 bool rememberAbscissa = FALSE;
4353
4354 // the command this action corresponds to or NULL if this action doesn't
4355 // change text at all or can't be undone
4356 wxTextCtrlCommand *command = (wxTextCtrlCommand *)NULL;
4357
4358 wxString action;
4359 bool del = FALSE,
4360 sel = FALSE;
4361 if ( actionOrig.StartsWith(wxACTION_TEXT_PREFIX_DEL, &action) )
4362 {
4363 if ( IsEditable() )
4364 del = TRUE;
4365 }
4366 else if ( actionOrig.StartsWith(wxACTION_TEXT_PREFIX_SEL, &action) )
4367 {
4368 sel = TRUE;
4369 }
4370 else // not selection nor delete action
4371 {
4372 action = actionOrig;
4373 }
4374
4375 // set newPos to -2 as it can't become equal to it in the assignments below
4376 // (but it can become -1)
4377 wxTextPos newPos = INVALID_POS_VALUE;
4378
4379 if ( action == wxACTION_TEXT_HOME )
4380 {
4381 newPos = m_curPos - m_curCol;
4382 }
4383 else if ( action == wxACTION_TEXT_END )
4384 {
4385 newPos = m_curPos + GetLineLength(m_curRow) - m_curCol;
4386 }
4387 else if ( (action == wxACTION_TEXT_GOTO) ||
4388 (action == wxACTION_TEXT_FIRST) ||
4389 (action == wxACTION_TEXT_LAST) )
4390 {
4391 if ( action == wxACTION_TEXT_FIRST )
4392 numArg = 0;
4393 else if ( action == wxACTION_TEXT_LAST )
4394 numArg = GetLastPosition();
4395 //else: numArg already contains the position
4396
4397 newPos = numArg;
4398 }
4399 else if ( action == wxACTION_TEXT_UP )
4400 {
4401 if ( !IsSingleLine() )
4402 {
4403 newPos = GetPositionAbove();
4404
4405 if ( newPos != INVALID_POS_VALUE )
4406 {
4407 // remember where the cursor original had been
4408 rememberAbscissa = TRUE;
4409 }
4410 }
4411 }
4412 else if ( action == wxACTION_TEXT_DOWN )
4413 {
4414 if ( !IsSingleLine() )
4415 {
4416 newPos = GetPositionBelow();
4417
4418 if ( newPos != INVALID_POS_VALUE )
4419 {
4420 // remember where the cursor original had been
4421 rememberAbscissa = TRUE;
4422 }
4423 }
4424 }
4425 else if ( action == wxACTION_TEXT_LEFT )
4426 {
4427 newPos = m_curPos - 1;
4428 }
4429 else if ( action == wxACTION_TEXT_WORD_LEFT )
4430 {
4431 newPos = GetWordStart();
4432 }
4433 else if ( action == wxACTION_TEXT_RIGHT )
4434 {
4435 newPos = m_curPos + 1;
4436 }
4437 else if ( action == wxACTION_TEXT_WORD_RIGHT )
4438 {
4439 newPos = GetWordEnd();
4440 }
4441 else if ( action == wxACTION_TEXT_INSERT )
4442 {
4443 if ( IsEditable() && !strArg.empty() )
4444 {
4445 // inserting text can be undone
4446 command = new wxTextCtrlInsertCommand(strArg);
4447
4448 textChanged = TRUE;
4449 }
4450 }
4451 else if ( (action == wxACTION_TEXT_PAGE_UP) ||
4452 (action == wxACTION_TEXT_PAGE_DOWN) )
4453 {
4454 if ( !IsSingleLine() )
4455 {
4456 size_t count = GetLinesPerPage();
4457 if ( count > PAGE_OVERLAP_IN_LINES )
4458 {
4459 // pages should overlap slightly to allow the reader to keep
4460 // orientation in the text
4461 count -= PAGE_OVERLAP_IN_LINES;
4462 }
4463
4464 // remember where the cursor original had been
4465 rememberAbscissa = TRUE;
4466
4467 bool goUp = action == wxACTION_TEXT_PAGE_UP;
4468 for ( size_t line = 0; line < count; line++ )
4469 {
4470 wxTextPos pos = goUp ? GetPositionAbove() : GetPositionBelow();
4471 if ( pos == INVALID_POS_VALUE )
4472 {
4473 // can't move further
4474 break;
4475 }
4476
4477 MoveInsertionPoint(pos);
4478 newPos = pos;
4479 }
4480
4481 // we implement the Unix scrolling model here: cursor will always
4482 // be on the first line after Page Down and on the last one after
4483 // Page Up
4484 //
4485 // Windows programs usually keep the cursor line offset constant
4486 // but do we really need it?
4487 wxCoord y;
4488 if ( goUp )
4489 {
4490 // find the line such that when it is the first one, the
4491 // current position is in the last line
4492 wxTextPos pos = 0;
4493 for ( size_t line = 0; line < count; line++ )
4494 {
4495 pos = GetPositionAbove();
4496 if ( pos == INVALID_POS_VALUE )
4497 break;
4498
4499 MoveInsertionPoint(pos);
4500 }
4501
4502 MoveInsertionPoint(newPos);
4503
4504 PositionToLogicalXY(pos, NULL, &y);
4505 }
4506 else // scrolled down
4507 {
4508 PositionToLogicalXY(newPos, NULL, &y);
4509 }
4510
4511 // scroll vertically only
4512 Scroll(-1, y);
4513 }
4514 }
4515 else if ( action == wxACTION_TEXT_SEL_WORD )
4516 {
4517 SetSelection(GetWordStart(), GetWordEnd());
4518 }
4519 else if ( action == wxACTION_TEXT_ANCHOR_SEL )
4520 {
4521 newPos = numArg;
4522 }
4523 else if ( action == wxACTION_TEXT_EXTEND_SEL )
4524 {
4525 SetSelection(m_selAnchor, numArg);
4526 }
4527 else if ( action == wxACTION_TEXT_COPY )
4528 {
4529 Copy();
4530 }
4531 else if ( action == wxACTION_TEXT_CUT )
4532 {
4533 if ( IsEditable() )
4534 Cut();
4535 }
4536 else if ( action == wxACTION_TEXT_PASTE )
4537 {
4538 if ( IsEditable() )
4539 Paste();
4540 }
4541 else if ( action == wxACTION_TEXT_UNDO )
4542 {
4543 if ( CanUndo() )
4544 Undo();
4545 }
4546 else if ( action == wxACTION_TEXT_REDO )
4547 {
4548 if ( CanRedo() )
4549 Redo();
4550 }
4551 else
4552 {
4553 return wxControl::PerformAction(action, numArg, strArg);
4554 }
4555
4556 if ( newPos != INVALID_POS_VALUE )
4557 {
4558 // bring the new position into the range
4559 if ( newPos < 0 )
4560 newPos = 0;
4561
4562 wxTextPos posLast = GetLastPosition();
4563 if ( newPos > posLast )
4564 newPos = posLast;
4565
4566 if ( del )
4567 {
4568 // if we have the selection, remove just it
4569 wxTextPos from, to;
4570 if ( HasSelection() )
4571 {
4572 from = m_selStart;
4573 to = m_selEnd;
4574 }
4575 else
4576 {
4577 // otherwise delete everything between current position and
4578 // the new one
4579 if ( m_curPos != newPos )
4580 {
4581 from = m_curPos;
4582 to = newPos;
4583 }
4584 else // nothing to delete
4585 {
4586 // prevent test below from working
4587 from = INVALID_POS_VALUE;
4588
4589 // and this is just to silent the compiler warning
4590 to = 0;
4591 }
4592 }
4593
4594 if ( from != INVALID_POS_VALUE )
4595 {
4596 command = new wxTextCtrlRemoveCommand(from, to);
4597 }
4598 }
4599 else // cursor movement command
4600 {
4601 // just go there
4602 DoSetInsertionPoint(newPos);
4603
4604 if ( sel )
4605 {
4606 SetSelection(m_selAnchor, m_curPos);
4607 }
4608 else // simple movement
4609 {
4610 // clear the existing selection
4611 ClearSelection();
4612 }
4613 }
4614
4615 if ( !rememberAbscissa && !IsSingleLine() )
4616 {
4617 MData().m_xCaret = -1;
4618 }
4619 }
4620
4621 if ( command )
4622 {
4623 // execute and remember it to be able to undo it later
4624 m_cmdProcessor->Submit(command);
4625
4626 // undoable commands always change text
4627 textChanged = TRUE;
4628 }
4629 else // no undoable command
4630 {
4631 // m_cmdProcessor->StopCompressing()
4632 }
4633
4634 if ( textChanged )
4635 {
4636 wxASSERT_MSG( IsEditable(), _T("non editable control changed?") );
4637
4638 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
4639 InitCommandEvent(event);
4640 event.SetString(GetValue());
4641 GetEventHandler()->ProcessEvent(event);
4642
4643 // as the text changed...
4644 m_isModified = TRUE;
4645 }
4646
4647 return TRUE;
4648 }
4649
4650 void wxTextCtrl::OnChar(wxKeyEvent& event)
4651 {
4652 // only process the key events from "simple keys" here
4653 if ( !event.HasModifiers() )
4654 {
4655 int keycode = event.GetKeyCode();
4656 if ( keycode == WXK_RETURN )
4657 {
4658 if ( IsSingleLine() || (GetWindowStyle() & wxTE_PROCESS_ENTER) )
4659 {
4660 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, GetId());
4661 InitCommandEvent(event);
4662 event.SetString(GetValue());
4663 GetEventHandler()->ProcessEvent(event);
4664 }
4665 else // interpret <Enter> normally: insert new line
4666 {
4667 PerformAction(wxACTION_TEXT_INSERT, -1, _T('\n'));
4668 }
4669 }
4670 else if ( keycode < 255 && isprint(keycode) )
4671 {
4672 PerformAction(wxACTION_TEXT_INSERT, -1, (wxChar)keycode);
4673
4674 // skip event.Skip() below
4675 return;
4676 }
4677 }
4678 #ifdef __WXDEBUG__
4679 // Ctrl-R refreshes the control in debug mode
4680 else if ( event.ControlDown() && event.GetKeyCode() == 'r' )
4681 Refresh();
4682 #endif // __WXDEBUG__
4683
4684 event.Skip();
4685 }
4686
4687 // ----------------------------------------------------------------------------
4688 // wxStdTextCtrlInputHandler
4689 // ----------------------------------------------------------------------------
4690
4691 wxStdTextCtrlInputHandler::wxStdTextCtrlInputHandler(wxInputHandler *inphand)
4692 : wxStdInputHandler(inphand)
4693 {
4694 m_winCapture = (wxTextCtrl *)NULL;
4695 }
4696
4697 /* static */
4698 wxTextPos wxStdTextCtrlInputHandler::HitTest(const wxTextCtrl *text,
4699 const wxPoint& pt)
4700 {
4701 wxTextCoord col, row;
4702 wxTextCtrlHitTestResult ht = text->HitTest(pt, &col, &row);
4703
4704 wxTextPos pos = text->XYToPosition(col, row);
4705
4706 // if the point is after the last column we must adjust the position to be
4707 // the last position in the line (unless it is already the last)
4708 if ( (ht == wxTE_HT_BEYOND) && (pos < text->GetLastPosition()) )
4709 {
4710 pos++;
4711 }
4712
4713 return pos;
4714 }
4715
4716 bool wxStdTextCtrlInputHandler::HandleKey(wxInputConsumer *consumer,
4717 const wxKeyEvent& event,
4718 bool pressed)
4719 {
4720 // we're only interested in key presses
4721 if ( !pressed )
4722 return FALSE;
4723
4724 int keycode = event.GetKeyCode();
4725
4726 wxControlAction action;
4727 wxString str;
4728 bool ctrlDown = event.ControlDown(),
4729 shiftDown = event.ShiftDown();
4730 if ( shiftDown )
4731 {
4732 action = wxACTION_TEXT_PREFIX_SEL;
4733 }
4734
4735 // the only key combination with Alt we recognize is Alt-Bksp for undo, so
4736 // treat it first separately
4737 if ( event.AltDown() )
4738 {
4739 if ( keycode == WXK_BACK && !ctrlDown && !shiftDown )
4740 action = wxACTION_TEXT_UNDO;
4741 }
4742 else switch ( keycode )
4743 {
4744 // cursor movement
4745 case WXK_HOME:
4746 action << (ctrlDown ? wxACTION_TEXT_FIRST
4747 : wxACTION_TEXT_HOME);
4748 break;
4749
4750 case WXK_END:
4751 action << (ctrlDown ? wxACTION_TEXT_LAST
4752 : wxACTION_TEXT_END);
4753 break;
4754
4755 case WXK_UP:
4756 if ( !ctrlDown )
4757 action << wxACTION_TEXT_UP;
4758 break;
4759
4760 case WXK_DOWN:
4761 if ( !ctrlDown )
4762 action << wxACTION_TEXT_DOWN;
4763 break;
4764
4765 case WXK_LEFT:
4766 action << (ctrlDown ? wxACTION_TEXT_WORD_LEFT
4767 : wxACTION_TEXT_LEFT);
4768 break;
4769
4770 case WXK_RIGHT:
4771 action << (ctrlDown ? wxACTION_TEXT_WORD_RIGHT
4772 : wxACTION_TEXT_RIGHT);
4773 break;
4774
4775 case WXK_PAGEDOWN:
4776 case WXK_NEXT:
4777 // we don't map Ctrl-PgUp/Dn to anything special - what should it
4778 // to? for now, it's the same as without control
4779 action << wxACTION_TEXT_PAGE_DOWN;
4780 break;
4781
4782 case WXK_PAGEUP:
4783 case WXK_PRIOR:
4784 action << wxACTION_TEXT_PAGE_UP;
4785 break;
4786
4787 // delete
4788 case WXK_DELETE:
4789 if ( !ctrlDown )
4790 action << wxACTION_TEXT_PREFIX_DEL << wxACTION_TEXT_RIGHT;
4791 break;
4792
4793 case WXK_BACK:
4794 if ( !ctrlDown )
4795 action << wxACTION_TEXT_PREFIX_DEL << wxACTION_TEXT_LEFT;
4796 break;
4797
4798 // something else
4799 default:
4800 // reset the action as it could be already set to one of the
4801 // prefixes
4802 action = wxACTION_NONE;
4803
4804 if ( ctrlDown )
4805 {
4806 switch ( keycode )
4807 {
4808 case 'A':
4809 action = wxACTION_TEXT_REDO;
4810 break;
4811
4812 case 'C':
4813 action = wxACTION_TEXT_COPY;
4814 break;
4815
4816 case 'V':
4817 action = wxACTION_TEXT_PASTE;
4818 break;
4819
4820 case 'X':
4821 action = wxACTION_TEXT_CUT;
4822 break;
4823
4824 case 'Z':
4825 action = wxACTION_TEXT_UNDO;
4826 break;
4827 }
4828 }
4829 }
4830
4831 if ( (action != wxACTION_NONE) && (action != wxACTION_TEXT_PREFIX_SEL) )
4832 {
4833 consumer->PerformAction(action, -1, str);
4834
4835 return TRUE;
4836 }
4837
4838 return wxStdInputHandler::HandleKey(consumer, event, pressed);
4839 }
4840
4841 bool wxStdTextCtrlInputHandler::HandleMouse(wxInputConsumer *consumer,
4842 const wxMouseEvent& event)
4843 {
4844 if ( event.LeftDown() )
4845 {
4846 wxASSERT_MSG( !m_winCapture, _T("left button going down twice?") );
4847
4848 wxTextCtrl *text = wxStaticCast(consumer->GetInputWindow(), wxTextCtrl);
4849
4850 m_winCapture = text;
4851 m_winCapture->CaptureMouse();
4852
4853 text->HideCaret();
4854
4855 wxTextPos pos = HitTest(text, event.GetPosition());
4856 if ( pos != -1 )
4857 {
4858 text->PerformAction(wxACTION_TEXT_ANCHOR_SEL, pos);
4859 }
4860 }
4861 else if ( event.LeftDClick() )
4862 {
4863 // select the word the cursor is on
4864 consumer->PerformAction(wxACTION_TEXT_SEL_WORD);
4865 }
4866 else if ( event.LeftUp() )
4867 {
4868 if ( m_winCapture )
4869 {
4870 m_winCapture->ShowCaret();
4871
4872 m_winCapture->ReleaseMouse();
4873 m_winCapture = (wxTextCtrl *)NULL;
4874 }
4875 }
4876
4877 return wxStdInputHandler::HandleMouse(consumer, event);
4878 }
4879
4880 bool wxStdTextCtrlInputHandler::HandleMouseMove(wxInputConsumer *consumer,
4881 const wxMouseEvent& event)
4882 {
4883 if ( m_winCapture )
4884 {
4885 // track it
4886 wxTextCtrl *text = wxStaticCast(m_winCapture, wxTextCtrl);
4887 wxTextPos pos = HitTest(text, event.GetPosition());
4888 if ( pos != -1 )
4889 {
4890 text->PerformAction(wxACTION_TEXT_EXTEND_SEL, pos);
4891 }
4892 }
4893
4894 return wxStdInputHandler::HandleMouseMove(consumer, event);
4895 }
4896
4897 bool wxStdTextCtrlInputHandler::HandleFocus(wxInputConsumer *consumer,
4898 const wxFocusEvent& event)
4899 {
4900 wxTextCtrl *text = wxStaticCast(consumer->GetInputWindow(), wxTextCtrl);
4901
4902 // the selection appearance changes depending on whether we have the focus
4903 text->RefreshSelection();
4904
4905 // never refresh entirely
4906 return FALSE;
4907 }
4908
4909 #endif // wxUSE_TEXTCTRL