Added some constants. wxRAISED_BORDER not GTK+-only.

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

diff --git a/docs/latex/wx/regex.tex b/docs/latex/wx/regex.tex
index 17673371912bc700fa6f01913ffeb188a9f838b9..91ac1c63745c1f88002c25ba2f27ab5d8abcb68b 100644 (file)
--- a/docs/latex/wx/regex.tex
+++ b/docs/latex/wx/regex.tex
@@ -18,31 +18,7 @@ supported but, unlike POSIX C API, the extended ones are used by default.
 This class provides support for regular expressions matching and also
 replacement. It is built on top of either the system library (if it has support
 for POSIX regular expressions - which is the case of the most modern Unices) or
 This class provides support for regular expressions matching and also
 replacement. It is built on top of either the system library (if it has support
 for POSIX regular expressions - which is the case of the most modern Unices) or

-uses the built in Henry Spencer's library. In the latter case you need to abide
-by the terms of its copyright:
-
-\begin{verbatim}
-Copyright 1992, 1993, 1994, 1997 Henry Spencer.  All rights reserved.
-This software is not subject to any license of the American Telephone
-and Telegraph Company or of the Regents of the University of California.
-
-Permission is granted to anyone to use this software for any purpose on
-any computer system, and to alter it and redistribute it, subject
-to the following restrictions:
-
-1. The author is not responsible for the consequences of use of this
-   software, no matter how awful, even if they arise from flaws in it.
-
-2. The origin of this software must not be misrepresented, either by
-   explicit claim or by omission.  Since few users ever read sources,
-   credits must appear in the documentation.
-
-3. Altered versions must be plainly marked as such, and must not be
-   misrepresented as being the original software.  Since few users
-   ever read sources, credits must appear in the documentation.
-
-4. This notice may not be removed or altered.
-\end{verbatim}
+uses the built-in Henry Spencer's library from tcl.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -80,7 +56,7 @@ enum
 Flags for regex matching to be used with \helpref{Matches()}{wxregexmatches}.
 
 These flags are mainly useful when doing several matches in a long string
 Flags for regex matching to be used with \helpref{Matches()}{wxregexmatches}.
 
 These flags are mainly useful when doing several matches in a long string

-to prevent erroneous matches for \verb|'^'| and {\tt '\$'}:
+to prevent erroneous matches for {\tt '\textasciicircum'} and {\tt '\$'}:

 
 \begin{verbatim}
 enum
 
 \begin{verbatim}
 enum


@@ -126,8 +102,6 @@ printf("text now contains %u hidden addresses", count);
 
 Default ctor: use \helpref{Compile()}{wxregexcompile} later.
 
 
 Default ctor: use \helpref{Compile()}{wxregexcompile} later.
 

-\membersection{wxRegEx::wxRegEx}\label{wxregexwxregex}
-

 \func{}{wxRegEx}{\param{const wxString\& }{expr}, \param{int }{flags = wxRE\_DEFAULT}}
 
 Create and compile the regular expression, use 
 \func{}{wxRegEx}{\param{const wxString\& }{expr}, \param{int }{flags = wxRE\_DEFAULT}}
 
 Create and compile the regular expression, use 


@@ -143,14 +117,14 @@ dtor not virtual, don't derive from this class
 
 \func{bool}{Compile}{\param{const wxString\& }{pattern}, \param{int }{flags = wxRE\_DEFAULT}}
 
 
 \func{bool}{Compile}{\param{const wxString\& }{pattern}, \param{int }{flags = wxRE\_DEFAULT}}
 

-Compile the string into regular expression, return {\tt TRUE} if ok or {\tt FALSE} 
+Compile the string into regular expression, return {\tt true} if ok or {\tt false} 

 if string has a syntax error.
 
 \membersection{wxRegEx::IsValid}\label{wxregexisvalid}
 
 \constfunc{bool}{IsValid}{\void}
 
 if string has a syntax error.
 
 \membersection{wxRegEx::IsValid}\label{wxregexisvalid}
 
 \constfunc{bool}{IsValid}{\void}
 

