Added wxDC::GetPartialTextExtents

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

diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex
index f5fe95c452bf799fe08202cebf896a8f72eb3a61..8aa7927cfb13770dd9e36621ee7df0b30c43dac5 100644 (file)
--- a/docs/latex/wx/text.tex
+++ b/docs/latex/wx/text.tex
@@ -17,6 +17,17 @@ No base class
 
 <wx/textctrl.h>
 
 
 <wx/textctrl.h>
 

+\wxheading{Typedefs}
+
+\texttt{wxTextPos} is the type containing the index of a position in a text
+control. \texttt{wxTextCoord} contains the index of a column or a row in the
+control.
+
+Note that alghough both of these types should probably have been unsigned, due
+to backwards compatibility reasons, are defined as \texttt{long} currently.
+Their use (instead of plain \texttt{long}) is still encouraged as it makes the
+code more readable.
+

 \wxheading{Constants}
 
 The following values can be passed to SetAlignment to determine
 \wxheading{Constants}
 
 The following values can be passed to SetAlignment to determine


@@ -59,8 +70,27 @@ for a text control.
 \end{verbatim}
 }
 
 \end{verbatim}
 }
 

+The values below are the possible return codes of the 
+\helpref{HitTest}{wxtextctrlhittest} method:
+{\small
+\begin{verbatim}
+// the point asked is ...
+enum wxTextCtrlHitTestResult
+{
+    wxTE_HT_UNKNOWN = -2,   // this means HitTest() is simply not implemented
+    wxTE_HT_BEFORE,         // either to the left or upper
+    wxTE_HT_ON_TEXT,        // directly on
+    wxTE_HT_BELOW,          // below [the last line]
+    wxTE_HT_BEYOND          // after [the end of line]
+};
+// ... the character returned
+\end{verbatim}
+}
+
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxTextAttr::wxTextAttr}\label{wxtextattrctor}
 
 \func{}{wxTextAttr}{\void}
 \membersection{wxTextAttr::wxTextAttr}\label{wxtextattrctor}
 
 \func{}{wxTextAttr}{\void}


@@ -73,36 +103,42 @@ colour, font, and alignment. The values not initialized in the constructor can b
 later, otherwise \helpref{wxTextCtrl::SetStyle}{wxtextctrlsetstyle} will use
 the default values for them.
 
 later, otherwise \helpref{wxTextCtrl::SetStyle}{wxtextctrlsetstyle} will use
 the default values for them.
 

+

 \membersection{wxTextAttr::GetAlignment}\label{wxtextattrgetalignment}
 
 \constfunc{wxTextAttrAlignment}{GetAlignment}{\void}
 
 Returns the paragraph alignment.
 
 \membersection{wxTextAttr::GetAlignment}\label{wxtextattrgetalignment}
 
 \constfunc{wxTextAttrAlignment}{GetAlignment}{\void}
 
 Returns the paragraph alignment.
 

+

 \membersection{wxTextAttr::GetBackgroundColour}\label{wxtextattrgetbackgroundcolour}
 
 \constfunc{const wxColour\&}{GetBackgroundColour}{\void}
 
 Return the background colour specified by this attribute.
 
 \membersection{wxTextAttr::GetBackgroundColour}\label{wxtextattrgetbackgroundcolour}
 
 \constfunc{const wxColour\&}{GetBackgroundColour}{\void}
 
 Return the background colour specified by this attribute.
 

+

 \membersection{wxTextAttr::GetFont}\label{wxtextattrgetfont}
 
 \constfunc{const wxFont\&}{GetFont}{\void}
 
 Return the text font specified by this attribute.
 
 \membersection{wxTextAttr::GetFont}\label{wxtextattrgetfont}
 
 \constfunc{const wxFont\&}{GetFont}{\void}
 
 Return the text font specified by this attribute.
 

+

 \membersection{wxTextAttr::GetLeftIndent}\label{wxtextattrgetleftindent}
 
 \constfunc{int}{GetLeftIndent}{\void}
 
 Returns the left indent in tenths of a millimetre.
 
 \membersection{wxTextAttr::GetLeftIndent}\label{wxtextattrgetleftindent}
 
 \constfunc{int}{GetLeftIndent}{\void}
 
 Returns the left indent in tenths of a millimetre.
 

+

 \membersection{wxTextAttr::GetRightIndent}\label{wxtextattrgetrightindent}
 
 \constfunc{int}{GetRightIndent}{\void}
 
 Returns the right indent in tenths of a millimetre.
 
 \membersection{wxTextAttr::GetRightIndent}\label{wxtextattrgetrightindent}
 
 \constfunc{int}{GetRightIndent}{\void}
 
 Returns the right indent in tenths of a millimetre.
 

+

 \membersection{wxTextAttr::GetTabs}\label{wxtextattrgettabs}
 
 \constfunc{const wxArrayInt\&}{GetTabs}{\void}
 \membersection{wxTextAttr::GetTabs}\label{wxtextattrgettabs}
 
 \constfunc{const wxArrayInt\&}{GetTabs}{\void}


