]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/regex.tex
Documented new menu label functions
[wxWidgets.git] / docs / latex / wx / regex.tex
index 58687c9934aca2fd17f1deb67240df238987f7d5..59026f0d713ca578ab1b0d576f46f1cf31499db0 100644 (file)
@@ -118,6 +118,10 @@ printf("text now contains %u hidden addresses", count);
 
 <wx/regex.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxRegEx::wxRegEx}\label{wxregexwxregex}
@@ -197,12 +201,15 @@ returns {\tt true} if matches and {\tt false} otherwise.
 
 {\it Flags} may be combination of {\tt wxRE\_NOTBOL} and {\tt wxRE\_NOTEOL}.
 
-System regex libraries always assume the text being searched is null
-terminated and any length given is ignored.
+Some regex libraries assume that the text given is null terminated, while
+others require the length be given as a separate parameter. Therefore for
+maximum portability assume that {\it text} cannot contain embedded nulls.
 
-When using the built-in regex library, the first overload obtains the length
-of the string using wxStrlen, the second from the {\it len} parameter and the
-third from the length of the {\it wxString}.
+When the {\it Matches(const wxChar *text, int flags = 0)} form is used,
+a {\it wxStrlen()} will be done internally if the regex library requires the
+length. When using {\it Matches()} in a loop
+the {\it Matches(text, flags, len)} form can be used instead, making it
+possible to avoid a {\it wxStrlen()} inside the loop.
 
 May only be called after successful call to \helpref{Compile()}{wxregexcompile}.