\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}
+\wxheading{Include files}
+
+<wx/textctrl.h>
+
\wxheading{Window styles}
\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxTE\_PROCESS\_ENTER}}{The callback function will
-receive the message wxEVENT\_TYPE\_TEXT\_ENTER\_COMMAND. Note
-that this will break tab traversal for this panel item under
-Windows.}
+\twocolitem{\windowstyle{wxTE\_PROCESS\_ENTER}}{The control will generate
+the message wxEVENT\_TYPE\_TEXT\_ENTER\_COMMAND (otherwise pressing <Enter> is
+either processed internally by the control or used for navigation between
+dialog controls).}
+\twocolitem{\windowstyle{wxTE\_PROCESS\_TAB}}{The control will receieve
+EVT\_CHAR messages for TAB pressed - normally, TAB is used for passing to the
+next control in a dialog instead. For the control created with this style,
+you can still use Ctrl-Enter to pass to the next control from the keyboard.}
\twocolitem{\windowstyle{wxTE\_MULTILINE}}{The text control allows multiple lines.}
\twocolitem{\windowstyle{wxTE\_PASSWORD}}{The text will be echoed as asterisks.}
\twocolitem{\windowstyle{wxTE\_READONLY}}{The text will not be user-editable.}
-\twocolitem{\windowstyle{wxHSCROLL}}{A horizontal scrollbar will be created.}
+\twocolitem{\windowstyle{wxHSCROLL}}{A horizontal scrollbar will be created. No effect under GTK+.}
\end{twocollist}
-See also \helpref{window styles overview}{windowstyles} and
-\helpref{wxtextctrlconstr}.
+See also \helpref{window styles overview}{windowstyles} and
+\helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}.
\wxheading{Remarks}
-This class multiply-inherits from {\bf streambuf} where compilers allow, allowing code such as the following:
+This class multiply-inherits from {\bf streambuf} where compilers allow, allowing code such as
+the following:
{\small%
\begin{verbatim}
\end{verbatim}
}%
-If your compiler does not support derivation from {\bf streambuf} and gives a compile error, define the symbol {\bf NO\_TEXT\_WINDOW\_STREAM} in the
-wxTextCtrl header file.
+If your compiler does not support derivation from {\bf streambuf} and gives a compile error, define the symbol
+{\bf NO\_TEXT\_WINDOW\_STREAM} in the wxTextCtrl header file.
+
+Note that any use of C++ iostreams (including this one) deprecated and might get completely removed
+in the future.
\wxheading{Event handling}
+The following commands are processed by default event handlers in wxTextCtrl: wxID\_CUT, wxID\_COPY,
+wxID\_PASTE, wxID\_UNDO, wxID\_REDO. The associated UI update events are also processed
+automatically, when the control has the focus.
+
To process input from a text control, use these event handler macros to direct input to member
functions that take a \helpref{wxCommandEvent}{wxcommandevent} argument.
\twocolwidtha{7cm}%
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_TEXT(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_UPDATED event,
-generated when the text changes.}
+generated when the text changes. Notice that this event will always be sent
+when the text controls contents changes - whether this is due to user input or
+comes from the program itself (for example, if SetValue() is called)}
\twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_ENTER event,
generated when enter is pressed in a single-line text control.}
\end{twocollist}%
\wxheading{Remarks}
-The horizontal scrollbar ({\bf wxTE\_HSCROLL} style flag) will only be created for multi-line text controls.
-Without a horizontal scrollbar, text lines that don't fit in the control's
+The horizontal scrollbar ({\bf wxTE\_HSCROLL} style flag) will only be created for multi-line text controls.
+Without a horizontal scrollbar, text lines that don't fit in the control's
size will be wrapped (but no newline character is inserted). Single line
controls don't have a horizontal scrollbar, the text is automatically scrolled
-so that the \helpref{insertion point}{wxtextctrlgetinsertionpoint} is always
+so that the \helpref{insertion point}{wxtextctrlgetinsertionpoint} is always
visible.
Under Windows, if the {\bf wxTE\_MULTILINE} style is used, the window is implemented
as a Windows rich text control with unlimited capacity. Otherwise, normal edit control limits
apply.
-For the GTK, the single line text control is implemented as a gtk\_entry,
-while the multi-line control is a gtk\_text.
-
\wxheading{See also}
\helpref{wxTextCtrl::Create}{wxtextctrlcreate}, \helpref{wxValidator}{wxvalidator}
Destructor, destroying the text control.
+\membersection{wxTextCtrl::AppendText}\label{wxtextctrlappendtext}
+
+\func{void}{AppendText}{\param{const wxString\& }{ text}}
+
+Appends the text to the end of the text control.
+
+\wxheading{Parameters}
+
+\docparam{text}{Text to write to the text control.}
+
+\wxheading{Remarks}
+
+After the text is appended, the insertion point will be at the end of the text control. If this behaviour is not desired,
+the programmer should use \helpref{GetInsertionPoint}{wxtextctrlgetinsertionpoint} and \helpref{SetInsertionPoint}{wxtextctrlsetinsertionpoint}.
+
+\wxheading{See also}
+
+\helpref{wxTextCtrl::WriteText}{wxtextctrlwritetext}
+
+\membersection{wxTextCtrl::CanCopy}\label{wxtextctrlcancopy}
+
+\func{virtual bool}{CanCopy}{\void}
+
+Returns TRUE if the selection can be copied to the clipboard.
+
+\membersection{wxTextCtrl::CanCut}\label{wxtextctrlcancut}
+
+\func{virtual bool}{CanCut}{\void}
+
+Returns TRUE if the selection can be cut to the clipboard.
+
+\membersection{wxTextCtrl::CanPaste}\label{wxtextctrlcanpaste}
+
+\func{virtual bool}{CanPaste}{\void}
+
+Returns TRUE if the contents of the clipboard can be pasted into the
+text control. On some platforms (Motif, GTK) this is an approximation
+and returns TRUE if the control is editable, FALSE otherwise.
+
+\membersection{wxTextCtrl::CanRedo}\label{wxtextctrlcanredo}
+
+\func{virtual bool}{CanRedo}{\void}
+
+Returns TRUE if there is a redo facility available and the last operation
+can be redone.
+
+\membersection{wxTextCtrl::CanUndo}\label{wxtextctrlcanundo}
+
+\func{virtual bool}{CanUndo}{\void}
+
+Returns TRUE if there is an undo facility available and the last operation
+can be undone.
+
\membersection{wxTextCtrl::Clear}\label{wxtextctrlclear}
\func{virtual void}{Clear}{\void}
Returns the insertion point. This is defined as the zero based index of the
character position to the right of the insertion point. For example, if
the insertion point is at the end of the text control, it is equal to
-both \helpref{GetValue()}{wxtextctrlgetvalue}.Length() and
-\helpref{GetLastPosition()}{wxtextctrlgetlastposition}.
+both \helpref{GetValue()}{wxtextctrlgetvalue}.Length() and
+\helpref{GetLastPosition()}{wxtextctrlgetlastposition}.
The following code snippet safely returns the character at the insertion
point or the zero character if the point is at the end of the control.
if (tc->GetInsertionPoint() == tc->GetLastPosition())
return '\0';
return tc->GetValue[tc->GetInsertionPoint()];
- }
+ }
\end{verbatim}
}%
\constfunc{virtual long}{GetLastPosition}{\void}
-Returns the zero based index of the last position in the text control,
+Returns the zero based index of the last position in the text control,
which is equal to the number of characters in the control.
\membersection{wxTextCtrl::GetLineLength}\label{wxtextctrlgetlinelength}
\constfunc{int}{GetLineLength}{\param{long}{ lineNo}}
-Gets the length of the specified line, not including any trailing newline
+Gets the length of the specified line, not including any trailing newline
character(s).
\wxheading{Parameters}
may wish to avoid using functions that work with line numbers if you are
working with controls that contain large amounts of text.
+\membersection{wxTextCtrl::GetSelection}\label{wxtextctrlgetselection}
+
+\func{virtual void}{GetSelection}{\param{long*}{ from}, \param{long*}{ to}}
+
+Gets the current selection span. If the returned values are equal, there was
+no selection.
+
+\wxheading{Parameters}
+
+\docparam{from}{The returned first position.}
+
+\docparam{to}{The returned last position.}
+
+\pythonnote{The wxPython version of this method returns a tuple
+consisting of the from and to values.}
+
\membersection{wxTextCtrl::GetValue}\label{wxtextctrlgetvalue}
\constfunc{wxString}{GetValue}{\void}
\membersection{wxTextCtrl::PositionToXY}\label{wxtextctrlpositiontoxy}
-\constfunc{long}{PositionToXY}{\param{long }{pos}, \param{long *}{x}, \param{long *}{y}}
+\constfunc{bool}{PositionToXY}{\param{long }{pos}, \param{long *}{x}, \param{long *}{y}}
Converts given position to a zero-based column, line number pair.
\wxheading{Return value}
-Non-zero on success, zero on failure (most likely due to a too large position
+TRUE on success, FALSE on failure (most likely due to a too large position
parameter).
\wxheading{See also}
y values, so (x,y) = PositionToXY() is equivalent to the call described
above.}
+\membersection{wxTextCtrl::Redo}\label{wxtextctrlredo}
+
+\func{virtual void}{Redo}{\void}
+
+If there is a redo facility and the last operation can be redone, redoes the last operation. Does nothing
+if there is no redo facility.
+
\membersection{wxTextCtrl::Remove}\label{wxtextctrlremove}
\func{virtual void}{Remove}{\param{long}{ from}, \param{long}{ to}}
\func{virtual void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{value}}
-Replaces the text starting at the first position up to (but not including)
+Replaces the text starting at the first position up to (but not including)
the character at the last position with the given text.
\wxheading{Parameters}
\docparam{pos}{The position that should be visible.}
+\membersection{wxTextCtrl::Undo}\label{wxtextctrlundo}
+
+\func{virtual void}{Undo}{\void}
+
+If there is an undo facility and the last operation can be undone, undoes the last operation. Does nothing
+if there is no undo facility.
+
\membersection{wxTextCtrl::WriteText}\label{wxtextctrlwritetext}
\func{void}{WriteText}{\param{const wxString\& }{ text}}
-Writes the text into the text control at the current insertion position.
+Writes the text into the text control at the current insertion position.
\wxheading{Parameters}
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.
-\membersection{wxTextCtrl::AppendText}\label{wxtextctrlappendtext}
-
-\func{void}{WriteText}{\param{const wxString\& }{ text}}
-
-Appends the text to the end of the text control.
-
-\wxheading{Parameters}
-
-\docparam{text}{Text to write to the text control.}
-
-\wxheading{Remarks}
-
-After the text is appended, the insertion point will be at the end of the text control. If this behaviour is not desired,
-the programmer should use \helpref{GetInsertionPoint}{wxtextctrlgetinsertionpoint} and \helpref{SetInsertionPoint}{wxtextctrlsetinsertionpoint}.
-
-\wxheading{See also}
-
-\helpref{wxTextCtrl::WriteText}{wxtextctrlwritetext}
-
\membersection{wxTextCtrl::XYToPosition}\label{wxtextctrlxytoposition}
\func{long}{XYToPosition}{\param{long}{ x}, \param{long}{ y}}
(*wnd) << "Welcome to text control number " << 1 << ".\n";
\end{verbatim}
-
projects / wxWidgets.git / blobdiff