@@ -110,78 +146,91 @@ Returns the right indent in tenths of a millimetre.
 Returns the array of integers representing the tab stops. Each
 array element specifies the tab stop in tenths of a millimetre.
 
 Returns the array of integers representing the tab stops. Each
 array element specifies the tab stop in tenths of a millimetre.
 

+

 \membersection{wxTextAttr::GetTextColour}\label{wxtextattrgettextcolour}
 
 \constfunc{const wxColour\&}{GetTextColour}{\void}
 
 Return the text colour specified by this attribute.
 
 \membersection{wxTextAttr::GetTextColour}\label{wxtextattrgettextcolour}
 
 \constfunc{const wxColour\&}{GetTextColour}{\void}
 
 Return the text colour specified by this attribute.
 

+

 \membersection{wxTextAttr::HasBackgroundColour}\label{wxtextattrhasbackgroundcolour}
 
 \constfunc{bool}{HasBackgroundColour}{\void}
 
 Returns {\tt true} if this style specifies the background colour to use.
 
 \membersection{wxTextAttr::HasBackgroundColour}\label{wxtextattrhasbackgroundcolour}
 
 \constfunc{bool}{HasBackgroundColour}{\void}
 
 Returns {\tt true} if this style specifies the background colour to use.
 

+

 \membersection{wxTextAttr::HasFont}\label{wxtextattrhasfont}
 
 \constfunc{bool}{HasFont}{\void}
 
 Returns {\tt true} if this style specifies the font to use.
 
 \membersection{wxTextAttr::HasFont}\label{wxtextattrhasfont}
 
 \constfunc{bool}{HasFont}{\void}
 
 Returns {\tt true} if this style specifies the font to use.
 

+

 \membersection{wxTextAttr::HasTextColour}\label{wxtextattrhastextcolour}
 
 \constfunc{bool}{HasTextColour}{\void}
 
 Returns {\tt true} if this style specifies the foreground colour to use.
 
 \membersection{wxTextAttr::HasTextColour}\label{wxtextattrhastextcolour}
 
 \constfunc{bool}{HasTextColour}{\void}
 
 Returns {\tt true} if this style specifies the foreground colour to use.
 

+

 \membersection{wxTextAttr::GetFlags}\label{wxtextattrgetflags}
 
 \func{long}{GetFlags}{\void}
 
 Returns a bitlist indicating which attributes will be set.
 
 \membersection{wxTextAttr::GetFlags}\label{wxtextattrgetflags}
 
 \func{long}{GetFlags}{\void}
 
 Returns a bitlist indicating which attributes will be set.
 

+

 \membersection{wxTextAttr::IsDefault}\label{wxtextattrisdefault}
 
 \constfunc{bool}{IsDefault}{\void}
 
 Returns {\tt true} if this style specifies any non-default attributes.
 
 \membersection{wxTextAttr::IsDefault}\label{wxtextattrisdefault}
 
 \constfunc{bool}{IsDefault}{\void}
 
 Returns {\tt true} if this style specifies any non-default attributes.
 

+

 \membersection{wxTextAttr::SetAlignment}\label{wxtextattrsetalignment}
 
 \func{void}{SetAlignment}{\param{wxTextAttrAlignment}{ alignment}}
 
 Sets the paragraph alignment.
 
 \membersection{wxTextAttr::SetAlignment}\label{wxtextattrsetalignment}
 
 \func{void}{SetAlignment}{\param{wxTextAttrAlignment}{ alignment}}
 
 Sets the paragraph alignment.
 

+

 \membersection{wxTextAttr::SetBackgroundColour}\label{wxtextattrsetbackgroundcolour}
 
 \func{void}{SetBackgroundColour}{\param{const wxColour\& }{colour}}
 
 Sets the background colour.
 
 \membersection{wxTextAttr::SetBackgroundColour}\label{wxtextattrsetbackgroundcolour}
 
 \func{void}{SetBackgroundColour}{\param{const wxColour\& }{colour}}
 
 Sets the background colour.
 

+

 \membersection{wxTextAttr::SetFlags}\label{wxtextattrsetflags}
 
 \func{void}{SetFlags}{\param{long}{ flags}}
 
 Pass a bitlist indicating which attributes will be set.
 
 \membersection{wxTextAttr::SetFlags}\label{wxtextattrsetflags}
 
 \func{void}{SetFlags}{\param{long}{ flags}}
 
 Pass a bitlist indicating which attributes will be set.
 

+

 \membersection{wxTextAttr::SetFont}\label{wxtextattrsetfont}
 
 \func{void}{SetFont}{\param{const wxFont\&}{ font}}
 
 Sets the text font.
 
 \membersection{wxTextAttr::SetFont}\label{wxtextattrsetfont}
 
 \func{void}{SetFont}{\param{const wxFont\&}{ font}}
 
 Sets the text font.
 

