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