wxPython documentation updates

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index a42a929f31e0a8716ed8d4c508e2f7c7f84d9d62..e260c3d7659a500108ae295a54114d89c7143fae 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -31,7 +31,8 @@ slashes.
 
 \func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
 
-Returns TRUE if the file exists.
+Returns TRUE if the file exists. It also returns TRUE if the file is
+a directory.
 
 \membersection{::wxFileNameFromPath}
 
@@ -48,11 +49,12 @@ temporary storage that should not be deallocated.
 
 This function does directory searching; returns the first file
 that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to
-get the next matching file.
+get the next matching file. Neither will report the current directory "." or the
+parent directory "..".
 
 {\it spec} may contain wildcards.
 
-{\it flags} is reserved for future use.
+{\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
 
 For example:
 
@@ -79,6 +81,17 @@ See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
 
 Returns the Windows directory under Windows; on other platforms returns the empty string.
 
+\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
+
+\func{void}{wxInitAllImageHandlers}{\void}
+
+Adds some common image format handlers, which, depending on wxWindows
+configuration, can be handlers for BMP (loading) (always installed), GIF
+(loading and saving), PCX (loading and saving), PNM (loading and saving as raw
+rgb), PNG (loading and saving), JPEG (loading and saving), file formats.
+
+See also: \helpref{wxImage}{wximage} \helpref{wxImageHandler}{wximagehandler}
+
 \membersection{::wxIsAbsolutePath}
 
 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
@@ -440,18 +453,15 @@ 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,
-wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, or 0. They are only significant
-at present in Windows.
+wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, or 0.
 
-Both the X and Windows versions implement a wildcard filter. Typing a
+Both the Unix and Windows versions implement a wildcard filter. Typing a
 filename containing wildcards (*, ?) in the filename text item, and
 clicking on Ok, will result in only those files matching the pattern being
-displayed. In the X version, supplying no default name will result in the
-wildcard filter being inserted in the filename text item; the filter is
-ignored if a default name is supplied.
+displayed.
 
-Under Windows (only), the wildcard may be a specification for multiple
-types of file with a description for each, such as:
+The wildcard may be a specification for multiple types of file 
+with a description for each, such as:
 
 \begin{verbatim}
  "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
@@ -637,7 +647,7 @@ The symbols are not shown when the generic function is used.
 
 \func{bool}{wxShowTip}{
     \param{wxWindow *}{parent},
-    \parent{wxTipProvider *}{tipProvider},
+    \param{wxTipProvider *}{tipProvider},
     \param{bool }{showAtStartup = TRUE}}
 
 This function shows a "startup tip" to the user.
@@ -1919,6 +1929,23 @@ base classes.
 
 <wx/object.h>
 
+\membersection{wxBITMAP}\label{wxbitmap}
+
+\func{}{wxBITMAP}{bitmapName}
+
+This macro loads a bitmap from either application resources (on the platforms
+for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
+avoid using {\tt #ifdef}s when creating bitmaps.
+
+\wxheading{See also}
+
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{wxICON}{wxicon}
+
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
 \membersection{WXDEBUG\_NEW}\label{debugnew}
 
 \func{}{WXDEBUG\_NEW}{arg}
@@ -1966,6 +1993,23 @@ Example:
 
 \helpref{RTTI overview}{runtimeclassoverview}
 
+\membersection{wxICON}\label{wxicon}
+
+\func{}{wxICON}{iconName}
+
+This macro loads an icon from either application resources (on the platforms
+for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
+avoid using {\tt #ifdef}s when creating icons.
+
+\wxheading{See also}
+
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{wxBITMAP}{wxbitmap}
+
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
 \membersection{WXTRACE}\label{trace}
 
 \wxheading{Include files}