+

 \membersection{wxTextAttr::SetLeftIndent}\label{wxtextattrsetleftindent}
 
 \func{void}{SetLeftIndent}{\param{int }{indent}}
 
 Sets the left indent in tenths of a millimetre.
 
 \membersection{wxTextAttr::SetLeftIndent}\label{wxtextattrsetleftindent}
 
 \func{void}{SetLeftIndent}{\param{int }{indent}}
 
 Sets the left indent in tenths of a millimetre.
 

+

 \membersection{wxTextAttr::SetRightIndent}\label{wxtextattrsetrightindent}
 
 \func{void}{SetRightIndent}{\param{int }{indent}}
 
 Sets the right indent in tenths of a millimetre.
 
 \membersection{wxTextAttr::SetRightIndent}\label{wxtextattrsetrightindent}
 
 \func{void}{SetRightIndent}{\param{int }{indent}}
 
 Sets the right indent in tenths of a millimetre.
 

+

 \membersection{wxTextAttr::SetTabs}\label{wxtextattrsettabs}
 
 \func{void}{SetTabs}{\param{const wxArrayInt\&}{ tabs}}
 \membersection{wxTextAttr::SetTabs}\label{wxtextattrsettabs}
 
 \func{void}{SetTabs}{\param{const wxArrayInt\&}{ tabs}}


@@ -189,6 +238,7 @@ Sets the right indent in tenths of a millimetre.
 Sets the array of integers representing the tab stops. Each
 array element specifies the tab stop in tenths of a millimetre.
 
 Sets the array of integers representing the tab stops. Each
 array element specifies the tab stop in tenths of a millimetre.
 

+

 \membersection{wxTextAttr::SetTextColour}\label{wxtextattrsettextcolour}
 
 \func{void}{SetTextColour}{\param{const wxColour\& }{colour}}
 \membersection{wxTextAttr::SetTextColour}\label{wxtextattrsettextcolour}
 
 \func{void}{SetTextColour}{\param{const wxColour\& }{colour}}


