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