X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eda40bfc08b7c15d395316768ea662959b5884b9..44b62d54c61e4a0989fcc0f24eecfe0bd883d72b:/docs/latex/wx/text.tex diff --git a/docs/latex/wx/text.tex b/docs/latex/wx/text.tex index 92cde1a233..d7bbb815c5 100644 --- a/docs/latex/wx/text.tex +++ b/docs/latex/wx/text.tex @@ -325,34 +325,34 @@ the programmer should use \helpref{GetInsertionPoint}{wxtextctrlgetinsertionpoin \func{virtual bool}{CanCopy}{\void} -Returns TRUE if the selection can be copied to the clipboard. +Returns {\tt 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. +Returns {\tt 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 +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 TRUE if the control is editable, FALSE otherwise. +and returns {\tt TRUE} if the control is editable, {\tt 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 +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} -Returns TRUE if there is an undo facility available and the last operation +Returns {\tt TRUE} if there is an undo facility available and the last operation can be undone. \membersection{wxTextCtrl::Clear}\label{wxtextctrlclear} @@ -389,7 +389,7 @@ Copies the selected text to the clipboard and removes the selection. Resets the internal `modified' flag as if the current edits had been saved. -\membersection{wxTextCtrl::GetDefaultStyle}{wxtextctrlgetdefaultstyle} +\membersection{wxTextCtrl::GetDefaultStyle}\label{wxtextctrlgetdefaultstyle} \constfunc{const wxTextAttr\& }{GetDefaultStyle}{\void} @@ -520,7 +520,8 @@ Windows where they are separated by a $\backslash$r$\backslash$n sequence in the \constfunc{bool}{IsModified}{\void} -Returns TRUE if the text has been 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::LoadFile}\label{wxtextctrlloadfile} @@ -534,7 +535,7 @@ Loads and displays the named file, if it exists. \wxheading{Return value} -TRUE if successful, FALSE otherwise. +{\tt TRUE} if successful, {\tt FALSE} otherwise. \membersection{wxTextCtrl::OnChar}\label{wxtextctrlonchar} @@ -605,7 +606,7 @@ Converts given position to a zero-based column, line number pair. \wxheading{Return value} -TRUE on success, FALSE on failure (most likely due to a too large position +{\tt TRUE} on success, {\tt FALSE} on failure (most likely due to a too large position parameter). \wxheading{See also} @@ -666,7 +667,7 @@ Saves the contents of the control in a text file. \wxheading{Return value} -TRUE if the operation was successful, FALSE otherwise. +{\tt TRUE} if the operation was successful, {\tt FALSE} otherwise. \membersection{wxTextCtrl::SetDefaultStyle}\label{wxtextctrlsetdefaultstyle} @@ -681,6 +682,10 @@ If either of the font, foreground, or background colour is not set in\rtfsp the previous default style didn't set them neither, the global font or colours of the text control itself are used as fall back. +However if the {\it style} parameter is the default wxTextAttr, then the +default style is just reset (instead of being combined with the new style which +wouldn't change it at all). + \wxheading{Parameters} \docparam{style}{The style for the new text.} @@ -702,7 +707,7 @@ Makes the text item editable or read-only, overriding the {\bf wxTE\_READONLY} f \wxheading{Parameters} -\docparam{editable}{If TRUE, the control is editable. If FALSE, the control is read-only.} +\docparam{editable}{If {\tt TRUE}, the control is editable. If {\tt FALSE}, the control is read-only.} \membersection{wxTextCtrl::SetInsertionPoint}\label{wxtextctrlsetinsertionpoint} @@ -782,7 +787,9 @@ the styles are not supported under this platform. \func{virtual void}{SetValue}{\param{const wxString\& }{ value}} -Sets the text value and marks the control as not-modified. +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). \wxheading{Parameters}