@@ -241,7 +291,8 @@ under Win32 only and requires wxTE\_RICH.}
 \twocolitem{\windowstyle{wxTE\_NOHIDESEL}}{By default, the Windows text control
 doesn't show the selection when it doesn't have focus - use this style to force
 it to always show it. It doesn't do anything under other platforms.}
 \twocolitem{\windowstyle{wxTE\_NOHIDESEL}}{By default, the Windows text control
 doesn't show the selection when it doesn't have focus - use this style to force
 it to always show it. It doesn't do anything under other platforms.}

-\twocolitem{\windowstyle{wxHSCROLL}}{A horizontal scrollbar will be created. No effect under GTK+.}
+\twocolitem{\windowstyle{wxHSCROLL}}{A horizontal scrollbar will be created and
+used, so that text won't be wrapped. No effect under GTK+.}

 \twocolitem{\windowstyle{wxTE\_LEFT}}{The text in the control will be left-justified (default).}
 \twocolitem{\windowstyle{wxTE\_CENTRE}}{The text in the control will be centered.}
 \twocolitem{\windowstyle{wxTE\_RIGHT}}{The text in the control will be right-justified.}
 \twocolitem{\windowstyle{wxTE\_LEFT}}{The text in the control will be left-justified (default).}
 \twocolitem{\windowstyle{wxTE\_CENTRE}}{The text in the control will be centered.}
 \twocolitem{\windowstyle{wxTE\_RIGHT}}{The text in the control will be right-justified.}


@@ -408,6 +459,7 @@ into the control than the limit set by
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxTextCtrl::wxTextCtrl}\label{wxtextctrlconstr}
 
 \func{}{wxTextCtrl}{\void}
 \membersection{wxTextCtrl::wxTextCtrl}\label{wxtextctrlconstr}
 
 \func{}{wxTextCtrl}{\void}


@@ -457,12 +509,14 @@ visible.
 
 \helpref{wxTextCtrl::Create}{wxtextctrlcreate}, \helpref{wxValidator}{wxvalidator}
 
 
 \helpref{wxTextCtrl::Create}{wxtextctrlcreate}, \helpref{wxValidator}{wxvalidator}
 

+

 \membersection{wxTextCtrl::\destruct{wxTextCtrl}}
 
 \func{}{\destruct{wxTextCtrl}}{\void}
 
 Destructor, destroying the text control.
 
 \membersection{wxTextCtrl::\destruct{wxTextCtrl}}
 
 \func{}{\destruct{wxTextCtrl}}{\void}
 
 Destructor, destroying the text control.
 

+

 \membersection{wxTextCtrl::AppendText}\label{wxtextctrlappendtext}
 
 \func{void}{AppendText}{\param{const wxString\& }{ text}}
 \membersection{wxTextCtrl::AppendText}\label{wxtextctrlappendtext}
 
 \func{void}{AppendText}{\param{const wxString\& }{ text}}


@@ -482,18 +536,21 @@ the programmer should use \helpref{GetInsertionPoint}{wxtextctrlgetinsertionpoin
 
 \helpref{wxTextCtrl::WriteText}{wxtextctrlwritetext}
 
 
 \helpref{wxTextCtrl::WriteText}{wxtextctrlwritetext}
 

+

 \membersection{wxTextCtrl::CanCopy}\label{wxtextctrlcancopy}
 
 \func{virtual bool}{CanCopy}{\void}
 
 Returns {\tt true} if the selection can be copied to the clipboard.
 
 \membersection{wxTextCtrl::CanCopy}\label{wxtextctrlcancopy}
 
 \func{virtual bool}{CanCopy}{\void}
 
 Returns {\tt true} if the selection can be copied to the clipboard.
 

+

 \membersection{wxTextCtrl::CanCut}\label{wxtextctrlcancut}
 
 \func{virtual bool}{CanCut}{\void}
 
 Returns {\tt true} if the selection can be cut to the clipboard.
 
 \membersection{wxTextCtrl::CanCut}\label{wxtextctrlcancut}
 
 \func{virtual bool}{CanCut}{\void}
 
 Returns {\tt true} if the selection can be cut to the clipboard.
 

+

 \membersection{wxTextCtrl::CanPaste}\label{wxtextctrlcanpaste}
 
 \func{virtual bool}{CanPaste}{\void}
 \membersection{wxTextCtrl::CanPaste}\label{wxtextctrlcanpaste}
 
 \func{virtual bool}{CanPaste}{\void}


@@ -502,6 +559,7 @@ Returns {\tt 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 {\tt true} if the control is editable, {\tt false} otherwise.
 
 text control. On some platforms (Motif, GTK) this is an approximation
 and returns {\tt true} if the control is editable, {\tt false} otherwise.
 

+

 \membersection{wxTextCtrl::CanRedo}\label{wxtextctrlcanredo}
 
 \func{virtual bool}{CanRedo}{\void}
 \membersection{wxTextCtrl::CanRedo}\label{wxtextctrlcanredo}
 
 \func{virtual bool}{CanRedo}{\void}


@@ -509,6 +567,7 @@ and returns {\tt true} if the control is editable, {\tt false} otherwise.
 Returns {\tt true} if there is a redo facility available and the last operation
 can be redone.
 
 Returns {\tt 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}
 \membersection{wxTextCtrl::CanUndo}\label{wxtextctrlcanundo}
 
 \func{virtual bool}{CanUndo}{\void}


@@ -516,6 +575,7 @@ can be redone.
 Returns {\tt true} if there is an undo facility available and the last operation
 can be undone.
 
 Returns {\tt 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}


@@ -525,12 +585,14 @@ Clears the text in the control.
 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.
 

+

 \membersection{wxTextCtrl::Copy}\label{wxtextctrlcopy}
 
 \func{virtual void}{Copy}{\void}
 
 Copies the selected text to the clipboard under Motif and MS Windows.
 
 \membersection{wxTextCtrl::Copy}\label{wxtextctrlcopy}
 
 \func{virtual void}{Copy}{\void}
 
 Copies the selected text to the clipboard under Motif and MS Windows.
 

+

 \membersection{wxTextCtrl::Create}\label{wxtextctrlcreate}
 
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
 \membersection{wxTextCtrl::Create}\label{wxtextctrlcreate}
 
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp


@@ -541,18 +603,21 @@ Creates the text control for two-step construction. Derived classes
 should call or replace this function. See \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}\rtfsp
 for further details.
 
 should call or replace this function. See \helpref{wxTextCtrl::wxTextCtrl}{wxtextctrlconstr}\rtfsp
 for further details.
 

+

 \membersection{wxTextCtrl::Cut}\label{wxtextctrlcut}
 
 \func{virtual void}{Cut}{\void}
 
 Copies the selected text to the clipboard and removes the selection.
 
 \membersection{wxTextCtrl::Cut}\label{wxtextctrlcut}
 
 \func{virtual void}{Cut}{\void}
 
 Copies the selected text to the clipboard and removes the selection.
 

+

 \membersection{wxTextCtrl::DiscardEdits}
 
 \func{void}{DiscardEdits}{\void}
 
 Resets the internal `modified' flag as if the current edits had been saved.
 
 \membersection{wxTextCtrl::DiscardEdits}
 
 \func{void}{DiscardEdits}{\void}
 
 Resets the internal `modified' flag as if the current edits had been saved.
 

+

 \membersection{wxTextCtrl::EmulateKeyPress}
 
 \func{bool}{EmulateKeyPress}{\param{const wxKeyEvent\& }{event}}
 \membersection{wxTextCtrl::EmulateKeyPress}
 
 \func{bool}{EmulateKeyPress}{\param{const wxKeyEvent\& }{event}}


@@ -570,6 +635,7 @@ under any platform but MSW.
 {\tt true} if the event resulted in a change to the control, {\tt false}
 otherwise.
 
 {\tt true} if the event resulted in a change to the control, {\tt false}
 otherwise.
 

+

 \membersection{wxTextCtrl::GetDefaultStyle}\label{wxtextctrlgetdefaultstyle}
 
 \constfunc{const wxTextAttr\& }{GetDefaultStyle}{\void}
 \membersection{wxTextCtrl::GetDefaultStyle}\label{wxtextctrlgetdefaultstyle}
 
 \constfunc{const wxTextAttr\& }{GetDefaultStyle}{\void}


@@ -580,6 +646,7 @@ Returns the style currently used for the new text.
 
 \helpref{SetDefaultStyle}{wxtextctrlsetdefaultstyle}
 
 
 \helpref{SetDefaultStyle}{wxtextctrlsetdefaultstyle}
 

+

 \membersection{wxTextCtrl::GetInsertionPoint}\label{wxtextctrlgetinsertionpoint}
 
 \constfunc{virtual long}{GetInsertionPoint}{\void}
 \membersection{wxTextCtrl::GetInsertionPoint}\label{wxtextctrlgetinsertionpoint}
 
 \constfunc{virtual long}{GetInsertionPoint}{\void}


@@ -603,6 +670,7 @@ point or the zero character if the point is at the end of the control.
 \end{verbatim}
 }%
 
 \end{verbatim}
 }%
 

+

 \membersection{wxTextCtrl::GetLastPosition}\label{wxtextctrlgetlastposition}
 
 \constfunc{virtual long}{GetLastPosition}{\void}
 \membersection{wxTextCtrl::GetLastPosition}\label{wxtextctrlgetlastposition}
 
 \constfunc{virtual long}{GetLastPosition}{\void}


@@ -610,6 +678,7 @@ point or the zero character if the point is at the end of the 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.
 
 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}}
 \membersection{wxTextCtrl::GetLineLength}\label{wxtextctrlgetlinelength}
 
 \constfunc{int}{GetLineLength}{\param{long}{ lineNo}}


