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