]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/qt4/qt_helpers.h
Fix the tab ordering of GuiDocument components.
[lyx.git] / src / frontends / qt4 / qt_helpers.h
index c2437deb10b213103c1f34ca24a132cadb60c31b..d7a471ca069bce8c4d2b98585afe70c49ba0ce3e 100644 (file)
 
 #include "Length.h"
 #include "support/qstring_helpers.h"
-#include "support/strfwd.h"
+#include "qt_i18n.h"
 
-#include <vector>
+#include <QString>
 
 class QComboBox;
 class QLineEdit;
 class QCheckBox;
 class QString;
 class QWidget;
+template <class T> class QList;
 
 class LengthCombo;
 
 namespace lyx {
 
-namespace support { class FileFilterList; }
+namespace support { class FileName; }
+
+class BufferParams;
 
 namespace frontend {
 
@@ -45,9 +48,20 @@ Length const & len, Length::UNIT default_unit);
 /// method to set widgets from a string
 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
 std::string const & len, Length::UNIT default_unit);
-/// method to set widgets from a Length with optional "auto" if zero
-void lengthAutoToWidgets(QLineEdit * input, LengthCombo * combo,
-Length const & len, Length::UNIT defaultUnit);
+/// method to set widgets from a docstring
+void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
+docstring const & len, Length::UNIT default_unit);
+
+/// method to get a double value from a localized widget (QLineEdit)
+double widgetToDouble(QLineEdit const * input);
+/// method to get a double value from a localized widget (QLineEdit)
+std::string widgetToDoubleStr(QLineEdit const * input);
+/// method to set a (localized) double value in a widget (QLineEdit)
+void doubleToWidget(QLineEdit * input, double const & value,
+       char f = 'g', int prec = 6);
+/// method to set a (localized) double value in a widget (QLineEdit)
+void doubleToWidget(QLineEdit * input, std::string const & value,
+       char f = 'g', int prec = 6);
 
 /// colors a widget red if invalid
 void setValid(QWidget * widget, bool valid);
@@ -55,14 +69,6 @@ void setValid(QWidget * widget, bool valid);
 } // namespace frontend
 
 
-/**
-* qt_ - i18nize string and convert to QString
- *
- * Use this in qt4/ instead of _()
- */
-QString const qt_(char const * str, const char * comment = 0);
-
-
 /**
  * qt_ - i18nize string and convert to QString
  *
@@ -71,70 +77,53 @@ QString const qt_(char const * str, const char * comment = 0);
 QString const qt_(std::string const & str);
 
 ///
-typedef std::pair<docstring, std::string> LanguagePair;
+support::FileName libFileSearch(QString const & dir, QString const & name,
+                               QString const & ext = QString());
 
-/** If the caller is the character dialog, add "No change" and "Reset"
-*  to the vector.
-*/
-std::vector<LanguagePair> const getLanguageData(bool character_dlg);
+///
+support::FileName imageLibFileSearch(QString & dir, QString const & name,
+                                    QString const & ext = QString());
 
-/** Launch a file dialog and return the chosen file.
-       filename: a suggested filename.
-       title: the title of the dialog.
-       pattern: *.ps etc.
-       dir1 = (name, dir), dir2 = (name, dir): extra buttons on the dialog.
-*/
-docstring browseFile(docstring const & filename,
-       docstring const & title,
-       support::FileFilterList const & filters,
-       bool save = false,
-       docstring const & label1 = docstring(),
-       docstring const & dir1 = docstring(),
-       docstring const & label2 = docstring(),
-       docstring const & dir2 = docstring());
+/** Wrappers around browseFile which try to provide a filename
+       relative to relpath.
 
+\param title: title for dialog
+       
+\param filters: *.ps, etc
 
-/** Wrapper around browseFile which tries to provide a filename
-       relative to relpath.  If the relative path is of the form "foo.txt"
-       or "bar/foo.txt", then it is returned as relative. OTOH, if it is
-       of the form "../baz/foo.txt", an absolute path is returned. This is
-       intended to be useful for insets which encapsulate files/
-*/
-docstring browseRelFile(docstring const & filename,
-       docstring const & refpath,
-       docstring const & title,
-       support::FileFilterList const & filters,
-       bool save = false,
-       docstring const & label1 = docstring(),
-       docstring const & dir1 = docstring(),
-       docstring const & label2 = docstring(),
-       docstring const & dir2 = docstring());
+\param save: whether to save dialog info (current path, etc) for next use.
 