@@ -625,6 +694,7 @@ character(s).
 
 The length of the line, or -1 if {\it lineNo} was invalid.
 
 
 The length of the line, or -1 if {\it lineNo} was invalid.
 

+

 \membersection{wxTextCtrl::GetLineText}\label{wxtextctrlgetlinetext}
 
 \constfunc{wxString}{GetLineText}{\param{long}{ lineNo}}
 \membersection{wxTextCtrl::GetLineText}\label{wxtextctrlgetlinetext}
 
 \constfunc{wxString}{GetLineText}{\param{long}{ lineNo}}


@@ -640,6 +710,7 @@ any trailing newline character(s).
 
 The contents of the line.
 
 
 The contents of the line.
 

+

 \membersection{wxTextCtrl::GetNumberOfLines}\label{wxtextctrlgetnumberoflines}
 
 \constfunc{int}{GetNumberOfLines}{\void}
 \membersection{wxTextCtrl::GetNumberOfLines}\label{wxtextctrlgetnumberoflines}
 
 \constfunc{int}{GetNumberOfLines}{\void}


@@ -656,6 +727,7 @@ 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::GetRange}\label{wxtextctrlgetrange}
 
 \constfunc{virtual wxString}{GetRange}{\param{long}{ from}, \param{long}{ to}}
 \membersection{wxTextCtrl::GetRange}\label{wxtextctrlgetrange}
 
 \constfunc{virtual wxString}{GetRange}{\param{long}{ from}, \param{long}{ to}}


@@ -671,6 +743,7 @@ representations ({\tt CR} or {\tt CR LF}) and so this method should be used to
 obtain the correct results instead of extracting parts of the entire value. It
 may also be more efficient, especially if the control contains a lot of data.
 
 obtain the correct results instead of extracting parts of the entire value. It
 may also be more efficient, especially if the control contains a lot of data.
 

+

 \membersection{wxTextCtrl::GetSelection}\label{wxtextctrlgetselection}
 
 \constfunc{virtual void}{GetSelection}{\param{long*}{ from}, \param{long*}{ to}}
 \membersection{wxTextCtrl::GetSelection}\label{wxtextctrlgetselection}
 
 \constfunc{virtual void}{GetSelection}{\param{long*}{ from}, \param{long*}{ to}}


@@ -697,6 +770,7 @@ consisting of the from and to values.}
 \perlnote{In wxPerl this method takes no parameter and returns a
 2-element list {\tt ( from, to )}.}
 
 \perlnote{In wxPerl this method takes no parameter and returns a
 2-element list {\tt ( from, to )}.}
 

+

 \membersection{wxTextCtrl::GetStringSelection}\label{wxtextctrlgetstringselection}
 
 \func{virtual wxString}{GetStringSelection}{\void}
 \membersection{wxTextCtrl::GetStringSelection}\label{wxtextctrlgetstringselection}
 
 \func{virtual wxString}{GetStringSelection}{\void}


@@ -704,6 +778,7 @@ consisting of the from and to values.}
 Gets the text currently selected in the control. If there is no selection, the
 returned string is empty.
 
 Gets the text currently selected in the control. If there is no selection, the
 returned string is empty.
 

