1 %%%%%%%%%%%%%%%%%%%%%%%%%%%% wxTextAttr %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 \section{\class{wxTextAttr
}}\label{wxtextattr
}
5 wxTextAttr represents the attributes, or style, for a range of text in a
\rtfsp
6 \helpref{wxTextCtrl
}{wxtextctrl
}.
8 \wxheading{Derived from
}
12 \wxheading{Include files
}
16 \latexignore{\rtfignore{\wxheading{Members
}}}
18 \membersection{wxTextAttr::wxTextAttr
}\label{wxtextattrctor
}
20 \func{}{wxTextAttr
}{\void}
22 \func{}{wxTextAttr
}{\param{const wxColour\&
}{colText
},
\param{const wxColour\&
}{colBack = wxNullColour
},
\param{const wxFont\&
}{font = wxNullFont
}}
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.
29 \membersection{wxTextAttr::GetBackgroundColour
}
31 \constfunc{const wxColour\&
}{GetBackgroundColour
}{\void}
33 Return the background colour specified by this attribute.
35 \membersection{wxTextAttr::GetFont
}
37 \constfunc{const wxFont\&
}{GetFont
}{\void}
39 Return the text font specified by this attribute.
41 \membersection{wxTextAttr::GetTextColour
}
43 \constfunc{const wxColour\&
}{GetTextColour
}{\void}
45 Return the text colour specified by this attribute.
47 \membersection{wxTextAttr::HasBackgroundColour
}
49 \constfunc{bool
}{HasBackgroundColour
}{\void}
51 Returns
{\tt TRUE
} if this style specifies the background colour to use.
53 \membersection{wxTextAttr::HasFont
}
55 \constfunc{bool
}{HasFont
}{\void}
57 Returns
{\tt TRUE
} if this style specifies the font to use.
59 \membersection{wxTextAttr::HasTextColour
}
61 \constfunc{bool
}{HasTextColour
}{\void}
63 Returns
{\tt TRUE
} if this style specifies the foreground colour to use.
65 \membersection{wxTextAttr::IsDefault
}
67 \constfunc{bool
}{IsDefault
}{\void}
69 Returns
{\tt TRUE
} if this style specifies any non-default attributes.
71 %%%%%%%%%%%%%%%%%%%%%%%%%%%% wxTextCtrl %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
73 \section{\class{wxTextCtrl
}}\label{wxtextctrl
}
75 A text control allows text to be displayed and edited. It may be
76 single line or multi-line.
78 \wxheading{Derived from
}
81 \helpref{wxControl
}{wxcontrol
}\\
82 \helpref{wxWindow
}{wxwindow
}\\
83 \helpref{wxEvtHandler
}{wxevthandler
}\\
84 \helpref{wxObject
}{wxobject
}
86 \wxheading{Include files
}
90 \wxheading{Window styles
}
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> is
96 either processed internally by the control or used for navigation between
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
\_DONTWRAP}}{Same as
{\tt wxHSCROLL
} style.
}
118 \twocolitem{\windowstyle{wxTE
\_LINEWRAP}}{Wrap the lines too long to be shown entirely at any position (wxUniv only currently)
}
119 \twocolitem{\windowstyle{wxTE
\_WORDWRAP}}{Wrap the lines too long to be shown entirely at word boundaries only (wxUniv only currently)
}
122 See also
\helpref{window styles overview
}{windowstyles
} and
123 \helpref{wxTextCtrl::wxTextCtrl
}{wxtextctrlconstr
}.
125 \wxheading{wxTextCtrl styles
}
127 Multi-line text controls support the styles, i.e. provide a possibility to set
128 colours and font for individual characters in it (note that under Windows
{\tt
129 wxTE
\_RICH} style is required for style support). To use the styles you can
130 either call
\helpref{SetDefaultStyle
}{wxtextctrlsetdefaultstyle
} before
131 inserting the text or call
\helpref{SetStyle
}{wxtextctrlsetstyle
} later to
132 change the style of the text already in the control (the first solution is
133 much more efficient).
135 In either case, if the style doesn't specify some of the attributes (for
136 example you only want to set the text colour but without changing the font nor
137 the text background), the values of the default style will be used for them.
138 If there is no default style, the attributes of the text control itself are
141 So the following code correctly describes what it does: the second call
142 to
\helpref{SetDefaultStyle
}{wxtextctrlsetdefaultstyle
} doesn't change the
143 text foreground colour (which stays red) while the last one doesn't change the
144 background colour (which stays grey):
148 text->SetDefaultStyle(wxTextAttr
(*wxRED));
149 text->AppendText("Red text\n");
150 text->SetDefaultStyle(wxTextAttr(wxNullColour, *wxLIGHT_GREY));
151 text->AppendText("Red on grey text\n");
152 text->SetDefaultStyle(wxTextAttr(*wxBLUE);
153 text->AppendText("Blue on grey text\n");
157 \wxheading{wxTextCtrl and C++ streams}
159 This class multiply-inherits from {\bf streambuf} where compilers allow,
160 allowing code such as the following:
164 wxTextCtrl *control = new wxTextCtrl(...);
166 ostream stream(control)
168 stream << 123.456 << " some text\n";
173 If your compiler does not support derivation from {\bf streambuf} and gives a
174 compile error, define the symbol {\bf NO\_TEXT\_WINDOW\_STREAM} in the
175 wxTextCtrl header file.
177 Note that independently of this setting you can always use wxTextCtrl itself
178 in a stream-like manner:
182 wxTextCtrl *control = new wxTextCtrl(...);
184 *control << 123.456 << " some text\n";
188 always works. However the possibility to create an ostream associated with
189 wxTextCtrl may be useful if you need to redirect the output of a function
190 taking an ostream as parameter to a text control.
192 Another commonly requested need is to redirect {\bf std::cout} to the text
193 control. This could be done in the following way:
199 wxTextCtrl *control = new wxTextCtrl(...);
201 std::streambuf *sbOld = std::cout.rdbuf();
202 std::cout.rdbuf(*control);
204 // use cout as usual, the output appears in the text control
207 std::cout.rdbuf(sbOld);
211 But wxWindows provides a convenient class to make it even simpler so instead
218 wxTextCtrl *control = new wxTextCtrl(...);
220 wxStreamToTextRedirector redirect(control);
222 // all output to cout goes into the text control until the exit from current
227 See \helpref{wxStreamToTextRedirector}{wxstreamtotextredirector} for more
230 \wxheading{Event handling}
232 The following commands are processed by default event handlers in wxTextCtrl: wxID\_CUT, wxID\_COPY,
233 wxID\_PASTE, wxID\_UNDO, wxID\_REDO. The associated UI update events are also processed
234 automatically, when the control has the focus.
236 To process input from a text control, use these event handler macros to direct input to member
237 functions that take a \helpref{wxCommandEvent}{wxcommandevent} argument.
240 \begin{twocollist}\itemsep=0pt
241 \twocolitem{{\bf EVT\_TEXT(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_UPDATED event,
242 generated when the text changes. Notice that this event will always be sent
243 when the text controls contents changes - whether this is due to user input or
244 comes from the program itself (for example, if SetValue() is called)}
245 \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_ENTER event,
246 generated when enter is pressed in a single-line text control.}
247 \twocolitem{{\bf EVT\_TEXT\_URL(id, func)}}{A mouse event occured over an URL
248 in the text control (Win32 only)}
249 \twocolitem{{\bf EVT\_TEXT\_MAXLEN(id, func)}}{User tried to enter more text
250 into the control than the limit set by
251 \helpref{SetMaxLength}{wxtextctrlsetmaxlength}.}
254 \latexignore{\rtfignore{\wxheading{Members}}}
256 \membersection{wxTextCtrl::wxTextCtrl}\label{wxtextctrlconstr}
258 \func{}{wxTextCtrl}{\void}
262 \func{}{wxTextCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
263 \param{const wxString\& }{value = ``"}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
264 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = wxTextCtrlNameStr}}
266 Constructor, creating and showing a text control.
268 \wxheading{Parameters}
270 \docparam{parent}{Parent window. Should not be NULL.}
272 \docparam{id}{Control identifier. A value of -1 denotes a default value.}
274 \docparam{value}{Default text value.}
276 \docparam{pos}{Text control position.}
278 \docparam{size}{Text control size.}
280 \docparam{style}{Window style. See \helpref{wxTextCtrl}{wxtextctrl}.}
282 \docparam{validator}{Window validator.}
284 \docparam{name}{Window name.}
288 The horizontal scrollbar ({\bf wxHSCROLL} style flag) will only be created
289 for multi-line text controls.
290 Without a horizontal scrollbar, text lines that don't fit in the control's
291 size will be wrapped (but no newline character is inserted). Single line
292 controls don't have a horizontal scrollbar, the text is automatically scrolled
293 so that the \helpref{insertion point}{wxtextctrlgetinsertionpoint} is always
296 % VZ: this is no longer true
297 %Under Windows, if the {\bf wxTE\_MULTILINE} style is used, the window is implemented
298 %as a Windows rich text control with unlimited capacity. Otherwise, normal edit control limits
303 \helpref{wxTextCtrl::Create}{wxtextctrlcreate}, \helpref{wxValidator}{wxvalidator}
305 \membersection{wxTextCtrl::\destruct{wxTextCtrl}}
307 \func{}{\destruct{wxTextCtrl}}{\void}
309 Destructor, destroying the text control.
311 \membersection{wxTextCtrl::AppendText}\label{wxtextctrlappendtext}
313 \func{void}{AppendText}{\param{const wxString\& }{ text}}
315 Appends the text to the end of the text control.
317 \wxheading{Parameters}
319 \docparam{text}{Text to write to the text control.}
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}.
328 \helpref{wxTextCtrl::WriteText}{wxtextctrlwritetext}
330 \membersection{wxTextCtrl::CanCopy}\label{wxtextctrlcancopy}
332 \func{virtual bool}{CanCopy}{\void}
334 Returns {\tt TRUE} if the selection can be copied to the clipboard.
336 \membersection{wxTextCtrl::CanCut}\label{wxtextctrlcancut}
338 \func{virtual bool}{CanCut}{\void}
340 Returns {\tt TRUE} if the selection can be cut to the clipboard.
342 \membersection{wxTextCtrl::CanPaste}\label{wxtextctrlcanpaste}
344 \func{virtual bool}{CanPaste}{\void}
346 Returns {\tt TRUE} if the contents of the clipboard can be pasted into the
347 text control. On some platforms (Motif, GTK) this is an approximation
348 and returns {\tt TRUE} if the control is editable, {\tt FALSE} otherwise.
350 \membersection{wxTextCtrl::CanRedo}\label{wxtextctrlcanredo}
352 \func{virtual bool}{CanRedo}{\void}
354 Returns {\tt TRUE} if there is a redo facility available and the last operation
357 \membersection{wxTextCtrl::CanUndo}\label{wxtextctrlcanundo}
359 \func{virtual bool}{CanUndo}{\void}
361 Returns {\tt TRUE} if there is an undo facility available and the last operation
364 \membersection{wxTextCtrl::Clear}\label{wxtextctrlclear}
366 \func{virtual void}{Clear}{\void}
368 Clears the text in the control.
370 \membersection{wxTextCtrl::Copy}\label{wxtextctrlcopy}
372 \func{virtual void}{Copy}{\void}
374 Copies the selected text to the clipboard under Motif and MS Windows.
376 \membersection{wxTextCtrl::Create}\label{wxtextctrlcreate}
378 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
379 \param{const wxString\& }{value = ``"}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
380 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = wxTextCtrlNameStr}}
382 Creates the text control for two-step construction. Derived classes
383 should call or replace this function. See \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}\rtfsp
386 \membersection{wxTextCtrl::Cut}\label{wxtextctrlcut}
388 \func{virtual void}{Cut}{\void}
390 Copies the selected text to the clipboard and removes the selection.
392 \membersection{wxTextCtrl::DiscardEdits}
394 \func{void}{DiscardEdits}{\void}
396 Resets the internal `modified' flag as if the current edits had been saved.
398 \membersection{wxTextCtrl::EmulateKeyPress}
400 \func{bool}{EmulateKeyPress}{\param{const wxKeyEvent\& }{event}}
402 This functions inserts into the control the character which would have been
403 inserted if the given key event had occured in the text control. The
404 {\it event} object should be the same as the one passed to {\tt EVT\_KEY\_DOWN}
405 handler previously by wxWindows.
407 \wxheading{Return value}
409 {\tt TRUE} if the event resulted in a change to the control, {\tt FALSE}
412 \membersection{wxTextCtrl::GetDefaultStyle}\label{wxtextctrlgetdefaultstyle}
414 \constfunc{const wxTextAttr\& }{GetDefaultStyle}{\void}
416 Returns the style currently used for the new text.
420 \helpref{SetDefaultStyle}{wxtextctrlsetdefaultstyle}
422 \membersection{wxTextCtrl::GetInsertionPoint}\label{wxtextctrlgetinsertionpoint}
424 \constfunc{virtual long}{GetInsertionPoint}{\void}
426 Returns the insertion point. This is defined as the zero based index of the
427 character position to the right of the insertion point. For example, if
428 the insertion point is at the end of the text control, it is equal to
429 both \helpref{GetValue()}{wxtextctrlgetvalue}.Length() and
430 \helpref{GetLastPosition()}{wxtextctrlgetlastposition}.
432 The following code snippet safely returns the character at the insertion
433 point or the zero character if the point is at the end of the control.
437 char GetCurrentChar(wxTextCtrl *tc) {
438 if (tc->GetInsertionPoint() == tc->GetLastPosition())
440 return tc->GetValue[tc->GetInsertionPoint()];
445 \membersection{wxTextCtrl::GetLastPosition}\label{wxtextctrlgetlastposition}
447 \constfunc{virtual long}{GetLastPosition}{\void}
449 Returns the zero based index of the last position in the text control,
450 which is equal to the number of characters in the control.
452 \membersection{wxTextCtrl::GetLineLength}\label{wxtextctrlgetlinelength}
454 \constfunc{int}{GetLineLength}{\param{long}{ lineNo}}
456 Gets the length of the specified line, not including any trailing newline
459 \wxheading{Parameters}
461 \docparam{lineNo}{Line number (starting from zero).}
463 \wxheading{Return value}
465 The length of the line, or -1 if {\it lineNo} was invalid.
467 \membersection{wxTextCtrl::GetLineText}\label{wxtextctrlgetlinetext}
469 \constfunc{wxString}{GetLineText}{\param{long}{ lineNo}}
471 Returns the contents of a given line in the text control, not including
472 any trailing newline character(s).
474 \wxheading{Parameters}
476 \docparam{lineNo}{The line number, starting from zero.}
478 \wxheading{Return value}
480 The contents of the line.
482 \membersection{wxTextCtrl::GetNumberOfLines}\label{wxtextctrlgetnumberoflines}
484 \constfunc{int}{GetNumberOfLines}{\void}
486 Returns the number of lines in the text control buffer.
490 Note that even empty text controls have one line (where the insertion point
491 is), so GetNumberOfLines() never returns 0.
493 For gtk\_text (multi-line) controls, the number of lines is
494 calculated by actually counting newline characters in the buffer. You
495 may wish to avoid using functions that work with line numbers if you are
496 working with controls that contain large amounts of text.
498 \membersection{wxTextCtrl::GetRange}\label{wxtextctrlgetrange}
500 \constfunc{virtual wxString}{GetRange}{\param{long}{ from}, \param{long}{ to}}
502 Returns the string containing the text staring in the positions {\it from} and
503 up to {\it to} in the control. The positions must have been returned by another
506 Please note that the positions in a multiline wxTextCtrl do {\bf not}
507 correspond to the indices in the string returned by
508 \helpref{GetValue}{wxtextctrlgetvalue} because of the different new line
509 representations ({\tt CR} or {\tt CR LF}) and so this method should be used to
510 obtain the correct results instead of extracting parts of the entire value. It
511 may also be more efficient, especially if the control contains a lot of data.
513 \membersection{wxTextCtrl::GetSelection}\label{wxtextctrlgetselection}
515 \constfunc{virtual void}{GetSelection}{\param{long*}{ from}, \param{long*}{ to}}
517 Gets the current selection span. If the returned values are equal, there was
520 Please note that the indices returned may be used with the other wxTextctrl
521 methods but don't necessarily represent the correct indices into the string
522 returned by \helpref{GetValue()}{wxtextctrlgetvalue} for multiline controls
523 under Windows (at least,) you should use
524 \helpref{GetStringSelection()}{wxtextctrlgetstringselection} to get the selected
527 \wxheading{Parameters}
529 \docparam{from}{The returned first position.}
531 \docparam{to}{The returned last position.}
533 \pythonnote{The wxPython version of this method returns a tuple
534 consisting of the from and to values.}
536 \perlnote{In wxPerl this method takes no parameter and returns a
537 2-element list {\tt ( from, to )}.}
539 \membersection{wxTextCtrl::GetStringSelection}\label{wxtextctrlgetstringselection}
541 \func{virtual wxString}{GetStringSelection}{\void}
543 Gets the text currently selected in the control. If there is no selection, the
544 returned string is empty.
546 \membersection{wxTextCtrl::GetValue}\label{wxtextctrlgetvalue}
548 \constfunc{wxString}{GetValue}{\void}
550 Gets the contents of the control. Notice that for a multiline text control,
551 the lines will be separated by (Unix-style) $\backslash$n characters, even under
552 Windows where they are separated by a $\backslash$r$\backslash$n sequence in the native control.
554 \membersection{wxTextCtrl::IsEditable}\label{wxtextctrliseditable}
556 \constfunc{bool}{IsEditable}{\void}
558 Returns {\tt TRUE} if the controls contents may be edited by user (note that it
559 always can be changed by the program), i.e. if the control hasn't been put in
560 read-only mode by a previous call to
561 \helpref{SetEditable}{wxtextctrlseteditable}.
563 \membersection{wxTextCtrl::IsModified}\label{wxtextctrlismodified}
565 \constfunc{bool}{IsModified}{\void}
567 Returns {\tt TRUE} if the text has been modified by user. Note that calling
568 \helpref{SetValue}{wxtextctrlsetvalue} doesn't make the control modified.
570 \membersection{wxTextCtrl::LoadFile}\label{wxtextctrlloadfile}
572 \func{bool}{LoadFile}{\param{const wxString\& }{ filename}}
574 Loads and displays the named file, if it exists.
576 \wxheading{Parameters}
578 \docparam{filename}{The filename of the file to load.}
580 \wxheading{Return value}
582 {\tt TRUE} if successful, {\tt FALSE} otherwise.
584 % VZ: commenting this out as: (a) the docs are wrong (you can't replace
585 % anything), (b) wxTextCtrl doesn't have any OnChar() anyhow
586 %% \membersection{wxTextCtrl::OnChar}\label{wxtextctrlonchar}
588 %% \func{void}{OnChar}{\param{wxKeyEvent\& }{event}}
590 %% Default handler for character input.
592 %% \wxheading{Remarks}
594 %% It is possible to intercept character
595 %% input by overriding this member. Call this function
596 %% to let the default behaviour take place; not calling
597 %% it results in the character being ignored. You can
598 %% replace the {\it keyCode} member of {\it event} to
599 %% translate keystrokes.
601 %% Note that Windows and Motif have different ways
602 %% of implementing the default behaviour. In Windows,
603 %% calling wxTextCtrl::OnChar immediately
604 %% processes the character. In Motif,
605 %% calling this function simply sets a flag
606 %% to let default processing happen. This might affect
607 %% the way in which you write your OnChar function
608 %% on different platforms.
610 %% \wxheading{See also}
612 %% \helpref{wxKeyEvent}{wxkeyevent}
614 \membersection{wxTextCtrl::OnDropFiles}\label{wxtextctrlondropfiles}
616 \func{void}{OnDropFiles}{\param{wxDropFilesEvent\& }{event}}
618 This event handler function implements default drag and drop behaviour, which
619 is to load the first dropped file into the control.
621 \wxheading{Parameters}
623 \docparam{event}{The drop files event.}
627 This is not implemented on non-Windows platforms.
631 \helpref{wxDropFilesEvent}{wxdropfilesevent}
633 \membersection{wxTextCtrl::Paste}\label{wxtextctrlpaste}
635 \func{virtual void}{Paste}{\void}
637 Pastes text from the clipboard to the text item.
639 \membersection{wxTextCtrl::PositionToXY}\label{wxtextctrlpositiontoxy}
641 \constfunc{bool}{PositionToXY}{\param{long }{pos}, \param{long *}{x}, \param{long *}{y}}
643 Converts given position to a zero-based column, line number pair.
645 \wxheading{Parameters}
647 \docparam{pos}{Position.}
649 \docparam{x}{Receives zero based column number.}
651 \docparam{y}{Receives zero based line number.}
653 \wxheading{Return value}
655 {\tt TRUE} on success, {\tt FALSE} on failure (most likely due to a too large position
660 \helpref{wxTextCtrl::XYToPosition}{wxtextctrlxytoposition}
662 \pythonnote{In Python, PositionToXY() returns a tuple containing the x and
663 y values, so (x,y) = PositionToXY() is equivalent to the call described
666 \perlnote{In wxPerl this method only takes the {\tt pos} parameter, and
667 returns a 2-element list {\tt ( x, y )}.}
669 \membersection{wxTextCtrl::Redo}\label{wxtextctrlredo}
671 \func{virtual void}{Redo}{\void}
673 If there is a redo facility and the last operation can be redone, redoes the last operation. Does nothing
674 if there is no redo facility.
676 \membersection{wxTextCtrl::Remove}\label{wxtextctrlremove}
678 \func{virtual void}{Remove}{\param{long}{ from}, \param{long}{ to}}
680 Removes the text starting at the first given position up to (but not including)
681 the character at the last position.
683 \wxheading{Parameters}
685 \docparam{from}{The first position.}
687 \docparam{to}{The last position.}
689 \membersection{wxTextCtrl::Replace}\label{wxtextctrlreplace}
691 \func{virtual void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{value}}
693 Replaces the text starting at the first position up to (but not including)
694 the character at the last position with the given text.
696 \wxheading{Parameters}
698 \docparam{from}{The first position.}
700 \docparam{to}{The last position.}
702 \docparam{value}{The value to replace the existing text with.}
704 \membersection{wxTextCtrl::SaveFile}\label{wxtextctrlsavefile}
706 \func{bool}{SaveFile}{\param{const wxString\& }{ filename}}
708 Saves the contents of the control in a text file.
710 \wxheading{Parameters}
712 \docparam{filename}{The name of the file in which to save the text.}
714 \wxheading{Return value}
716 {\tt TRUE} if the operation was successful, {\tt FALSE} otherwise.
718 \membersection{wxTextCtrl::SetDefaultStyle}\label{wxtextctrlsetdefaultstyle}
720 \func{bool}{SetDefaultStyle}{\param{const wxTextAttr\& }{style}}
722 Changes the default style to use for the new text which is going to be added
723 to the control using \helpref{WriteText}{wxtextctrlwritetext} or\rtfsp
724 \helpref{AppendText}{wxtextctrlappendtext}.
726 If either of the font, foreground, or background colour is not set in\rtfsp
727 {\it style}, the values of the previous default style are used for them. If
728 the previous default style didn't set them neither, the global font or colours
729 of the text control itself are used as fall back.
731 However if the {\it style} parameter is the default wxTextAttr, then the
732 default style is just reset (instead of being combined with the new style which
733 wouldn't change it at all).
735 \wxheading{Parameters}
737 \docparam{style}{The style for the new text.}
739 \wxheading{Return value}
741 {\tt TRUE} on success, {\tt FALSE} if an error occured - may also mean that
742 the styles are not supported under this platform.
746 \helpref{GetDefaultStyle}{wxtextctrlgetdefaultstyle}
748 \membersection{wxTextCtrl::SetEditable}\label{wxtextctrlseteditable}
750 \func{virtual void}{SetEditable}{\param{const bool}{ editable}}
752 Makes the text item editable or read-only, overriding the {\bf wxTE\_READONLY} flag.
754 \wxheading{Parameters}
756 \docparam{editable}{If {\tt TRUE}, the control is editable. If {\tt FALSE}, the control is read-only.}
760 \helpref{IsEditable}{wxtextctrliseditable}
762 \membersection{wxTextCtrl::SetInsertionPoint}\label{wxtextctrlsetinsertionpoint}
764 \func{virtual void}{SetInsertionPoint}{\param{long}{ pos}}
766 Sets the insertion point at the given position.
768 \wxheading{Parameters}
770 \docparam{pos}{Position to set.}
772 \membersection{wxTextCtrl::SetInsertionPointEnd}\label{wxtextctrlsetinsertionpointend}
774 \func{virtual void}{SetInsertionPointEnd}{\void}
776 Sets the insertion point at the end of the text control. This is equivalent
777 to \helpref{SetInsertionPoint}{wxtextctrlsetinsertionpoint}(\helpref{GetLastPosition}{wxtextctrlgetlastposition}()).
779 \membersection{wxTextCtrl::SetMaxLength}\label{wxtextctrlsetmaxlength}
781 \func{virtual void}{SetMaxLength}{\param{unsigned long }{len}}
783 This function sets the maximum number of characters the user can enter into the
784 control. In other words, it allows to limit the text value length to {\it len}
785 not counting the terminating {\tt NUL} character.
787 If {\it len} is $0$, the previously set max length limit, if any, is discarded
788 and the user may enter as much text as the underlying native text control
789 widget supports (typically at least 32Kb).
791 If the user tries to enter more characters into the text control when it
792 already is filled up to the maximal length, a
793 {\tt wxEVT\_COMMAND\_TEXT\_MAXLEN} event is sent to notify the program about it
794 (giving it the possibility to show an explanatory message, for example) and the
795 extra input is discarded.
797 Note that this function may only be used with single line text controls.
799 \wxheading{Compatibility}
801 Only implemented in wxMSW/wxGTK starting with wxWindows 2.3.2.
803 \membersection{wxTextCtrl::SetSelection}\label{wxtextctrlsetselection}
805 \func{virtual void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}
807 Selects the text starting at the first position up to (but not including) the character at the last position.
809 \wxheading{Parameters}
811 \docparam{from}{The first position.}
813 \docparam{to}{The last position.}
815 \membersection{wxTextCtrl::SetStyle}\label{wxtextctrlsetstyle}
817 \func{bool}{SetStyle}{\param{long }{start}, \param{long }{end}, \param{const wxTextAttr\& }{style}}
819 Changes the style of the selection. If either of the font, foreground, or
820 background colour is not set in {\it style}, the values of\rtfsp
821 \helpref{GetDefaultStyle()}{wxtextctrlgetdefaultstyle} are used.
823 \wxheading{Parameters}
825 \docparam{start}{The start of selection to change.}
827 \docparam{end}{The end of selection to change.}
829 \docparam{style}{The new style for the selection.}
831 \wxheading{Return value}
833 {\tt TRUE} on success, {\tt FALSE} if an error occured - may also mean that
834 the styles are not supported under this platform.
836 \membersection{wxTextCtrl::SetValue}\label{wxtextctrlsetvalue}
838 \func{virtual void}{SetValue}{\param{const wxString\& }{ value}}
840 Sets the text value and marks the control as not-modified (which means that
841 \helpref{IsModified}{wxtextctrlismodified} would return {\tt FALSE} immediately
842 after the call to SetValue).
844 \wxheading{Parameters}
846 \docparam{value}{The new value to set. It may contain newline characters if the text control is multi-line.}
848 \membersection{wxTextCtrl::ShowPosition}\label{wxtextctrlshowposition}
850 \func{void}{ShowPosition}{\param{long}{ pos}}
852 Makes the line containing the given position visible.
854 \wxheading{Parameters}
856 \docparam{pos}{The position that should be visible.}
858 \membersection{wxTextCtrl::Undo}\label{wxtextctrlundo}
860 \func{virtual void}{Undo}{\void}
862 If there is an undo facility and the last operation can be undone, undoes the last operation. Does nothing
863 if there is no undo facility.
865 \membersection{wxTextCtrl::WriteText}\label{wxtextctrlwritetext}
867 \func{void}{WriteText}{\param{const wxString\& }{ text}}
869 Writes the text into the text control at the current insertion position.
871 \wxheading{Parameters}
873 \docparam{text}{Text to write to the text control.}
877 Newlines in the text string
878 are the only control characters allowed, and they will cause appropriate
879 line breaks. See \helpref{wxTextCtrl::\cinsert}{wxtextctrlinsert} and \helpref{wxTextCtrl::AppendText}{wxtextctrlappendtext} for more convenient ways of writing to the window.
881 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.
883 \membersection{wxTextCtrl::XYToPosition}\label{wxtextctrlxytoposition}
885 \func{long}{XYToPosition}{\param{long}{ x}, \param{long}{ y}}
887 Converts the given zero based column and line number to a position.
889 \wxheading{Parameters}
891 \docparam{x}{The column number.}
893 \docparam{y}{The line number.}
895 \wxheading{Return value}
899 \membersection{wxTextCtrl::operator \cinsert}\label{wxtextctrlinsert}
901 \func{wxTextCtrl\&}{operator \cinsert}{\param{const wxString\& }{s}}
903 \func{wxTextCtrl\&}{operator \cinsert}{\param{int}{ i}}
905 \func{wxTextCtrl\&}{operator \cinsert}{\param{long}{ i}}
907 \func{wxTextCtrl\&}{operator \cinsert}{\param{float}{ f}}
909 \func{wxTextCtrl\&}{operator \cinsert}{\param{double}{ d}}
911 \func{wxTextCtrl\&}{operator \cinsert}{\param{char}{ c}}
913 Operator definitions for appending to a text control, for example:
916 wxTextCtrl *wnd = new wxTextCtrl(my_frame);
918 (*wnd) << "Welcome to text control number " << 1 << ".\n";