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 support::FileName libFileSearch(QString const & dir, QString const & name,
  72                                 QString const & ext = QString());
  73
  74 /** Wrapper around browseFile which tries to provide a filename
  75         relative to relpath.  If the relative path is of the form "foo.txt"
  76         or "bar/foo.txt", then it is returned as relative. OTOH, if it is
  77         of the form "../baz/foo.txt", an absolute path is returned. This is
  78         intended to be useful for insets which encapsulate files/
  79 */
  80 QString browseRelFile(QString const & filename,
  81         QString const & refpath,
  82         QString const & title,
  83         QStringList const & filters,
  84         bool save = false,
  85         QString const & label1 = QString(),
  86         QString const & dir1 = QString(),
  87         QString const & label2 = QString(),
  88         QString const & dir2 = QString());
  89
  90
  91 /** Build filelists of all availabe bst/cls/sty-files. Done through
  92 *  kpsewhich and an external script, saved in *Files.lst.
  93 */
  94 void rescanTexStyles();
  95
  96 /** Fill \c contents from one of the three texfiles.
  97  *  Each entry in the file list is returned as a name_with_path
  98  */
  99 QStringList texFileList(QString const & filename);
 100
 101 // wrapper around the docstring versions
 102 QString internalPath(QString const &);
 103 QString onlyFilename(QString const & str);
 104 QString onlyPath(QString const & str);
 105 QStringList fileFilters(QString const & description);
 106
 107 QString changeExtension(QString const & oldname, QString const & extension);
 108
 109 /// Remove the extension from \p name
 110 QString removeExtension(QString const & name);
 111
 112 /** Add the extension \p ext to \p name.
 113  Use this instead of changeExtension if you know that \p name is without
 114  extension, because changeExtension would wrongly interpret \p name if it
 115  contains a dot.
 116  */
 117 QString addExtension(QString const & name, QString const & extension);
 118
 119 /// Return the extension of the file (not including the .)
 120 QString getExtension(QString const & name);
 121 QString makeAbsPath(QString const & relpath, QString const & base);
 122 QString changeExtension(QString const & oldname, QString const & ext);
 123
 124 } // namespace lyx
 125
 126 #endif // QTHELPERS_H