+

 \membersection{wxTextCtrl::GetStyle}\label{wxtextctrlgetstyle}
 
 \func{bool}{GetStyle}{\param{long }{position}, \param{wxTextAttr\& }{style}}
 \membersection{wxTextCtrl::GetStyle}\label{wxtextctrlgetstyle}
 
 \func{bool}{GetStyle}{\param{long }{position}, \param{wxTextAttr\& }{style}}


@@ -720,6 +795,7 @@ the styles are not supported under this platform.
 
 \helpref{wxTextCtrl::SetStyle}{wxtextctrlsetstyle}, \helpref{wxTextAttr}{wxtextattr}
 
 
 \helpref{wxTextCtrl::SetStyle}{wxtextctrlsetstyle}, \helpref{wxTextAttr}{wxtextattr}
 

+

 \membersection{wxTextCtrl::GetValue}\label{wxtextctrlgetvalue}
 
 \constfunc{wxString}{GetValue}{\void}
 \membersection{wxTextCtrl::GetValue}\label{wxtextctrlgetvalue}
 
 \constfunc{wxString}{GetValue}{\void}


@@ -729,6 +805,24 @@ 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.
 
 under Windows where they are separated by a $\backslash$r$\backslash$n
 sequence in the native control.
 

+
+\membersection{wxTextCtrl::HitTest}\label{wxtextctrlhittest}
+
+\constfunc{wxTextCtrlHitTestResult}{HitTest}{\param{const wxPoint\& }{pt}, \param{wxTextCoord }{*col}, \param{wxTextCoord }{*row}}
+
+This function finds the character at the specified position expressed in
+pixels. If the return code is not \texttt{wxTE\_HT\_UNKNOWN} the row and column
+of the character closest to this position are returned in the \arg{col} and 
+\arg{row} parameters (unless the pointers are \tt{NULL} which is allowed).
+
+Please note that this function is currently only implemented in wxUniv and
+wxMSW ports.
+
+\wxheading{See also}
+
+\helpref{PositionToXY}{wxtextctrlpositiontoxy}, \helpref{XYToPosition}{wxtextctrlxytoposition},
+
+

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


@@ -738,6 +832,7 @@ always can be changed by the program), i.e. if the control hasn't been put in
 read-only mode by a previous call to 
 \helpref{SetEditable}{wxtextctrlseteditable}.
 
 read-only mode by a previous call to 
 \helpref{SetEditable}{wxtextctrlseteditable}.
 

+

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


@@ -745,6 +840,7 @@ read-only mode by a previous call to
 Returns {\tt true} if the text has been modified by user. Note that calling 
 \helpref{SetValue}{wxtextctrlsetvalue} doesn't make the control modified.
 
 Returns {\tt true} if the text has been modified by user. Note that calling 
 \helpref{SetValue}{wxtextctrlsetvalue} doesn't make the control modified.
 

+

 \membersection{wxTextCtrl::IsMultiLine}\label{wxtextctrlismultiline}
 
 \constfunc{bool}{IsMultiLine}{\void}
 \membersection{wxTextCtrl::IsMultiLine}\label{wxtextctrlismultiline}
 
 \constfunc{bool}{IsMultiLine}{\void}


@@ -756,6 +852,7 @@ otherwise.
 
 \helpref{IsSingleLine}{wxtextctrlissingleline}
 
 
 \helpref{IsSingleLine}{wxtextctrlissingleline}
 

+

 \membersection{wxTextCtrl::IsSingleLine}\label{wxtextctrlissingleline}
 
 \constfunc{bool}{IsSingleLine}{\void}
 \membersection{wxTextCtrl::IsSingleLine}\label{wxtextctrlissingleline}
 
 \constfunc{bool}{IsSingleLine}{\void}


@@ -767,6 +864,7 @@ otherwise.
 
 \helpref{IsMultiLine}{wxtextctrlissingleline}
 
 
 \helpref{IsMultiLine}{wxtextctrlissingleline}
 

+

 \membersection{wxTextCtrl::LoadFile}\label{wxtextctrlloadfile}
 
 \func{bool}{LoadFile}{\param{const wxString\& }{ filename}}
 \membersection{wxTextCtrl::LoadFile}\label{wxtextctrlloadfile}
 
 \func{bool}{LoadFile}{\param{const wxString\& }{ filename}}


@@ -811,6 +909,7 @@ Loads and displays the named file, if it exists.
 %% 
 %% \helpref{wxKeyEvent}{wxkeyevent}
 
 %% 
 %% \helpref{wxKeyEvent}{wxkeyevent}
 

+

 \membersection{wxTextCtrl::OnDropFiles}\label{wxtextctrlondropfiles}
 
 \func{void}{OnDropFiles}{\param{wxDropFilesEvent\& }{event}}
 \membersection{wxTextCtrl::OnDropFiles}\label{wxtextctrlondropfiles}
 
 \func{void}{OnDropFiles}{\param{wxDropFilesEvent\& }{event}}


@@ -830,12 +929,14 @@ This is not implemented on non-Windows platforms.
 
 \helpref{wxDropFilesEvent}{wxdropfilesevent}
 
 
 \helpref{wxDropFilesEvent}{wxdropfilesevent}
 