+The \param labelN and \param dirN arguments provide for extra buttons 
+in the dialog (e.g., "Templates" and a path to that directory).
 
-/** Wrapper around browseFile which tries to provide a filename
-*  relative to the user or system directory. The dir, name and ext
-*  parameters have the same meaning as in the
-*  support::LibFileSearch function.
-*/
-docstring browseLibFile(docstring const & dir,
-       docstring const & name,
-       docstring const & ext,
-       docstring const & title,
-       support::FileFilterList const & filters);
+The difference between the functions concerns when we think we have a 
+relative path. 
 
+In \c browseRelToParent, we return a relative path only if it IS NOT of 
+       the form "../../foo.txt".
 
-/** Launch a file dialog and return the chosen directory.
-       pathname: a suggested pathname.
-       title: the title of the dialog.
-       dir1 = (name, dir), dir2 = (name, dir): extra buttons on the dialog.
+In \c browseRelToSub, we return a relative path only if it IS of the
+ form "../../foo.txt".
 */
-docstring browseDir(docstring const & pathname,
-       docstring const & title,
-       docstring const & label1 = docstring(),
-       docstring const & dir1 = docstring(),
-       docstring const & label2 = docstring(),
-       docstring const & dir2 = docstring());
-
+QString browseRelToParent(QString const & filename,
+       QString const & relpath,
+       QString const & title,
+       QStringList const & filters,
+       bool save = false,
+       QString const & label1 = QString(),
+       QString const & dir1 = QString(),
+       QString const & label2 = QString(),
+       QString const & dir2 = QString());
+
+QString browseRelToSub(QString const & filename,
+       QString const & relpath,
+       QString const & title,
+       QStringList const & filters,
+       bool save = false,
+       QString const & label1 = QString(),
+       QString const & dir1 = QString(),
+       QString const & label2 = QString(),
+       QString const & dir2 = QString());
 
 /** Build filelists of all availabe bst/cls/sty-files. Done through
 *  kpsewhich and an external script, saved in *Files.lst.
@@ -144,7 +133,40 @@ void rescanTexStyles();
 /** Fill \c contents from one of the three texfiles.
  *  Each entry in the file list is returned as a name_with_path
  */
-void getTexFileList(std::string const & filename, std::vector<std::string> & contents);
+QStringList texFileList(QString const & filename);
+
+/// Convert internal line endings to line endings as expected by the OS
+QString const externalLineEnding(docstring const & str);
+
+/// Convert line endings in any formnat to internal line endings
+docstring const internalLineEnding(QString const & str);
+
+// wrapper around the docstring versions
+QString internalPath(QString const &);
+QString onlyFileName(QString const & str);
+QString onlyPath(QString const & str);
+QStringList fileFilters(QString const & description);
+
+QString changeExtension(QString const & oldname, QString const & extension);
+
+/// Remove the extension from \p name
+QString removeExtension(QString const & name);
+
+/** Add the extension \p ext to \p name.
+ Use this instead of changeExtension if you know that \p name is without
+ extension, because changeExtension would wrongly interpret \p name if it
+ contains a dot.
+ */
+QString addExtension(QString const & name, QString const & extension);
+
+/// Return the extension of the file (not including the .)
+QString getExtension(QString const & name);
+QString makeAbsPath(QString const & relpath, QString const & base);
+QString changeExtension(QString const & oldname, QString const & ext);
+
+/// \return the display string associated with given type and buffer
+/// parameter.
+QString guiName(std::string const & type, BufferParams const & bp);
 
 } // namespace lyx