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