src/frontends/qt4/qt_helpers.h

   1 // -*- C++ -*-
   2 /**
   3  * \file qt_helpers.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Dekel Tsur
   8  * \author Richard Heck
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef QTHELPERS_H
  14 #define QTHELPERS_H
  15
  16 #include "Length.h"
  17 #include "support/qstring_helpers.h"
  18 #include "qt_i18n.h"
  19
  20 #include <QString>
  21
  22 class QComboBox;
  23 class QLineEdit;
  24 class QCheckBox;
  25 class QString;
  26 class QWidget;
  27 template <class T> class QList;
  28
  29 class LengthCombo;
  30
  31 namespace lyx {
  32
  33 namespace support { class FileName; }
  34
  35 class LyXErr;
  36
  37 LyXErr & operator<<(LyXErr &, QString const &);
  38
  39 namespace frontend {
  40
  41 /// method to get a Length from widgets (LengthCombo)
  42 std::string widgetsToLength(QLineEdit const * input, LengthCombo const * combo);
  43 /// method to get a Length from widgets (QComboBox)
  44 Length widgetsToLength(QLineEdit const * input, QComboBox const * combo);
  45
  46 //FIXME It would be nice if defaultUnit were a default argument
  47 /// method to set widgets from a Length
  48 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
  49 Length const & len, Length::UNIT default_unit);
  50 /// method to set widgets from a string
  51 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
  52 std::string const & len, Length::UNIT default_unit);
  53 /// method to set widgets from a Length with optional "auto" if zero
  54 void lengthAutoToWidgets(QLineEdit * input, LengthCombo * combo,
  55 Length const & len, Length::UNIT defaultUnit);
  56
  57 /// colors a widget red if invalid
  58 void setValid(QWidget * widget, bool valid);
  59
  60 } // namespace frontend
  61
  62
  63 /**
  64  * qt_ - i18nize string and convert to QString
  65  *
  66  * Use this in qt4/ instead of _()
  67  */
  68 QString const qt_(std::string const & str);
  69
  70 ///
  71 typedef std::pair<QString, QString> LanguagePair;
  72
  73 ///
  74 QList<LanguagePair> languageData();
  75
  76 support::FileName libFileSearch(QString const & dir, QString const & name,
  77                                 QString const & ext = QString());
  78
  79 /** Wrapper around browseFile which tries to provide a filename
  80         relative to relpath.  If the relative path is of the form "foo.txt"
  81         or "bar/foo.txt", then it is returned as relative. OTOH, if it is
  82         of the form "../baz/foo.txt", an absolute path is returned. This is
  83         intended to be useful for insets which encapsulate files/
  84 */
  85 QString browseRelFile(QString const & filename,
  86         QString const & refpath,
  87         QString const & title,
  88         QStringList const & filters,
  89         bool save = false,
  90         QString const & label1 = QString(),
  91         QString const & dir1 = QString(),
  92         QString const & label2 = QString(),
  93         QString const & dir2 = QString());
  94
  95
  96 /** Build filelists of all availabe bst/cls/sty-files. Done through
  97 *  kpsewhich and an external script, saved in *Files.lst.
  98 */
  99 void rescanTexStyles();
 100
 101 /** Fill \c contents from one of the three texfiles.
 102  *  Each entry in the file list is returned as a name_with_path
 103  */
 104 QStringList texFileList(QString const & filename);
 105
 106 // wrapper around the docstring versions
 107 QString internalPath(QString const &);
 108 QString onlyFilename(QString const & str);
 109 QString onlyPath(QString const & str);
 110 QStringList fileFilters(QString const & description);
 111
 112 QString changeExtension(QString const & oldname, QString const & extension);
 113
 114 /// Remove the extension from \p name
 115 QString removeExtension(QString const & name);
 116
 117 /** Add the extension \p ext to \p name.
 118  Use this instead of changeExtension if you know that \p name is without
 119  extension, because changeExtension would wrongly interpret \p name if it
 120  contains a dot.
 121  */
 122 QString addExtension(QString const & name, QString const & extension);
 123
 124 /// Return the extension of the file (not including the .)
 125 QString getExtension(QString const & name);
 126 QString makeAbsPath(QString const & relpath, QString const & base);
 127 QString changeExtension(QString const & oldname, QString const & ext);
 128
 129 } // namespace lyx
 130
 131 #endif // QTHELPERS_H