Corrected some spacing and typo errors.

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 58e9646b9b08ea19180dea57b4cb9b31a401bbd4..d7c5913610bc5b8f0d1cf37c747d48bd3bb282c6 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -181,6 +181,7 @@ the corresponding topic.
 \helpref{wxNow}{wxnow}\\
 \helpref{wxOnAssert}{wxonassert}\\
 \helpref{wxOpenClipboard}{wxopenclipboard}\\
 \helpref{wxNow}{wxnow}\\
 \helpref{wxOnAssert}{wxonassert}\\
 \helpref{wxOpenClipboard}{wxopenclipboard}\\

+\helpref{wxParseWildcard}{wxparsewildcard}\\

 \helpref{wxPathOnly}{wxpathonly}\\
 \helpref{wxPostDelete}{wxpostdelete}\\
 \helpref{wxPostEvent}{wxpostevent}\\
 \helpref{wxPathOnly}{wxpathonly}\\
 \helpref{wxPostDelete}{wxpostdelete}\\
 \helpref{wxPostEvent}{wxpostevent}\\


@@ -1093,6 +1094,18 @@ Makes the directory {\it dir}, returning true if successful.
 supported (Unix) and doesn't have effect for the other ones.
 
 
 supported (Unix) and doesn't have effect for the other ones.
 
 

+\membersection{::wxParseWildcard}\label{wxparsewildcard}
+
+\func{int}{wxParseWildcard}{\param{const wxString\& }{wildCard}, \param{wxArrayString\& }{descriptions}, \param{wxArrayString\& }{filters}}
+
+Parses the wildCard, returning the number of filters.
+Returns 0 if none or if there's a problem,
+The arrays will contain an equal number of items found before the error.
+{\it wildCard} is in the form:
+\begin{verbatim}
+ "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
+\end{verbatim}
+

 \membersection{::wxRemoveFile}\label{wxremovefile}
 
 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
 \membersection{::wxRemoveFile}\label{wxremovefile}
 
 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}


@@ -1399,7 +1412,7 @@ This function is deprecated, use \helpref{wxString}{wxstring} class instead.
 
 This macro expands into a call to plural form version of
 \helpref{wxGetTranslation}{wxgettranslation} 
 
 This macro expands into a call to plural form version of
 \helpref{wxGetTranslation}{wxgettranslation} 

-function, so it marks the message for the extraction by {\tt xgettext} just as
+function, so it marks the message for the extraction by {\tt xgettext} just as 

 \helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of
 the string for the current locale during execution, either singular or plural
 form depending on the value of \arg{n}.
 \helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of
 the string for the current locale during execution, either singular or plural
 form depending on the value of \arg{n}.


@@ -1544,21 +1557,21 @@ build. In fact, its definition is:
 \func{const wxChar *}{wxTRANSLATE}{\param{const char *}{s}}
 
 This macro doesn't do anything in the program code -- it simply expands to the
 \func{const wxChar *}{wxTRANSLATE}{\param{const char *}{s}}
 
 This macro doesn't do anything in the program code -- it simply expands to the

-value of its argument (expand in Unicode build where it is equivalent to 
+value of its argument (except in Unicode build where it is equivalent to 

 \helpref{wxT}{wxt} which makes it unnecessary to use both wxTRANSLATE and wxT
 with the same string which would be really unreadable).
 
 However it does have a purpose and it is to mark the literal strings for the
 extraction into the message catalog created by {\tt xgettext} program. Usually
 this is achieved using \helpref{\_()}{underscore} but that macro not only marks
 \helpref{wxT}{wxt} which makes it unnecessary to use both wxTRANSLATE and wxT
 with the same string which would be really unreadable).
 
 However it does have a purpose and it is to mark the literal strings for the
 extraction into the message catalog created by {\tt xgettext} program. Usually
 this is achieved using \helpref{\_()}{underscore} but that macro not only marks

-the string for extraction but also expands into 
+the string for extraction but also expands into a 

 \helpref{wxGetTranslation}{wxgettranslation} function call which means that it
 \helpref{wxGetTranslation}{wxgettranslation} function call which means that it

-cannot be used in some situations, notably for the static arrays
+cannot be used in some situations, notably for static array

 initialization.
 
 Here is an example which should make it more clear: suppose that you have a
 static array of strings containing the weekday names and which have to be
 initialization.
 
 Here is an example which should make it more clear: suppose that you have a
 static array of strings containing the weekday names and which have to be

-translated (note that it is a bad example, really, as
+translated (note that it is a bad example, really, as 

 \helpref{wxDateTime}{wxdatetime} already can be used to get the localized week
 day names already). If you write
 
 \helpref{wxDateTime}{wxdatetime} already can be used to get the localized week
 day names already). If you write
 


@@ -1584,8 +1597,6 @@ wxTRANSLATE() in the above, it wouldn't work as expected because there would be
 no translations for the weekday names in the program message catalog and
 wxGetTranslation wouldn't find them.
 
 no translations for the weekday names in the program message catalog and
 wxGetTranslation wouldn't find them.
 

-
-

 \membersection{::wxVsnprintf}\label{wxvsnprintf}
 
 \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}
 \membersection{::wxVsnprintf}\label{wxvsnprintf}
 
 \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}


@@ -1729,7 +1740,7 @@ If path is empty, the current directory will be used. If filename is empty,
 no default filename will be supplied. The wildcard determines what files
 are displayed in the file selector, and file extension supplies a type
 extension for the required filename. Flags may be a combination of wxOPEN,
 no default filename will be supplied. The wildcard determines what files
 are displayed in the file selector, and file extension supplies a type
 extension for the required filename. Flags may be a combination of wxOPEN,

-wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.
+wxSAVE, wxOVERWRITE\_PROMPT, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.

 
 Both the Unix and Windows versions implement a wildcard filter. Typing a
 filename containing wildcards (*, ?) in the filename text item, and
 
 Both the Unix and Windows versions implement a wildcard filter. Typing a
 filename containing wildcards (*, ?) in the filename text item, and


@@ -1883,7 +1894,7 @@ Dialog is centered on its {\it parent} unless an explicit position is given in
 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<wx/textdlg.h>
+<wx/numdlg.h>

 
 
 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
 
 
 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}