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