]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/filedlg.tex
remove wine path from doxygen_chm: instead add some comments with urls about where...
[wxWidgets.git] / docs / latex / wx / filedlg.tex
index b494f89f8a20b90684f82b0a8624f1c7ce59426d..2b7a75f71c848ea93494e3aff6629ea63090ee3c 100644 (file)
@@ -5,6 +5,7 @@ This class represents the file chooser dialog.
 \wxheading{Derived from}
 
 \helpref{wxDialog}{wxdialog}\\
+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
@@ -13,6 +14,10 @@ This class represents the file chooser dialog.
 
 <wx/filedlg.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{Window styles}
 
 \begin{twocollist}\itemsep=0pt
@@ -23,6 +28,7 @@ This class represents the file chooser dialog.
 \twocolitem{{\windowstyle wxFD\_FILE\_MUST\_EXIST}}{For open dialog only: the user may only select files that actually exist.}
 \twocolitem{{\windowstyle wxFD\_MULTIPLE}}{For open dialog only: allows selecting multiple files.}
 \twocolitem{{\windowstyle wxFD\_CHANGE\_DIR}}{Change the current working directory to the directory where the file(s) chosen by the user are.}
+\twocolitem{{\windowstyle wxFD\_PREVIEW}}{Show the preview of the selected files (currently only supported by wxGTK using GTK+ 2.4 or later).}
 \end{twocollist}
 
 {\bf NB:} Previous versions of wxWidgets used {\tt wxFD\_CHANGE\_DIR} by default
@@ -110,6 +116,15 @@ Destructor.
 
 Returns the default directory.
 
+\membersection{wxFileDialog::GetExtraControl}\label{wxfiledialoggetextracontrol}
+
+\constfunc{wxWindow* }{GetExtraControl}{\void}
+
+If functions 
+\helpref{SetExtraControlCreator}{wxfiledialogsetextracontrolcreator}
+and \helpref{ShowModal}{wxfiledialogshowmodal} were called,
+returns the extra window. Otherwise returns \NULL.
+
 \membersection{wxFileDialog::GetFilename}\label{wxfiledialoggetfilename}
 
 \constfunc{wxString}{GetFilename}{\void}
@@ -121,7 +136,7 @@ Returns the default filename.
 \constfunc{void}{GetFilenames}{\param{wxArrayString\& }{filenames}}
 
 Fills the array {\it filenames} with the names of the files chosen. This
-function should only be used with the dialogs which have {\tt wxMULTIPLE} style,
+function should only be used with the dialogs which have {\tt wxFD\_MULTIPLE} style,
 use \helpref{GetFilename}{wxfiledialoggetfilename} for the others.
 
 Note that under Windows, if the user selects shortcuts, the filenames
@@ -154,7 +169,7 @@ Returns the full path (directory and filename) of the selected file.
 \constfunc{void}{GetPaths}{\param{wxArrayString\& }{paths}}
 
 Fills the array {\it paths} with the full paths of the files chosen. This
-function should only be used with the dialogs which have {\tt wxMULTIPLE} style,
+function should only be used with the dialogs which have {\tt wxFD\_MULTIPLE} style,
 use \helpref{GetPath}{wxfiledialoggetpath} for the others.
 
 \membersection{wxFileDialog::GetWildcard}\label{wxfiledialoggetwildcard}
@@ -169,6 +184,26 @@ Returns the file dialog wildcard.
 
 Sets the default directory.
 
+\membersection{wxFileDialog::SetExtraControlCreator}\label{wxfiledialogsetextracontrolcreator}
+
+\begin{verbatim}
+typedef wxWindow* (*ExtraControlCreatorFunction)(wxWindow*);
+\end{verbatim}
+\func{bool}{SetExtraControlCreator}{\param{t\_extraControlCreator }{creator}}
+
+Customize file dialog by adding extra window, which is typically placed
+below the list of files and above the buttons.
+
+SetExtraControlCreator can be called only once, before calling
+\helpref{ShowModal}{wxfiledialogshowmodal}.
+The {\tt creator} function should take pointer to parent window (file dialog)
+and should return a window allocated with operator new.
+
+Supported platforms: wxGTK, wxUniv.
+
+\wxheading{Return value}
+{\tt true} if adding extra controls is supported, {\tt false} otherwise.
+
 \membersection{wxFileDialog::SetFilename}\label{wxfiledialogsetfilename}
 
 \func{void}{SetFilename}{\param{const wxString\& }{setfilename}}