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