+

 \membersection{wxTextCtrl::Paste}\label{wxtextctrlpaste}
 
 \func{virtual void}{Paste}{\void}
 
 Pastes text from the clipboard to the text item.
 
 \membersection{wxTextCtrl::Paste}\label{wxtextctrlpaste}
 
 \func{virtual void}{Paste}{\void}
 
 Pastes text from the clipboard to the text item.
 

+

 \membersection{wxTextCtrl::PositionToXY}\label{wxtextctrlpositiontoxy}
 
 \constfunc{bool}{PositionToXY}{\param{long }{pos}, \param{long *}{x}, \param{long *}{y}}
 \membersection{wxTextCtrl::PositionToXY}\label{wxtextctrlpositiontoxy}
 
 \constfunc{bool}{PositionToXY}{\param{long }{pos}, \param{long *}{x}, \param{long *}{y}}


@@ -866,6 +967,7 @@ above.}
 \perlnote{In wxPerl this method only takes the {\tt pos} parameter, and
 returns a 2-element list {\tt ( x, y )}.}
 
 \perlnote{In wxPerl this method only takes the {\tt pos} parameter, and
 returns a 2-element list {\tt ( x, y )}.}
 

+

 \membersection{wxTextCtrl::Redo}\label{wxtextctrlredo}
 
 \func{virtual void}{Redo}{\void}
 \membersection{wxTextCtrl::Redo}\label{wxtextctrlredo}
 
 \func{virtual void}{Redo}{\void}


@@ -873,6 +975,7 @@ returns a 2-element list {\tt ( x, y )}.}
 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.
 
 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}}


@@ -886,6 +989,7 @@ the character at the last position.
 
 \docparam{to}{The last position.}
 
 
 \docparam{to}{The last position.}
 

+

 \membersection{wxTextCtrl::Replace}\label{wxtextctrlreplace}
 
 \func{virtual void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{value}}
 \membersection{wxTextCtrl::Replace}\label{wxtextctrlreplace}
 
 \func{virtual void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{value}}


@@ -901,6 +1005,7 @@ the character at the last position with the given text.
 
 \docparam{value}{The value to replace the existing text with.}
 
 
 \docparam{value}{The value to replace the existing text with.}
 

+

 \membersection{wxTextCtrl::SaveFile}\label{wxtextctrlsavefile}
 
 \func{bool}{SaveFile}{\param{const wxString\& }{ filename}}
 \membersection{wxTextCtrl::SaveFile}\label{wxtextctrlsavefile}
 
 \func{bool}{SaveFile}{\param{const wxString\& }{ filename}}


@@ -915,6 +1020,7 @@ Saves the contents of the control in a text file.
 
 {\tt true} if the operation was successful, {\tt false} otherwise.
 
 
 {\tt true} if the operation was successful, {\tt false} otherwise.
 

+

 \membersection{wxTextCtrl::SetDefaultStyle}\label{wxtextctrlsetdefaultstyle}
 
 \func{bool}{SetDefaultStyle}{\param{const wxTextAttr\& }{style}}
 \membersection{wxTextCtrl::SetDefaultStyle}\label{wxtextctrlsetdefaultstyle}
 
 \func{bool}{SetDefaultStyle}{\param{const wxTextAttr\& }{style}}


@@ -945,6 +1051,7 @@ the styles are not supported under this platform.
 
 \helpref{GetDefaultStyle}{wxtextctrlgetdefaultstyle}
 
 
 \helpref{GetDefaultStyle}{wxtextctrlgetdefaultstyle}
 

+

 \membersection{wxTextCtrl::SetEditable}\label{wxtextctrlseteditable}
 
 \func{virtual void}{SetEditable}{\param{const bool}{ editable}}
 \membersection{wxTextCtrl::SetEditable}\label{wxtextctrlseteditable}
 
 \func{virtual void}{SetEditable}{\param{const bool}{ editable}}


@@ -959,6 +1066,7 @@ Makes the text item editable or read-only, overriding the {\bf wxTE\_READONLY} f
 
 \helpref{IsEditable}{wxtextctrliseditable}
 
 
 \helpref{IsEditable}{wxtextctrliseditable}
 

+

 \membersection{wxTextCtrl::SetInsertionPoint}\label{wxtextctrlsetinsertionpoint}
 
 \func{virtual void}{SetInsertionPoint}{\param{long}{ pos}}
 \membersection{wxTextCtrl::SetInsertionPoint}\label{wxtextctrlsetinsertionpoint}
 
 \func{virtual void}{SetInsertionPoint}{\param{long}{ pos}}


@@ -969,6 +1077,7 @@ Sets the insertion point at the given position.
 
 \docparam{pos}{Position to set.}
 
 
 \docparam{pos}{Position to set.}
 

+

 \membersection{wxTextCtrl::SetInsertionPointEnd}\label{wxtextctrlsetinsertionpointend}
 
 \func{virtual void}{SetInsertionPointEnd}{\void}
 \membersection{wxTextCtrl::SetInsertionPointEnd}\label{wxtextctrlsetinsertionpointend}
 
 \func{virtual void}{SetInsertionPointEnd}{\void}


