docs/latex/wx/text.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%% wxTextCtrl %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3 \section{\class{wxTextCtrl}}\label{wxtextctrl}
   4
   5 A text control allows text to be displayed and edited. It may be
   6 single line or multi-line.
   7
   8 \wxheading{Derived from}
   9
  10 streambuf\\
  11 \helpref{wxControl}{wxcontrol}\\
  12 \helpref{wxWindow}{wxwindow}\\
  13 \helpref{wxEvtHandler}{wxevthandler}\\
  14 \helpref{wxObject}{wxobject}
  15
  16 \wxheading{Include files}
  17
  18 <wx/textctrl.h>
  19
  20 \wxheading{Library}
  21
  22 \helpref{wxCore}{librarieslist}
  23
  24 \wxheading{Window styles}
  25
  26 \twocolwidtha{5cm}
  27 \begin{twocollist}\itemsep=0pt
  28 \twocolitem{\windowstyle{wxTE\_PROCESS\_ENTER}}{The control will generate
  29 the event wxEVT\_COMMAND\_TEXT\_ENTER (otherwise pressing Enter key
  30 is either processed internally by the control or used for navigation between
  31 dialog controls).}
  32 \twocolitem{\windowstyle{wxTE\_PROCESS\_TAB}}{The control will receive
  33 wxEVT\_CHAR events for TAB pressed - normally, TAB is used for passing to the
  34 next control in a dialog instead. For the control created with this style,
  35 you can still use Ctrl-Enter to pass to the next control from the keyboard.}
  36 \twocolitem{\windowstyle{wxTE\_MULTILINE}}{The text control allows multiple lines.}
  37 \twocolitem{\windowstyle{wxTE\_PASSWORD}}{The text will be echoed as asterisks.}
  38 \twocolitem{\windowstyle{wxTE\_READONLY}}{The text will not be user-editable.}
  39 \twocolitem{\windowstyle{wxTE\_RICH}}{Use rich text control under Win32, this
  40 allows to have more than 64KB of text in the control even under Win9x. This
  41 style is ignored under other platforms.}
  42 \twocolitem{\windowstyle{wxTE\_RICH2}}{Use rich text control version 2.0 or 3.0
  43 under Win32, this style is ignored under other platforms}
  44 \twocolitem{\windowstyle{wxTE\_AUTO\_URL}}{Highlight the URLs and generate the
  45 wxTextUrlEvents when mouse events occur over them. This style is only supported
  46 for wxTE\_RICH Win32 and multi-line wxGTK2 text controls.}
  47 \twocolitem{\windowstyle{wxTE\_NOHIDESEL}}{By default, the Windows text control
  48 doesn't show the selection when it doesn't have focus - use this style to force
  49 it to always show it. It doesn't do anything under other platforms.}
  50 \twocolitem{\windowstyle{wxHSCROLL}}{A horizontal scrollbar will be created and
  51 used, so that text won't be wrapped. No effect under wxGTK1.}
  52 \twocolitem{\windowstyle{wxTE\_NO\_VSCROLL}}{For multiline controls only:
  53 vertical scrollbar will never be created. This limits the amount of text which
  54 can be entered into the control to what can be displayed in it under MSW but
  55 not under GTK2. Currently not implemented for the other platforms.}
  56 \twocolitem{\windowstyle{wxTE\_LEFT}}{The text in the control will be left-justified (default).}
  57 \twocolitem{\windowstyle{wxTE\_CENTRE}}{The text in the control will be centered (currently wxMSW and wxGTK2 only).}
  58 \twocolitem{\windowstyle{wxTE\_RIGHT}}{The text in the control will be right-justified (currently wxMSW and wxGTK2 only).}
  59 \twocolitem{\windowstyle{wxTE\_DONTWRAP}}{Same as {\tt wxHSCROLL} style: don't wrap at all, show horizontal scrollbar instead.}
  60 \twocolitem{\windowstyle{wxTE\_CHARWRAP}}{Wrap the lines too long to be shown entirely at any position (wxUniv and wxGTK2 only).}
  61 \twocolitem{\windowstyle{wxTE\_WORDWRAP}}{Wrap the lines too long to be shown entirely at word boundaries (wxUniv and wxGTK2 only).}
  62 \twocolitem{\windowstyle{wxTE\_BESTWRAP}}{Wrap the lines at word boundaries or at any other character if there are words longer than the window width (this is the default).}
  63 \twocolitem{\windowstyle{wxTE\_CAPITALIZE}}{On PocketPC and Smartphone, causes the first letter to be capitalized.}
  64 \end{twocollist}
  65
  66 See also \helpref{window styles overview}{windowstyles} and \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlctor}.
  67
  68 Note that alignment styles (\windowstyle{wxTE\_LEFT},
  69 \windowstyle{wxTE\_CENTRE} and \windowstyle{wxTE\_RIGHT}) can be changed
  70 dynamically after control creation on wxMSW and wxGTK.
  71 \windowstyle{wxTE\_READONLY}, \windowstyle{wxTE\_PASSWORD} and wrapping styles
  72 can be dynamically changed under wxGTK but not wxMSW. The other styles can be
  73 only set during control creation.
  74
  75
  76 \wxheading{wxTextCtrl text format}
  77
  78 The multiline text controls always store the text as a sequence of lines
  79 separated by {\tt $\backslash$n} characters, i.e. in the Unix text format even
  80 on non-Unix platforms. This allows the user code to ignore the differences
  81 between the platforms but at a price: the indices in the control such as those
  82 returned by \helpref{GetInsertionPoint}{wxtextctrlgetinsertionpoint} or
  83 \helpref{GetSelection}{wxtextctrlgetselection} can {\bf not} be used as
  84 indices into the string returned by \helpref{GetValue}{wxtextctrlgetvalue} as
  85 they're going to be slightly off for platforms using
  86 {\tt $\backslash$r$\backslash$n} as separator (as Windows does), for example.
  87
  88 Instead, if you need to obtain a substring between the $2$ indices obtained
  89 from the control with the help of the functions mentioned above, you should
  90 use \helpref{GetRange}{wxtextctrlgetrange}. And the indices themselves can
  91 only be passed to other methods, for example
  92 \helpref{SetInsertionPoint}{wxtextctrlsetinsertionpoint} or
  93 \helpref{SetSelection}{wxtextctrlsetselection}.
  94
  95 To summarize: never use the indices returned by (multiline) wxTextCtrl as
  96 indices into the string it contains, but only as arguments to be passed back
  97 to the other wxTextCtrl methods.
  98
  99 \wxheading{wxTextCtrl styles}
 100
 101 Multi-line text controls support the styles, i.e. provide a possibility to set
 102 colours and font for individual characters in it (note that under Windows {\tt
 103 wxTE\_RICH} style is required for style support). To use the styles you can
 104 either call \helpref{SetDefaultStyle}{wxtextctrlsetdefaultstyle} before
 105 inserting the text or call \helpref{SetStyle}{wxtextctrlsetstyle} later to
 106 change the style of the text already in the control (the first solution is
 107 much more efficient).
 108
 109 In either case, if the style doesn't specify some of the attributes (for
 110 example you only want to set the text colour but without changing the font nor
 111 the text background), the values of the default style will be used for them.
 112 If there is no default style, the attributes of the text control itself are
 113 used.
 114
 115 So the following code correctly describes what it does: the second call
 116 to \helpref{SetDefaultStyle}{wxtextctrlsetdefaultstyle} doesn't change the
 117 text foreground colour (which stays red) while the last one doesn't change the
 118 background colour (which stays grey):
 119
 120 {\small%
 121 \begin{verbatim}
 122     text->SetDefaultStyle(wxTextAttr(*wxRED));
 123     text->AppendText("Red text\n");
 124     text->SetDefaultStyle(wxTextAttr(wxNullColour, *wxLIGHT_GREY));
 125     text->AppendText("Red on grey text\n");
 126     text->SetDefaultStyle(wxTextAttr(*wxBLUE);
 127     text->AppendText("Blue on grey text\n");
 128 \end{verbatim}
 129 }%
 130
 131 \wxheading{wxTextCtrl and C++ streams}
 132
 133 This class multiply-inherits from {\bf streambuf} where compilers allow,
 134 allowing code such as the following:
 135
 136 {\small%
 137 \begin{verbatim}
 138   wxTextCtrl *control = new wxTextCtrl(...);
 139
 140   ostream stream(control)
 141
 142   stream << 123.456 << " some text\n";
 143   stream.flush();
 144 \end{verbatim}
 145 }%
 146
 147 If your compiler does not support derivation from {\bf streambuf} and gives a
 148 compile error, define the symbol {\bf NO\_TEXT\_WINDOW\_STREAM} in the
 149 wxTextCtrl header file.
 150
 151 Note that independently of this setting you can always use wxTextCtrl itself
 152 in a stream-like manner:
 153
 154 {\small%
 155 \begin{verbatim}
 156   wxTextCtrl *control = new wxTextCtrl(...);
 157
 158   *control << 123.456 << " some text\n";
 159 \end{verbatim}
 160 }%
 161
 162 always works. However the possibility to create an ostream associated with
 163 wxTextCtrl may be useful if you need to redirect the output of a function
 164 taking an ostream as parameter to a text control.
 165
 166 Another commonly requested need is to redirect {\bf std::cout} to the text
 167 control. This could be done in the following way:
 168
 169 {\small%
 170 \begin{verbatim}
 171   #include <iostream>
 172
 173   wxTextCtrl *control = new wxTextCtrl(...);
 174
 175   std::streambuf *sbOld = std::cout.rdbuf();
 176   std::cout.rdbuf(control);
 177
 178   // use cout as usual, the output appears in the text control
 179   ...
 180
 181   std::cout.rdbuf(sbOld);
 182 \end{verbatim}
 183 }%
 184
 185 But wxWidgets provides a convenient class to make it even simpler so instead
 186 you may just do
 187
 188 {\small%
 189 \begin{verbatim}
 190   #include <iostream>
 191
 192   wxTextCtrl *control = new wxTextCtrl(...);
 193
 194   wxStreamToTextRedirector redirect(control);
 195
 196   // all output to cout goes into the text control until the exit from current
 197   // scope
 198 \end{verbatim}
 199 }%
 200
 201 See \helpref{wxStreamToTextRedirector}{wxstreamtotextredirector} for more
 202 details.
 203
 204 \wxheading{Constants}
 205
 206 The values below are the possible return codes of the
 207 \helpref{HitTest}{wxtextctrlhittest} method:
 208
 209 {\small
 210 \begin{verbatim}
 211 // the point asked is ...
 212 enum wxTextCtrlHitTestResult
 213 {
 214     wxTE_HT_UNKNOWN = -2,   // this means HitTest() is simply not implemented
 215     wxTE_HT_BEFORE,         // either to the left or upper
 216     wxTE_HT_ON_TEXT,        // directly on
 217     wxTE_HT_BELOW,          // below [the last line]
 218     wxTE_HT_BEYOND          // after [the end of line]
 219 };
 220 // ... the character returned
 221 \end{verbatim}
 222 }
 223
 224
 225 \wxheading{Event handling}
 226
 227 The following commands are processed by default event handlers in wxTextCtrl: wxID\_CUT, wxID\_COPY,
 228 wxID\_PASTE, wxID\_UNDO, wxID\_REDO. The associated UI update events are also processed
 229 automatically, when the control has the focus.
 230
 231 To process input from a text control, use these event handler macros to direct input to member
 232 functions that take a \helpref{wxCommandEvent}{wxcommandevent} argument.
 233
 234 \twocolwidtha{7cm}%
 235 \begin{twocollist}\itemsep=0pt
 236 \twocolitem{{\bf EVT\_TEXT(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_UPDATED event,
 237 generated when the text changes. Notice that this event will be sent
 238 when the text controls contents changes - whether this is due to user input or
 239 comes from the program itself (for example, if SetValue() is called); see ChangeValue() for
 240 a function which does not send this event.}
 241 \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_ENTER event,
 242 generated when enter is pressed in a text control (which must have
 243 wxTE\_PROCESS\_ENTER style for this event to be generated).}
 244 \twocolitem{{\bf EVT\_TEXT\_URL(id, func)}}{A mouse event occurred over an URL
 245 in the text control (wxMSW and wxGTK2 only)}
 246 \twocolitem{{\bf EVT\_TEXT\_MAXLEN(id, func)}}{User tried to enter more text
 247 into the control than the limit set by
 248 \helpref{SetMaxLength}{wxtextctrlsetmaxlength}.}
 249 \end{twocollist}%
 250
 251 \latexignore{\rtfignore{\wxheading{Members}}}
 252
 253
 254 \membersection{wxTextCtrl::wxTextCtrl}\label{wxtextctrlctor}
 255
 256 \func{}{wxTextCtrl}{\void}
 257
 258 Default constructor.
 259
 260 \func{}{wxTextCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
 261 \param{const wxString\& }{value = ``"}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 262 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = wxTextCtrlNameStr}}
 263
 264 Constructor, creating and showing a text control.
 265
 266 \wxheading{Parameters}
 267
 268 \docparam{parent}{Parent window. Should not be NULL.}
 269
 270 \docparam{id}{Control identifier. A value of -1 denotes a default value.}
 271
 272 \docparam{value}{Default text value.}
 273
 274 \docparam{pos}{Text control position.}
 275
 276 \docparam{size}{Text control size.}
 277
 278 \docparam{style}{Window style. See \helpref{wxTextCtrl}{wxtextctrl}.}
 279
 280 \docparam{validator}{Window validator.}
 281
 282 \docparam{name}{Window name.}
 283
 284 \wxheading{Remarks}
 285
 286 The horizontal scrollbar ({\bf wxHSCROLL} style flag) will only be created
 287 for multi-line text controls.
 288 Without a horizontal scrollbar, text lines that don't fit in the control's
 289 size will be wrapped (but no newline character is inserted). Single line
 290 controls don't have a horizontal scrollbar, the text is automatically scrolled
 291 so that the \helpref{insertion point}{wxtextctrlgetinsertionpoint} is always
 292 visible.
 293
 294 % VZ: this is no longer true
 295 %Under Windows, if the {\bf wxTE\_MULTILINE} style is used, the window is implemented
 296 %as a Windows rich text control with unlimited capacity. Otherwise, normal edit control limits
 297 %apply.
 298
 299 \wxheading{See also}
 300
 301 \helpref{wxTextCtrl::Create}{wxtextctrlcreate}, \helpref{wxValidator}{wxvalidator}
 302
 303
 304 \membersection{wxTextCtrl::\destruct{wxTextCtrl}}\label{wxtextctrldtor}
 305
 306 \func{}{\destruct{wxTextCtrl}}{\void}
 307
 308 Destructor, destroying the text control.
 309
 310
 311 \membersection{wxTextCtrl::AppendText}\label{wxtextctrlappendtext}
 312
 313 \func{void}{AppendText}{\param{const wxString\& }{ text}}
 314
 315 Appends the text to the end of the text control.
 316
 317 \wxheading{Parameters}
 318
 319 \docparam{text}{Text to write to the text control.}
 320
 321 \wxheading{Remarks}
 322
 323 After the text is appended, the insertion point will be at the end of the text control. If this behaviour is not desired,
 324 the programmer should use \helpref{GetInsertionPoint}{wxtextctrlgetinsertionpoint} and \helpref{SetInsertionPoint}{wxtextctrlsetinsertionpoint}.
 325
 326 \wxheading{See also}
 327
 328 \helpref{wxTextCtrl::WriteText}{wxtextctrlwritetext}
 329
 330
 331 \membersection{wxTextCtrl::AutoComplete}\label{wxtextctrlautocomplete}
 332
 333 \func{bool}{AutoComplete}{\param{const wxArrayString\& }{choices}}
 334
 335 Call this function to enable auto-completion of the text typed in a single-line
 336 text control using the given \arg{choices}.
 337
 338 Notice that currently this function is only implemented in wxGTK2 and wxMSW
 339 ports and does nothing under the other platforms.
 340
 341 \newsince{2.9.0}
 342
 343 \wxheading{Return value}
 344
 345 \true if the auto-completion was enabled or \false if the operation failed,
 346 typically because auto-completion is not supported by the current platform.
 347
 348 \wxheading{See also}
 349
 350 \helpref{AutoCompleteFileNames}{wxtextctrlautocompletefilenames}
 351
 352
 353 \membersection{wxTextCtrl::AutoCompleteFileNames}\label{wxtextctrlautocompletefilenames}
 354
 355 \func{bool}{AutoCompleteFileNames}{\void}
 356
 357 Call this function to enable auto-completion of the text typed in a single-line
 358 text control using all valid file system paths.
 359
 360 Notice that currently this function is only implemented in wxGTK2 port and does
 361 nothing under the other platforms.
 362
 363 \newsince{2.9.0}
 364
 365 \wxheading{Return value}
 366
 367 \true if the auto-completion was enabled or \false if the operation failed,
 368 typically because auto-completion is not supported by the current platform.
 369
 370 \wxheading{See also}
 371
 372 \helpref{AutoComplete}{wxtextctrlautocomplete}
 373
 374
 375 \membersection{wxTextCtrl::CanCopy}\label{wxtextctrlcancopy}
 376
 377 \func{virtual bool}{CanCopy}{\void}
 378
 379 Returns {\tt true} if the selection can be copied to the clipboard.
 380
 381
 382 \membersection{wxTextCtrl::CanCut}\label{wxtextctrlcancut}
 383
 384 \func{virtual bool}{CanCut}{\void}
 385
 386 Returns {\tt true} if the selection can be cut to the clipboard.
 387
 388
 389 \membersection{wxTextCtrl::CanPaste}\label{wxtextctrlcanpaste}
 390
 391 \func{virtual bool}{CanPaste}{\void}
 392
 393 Returns {\tt true} if the contents of the clipboard can be pasted into the
 394 text control. On some platforms (Motif, GTK) this is an approximation
 395 and returns {\tt true} if the control is editable, {\tt false} otherwise.
 396
 397
 398 \membersection{wxTextCtrl::CanRedo}\label{wxtextctrlcanredo}
 399
 400 \func{virtual bool}{CanRedo}{\void}
 401
 402 Returns {\tt true} if there is a redo facility available and the last operation
 403 can be redone.
 404
 405
 406 \membersection{wxTextCtrl::CanUndo}\label{wxtextctrlcanundo}
 407
 408 \func{virtual bool}{CanUndo}{\void}
 409
 410 Returns {\tt true} if there is an undo facility available and the last operation
 411 can be undone.
 412
 413
 414 \membersection{wxTextCtrl::Clear}\label{wxtextctrlclear}
 415
 416 \func{virtual void}{Clear}{\void}
 417
 418 Clears the text in the control.
 419
 420 Note that this function will generate a {\tt wxEVT\_COMMAND\_TEXT\_UPDATED}
 421 event.
 422
 423
 424 \membersection{wxTextCtrl::Copy}\label{wxtextctrlcopy}
 425
 426 \func{virtual void}{Copy}{\void}
 427
 428 Copies the selected text to the clipboard under Motif and MS Windows.
 429
 430
 431 \membersection{wxTextCtrl::Create}\label{wxtextctrlcreate}
 432
 433 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
 434 \param{const wxString\& }{value = ``"}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 435 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = wxTextCtrlNameStr}}
 436
 437 Creates the text control for two-step construction. Derived classes
 438 should call or replace this function. See \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlctor}\rtfsp
 439 for further details.
 440
 441
 442 \membersection{wxTextCtrl::Cut}\label{wxtextctrlcut}
 443
 444 \func{virtual void}{Cut}{\void}
 445
 446 Copies the selected text to the clipboard and removes the selection.
 447
 448
 449 \membersection{wxTextCtrl::DiscardEdits}\label{wxtextctrldiscardedits}
 450
 451 \func{void}{DiscardEdits}{\void}
 452
 453 Resets the internal `modified' flag as if the current edits had been saved.
 454
 455
 456 \membersection{wxTextCtrl::EmulateKeyPress}\label{wxtextctrlemulatekeypress}
 457
 458 \func{bool}{EmulateKeyPress}{\param{const wxKeyEvent\& }{event}}
 459
 460 This functions inserts into the control the character which would have been
 461 inserted if the given key event had occurred in the text control. The
 462 {\it event} object should be the same as the one passed to {\tt EVT\_KEY\_DOWN}
 463 handler previously by wxWidgets.
 464
 465 Please note that this function doesn't currently work correctly for all keys
 466 under any platform but MSW.
 467
 468 \wxheading{Return value}
 469
 470 {\tt true} if the event resulted in a change to the control, {\tt false}
 471 otherwise.
 472
 473
 474 \membersection{wxTextCtrl::GetDefaultStyle}\label{wxtextctrlgetdefaultstyle}
 475
 476 \constfunc{const wxTextAttr\& }{GetDefaultStyle}{\void}
 477
 478 Returns the style currently used for the new text.
 479
 480 \wxheading{See also}
 481
 482 \helpref{SetDefaultStyle}{wxtextctrlsetdefaultstyle}
 483
 484
 485 \membersection{wxTextCtrl::GetInsertionPoint}\label{wxtextctrlgetinsertionpoint}
 486
 487 \constfunc{virtual long}{GetInsertionPoint}{\void}
 488
 489 Returns the insertion point. This is defined as the zero based index of the
 490 character position to the right of the insertion point. For example, if
 491 the insertion point is at the end of the text control, it is equal to
 492 both \helpref{GetValue()}{wxtextctrlgetvalue}.Length() and
 493 \helpref{GetLastPosition()}{wxtextctrlgetlastposition}.
 494
 495 The following code snippet safely returns the character at the insertion
 496 point or the zero character if the point is at the end of the control.
 497
 498 {\small%
 499 \begin{verbatim}
 500   char GetCurrentChar(wxTextCtrl *tc) {
 501     if (tc->GetInsertionPoint() == tc->GetLastPosition())
 502       return '\0';
 503     return tc->GetValue[tc->GetInsertionPoint()];
 504   }
 505 \end{verbatim}
 506 }%
 507
 508
 509 \membersection{wxTextCtrl::GetLastPosition}\label{wxtextctrlgetlastposition}
 510
 511 \constfunc{virtual wxTextPos}{GetLastPosition}{\void}
 512
 513 Returns the zero based index of the last position in the text control,
 514 which is equal to the number of characters in the control.
 515
 516
 517 \membersection{wxTextCtrl::GetLineLength}\label{wxtextctrlgetlinelength}
 518
 519 \constfunc{int}{GetLineLength}{\param{long}{ lineNo}}
 520
 521 Gets the length of the specified line, not including any trailing newline
 522 character(s).
 523
 524 \wxheading{Parameters}
 525
 526 \docparam{lineNo}{Line number (starting from zero).}
 527
 528 \wxheading{Return value}
 529
 530 The length of the line, or -1 if {\it lineNo} was invalid.
 531
 532
 533 \membersection{wxTextCtrl::GetLineText}\label{wxtextctrlgetlinetext}
 534
 535 \constfunc{wxString}{GetLineText}{\param{long}{ lineNo}}
 536
 537 Returns the contents of a given line in the text control, not including
 538 any trailing newline character(s).
 539
 540 \wxheading{Parameters}
 541
 542 \docparam{lineNo}{The line number, starting from zero.}
 543
 544 \wxheading{Return value}
 545
 546 The contents of the line.
 547
 548
 549 \membersection{wxTextCtrl::GetNumberOfLines}\label{wxtextctrlgetnumberoflines}
 550
 551 \constfunc{int}{GetNumberOfLines}{\void}
 552
 553 Returns the number of lines in the text control buffer.
 554
 555 \wxheading{Remarks}
 556
 557 Note that even empty text controls have one line (where the insertion point
 558 is), so GetNumberOfLines() never returns $0$.
 559
 560 For wxGTK using GTK+ 1.2.x and earlier, the number of lines in a multi-line
 561 text control is calculated by actually counting newline characters in the
 562 buffer, i.e. this function returns the number of logical lines and doesn't
 563 depend on whether any of them are wrapped. For all the other platforms, the
 564 number of physical lines in the control is returned.
 565
 566 Also note that you may wish to avoid using functions that work with line
 567 numbers if you are working with controls that contain large amounts of text as
 568 this function has $O(N)$ complexity for $N$ being the number of lines.
 569
 570
 571 \membersection{wxTextCtrl::GetRange}\label{wxtextctrlgetrange}
 572
 573 \constfunc{virtual wxString}{GetRange}{\param{long}{ from}, \param{long}{ to}}
 574
 575 Returns the string containing the text starting in the positions {\it from} and
 576 up to {\it to} in the control. The positions must have been returned by another
 577 wxTextCtrl method.
 578
 579 Please note that the positions in a multiline wxTextCtrl do {\bf not}
 580 correspond to the indices in the string returned by
 581 \helpref{GetValue}{wxtextctrlgetvalue} because of the different new line
 582 representations ({\tt CR} or {\tt CR LF}) and so this method should be used to
 583 obtain the correct results instead of extracting parts of the entire value. It
 584 may also be more efficient, especially if the control contains a lot of data.
 585
 586
 587 \membersection{wxTextCtrl::GetSelection}\label{wxtextctrlgetselection}
 588
 589 \constfunc{virtual void}{GetSelection}{\param{long*}{ from}, \param{long*}{ to}}
 590
 591 Gets the current selection span. If the returned values are equal, there was
 592 no selection.
 593
 594 Please note that the indices returned may be used with the other wxTextctrl
 595 methods but don't necessarily represent the correct indices into the string
 596 returned by \helpref{GetValue()}{wxtextctrlgetvalue} for multiline controls
 597 under Windows (at least,) you should use
 598 \helpref{GetStringSelection()}{wxtextctrlgetstringselection} to get the selected
 599 text.
 600
 601 \wxheading{Parameters}
 602
 603 \docparam{from}{The returned first position.}
 604
 605 \docparam{to}{The returned last position.}
 606
 607 \pythonnote{The wxPython version of this method returns a tuple
 608 consisting of the from and to values.}
 609
 610 \perlnote{In wxPerl this method takes no parameter and returns a
 611 2-element list {\tt ( from, to )}.}
 612
 613
 614 \membersection{wxTextCtrl::GetStringSelection}\label{wxtextctrlgetstringselection}
 615
 616 \func{virtual wxString}{GetStringSelection}{\void}
 617
 618 Gets the text currently selected in the control. If there is no selection, the
 619 returned string is empty.
 620
 621
 622 \membersection{wxTextCtrl::GetStyle}\label{wxtextctrlgetstyle}
 623
 624 \func{bool}{GetStyle}{\param{long }{position}, \param{wxTextAttr\& }{style}}
 625
 626 Returns the style at this position in the text control. Not all platforms
 627 support this function.
 628
 629 \wxheading{Return value}
 630
 631 {\tt true} on success, {\tt false} if an error occurred - it may also mean that
 632 the styles are not supported under this platform.
 633
 634 \wxheading{See also}
 635
 636 \helpref{wxTextCtrl::SetStyle}{wxtextctrlsetstyle}, \helpref{wxTextAttr}{wxtextattr}
 637
 638
 639 \membersection{wxTextCtrl::GetValue}\label{wxtextctrlgetvalue}
 640
 641 \constfunc{wxString}{GetValue}{\void}
 642
 643 Gets the contents of the control. Notice that for a multiline text control,
 644 the lines will be separated by (Unix-style) $\backslash$n characters, even
 645 under Windows where they are separated by a $\backslash$r$\backslash$n
 646 sequence in the native control.
 647
 648
 649 \membersection{wxTextCtrl::HitTest}\label{wxtextctrlhittest}
 650
 651 \constfunc{wxTextCtrlHitTestResult}{HitTest}{\param{const wxPoint\& }{pt}, \param{wxTextCoord }{*col}, \param{wxTextCoord }{*row}}
 652
 653 This function finds the character at the specified position expressed in
 654 pixels. If the return code is not \texttt{wxTE\_HT\_UNKNOWN} the row and column
 655 of the character closest to this position are returned in the \arg{col} and
 656 \arg{row} parameters (unless the pointers are {\tt NULL} which is allowed).
 657
 658 Please note that this function is currently only implemented in wxUniv,
 659 wxMSW and wxGTK2 ports.
 660
 661 \wxheading{See also}
 662
 663 \helpref{PositionToXY}{wxtextctrlpositiontoxy}, \helpref{XYToPosition}{wxtextctrlxytoposition}
 664
 665 \perlnote{In wxPerl this function takes only the position argument and
 666 returns a 3-element list \texttt{(result, col, row)}}.
 667
 668
 669 \membersection{wxTextCtrl::IsEditable}\label{wxtextctrliseditable}
 670
 671 \constfunc{bool}{IsEditable}{\void}
 672
 673 Returns {\tt true} if the controls contents may be edited by user (note that it
 674 always can be changed by the program), i.e. if the control hasn't been put in
 675 read-only mode by a previous call to
 676 \helpref{SetEditable}{wxtextctrlseteditable}.
 677
 678
 679 \membersection{wxTextCtrl::IsEmpty}\label{wxtextctrlisempty}
 680
 681 \constfunc{bool}{IsEmpty}{\void}
 682
 683 Returns \true if the control is currently empty. This is the same as
 684 \texttt{GetValue().empty()} but can be much more efficient for the multiline
 685 controls containing big amounts of text.
 686
 687 \newsince{2.7.1}
 688
 689
 690 \membersection{wxTextCtrl::IsModified}\label{wxtextctrlismodified}
 691
 692 \constfunc{bool}{IsModified}{\void}
 693
 694 Returns {\tt true} if the text has been modified by user. Note that calling
 695 \helpref{SetValue}{wxtextctrlsetvalue} doesn't make the control modified.
 696
 697 \wxheading{See also}
 698
 699 \helpref{MarkDirty}{wxtextctrlmarkdirty}
 700
 701
 702 \membersection{wxTextCtrl::IsMultiLine}\label{wxtextctrlismultiline}
 703
 704 \constfunc{bool}{IsMultiLine}{\void}
 705
 706 Returns {\tt true} if this is a multi line edit control and {\tt false}
 707 otherwise.
 708
 709 \wxheading{See also}
 710
 711 \helpref{IsSingleLine}{wxtextctrlissingleline}
 712
 713
 714 \membersection{wxTextCtrl::IsSingleLine}\label{wxtextctrlissingleline}
 715
 716 \constfunc{bool}{IsSingleLine}{\void}
 717
 718 Returns {\tt true} if this is a single line edit control and {\tt false}
 719 otherwise.
 720
 721 \wxheading{See also}
 722
 723 \helpref{IsMultiLine}{wxtextctrlissingleline}
 724
 725
 726 \membersection{wxTextCtrl::LoadFile}\label{wxtextctrlloadfile}
 727
 728 \func{bool}{LoadFile}{\param{const wxString\& }{ filename}, \param{int }{fileType = wxTEXT\_TYPE\_ANY}}
 729
 730 Loads and displays the named file, if it exists.
 731
 732 \wxheading{Parameters}
 733
 734 \docparam{filename}{The filename of the file to load.}
 735
 736 \docparam{fileType}{The type of file to load. This is currently ignored in wxTextCtrl.}
 737
 738 \wxheading{Return value}
 739
 740 {\tt true} if successful, {\tt false} otherwise.
 741
 742 % VZ: commenting this out as: (a) the docs are wrong (you can't replace
 743 %     anything), (b) wxTextCtrl doesn't have any OnChar() anyhow
 744 %% \membersection{wxTextCtrl::OnChar}\label{wxtextctrlonchar}
 745 %%
 746 %% \func{void}{OnChar}{\param{wxKeyEvent\& }{event}}
 747 %%
 748 %% Default handler for character input.
 749 %%
 750 %% \wxheading{Remarks}
 751 %%
 752 %% It is possible to intercept character
 753 %% input by overriding this member. Call this function
 754 %% to let the default behaviour take place; not calling
 755 %% it results in the character being ignored. You can
 756 %% replace the {\it keyCode} member of {\it event} to
 757 %% translate keystrokes.
 758 %%
 759 %% Note that Windows and Motif have different ways
 760 %% of implementing the default behaviour. In Windows,
 761 %% calling wxTextCtrl::OnChar immediately
 762 %% processes the character. In Motif,
 763 %% calling this function simply sets a flag
 764 %% to let default processing happen. This might affect
 765 %% the way in which you write your OnChar function
 766 %% on different platforms.
 767 %%
 768 %% \wxheading{See also}
 769 %%
 770 %% \helpref{wxKeyEvent}{wxkeyevent}
 771
 772
 773 \membersection{wxTextCtrl::MarkDirty}\label{wxtextctrlmarkdirty}
 774
 775 \func{void}{MarkDirty}{\void}
 776
 777 Mark text as modified (dirty).
 778
 779 \wxheading{See also}
 780
 781 \helpref{IsModified}{wxtextctrlismodified}
 782
 783
 784 \membersection{wxTextCtrl::OnDropFiles}\label{wxtextctrlondropfiles}
 785
 786 \func{void}{OnDropFiles}{\param{wxDropFilesEvent\& }{event}}
 787
 788 This event handler function implements default drag and drop behaviour, which
 789 is to load the first dropped file into the control.
 790
 791 \wxheading{Parameters}
 792
 793 \docparam{event}{The drop files event.}
 794
 795 \wxheading{Remarks}
 796
 797 This is not implemented on non-Windows platforms.
 798
 799 \wxheading{See also}
 800
 801 \helpref{wxDropFilesEvent}{wxdropfilesevent}
 802
 803
 804 \membersection{wxTextCtrl::Paste}\label{wxtextctrlpaste}
 805
 806 \func{virtual void}{Paste}{\void}
 807
 808 Pastes text from the clipboard to the text item.
 809
 810
 811 \membersection{wxTextCtrl::PositionToXY}\label{wxtextctrlpositiontoxy}
 812
 813 \constfunc{bool}{PositionToXY}{\param{long }{pos}, \param{long *}{x}, \param{long *}{y}}
 814
 815 Converts given position to a zero-based column, line number pair.
 816
 817 \wxheading{Parameters}
 818
 819 \docparam{pos}{Position.}
 820
 821 \docparam{x}{Receives zero based column number.}
 822
 823 \docparam{y}{Receives zero based line number.}
 824
 825 \wxheading{Return value}
 826
 827 {\tt true} on success, {\tt false} on failure (most likely due to a too large position
 828 parameter).
 829
 830 \wxheading{See also}
 831
 832 \helpref{wxTextCtrl::XYToPosition}{wxtextctrlxytoposition}
 833
 834 \pythonnote{In Python, PositionToXY() returns a tuple containing the x and
 835 y values, so (x,y) = PositionToXY() is equivalent to the call described
 836 above.}
 837
 838 \perlnote{In wxPerl this method only takes the {\tt pos} parameter, and
 839 returns a 2-element list {\tt ( x, y )}.}
 840
 841
 842 \membersection{wxTextCtrl::Redo}\label{wxtextctrlredo}
 843
 844 \func{virtual void}{Redo}{\void}
 845
 846 If there is a redo facility and the last operation can be redone, redoes the last operation. Does nothing
 847 if there is no redo facility.
 848
 849
 850 \membersection{wxTextCtrl::Remove}\label{wxtextctrlremove}
 851
 852 \func{virtual void}{Remove}{\param{long}{ from}, \param{long}{ to}}
 853
 854 Removes the text starting at the first given position up to (but not including)
 855 the character at the last position.
 856
 857 \wxheading{Parameters}
 858
 859 \docparam{from}{The first position.}
 860
 861 \docparam{to}{The last position.}
 862
 863
 864 \membersection{wxTextCtrl::Replace}\label{wxtextctrlreplace}
 865
 866 \func{virtual void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{value}}
 867
 868 Replaces the text starting at the first position up to (but not including)
 869 the character at the last position with the given text.
 870
 871 \wxheading{Parameters}
 872
 873 \docparam{from}{The first position.}
 874
 875 \docparam{to}{The last position.}
 876
 877 \docparam{value}{The value to replace the existing text with.}
 878
 879
 880 \membersection{wxTextCtrl::SaveFile}\label{wxtextctrlsavefile}
 881
 882 \func{bool}{SaveFile}{\param{const wxString\& }{ filename}, \param{int }{fileType = wxTEXT\_TYPE\_ANY}}
 883
 884 Saves the contents of the control in a text file.
 885
 886 \wxheading{Parameters}
 887
 888 \docparam{filename}{The name of the file in which to save the text.}
 889
 890 \docparam{fileType}{The type of file to save. This is currently ignored in wxTextCtrl.}
 891
 892 \wxheading{Return value}
 893
 894 {\tt true} if the operation was successful, {\tt false} otherwise.
 895
 896
 897 \membersection{wxTextCtrl::SetDefaultStyle}\label{wxtextctrlsetdefaultstyle}
 898
 899 \func{bool}{SetDefaultStyle}{\param{const wxTextAttr\& }{style}}
 900
 901 Changes the default style to use for the new text which is going to be added
 902 to the control using \helpref{WriteText}{wxtextctrlwritetext} or\rtfsp
 903 \helpref{AppendText}{wxtextctrlappendtext}.
 904
 905 If either of the font, foreground, or background colour is not set in\rtfsp
 906 {\it style}, the values of the previous default style are used for them. If
 907 the previous default style didn't set them neither, the global font or colours
 908 of the text control itself are used as fall back.
 909
 910 However if the {\it style} parameter is the default wxTextAttr, then the
 911 default style is just reset (instead of being combined with the new style which
 912 wouldn't change it at all).
 913
 914 \wxheading{Parameters}
 915
 916 \docparam{style}{The style for the new text.}
 917
 918 \wxheading{Return value}
 919
 920 {\tt true} on success, {\tt false} if an error occurred - may also mean that
 921 the styles are not supported under this platform.
 922
 923 \wxheading{See also}
 924
 925 \helpref{GetDefaultStyle}{wxtextctrlgetdefaultstyle}
 926
 927
 928 \membersection{wxTextCtrl::SetEditable}\label{wxtextctrlseteditable}
 929
 930 \func{virtual void}{SetEditable}{\param{const bool}{ editable}}
 931
 932 Makes the text item editable or read-only, overriding the {\bf wxTE\_READONLY} flag.
 933
 934 \wxheading{Parameters}
 935
 936 \docparam{editable}{If {\tt true}, the control is editable. If {\tt false}, the control is read-only.}
 937
 938 \wxheading{See also}
 939
 940 \helpref{IsEditable}{wxtextctrliseditable}
 941
 942
 943 \membersection{wxTextCtrl::SetInsertionPoint}\label{wxtextctrlsetinsertionpoint}
 944
 945 \func{virtual void}{SetInsertionPoint}{\param{long}{ pos}}
 946
 947 Sets the insertion point at the given position.
 948
 949 \wxheading{Parameters}
 950
 951 \docparam{pos}{Position to set.}
 952
 953
 954 \membersection{wxTextCtrl::SetInsertionPointEnd}\label{wxtextctrlsetinsertionpointend}
 955
 956 \func{virtual void}{SetInsertionPointEnd}{\void}
 957
 958 Sets the insertion point at the end of the text control. This is equivalent
 959 to \helpref{SetInsertionPoint}{wxtextctrlsetinsertionpoint}(\helpref{GetLastPosition}{wxtextctrlgetlastposition}()).
 960
 961
 962 \membersection{wxTextCtrl::SetMaxLength}\label{wxtextctrlsetmaxlength}
 963
 964 \func{virtual void}{SetMaxLength}{\param{unsigned long }{len}}
 965
 966 This function sets the maximum number of characters the user can enter into the
 967 control. In other words, it allows to limit the text value length to {\it len}
 968 not counting the terminating {\tt NUL} character.
 969
 970 If {\it len} is $0$, the previously set max length limit, if any, is discarded
 971 and the user may enter as much text as the underlying native text control
 972 widget supports (typically at least 32Kb).
 973
 974 If the user tries to enter more characters into the text control when it
 975 already is filled up to the maximal length, a
 976 {\tt wxEVT\_COMMAND\_TEXT\_MAXLEN} event is sent to notify the program about it
 977 (giving it the possibility to show an explanatory message, for example) and the
 978 extra input is discarded.
 979
 980 Note that under GTK+, this function may only be used with single line text controls.
 981
 982 \wxheading{Compatibility}
 983
 984 Only implemented in wxMSW/wxGTK starting with wxWidgets 2.3.2.
 985
 986
 987 \membersection{wxTextCtrl::SetModified}\label{wxtextctrlsetmodified}
 988
 989 \func{void}{SetModified}{\param{bool }{modified}}
 990
 991 Marks the control as being modified by the user or not.
 992
 993 \wxheading{See also}
 994
 995 \helpref{MarkDirty}{wxtextctrlmarkdirty}, \helpref{DiscardEdits}{wxtextctrldiscardedits}
 996
 997
 998 \membersection{wxTextCtrl::SetSelection}\label{wxtextctrlsetselection}
 999
1000 \func{virtual void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}
1001
1002 Selects the text starting at the first position up to (but not including) the
1003 character at the last position. If both parameters are equal to $-1$ all text
1004 in the control is selected.
1005
1006 \wxheading{Parameters}
1007
1008 \docparam{from}{The first position.}
1009
1010 \docparam{to}{The last position.}
1011
1012
1013 \membersection{wxTextCtrl::SetStyle}\label{wxtextctrlsetstyle}
1014
1015 \func{bool}{SetStyle}{\param{long }{start}, \param{long }{end}, \param{const wxTextAttr\& }{style}}
1016
1017 Changes the style of the given range. If any attribute within {\it style} is
1018 not set, the corresponding attribute from \helpref{GetDefaultStyle()}{wxtextctrlgetdefaultstyle} is used.
1019
1020 \wxheading{Parameters}
1021
1022 \docparam{start}{The start of the range to change.}
1023
1024 \docparam{end}{The end of the range to change.}
1025
1026 \docparam{style}{The new style for the range.}
1027
1028 \wxheading{Return value}
1029
1030 {\tt true} on success, {\tt false} if an error occurred - it may also mean that
1031 the styles are not supported under this platform.
1032
1033 \wxheading{See also}
1034
1035 \helpref{wxTextCtrl::GetStyle}{wxtextctrlgetstyle}, \helpref{wxTextAttr}{wxtextattr}
1036
1037
1038 \membersection{wxTextCtrl::SetValue}\label{wxtextctrlsetvalue}
1039
1040 \func{virtual void}{SetValue}{\param{const wxString\& }{ value}}
1041
1042 Sets the text value and marks the control as not-modified (which means that
1043 \helpref{IsModified}{wxtextctrlismodified} would return {\tt false} immediately
1044 after the call to SetValue).
1045
1046 Note that this function will generate a {\tt wxEVT\_COMMAND\_TEXT\_UPDATED}
1047 event.
1048
1049 This function is deprecated and should not be used in new code. Please use the
1050 \helpref{ChangeValue}{wxtextctrlchangevalue} function instead.
1051
1052 \wxheading{Parameters}
1053
1054 \docparam{value}{The new value to set. It may contain newline characters if the text control is multi-line.}
1055
1056
1057 \membersection{wxTextCtrl::ChangeValue}\label{wxtextctrlchangevalue}
1058
1059 \func{virtual void}{ChangeValue}{\param{const wxString\& }{ value}}
1060
1061 Sets the text value and marks the control as not-modified (which means that
1062 \helpref{IsModified}{wxtextctrlismodified} would return {\tt false} immediately
1063 after the call to SetValue).
1064
1065 Note that this function will \emph{not} generate the {\tt wxEVT\_COMMAND\_TEXT\_UPDATED}
1066 event.
1067 This is the only difference with \helpref{SetValue}{wxtextctrlsetvalue}.
1068 See \helpref{this topic}{progevent} for more information.
1069
1070 \newsince{2.7.1}
1071
1072 \wxheading{Parameters}
1073
1074 \docparam{value}{The new value to set. It may contain newline characters if the text control is multi-line.}
1075
1076
1077 \membersection{wxTextCtrl::ShowPosition}\label{wxtextctrlshowposition}
1078
1079 \func{void}{ShowPosition}{\param{long}{ pos}}
1080
1081 Makes the line containing the given position visible.
1082
1083 \wxheading{Parameters}
1084
1085 \docparam{pos}{The position that should be visible.}
1086
1087
1088 \membersection{wxTextCtrl::Undo}\label{wxtextctrlundo}
1089
1090 \func{virtual void}{Undo}{\void}
1091
1092 If there is an undo facility and the last operation can be undone, undoes the last operation. Does nothing
1093 if there is no undo facility.
1094
1095
1096 \membersection{wxTextCtrl::WriteText}\label{wxtextctrlwritetext}
1097
1098 \func{void}{WriteText}{\param{const wxString\& }{ text}}
1099
1100 Writes the text into the text control at the current insertion position.
1101
1102 \wxheading{Parameters}
1103
1104 \docparam{text}{Text to write to the text control.}
1105
1106 \wxheading{Remarks}
1107
1108 Newlines in the text string
1109 are the only control characters allowed, and they will cause appropriate
1110 line breaks.  See \helpref{wxTextCtrl::\cinsert}{wxtextctrlinsert} and \helpref{wxTextCtrl::AppendText}{wxtextctrlappendtext} for more convenient ways of writing to the window.
1111
1112 After the write operation, the insertion point will be at the end of the inserted text, so subsequent write operations will be appended. To append text after the user may have interacted with the control, call \helpref{wxTextCtrl::SetInsertionPointEnd}{wxtextctrlsetinsertionpointend} before writing.
1113
1114
1115 \membersection{wxTextCtrl::XYToPosition}\label{wxtextctrlxytoposition}
1116
1117 \func{long}{XYToPosition}{\param{long}{ x}, \param{long}{ y}}
1118
1119 Converts the given zero based column and line number to a position.
1120
1121 \wxheading{Parameters}
1122
1123 \docparam{x}{The column number.}
1124
1125 \docparam{y}{The line number.}
1126
1127 \wxheading{Return value}
1128
1129 The position value, or -1 if {\tt x} or {\tt y} was invalid.
1130
1131
1132 \membersection{wxTextCtrl::operator \cinsert}\label{wxtextctrlinsert}
1133
1134 \func{wxTextCtrl\&}{operator \cinsert}{\param{const wxString\& }{s}}
1135
1136 \func{wxTextCtrl\&}{operator \cinsert}{\param{int}{ i}}
1137
1138 \func{wxTextCtrl\&}{operator \cinsert}{\param{long}{ i}}
1139
1140 \func{wxTextCtrl\&}{operator \cinsert}{\param{float}{ f}}
1141
1142 \func{wxTextCtrl\&}{operator \cinsert}{\param{double}{ d}}
1143
1144 \func{wxTextCtrl\&}{operator \cinsert}{\param{char}{ c}}
1145
1146 Operator definitions for appending to a text control, for example:
1147
1148 \begin{verbatim}
1149   wxTextCtrl *wnd = new wxTextCtrl(my_frame);
1150
1151   (*wnd) << "Welcome to text control number " << 1 << ".\n";
1152 \end{verbatim}
1153