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 ee1ed4a49894a2f07c42123f2c3f6d0c000eac71..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}}
 
 
 \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}
 
 
 \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
 
 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 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:
 
 
 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.
 
 
 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}}
 \membersection{::wxIsAbsolutePath}
 
 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}


@@ -405,6 +418,27 @@ parameters are optional. However, it is recommended to pass a parent frame
 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
 the front when the dialog box is popped up.
 
 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
 the front when the dialog box is popped up.
 

+\membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
+
+\func{wxTipProvider *}{wxCreateFileTipProvider}{
+    \param{const wxString\& }{filename},
+    \param{size\_t }{currentTip}}
+
+This function creates a \helpref{wxTipProvider}{wxtipprovider} which may be
+used with \helpref{wxShowTip}{wxshowtip}.
+
+\docparam{filename}{The name of the file containing the tips, one per line}
+\docparam{currentTip}{The index of the first tip to show - normally this index
+    is remembered between the 2 program runs.}
+
+\wxheading{See also:}
+
+\helpref{Tips overview}{tipsoverview}
+
+\wxheading{Include files}
+
+<wx/tipdlg.h>
+

 \membersection{::wxFileSelector}\label{wxfileselector}
 
 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
 \membersection{::wxFileSelector}\label{wxfileselector}
 
 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\


@@ -419,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,
 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
 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"
 
 \begin{verbatim}
  "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"


@@ -451,6 +482,33 @@ if (s)
 
 <wx/filedlg.h>
 
 
 <wx/filedlg.h>
 

+\membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
+
+\func{long}{wxGetNumberFromUser}{
+    \param{const wxString\& }{message},
+    \param{const wxString\& }{prompt},
+    \param{const wxString\& }{caption},
+    \param{long }{value},
+    \param{long }{min = 0},
+    \param{long }{max = 100},
+    \param{wxWindow *}{parent = NULL},
+    \param{const wxPoint\& }{pos = wxDefaultPosition}}
+
+Shows a dialog asking the user for numeric input. The dialogs title is set to 
+{\it caption}, it contains a (possibly) multiline {\it message} above the
+single line {\it prompt} and the zone for entering the number.
+
+The number entered must be in the range {\it min}..{\it max} (both of which
+should be positive) and {\it value} is the initial value of it. If the user
+enters an invalid value or cancels the dialog, the function will return -1.
+
+Dialog is centered on its {\it parent} unless an explicit position is given in 
+{\it pos}.
+
+\wxheading{Include files}
+
+<wx/textdlg.h>
+

 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
 
 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
 
 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\


@@ -585,6 +643,33 @@ The symbols are not shown when the generic function is used.
 
 <wx/msgdlg.h>
 
 
 <wx/msgdlg.h>
 

+\membersection{::wxShowTip}\label{wxshowtip}
+
+\func{bool}{wxShowTip}{
+    \param{wxWindow *}{parent},
+    \param{wxTipProvider *}{tipProvider},
+    \param{bool }{showAtStartup = TRUE}}
+
+This function shows a "startup tip" to the user.
+
+\docparam{parent}{The parent window for the modal dialog}
+
+\docparam{tipProvider}{An object which is used to get the text of the tips.
+    It may be created with 
+    \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
+
+\docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
+    otherwise. This is used as the initial value for "Show tips at startup"
+    checkbox which is shown in the tips dialog.}
+
+\wxheading{See also:}
+
+\helpref{Tips overview}{tipsoverview}
+
+\wxheading{Include files}
+
+<wx/tipdlg.h>
+

 \section{GDI functions}\label{gdifunctions}
 
 The following are relevant to the GDI (Graphics Device Interface).
 \section{GDI functions}\label{gdifunctions}
 
 The following are relevant to the GDI (Graphics Device Interface).


@@ -637,11 +722,13 @@ This function is only available under Windows.
 
 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
 
 
 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
 

-Globally sets the cursor; only has an effect in MS Windows.
+Globally sets the cursor; only has an effect in Windows and GTK.

 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
 
 \section{Printer settings}\label{printersettings}
 
 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
 
 \section{Printer settings}\label{printersettings}
 

