docs/latex/wx/text.tex

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