added missing \wxheading{Parameters}

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

diff --git a/docs/latex/wx/filedlg.tex b/docs/latex/wx/filedlg.tex
index 6fc83576376ae4bac49b0f5b5eeec15f25287e84..09fa44304a46b39ea9755d7f9ee19462cf9a8c54 100644 (file)
--- a/docs/latex/wx/filedlg.tex
+++ b/docs/latex/wx/filedlg.tex
@@ -5,6 +5,7 @@ This class represents the file chooser dialog.
 \wxheading{Derived from}
 
 \helpref{wxDialog}{wxdialog}\\
 \wxheading{Derived from}
 
 \helpref{wxDialog}{wxdialog}\\

+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\

 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}


@@ -13,19 +14,24 @@ This class represents the file chooser dialog.
 
 <wx/filedlg.h>
 
 
 <wx/filedlg.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Window styles}
 
 \begin{twocollist}\itemsep=0pt
 \wxheading{Window styles}
 
 \begin{twocollist}\itemsep=0pt

-\twocolitem{\windowstyle{wxFD\_DEFAULT\_STYLE}}{Equivalent to wxFD_OPEN.}
+\twocolitem{\windowstyle{wxFD\_DEFAULT\_STYLE}}{Equivalent to wxFD\_OPEN.}

 \twocolitem{\windowstyle{wxFD\_OPEN}}{This is an open dialog; usually this means that the default button's label of the dialog is "Open". Cannot be combined with wxFD\_SAVE.}
 \twocolitem{\windowstyle{wxFD\_SAVE}}{This is a save dialog; usually this means that the default button's label of the dialog is "Save". Cannot be combined with wxFD\_OPEN.}
 \twocolitem{{\windowstyle wxFD\_OVERWRITE\_PROMPT}}{For save dialog only: prompt for a confirmation if a file will be overwritten.}
 \twocolitem{{\windowstyle wxFD\_FILE\_MUST\_EXIST}}{For open dialog only: the user may only select files that actually exist.}
 \twocolitem{\windowstyle{wxFD\_OPEN}}{This is an open dialog; usually this means that the default button's label of the dialog is "Open". Cannot be combined with wxFD\_SAVE.}
 \twocolitem{\windowstyle{wxFD\_SAVE}}{This is a save dialog; usually this means that the default button's label of the dialog is "Save". Cannot be combined with wxFD\_OPEN.}
 \twocolitem{{\windowstyle wxFD\_OVERWRITE\_PROMPT}}{For save dialog only: prompt for a confirmation if a file will be overwritten.}
 \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\_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}
 
 \end{twocollist}
 

-{\bf NB:} Previous versions of wxWidgets used {\tt wxFD_CHANGE\_DIR} by default
+{\bf NB:} Previous versions of wxWidgets used {\tt wxFD\_CHANGE\_DIR} by default

 under MS Windows which allowed the program to simply remember the last
 directory where user selected the files to open/save. This (desired)
 functionality must be implemented in the program itself now (manually remember
 under MS Windows which allowed the program to simply remember the last
 directory where user selected the files to open/save. This (desired)
 functionality must be implemented in the program itself now (manually remember


@@ -89,7 +95,7 @@ Constructor. Use \helpref{wxFileDialog::ShowModal}{wxfiledialogshowmodal} to sho
 Note that the native Motif dialog has some limitations with respect to
 wildcards; see the Remarks section above.}
 
 Note that the native Motif dialog has some limitations with respect to
 wildcards; see the Remarks section above.}
 

-\docparam{style}{A dialog style. See wxFD_* styles for more info.}
+\docparam{style}{A dialog style. See wxFD\_* styles for more info.}

 
 \docparam{pos}{Dialog position. Not implemented.}
 
 
 \docparam{pos}{Dialog position. Not implemented.}
 


@@ -121,7 +127,7 @@ Returns the default filename.
 \constfunc{void}{GetFilenames}{\param{wxArrayString\& }{filenames}}
 
 Fills the array {\it filenames} with the names of the files chosen. This
 \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
 use \helpref{GetFilename}{wxfiledialoggetfilename} for the others.
 
 Note that under Windows, if the user selects shortcuts, the filenames


@@ -154,7 +160,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
 \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}
 use \helpref{GetPath}{wxfiledialoggetpath} for the others.
 
 \membersection{wxFileDialog::GetWildcard}\label{wxfiledialoggetwildcard}