+These routines are obsolete and should no longer be used!
+

 The following functions are used to control PostScript printing. Under
 Windows, PostScript output can only be sent to a file.
 
 The following functions are used to control PostScript printing. Under
 Windows, PostScript output can only be sent to a file.
 


@@ -1378,7 +1465,7 @@ Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxSafeYield}{wxsafeyield}
+\membersection{::wxSafeYield}\label{wxsafeyield}

 
 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
 
 
 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
 


@@ -1393,7 +1480,7 @@ Returns the result of the call to \helpref{::wxYield}{wxyield}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxEnableTopLevelWindows}{wxenabletoplevelwindows}
+\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}

 
 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
 
 
 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
 


@@ -1586,28 +1673,60 @@ function.
 
 These macros are defined in wxWindows.
 
 
 These macros are defined in wxWindows.
 

-\membersection{CLASSINFO}\label{classinfo}
+\membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}

 
 

-\func{wxClassInfo *}{CLASSINFO}{className}
+\func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}

 
 

-Returns a pointer to the wxClassInfo object associated with this class.
+\func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}

 
 

-\wxheading{Include files}
+\func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}

 
 

-<wx/object.h>
+\func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}

 
 

-\membersection{WXDEBUG\_NEW}\label{debugnew}
+This macro will swap the bytes of the {\it value} variable from little
+endian to big endian or vice versa.

 
 

-\func{}{WXDEBUG\_NEW}{arg}
+\membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}

 
 

-This is defined in debug mode to be call the redefined new operator
-with filename and line number arguments. The definition is:
+\func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}

 
 

-\begin{verbatim}
-#define WXDEBUG_NEW new(__FILE__,__LINE__)
-\end{verbatim}
+\func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}

 
 

-In non-debug mode, this is defined as the normal new operator.
+\func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
+
+\func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
+
+This macro will swap the bytes of the {\it value} variable from little
+endian to big endian or vice versa if the program is compiled on a
+big-endian architecture (such as Sun work stations). If the program has 
+been compiled on a little-endian architecture, the value will be unchanged.
+
+Use these macros to read data from and write data to a file that stores 
+data in little endian (Intel i386) format.
+
+\membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
+
+\func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
+
+\func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
+
+\func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
+
+\func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
+
+This macro will swap the bytes of the {\it value} variable from little
+endian to big endian or vice versa if the program is compiled on a
+little-endian architecture (such as Intel PCs). If the program has 
+been compiled on a big-endian architecture, the value will be unchanged.
+
+Use these macros to read data from and write data to a file that stores 
+data in big endian format.
+
+\membersection{CLASSINFO}\label{classinfo}
+
+\func{wxClassInfo *}{CLASSINFO}{className}
+
+Returns a pointer to the wxClassInfo object associated with this class.

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -1810,8 +1929,93 @@ base classes.
 
 <wx/object.h>
 
 
 <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}
+
+This is defined in debug mode to be call the redefined new operator
+with filename and line number arguments. The definition is:
+
+\begin{verbatim}
+#define WXDEBUG_NEW new(__FILE__,__LINE__)
+\end{verbatim}
+
+In non-debug mode, this is defined as the normal new operator.
+
+\wxheading{Include files}
+
+<wx/object.h>
+
+\membersection{wxDynamicCast}\label{wxdynamiccast}
+
+\func{}{wxDynamicCast}{ptr, classname}
+
+This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
+the pointer is of this type (the check is done during the run-time) or NULL
+otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf()
+function.
+
+The {\it ptr} argument may be NULL, in which case NULL will be returned.
+
+Example:
+
+\begin{verbatim}
+    wxWindow *win = wxWindow::FindFocus();
+    wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
+    if ( text )
+    {
+        // a text control has the focus...
+    }
+    else
+    {
+        // no window has the focus or it's not a text control
+    }
+\end{verbatim}
+
+\wxheading{See also}
+
+\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}
 
 \membersection{WXTRACE}\label{trace}
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \func{}{WXTRACE}{formatString, ...}
 
 Calls wxTrace with printf-style variable argument syntax. Output
 \func{}{WXTRACE}{formatString, ...}
 
 Calls wxTrace with printf-style variable argument syntax. Output