use wxChar correctly in wxString docs; mark wx1 compatibility functions

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

diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex
index e44427d4ff6250e2b5f5ddb1d875e7274dbb65a6..b19864deb8350ce37e0f69aac869f9b5f15be9f0 100644 (file)
--- a/docs/latex/wx/text.tex
+++ b/docs/latex/wx/text.tex
@@ -53,9 +53,6 @@ used, so that text won't be wrapped. No effect under wxGTK1.}
 \twocolitem{\windowstyle{wxTE\_WORDWRAP}}{Wrap the lines too long to be shown entirely at word boundaries (wxUniv and wxGTK2 only).}
 \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).}
 \twocolitem{\windowstyle{wxTE\_CAPITALIZE}}{On PocketPC and Smartphone, causes the first letter to be capitalized.}
 \twocolitem{\windowstyle{wxTE\_WORDWRAP}}{Wrap the lines too long to be shown entirely at word boundaries (wxUniv and wxGTK2 only).}
 \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).}
 \twocolitem{\windowstyle{wxTE\_CAPITALIZE}}{On PocketPC and Smartphone, causes the first letter to be capitalized.}

-\twocolitem{\windowstyle{wxTE\_FILENAME}}{Should be used for the text controls
-containing file names. This currently just enables file names auto-completion
-(and only under Windows for now) but can have other effects in the future.}

 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles} and \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlctor}.
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles} and \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlctor}.


@@ -221,9 +218,10 @@ 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,
 \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. Notice that this event will always be sent
+generated when the text changes. Notice that this event will be sent

 when the text controls contents changes - whether this is due to user input or
 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)}
+comes from the program itself (for example, if SetValue() is called); see ChangeValue() for
+a function which does not send this event.}

 \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_ENTER event,
 generated when enter is pressed in a text control (which must have
 wxTE\_PROCESS\_ENTER style for this event to be generated).}
 \twocolitem{{\bf EVT\_TEXT\_ENTER(id, func)}}{Respond to a wxEVT\_COMMAND\_TEXT\_ENTER event,
 generated when enter is pressed in a text control (which must have
 wxTE\_PROCESS\_ENTER style for this event to be generated).}


@@ -607,6 +605,7 @@ wxMSW and wxGTK2 ports.
 \perlnote{In wxPerl this function takes only the position argument and
 returns a 3-element list \texttt{(result, col, row)}}.
 
 \perlnote{In wxPerl this function takes only the position argument and
 returns a 3-element list \texttt{(result, col, row)}}.
 

+

 \membersection{wxTextCtrl::IsEditable}\label{wxtextctrliseditable}
 
 \constfunc{bool}{IsEditable}{\void}
 \membersection{wxTextCtrl::IsEditable}\label{wxtextctrliseditable}
 
 \constfunc{bool}{IsEditable}{\void}


@@ -617,6 +616,17 @@ read-only mode by a previous call to
 \helpref{SetEditable}{wxtextctrlseteditable}.
 
 
 \helpref{SetEditable}{wxtextctrlseteditable}.
 
 

+\membersection{wxTextCtrl::IsEmpty}\label{wxtextctrlisempty}
+
+\constfunc{bool}{IsEmpty}{\void}
+
+Returns \true if the control is currently empty. This is the same as 
+\texttt{GetValue().empty()} but can be much more efficient for the multiline
+controls containing big amounts of text.
+
+\newsince{2.7.1}
+
+

 \membersection{wxTextCtrl::IsModified}\label{wxtextctrlismodified}
 
 \constfunc{bool}{IsModified}{\void}
 \membersection{wxTextCtrl::IsModified}\label{wxtextctrlismodified}
 
 \constfunc{bool}{IsModified}{\void}


@@ -655,7 +665,7 @@ otherwise.
 
 \membersection{wxTextCtrl::LoadFile}\label{wxtextctrlloadfile}
 
 
 \membersection{wxTextCtrl::LoadFile}\label{wxtextctrlloadfile}
 

-\func{bool}{LoadFile}{\param{const wxString\& }{ filename}}
+\func{bool}{LoadFile}{\param{const wxString\& }{ filename}, \param{int }{fileType = wxTEXT\_TYPE\_ANY}}

 
 Loads and displays the named file, if it exists.
 
 
 Loads and displays the named file, if it exists.
 


@@ -663,6 +673,8 @@ Loads and displays the named file, if it exists.
 
 \docparam{filename}{The filename of the file to load.}
 
 
 \docparam{filename}{The filename of the file to load.}
 

+\docparam{fileType}{The type of file to load. This is currently ignored in wxTextCtrl.}
+

 \wxheading{Return value}
 
 {\tt true} if successful, {\tt false} otherwise.
 \wxheading{Return value}
 
 {\tt true} if successful, {\tt false} otherwise.


@@ -807,7 +819,7 @@ the character at the last position with the given text.
 
 \membersection{wxTextCtrl::SaveFile}\label{wxtextctrlsavefile}
 
 
 \membersection{wxTextCtrl::SaveFile}\label{wxtextctrlsavefile}
 

-\func{bool}{SaveFile}{\param{const wxString\& }{ filename}}
+\func{bool}{SaveFile}{\param{const wxString\& }{ filename}, \param{int }{fileType = wxTEXT\_TYPE\_ANY}}

 
 Saves the contents of the control in a text file.
 
 
 Saves the contents of the control in a text file.
 


@@ -815,6 +827,8 @@ Saves the contents of the control in a text file.
 
 \docparam{filename}{The name of the file in which to save the text.}
 
 
 \docparam{filename}{The name of the file in which to save the text.}
 

+\docparam{fileType}{The type of file to save. This is currently ignored in wxTextCtrl.}
+

 \wxheading{Return value}
 
 {\tt true} if the operation was successful, {\tt false} otherwise.
 \wxheading{Return value}
 
 {\tt true} if the operation was successful, {\tt false} otherwise.


@@ -972,6 +986,29 @@ after the call to SetValue).
 Note that this function will generate a {\tt wxEVT\_COMMAND\_TEXT\_UPDATED}
 event.
 
 Note that this function will generate a {\tt wxEVT\_COMMAND\_TEXT\_UPDATED}
 event.
 

+This function is deprecated and should not be used in new code. Please use the
+\helpref{ChangeValue}{wxtextctrlchangevalue} function instead.
+
+\wxheading{Parameters}
+
+\docparam{value}{The new value to set. It may contain newline characters if the text control is multi-line.}
+
+
+\membersection{wxTextCtrl::ChangeValue}\label{wxtextctrlchangevalue}
+
+\func{virtual void}{ChangeValue}{\param{const wxString\& }{ value}}
+
+Sets the text value and marks the control as not-modified (which means that
+\helpref{IsModified}{wxtextctrlismodified} would return {\tt false} immediately
+after the call to SetValue).
+
+Note that this function will \emph{not} generate the {\tt wxEVT\_COMMAND\_TEXT\_UPDATED} 
+event.
+This is the only difference with \helpref{SetValue}{wxtextctrlsetvalue}.
+See \helpref{this topic}{progevent} for more information.
+
+\newsince{2.7.1}
+

 \wxheading{Parameters}
 
 \docparam{value}{The new value to set. It may contain newline characters if the text control is multi-line.}
 \wxheading{Parameters}
 
 \docparam{value}{The new value to set. It may contain newline characters if the text control is multi-line.}