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