Chnaged includes to work without precompiled headers

[wxWidgets.git] / docs / latex / wx / text.tex

diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex
index 80f68cc1c75e368aabd24da7f5107deb86f6b056..ce3b6c77db6e6f1f001bd2f8029d317525e5c976 100644 (file)
--- a/docs/latex/wx/text.tex
+++ b/docs/latex/wx/text.tex
@@ -11,26 +11,35 @@ streambuf\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/textctrl.h>
+

 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \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{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 
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles} and 

-\helpref{wxtextctrlconstr}.
+\helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}.

 
 \wxheading{Remarks}
 
 
 \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}
 
 {\small%
 \begin{verbatim}


@@ -43,18 +52,27 @@ This class multiply-inherits from {\bf streambuf} where compilers allow, allowin
 \end{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}
 
 
 \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,
 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}%
 \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}%


@@ -97,20 +115,17 @@ Constructor, creating and showing a text control.
 
 \wxheading{Remarks}
 
 
 \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
 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.
 
 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}
 \wxheading{See also}
 
 \helpref{wxTextCtrl::Create}{wxtextctrlcreate}, \helpref{wxValidator}{wxvalidator}


@@ -121,6 +136,59 @@ while the multi-line control is a gtk\_text.
 
 Destructor, destroying the text control.
 
 
 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}
 \membersection{wxTextCtrl::Clear}\label{wxtextctrlclear}
 
 \func{virtual void}{Clear}{\void}


@@ -162,8 +230,8 @@ Resets the internal `modified' flag as if the current edits had been saved.
 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
 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.
 
 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.


@@ -174,7 +242,7 @@ 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()];
     if (tc->GetInsertionPoint() == tc->GetLastPosition())
       return '\0';
     return tc->GetValue[tc->GetInsertionPoint()];

-  }    
+  }

 \end{verbatim}
 }%
 
 \end{verbatim}
 }%
 


@@ -182,14 +250,14 @@ point or the zero character if the point is at the end of the control.
 
 \constfunc{virtual long}{GetLastPosition}{\void}
 
 
 \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}}
 
 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}
 character(s).
 
 \wxheading{Parameters}


@@ -231,11 +299,29 @@ calculated by actually counting newline characters in the buffer. You
 may wish to avoid using functions that work with line numbers if you are
 working with controls that contain large amounts of text.
 
 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::GetValue}\label{wxtextctrlgetvalue}
 
 \constfunc{wxString}{GetValue}{\void}
 

-Gets the contents of the control.
+Gets the contents of the control. Notice that for a multiline text control,
+the lines will be separated by (Unix-style) $\backslash$n characters, even under
+Windows where they are separated by a $\backslash$r$\backslash$n sequence in the native control.

 
 \membersection{wxTextCtrl::IsModified}\label{wxtextctrlismodified}
 
 
 \membersection{wxTextCtrl::IsModified}\label{wxtextctrlismodified}
 


@@ -298,7 +384,7 @@ is to load the first dropped file into the control.
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-This is not yet implemented for the GTK.
+This is not implemented on non-Windows platforms.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -312,7 +398,7 @@ Pastes text from the clipboard to the text item.
 
 \membersection{wxTextCtrl::PositionToXY}\label{wxtextctrlpositiontoxy}
 
 
 \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.
 
 
 Converts given position to a zero-based column, line number pair.
 


@@ -326,7 +412,7 @@ Converts given position to a zero-based column, line number pair.
 
 \wxheading{Return value}
 
 
 \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}
 parameter).
 
 \wxheading{See also}


@@ -337,6 +423,13 @@ parameter).
 y values, so (x,y) = PositionToXY() is equivalent to the call described
 above.}
 
 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}}
 \membersection{wxTextCtrl::Remove}\label{wxtextctrlremove}
 
 \func{virtual void}{Remove}{\param{long}{ from}, \param{long}{ to}}


@@ -354,7 +447,7 @@ the character at the last position.
 
 \func{virtual void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{value}}
 
 
 \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}
 the character at the last position with the given text.
 
 \wxheading{Parameters}


@@ -383,8 +476,7 @@ TRUE if the operation was successful, FALSE otherwise.
 
 \func{virtual void}{SetEditable}{\param{const bool}{ editable}}
 
 
 \func{virtual void}{SetEditable}{\param{const bool}{ editable}}
 

-Makes the text item editable or read-only, overriding the {\bf wxTE\_READONLY}
-flag.
+Makes the text item editable or read-only, overriding the {\bf wxTE\_READONLY} flag.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -439,11 +531,18 @@ Makes the line containing the given position visible.
 
 \docparam{pos}{The position that should be visible.}
 
 
 \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}}
 
 \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}
 
 
 \wxheading{Parameters}
 


@@ -453,7 +552,7 @@ Writes the text into the text control at the current insertion position.
 
 Newlines in the text string
 are the only control characters allowed, and they will cause appropriate
 
 Newlines in the text string
 are the only control characters allowed, and they will cause appropriate

-line breaks.  See \helpref{wxTextCtrl::\cinsert}{wxtextctrlinsert} for more convenient ways of writing to the window.
+line breaks.  See \helpref{wxTextCtrl::\cinsert}{wxtextctrlinsert} and \helpref{wxTextCtrl::AppendText}{wxtextctrlappendtext} for more convenient ways of writing to the window.

 
 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.
 
 
 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.
 


@@ -487,7 +586,7 @@ The position value.
 
 \func{wxTextCtrl\&}{operator \cinsert}{\param{char}{ c}}
 
 
 \func{wxTextCtrl\&}{operator \cinsert}{\param{char}{ c}}
 

-Operator definitions for writing to a text control, for example:
+Operator definitions for appending to a text control, for example:

 
 \begin{verbatim}
   wxTextCtrl *wnd = new wxTextCtrl(my_frame);
 
 \begin{verbatim}
   wxTextCtrl *wnd = new wxTextCtrl(my_frame);


@@ -495,4 +594,3 @@ Operator definitions for writing to a text control, for example:
   (*wnd) << "Welcome to text control number " << 1 << ".\n";
 \end{verbatim}
 
   (*wnd) << "Welcome to text control number " << 1 << ".\n";
 \end{verbatim}
 

-