-Return {\tt TRUE} if this is a valid compiled regular expression, {\tt FALSE} 
+Return {\tt true} if this is a valid compiled regular expression, {\tt false} 

 otherwise.
 
 \membersection{wxRegEx::GetMatch}\label{wxregexgetmatch}
 otherwise.
 
 \membersection{wxRegEx::GetMatch}\label{wxregexgetmatch}


@@ -165,7 +139,7 @@ May only be called after successful call to \helpref{Matches()}{wxregexmatches}
 and only if {\tt wxRE\_NOSUB} was {\bf not} used in 
 \helpref{Compile()}{wxregexcompile}.
 
 and only if {\tt wxRE\_NOSUB} was {\bf not} used in 
 \helpref{Compile()}{wxregexcompile}.
 

-Returns {\tt FALSE} if no match or if an error occured.
+Returns {\tt false} if no match or if an error occured.

 
 \constfunc{wxString}{GetMatch}{\param{const wxString\& }{text}, \param{size\_t }{index = 0}}
 
 
 \constfunc{wxString}{GetMatch}{\param{const wxString\& }{text}, \param{size\_t }{index = 0}}
 


@@ -181,7 +155,7 @@ and only if {\tt wxRE\_NOSUB} was {\bf not} used in
 \constfunc{bool}{Matches}{\param{const wxChar* }{text}, \param{int }{flags = 0}}
 
 Matches the precompiled regular expression against the string {\it text},
 \constfunc{bool}{Matches}{\param{const wxChar* }{text}, \param{int }{flags = 0}}
 
 Matches the precompiled regular expression against the string {\it text},

-returns {\tt TRUE} if matches and {\tt FALSE} otherwise.
+returns {\tt true} if matches and {\tt false} otherwise.

 
 Flags may be combination of {\tt wxRE\_NOTBOL} and {\tt wxRE\_NOTEOL}.
 
 
 Flags may be combination of {\tt wxRE\_NOTBOL} and {\tt wxRE\_NOTEOL}.
 


@@ -201,14 +175,14 @@ pattern match. {\tt $\backslash$0} corresponds to the entire match and {\tt \&}
 synonym for it. Backslash may be used to quote itself or {\tt \&} character.
 
 {\it maxMatches} may be used to limit the number of replacements made, setting
 synonym for it. Backslash may be used to quote itself or {\tt \&} character.
 
 {\it maxMatches} may be used to limit the number of replacements made, setting

-it to $1$, for example, will only replace first occurence (if any) of the
+it to $1$, for example, will only replace first occurrence (if any) of the

 pattern in the text while default value of $0$ means replace all.
 
 \membersection{wxRegEx::ReplaceAll}\label{wxregexreplaceall}
 
 \constfunc{int}{ReplaceAll}{\param{wxString* }{text}, \param{const wxString\& }{replacement}}
 
 pattern in the text while default value of $0$ means replace all.
 
 \membersection{wxRegEx::ReplaceAll}\label{wxregexreplaceall}
 
 \constfunc{int}{ReplaceAll}{\param{wxString* }{text}, \param{const wxString\& }{replacement}}
 

-Replace all occurences: this is actually a synonym for 
+Replace all occurrences: this is actually a synonym for 

 \helpref{Replace()}{wxregexreplace}.
 
 \wxheading{See also}
 \helpref{Replace()}{wxregexreplace}.
 
 \wxheading{See also}


@@ -219,7 +193,7 @@ Replace all occurences: this is actually a synonym for
 
 \constfunc{int}{ReplaceFirst}{\param{wxString* }{text}, \param{const wxString\& }{replacement}}
 
 
 \constfunc{int}{ReplaceFirst}{\param{wxString* }{text}, \param{const wxString\& }{replacement}}
 

-Replace the first occurence.
+Replace the first occurrence.

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