// -*- C++ -*-
/**
* \file FileDialog.h
- * Copyright 2001 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
* \author unknown
* \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
*/
#ifndef FILEDIALOG_H
#define FILEDIALOG_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "lfuns.h"
#include <utility>
+#include <string>
+
+
+namespace lyx {
+namespace support {
+
+class FileFilterList;
-#include "commandtags.h"
+} // namespace support
+} // namespace lyx
-#include "LString.h"
-class LyXView;
/**
* \class FileDialog
{
public:
/// label, directory path button
- typedef std::pair<string, string> Button;
+ typedef std::pair<std::string, std::string> Button;
/// result type
enum ResultType {
};
/// result return
- typedef std::pair<FileDialog::ResultType, string> Result;
+ typedef std::pair<FileDialog::ResultType, std::string> Result;
/**
- * Constructs a file dialog attached to LyXView \param lv, with
- * title \param title. If param \a is \const LFUN_SELECT_FILE_SYNC
- * then a value will be returned immediately upon performing a Select(),
+ * Constructs a file dialog with title \param title.
+ * If \param a is \const LFUN_SELECT_FILE_SYNC then a value
+ * will be returned immediately upon performing a open(),
* otherwise a callback Dispatch() will be invoked with the filename as
* argument, of action \param a.
*
- * Up to two optional extra buttons are allowed for specifying addtional
- * directories in the navigation.
+ * Up to two optional extra buttons are allowed for specifying
+ * additional directories in the navigation (an empty
+ * directory is interpreted as getcwd())
*/
- FileDialog(LyXView * lv, string const & title, kb_action a = LFUN_SELECT_FILE_SYNC,
- Button b1 = Button(string(), string()),
- Button b2 = Button(string(), string()));
-
+ FileDialog(std::string const & title,
+ kb_action a = LFUN_SELECT_FILE_SYNC,
+ Button b1 = Button(std::string(), std::string()),
+ Button b2 = Button(std::string(), std::string()));
+
~FileDialog();
- /**
- * Choose a file for selection, starting in directory \param path, with the file
- * selection \param mask. The \param mask string is of the form :
- *
- * <regular expression to match> | <description>
- *
- * for example, "*.ps | PostScript files (*.ps)".
- *
- * FIXME: should support multiple lines of these for different file types.
- */
- Result const Select(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(std::string const & path,
+ lyx::support::FileFilterList const & filters,
+ std::string const & suggested);
+ /// Choose a directory, starting in directory \c path.
+ Result const opendir(std::string const & path = std::string(),
+ std::string const & suggested = std::string());
- /* 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
- */
+ /// Choose a file for saving, starting in directory \c path.
+ Result const save(std::string const & path,
+ lyx::support::FileFilterList const & filters,
+ std::string const & suggested);
+
+private:
class Private;
friend class Private;
Private * private_;
-private:
- /// our LyXView
- LyXView * lv_;
-
/// the dialog title
- string title_;
+ std::string title_;
/// success action to perform if not synchronous
kb_action success_;