* \author unknown
* \author John Levon
*
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
*/
#ifndef FILEDIALOG_H
#define FILEDIALOG_H
+#include "lfuns.h"
+#include "support/docstring.h"
#include <utility>
+#include <string>
-#include "lfuns.h"
-#include "LString.h"
+namespace lyx {
+
+namespace support { class FileFilterList; }
+
/**
* \class FileDialog
{
public:
/// label, directory path button
- typedef std::pair<string, string> Button;
+ typedef std::pair<docstring, docstring> Button;
/// result type
enum ResultType {
};
/// result return
- typedef std::pair<FileDialog::ResultType, string> Result;
+ typedef std::pair<FileDialog::ResultType, docstring> Result;
/**
* Constructs a file dialog with title \param title.
* additional directories in the navigation (an empty
* directory is interpreted as getcwd())
*/
- FileDialog(string const & title,
+ FileDialog(docstring const & title,
kb_action a = LFUN_SELECT_FILE_SYNC,
- Button b1 = Button(string(), string()),
- Button b2 = Button(string(), string()));
+ Button b1 = Button(docstring(), docstring()),
+ Button b2 = Button(docstring(), docstring()));
~FileDialog();
- /**
- * Choose a file for opening, starting in directory \param
- * path, with the file selection \param mask. The \param mask
- * string is of the form :
- *
- * <glob to match> | <description>
- *
- * for example, "*.ps | PostScript files (*.ps)".
- *
- * FIXME: should support multiple lines of these for different file types.
- */
- Result const open(string const & path = string(),
- string const & mask = string(),
- string const & suggested = string());
+ /// Choose a file for opening, starting in directory \c path.
+ Result const open(docstring const & path,
+ support::FileFilterList const & filters,
+ docstring const & suggested);
- /**
- * Choose a directory, starting in directory \param
- * path.
- */
- Result const opendir(string const & path = string(),
- string const & suggested = string());
-
- /**
- * Choose a file for saving, starting in directory \param
- * path, with the file selection \param mask. The \param mask
- * string is of the form :
- *
- * <glob to match> | <description>
- *
- * for example, "*.ps | PostScript files (*.ps)".
- */
- Result const save(string const & path = string(),
- string const & mask = string(),
- string const & suggested = string());
+ /// Choose a directory, starting in directory \c path.
+ Result const opendir(docstring const & path = docstring(),
+ docstring const & suggested = docstring());
+ /// Choose a file for saving, starting in directory \c path.
+ Result const save(docstring const & path,
+ support::FileFilterList const & filters,
+ docstring const & suggested);
- /* This *has* to be public because there is no way to specify extern "C" functions
- * as friends of Private implementation for the xforms implementation ... grr
- */
+private:
class Private;
friend class Private;
Private * private_;
-private:
/// the dialog title
- string title_;
+ docstring title_;
/// success action to perform if not synchronous
kb_action success_;
-
};
+} // namespace lyx
+
#endif // FILEDIALOG_H