]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/qt4/qt_helpers.h
Use QFontMetrics information for underlines (and friends) width and position
[lyx.git] / src / frontends / qt4 / qt_helpers.h
index 920cc9c8a4e30854a05aed44dd3f3589760dbe0c..fcdcd53102e85a9dfcdd2230e180e9653d9cd44e 100644 (file)
 
 #include "Length.h"
 #include "support/qstring_helpers.h"
-#include "support/strfwd.h"
+#include "support/filetools.h"
+#include "qt_i18n.h"
 
-#include <vector>
+#include <QHeaderView>
 
 class QComboBox;
 class QLineEdit;
 class QCheckBox;
 class QString;
 class QWidget;
-
-class LengthCombo;
+template <class T> class QList;
 
 namespace lyx {
 
-namespace support { class FileFilterList; }
+namespace support { class FileName; }
 
+class BufferParams;
 namespace frontend {
 
+class LengthCombo;
+
 /// method to get a Length from widgets (LengthCombo)
 std::string widgetsToLength(QLineEdit const * input, LengthCombo const * combo);
 /// method to get a Length from widgets (QComboBox)
 Length widgetsToLength(QLineEdit const * input, QComboBox const * combo);
 
-//FIXME It would be nice if defaultUnit were a default argument
 /// method to set widgets from a Length
+//FIXME Remove default_unit argument for the first form. FIXME Change
+// all the code to remove default_unit argument when equal to the
+// default.
 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
-Length const & len, Length::UNIT default_unit);
+                    Length const & len, 
+                    Length::UNIT default_unit = Length::defaultUnit());
 /// 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);
+                    std::string const & len, 
+                    Length::UNIT default_unit = Length::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);
+/**
+ * method to format localized floating point numbers without
+ * ever using scientific notation
+ */
+QString formatLocFPNumber(double d);
 
 /// colors a widget red if invalid
 void setValid(QWidget * widget, bool valid);
 
-} // namespace frontend
+/// Qt5 changed setSectionMode to setSectionResizeMode
+/// These wrappers work for Qt4 and Qt5
+void setSectionResizeMode(QHeaderView * view,
+    int logicalIndex, QHeaderView::ResizeMode mode);
+void setSectionResizeMode(QHeaderView * view,
+       QHeaderView::ResizeMode mode);
 
-
-/**
-* qt_ - i18nize string and convert to QString
- *
- * Use this in qt4/ instead of _()
- */
-QString const qt_(char const * str, const char * comment = 0);
+} // namespace frontend
 
 
 /**
@@ -69,46 +92,104 @@ QString const qt_(char const * str, const char * comment = 0);
  * Use this in qt4/ instead of _()
  */
 QString const qt_(std::string const & str);
+QString const qt_(QString const & qstr);
+
 
 ///
-typedef std::pair<docstring, std::string> LanguagePair;
+support::FileName libFileSearch(QString const & dir, QString const & name,
+                               QString const & ext = QString(),
+                               support::search_mode mode = support::must_exist);
 
-/** 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(),
+                               support::search_mode mode = support::must_exist);
+
+/** 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/
+\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).
+
+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".
+
+In \c browseRelToSub, we return a relative path only if it IS of the
+ form "../../foo.txt".
 */
-QString browseRelFile(QString const & filename,
-       QString const & refpath,
+QString browseRelToParent(QString const & filename,
+       QString const & relpath,
        QString const & title,
-       support::FileFilterList const & filters,
+       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.
+*  \param arg: cls, sty, bst, or bib, as required by TeXFiles.py.
+*         Can be a list of these, too.
 */
-void rescanTexStyles();
+void rescanTexStyles(std::string const & arg = empty_string());
 
 /** 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(const QString &);
-QString onlyFilename(const QString & str);
-QString onlyPath(const QString & str);
+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