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 BufferParams;
  36
  37 namespace frontend {
  38
  39 /// method to get a Length from widgets (LengthCombo)
  40 std::string widgetsToLength(QLineEdit const * input, LengthCombo const * combo);
  41 /// method to get a Length from widgets (QComboBox)
  42 Length widgetsToLength(QLineEdit const * input, QComboBox const * combo);
  43
  44 //FIXME It would be nice if defaultUnit were a default argument
  45 /// method to set widgets from a Length
  46 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
  47 Length const & len, Length::UNIT default_unit);
  48 /// method to set widgets from a string
  49 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
  50 std::string const & len, Length::UNIT default_unit);
  51 /// method to set widgets from a docstring
  52 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
  53 docstring const & len, Length::UNIT default_unit);
  54
  55 /// method to get a double value from a localized widget (QLineEdit)
  56 double widgetToDouble(QLineEdit const * input);
  57 /// method to get a double value from a localized widget (QLineEdit)
  58 std::string widgetToDoubleStr(QLineEdit const * input);
  59 /// method to set a (localized) double value in a widget (QLineEdit)
  60 void doubleToWidget(QLineEdit * input, double const & value,
  61         char f = 'g', int prec = 6);
  62 /// method to set a (localized) double value in a widget (QLineEdit)
  63 void doubleToWidget(QLineEdit * input, std::string const & value,
  64         char f = 'g', int prec = 6);
  65
  66 /// colors a widget red if invalid
  67 void setValid(QWidget * widget, bool valid);
  68
  69 } // namespace frontend
  70
  71
  72 /**
  73  * qt_ - i18nize string and convert to QString
  74  *
  75  * Use this in qt4/ instead of _()
  76  */
  77 QString const qt_(std::string const & str);
  78
  79 ///
  80 support::FileName libFileSearch(QString const & dir, QString const & name,
  81                                 QString const & ext = QString());
  82
  83 ///
  84 support::FileName imageLibFileSearch(QString & dir, QString const & name,
  85                                      QString const & ext = QString());
  86
  87 /** Wrappers around browseFile which try to provide a filename
  88         relative to relpath.
  89
  90 \param title: title for dialog
  91
  92 \param filters: *.ps, etc
  93
  94 \param save: whether to save dialog info (current path, etc) for next use.
  95
  96 The \param labelN and \param dirN arguments provide for extra buttons
  97 in the dialog (e.g., "Templates" and a path to that directory).
  98
  99 The difference between the functions concerns when we think we have a
 100 relative path.
 101
 102 In \c browseRelToParent, we return a relative path only if it IS NOT of
 103         the form "../../foo.txt".
 104
 105 In \c browseRelToSub, we return a relative path only if it IS of the
 106  form "../../foo.txt".
 107 */
 108 QString browseRelToParent(QString const & filename,
 109         QString const & relpath,
 110         QString const & title,
 111         QStringList const & filters,
 112         bool save = false,
 113         QString const & label1 = QString(),
 114         QString const & dir1 = QString(),
 115         QString const & label2 = QString(),
 116         QString const & dir2 = QString());
 117
 118 QString browseRelToSub(QString const & filename,
 119         QString const & relpath,
 120         QString const & title,
 121         QStringList const & filters,
 122         bool save = false,
 123         QString const & label1 = QString(),
 124         QString const & dir1 = QString(),
 125         QString const & label2 = QString(),
 126         QString const & dir2 = QString());
 127
 128 /** Build filelists of all availabe bst/cls/sty-files. Done through
 129 *  kpsewhich and an external script, saved in *Files.lst.
 130 */
 131 void rescanTexStyles();
 132
 133 /** Fill \c contents from one of the three texfiles.
 134  *  Each entry in the file list is returned as a name_with_path
 135  */
 136 QStringList texFileList(QString const & filename);
 137
 138 /// Convert internal line endings to line endings as expected by the OS
 139 QString const externalLineEnding(docstring const & str);
 140
 141 /// Convert line endings in any formnat to internal line endings
 142 docstring const internalLineEnding(QString const & str);
 143
 144 // wrapper around the docstring versions
 145 QString internalPath(QString const &);
 146 QString onlyFileName(QString const & str);
 147 QString onlyPath(QString const & str);
 148 QStringList fileFilters(QString const & description);
 149
 150 QString changeExtension(QString const & oldname, QString const & extension);
 151
 152 /// Remove the extension from \p name
 153 QString removeExtension(QString const & name);
 154
 155 /** Add the extension \p ext to \p name.
 156  Use this instead of changeExtension if you know that \p name is without
 157  extension, because changeExtension would wrongly interpret \p name if it
 158  contains a dot.
 159  */
 160 QString addExtension(QString const & name, QString const & extension);
 161
 162 /// Return the extension of the file (not including the .)
 163 QString getExtension(QString const & name);
 164 QString makeAbsPath(QString const & relpath, QString const & base);
 165 QString changeExtension(QString const & oldname, QString const & ext);
 166
 167 /// \return the display string associated with given type and buffer
 168 /// parameter.
 169 QString guiName(std::string const & type, BufferParams const & bp);
 170
 171 } // namespace lyx
 172
 173 #endif // QTHELPERS_H