@@ -976,6 +1085,7 @@ Sets the insertion point at the given position.
 Sets the insertion point at the end of the text control. This is equivalent
 to \helpref{SetInsertionPoint}{wxtextctrlsetinsertionpoint}(\helpref{GetLastPosition}{wxtextctrlgetlastposition}()).
 
 Sets the insertion point at the end of the text control. This is equivalent
 to \helpref{SetInsertionPoint}{wxtextctrlsetinsertionpoint}(\helpref{GetLastPosition}{wxtextctrlgetlastposition}()).
 

+

 \membersection{wxTextCtrl::SetMaxLength}\label{wxtextctrlsetmaxlength}
 
 \func{virtual void}{SetMaxLength}{\param{unsigned long }{len}}
 \membersection{wxTextCtrl::SetMaxLength}\label{wxtextctrlsetmaxlength}
 
 \func{virtual void}{SetMaxLength}{\param{unsigned long }{len}}


@@ -1000,6 +1110,7 @@ Note that this function may only be used with single line text controls.
 
 Only implemented in wxMSW/wxGTK starting with wxWindows 2.3.2.
 
 
 Only implemented in wxMSW/wxGTK starting with wxWindows 2.3.2.
 

+

 \membersection{wxTextCtrl::SetSelection}\label{wxtextctrlsetselection}
 
 \func{virtual void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}
 \membersection{wxTextCtrl::SetSelection}\label{wxtextctrlsetselection}
 
 \func{virtual void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}


@@ -1014,6 +1125,7 @@ in the control is selected.
 
 \docparam{to}{The last position.}
 
 
 \docparam{to}{The last position.}
 

+

 \membersection{wxTextCtrl::SetStyle}\label{wxtextctrlsetstyle}
 
 \func{bool}{SetStyle}{\param{long }{start}, \param{long }{end}, \param{const wxTextAttr\& }{style}}
 \membersection{wxTextCtrl::SetStyle}\label{wxtextctrlsetstyle}
 
 \func{bool}{SetStyle}{\param{long }{start}, \param{long }{end}, \param{const wxTextAttr\& }{style}}


@@ -1038,6 +1150,7 @@ the styles are not supported under this platform.
 
 \helpref{wxTextCtrl::GetStyle}{wxtextctrlgetstyle}, \helpref{wxTextAttr}{wxtextattr}
 
 
 \helpref{wxTextCtrl::GetStyle}{wxtextctrlgetstyle}, \helpref{wxTextAttr}{wxtextattr}
 

+

 \membersection{wxTextCtrl::SetValue}\label{wxtextctrlsetvalue}
 
 \func{virtual void}{SetValue}{\param{const wxString\& }{ value}}
 \membersection{wxTextCtrl::SetValue}\label{wxtextctrlsetvalue}
 
 \func{virtual void}{SetValue}{\param{const wxString\& }{ value}}


@@ -1053,6 +1166,7 @@ event.
 
 \docparam{value}{The new value to set. It may contain newline characters if the text control is multi-line.}
 
 
 \docparam{value}{The new value to set. It may contain newline characters if the text control is multi-line.}
 

+

 \membersection{wxTextCtrl::ShowPosition}\label{wxtextctrlshowposition}
 
 \func{void}{ShowPosition}{\param{long}{ pos}}
 \membersection{wxTextCtrl::ShowPosition}\label{wxtextctrlshowposition}
 
 \func{void}{ShowPosition}{\param{long}{ pos}}


@@ -1063,6 +1177,7 @@ 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}
 \membersection{wxTextCtrl::Undo}\label{wxtextctrlundo}
 
 \func{virtual void}{Undo}{\void}


@@ -1070,6 +1185,7 @@ Makes the line containing the given position visible.
 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.
 
 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}}


@@ -1088,6 +1204,7 @@ line breaks.  See \helpref{wxTextCtrl::\cinsert}{wxtextctrlinsert} and \helpref{
 
 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.
 

+

 \membersection{wxTextCtrl::XYToPosition}\label{wxtextctrlxytoposition}
 
 \func{long}{XYToPosition}{\param{long}{ x}, \param{long}{ y}}
 \membersection{wxTextCtrl::XYToPosition}\label{wxtextctrlxytoposition}
 
 \func{long}{XYToPosition}{\param{long}{ x}, \param{long}{ y}}


@@ -1104,6 +1221,7 @@ Converts the given zero based column and line number to a position.
 
 The position value.
 
 
 The position value.
 

+

 \membersection{wxTextCtrl::operator \cinsert}\label{wxtextctrlinsert}
 
 \func{wxTextCtrl\&}{operator \cinsert}{\param{const wxString\& }{s}}
 \membersection{wxTextCtrl::operator \cinsert}\label{wxtextctrlinsert}
 
 \func{wxTextCtrl\&}{operator \cinsert}{\param{const wxString\& }{s}}