Added documentation for wxMenuBar::Refresh()

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

diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex
index d15cf7908ae5e558ef4ae055af3e4b4134416d3d..a9bf9028d5aae5146739a9f7043ebc145d053c1b 100644 (file)
--- a/docs/latex/wx/text.tex
+++ b/docs/latex/wx/text.tex
@@ -19,22 +19,27 @@ streambuf\\
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 
 \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}
 
 \end{twocollist}
 

-See also \helpref{window styles overview}{windowstyles} and 
+See also \helpref{window styles overview}{windowstyles} and

 \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}.
 
 \wxheading{Remarks}
 
 \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}
 
 {\small%
 \begin{verbatim}


@@ -47,8 +52,11 @@ 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}
 


@@ -62,7 +70,9 @@ 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.}
+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}%


@@ -105,11 +115,11 @@ 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
 visible.
 
 Under Windows, if the {\bf wxTE\_MULTILINE} style is used, the window is implemented


@@ -220,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.


@@ -232,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}
 }%
 


@@ -240,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}


@@ -302,6 +312,9 @@ no selection.
 
 \docparam{to}{The returned last 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}


@@ -383,7 +396,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.
 


@@ -397,7 +410,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}


@@ -432,7 +445,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}


@@ -528,7 +541,7 @@ if there is no undo facility.
 
 \func{void}{WriteText}{\param{const wxString\& }{ text}}
 
 
 \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}