src/frontends/qt/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 "ColorSet.h"
  17 #include "support/Length.h"
  18 #include "support/qstring_helpers.h"
  19 #include "support/filetools.h"
  20 #include "qt_i18n.h"
  21
  22 #include <list>
  23
  24 #include <QHeaderView>
  25
  26 class QComboBox;
  27 class QLineEdit;
  28 class QCheckBox;
  29 class QString;
  30 class QWidget;
  31 template <class T> class QList;
  32
  33 namespace lyx {
  34
  35 namespace support { class FileName; }
  36
  37 class BufferParams;
  38
  39 namespace frontend {
  40
  41 class LengthCombo;
  42
  43 /// method to get a Length from widgets (LengthCombo)
  44 std::string widgetsToLength(QLineEdit const * input, LengthCombo const * combo);
  45 /// method to get a Length from widgets (QComboBox)
  46 Length widgetsToLength(QLineEdit const * input, QComboBox const * combo);
  47
  48 /// method to set widgets from a Length
  49 //FIXME Remove default_unit argument for the first form. FIXME Change
  50 // all the code to remove default_unit argument when equal to the
  51 // default.
  52 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
  53                      Length const & len,
  54                      Length::UNIT default_unit = Length::defaultUnit());
  55 /// method to set widgets from a string
  56 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
  57                      std::string const & len,
  58                      Length::UNIT default_unit = Length::defaultUnit());
  59 /// method to set widgets from a docstring
  60 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
  61 docstring const & len, Length::UNIT default_unit);
  62
  63 /// method to get a double value from a localized widget (QLineEdit)
  64 double widgetToDouble(QLineEdit const * input);
  65 /// method to get a double value from a localized widget (QLineEdit)
  66 std::string widgetToDoubleStr(QLineEdit const * input);
  67 /// method to set a (localized) double value in a widget (QLineEdit)
  68 void doubleToWidget(QLineEdit * input, double const & value,
  69         char f = 'g', int prec = 6);
  70 /// method to set a (localized) double value in a widget (QLineEdit)
  71 void doubleToWidget(QLineEdit * input, std::string const & value,
  72         char f = 'g', int prec = 6);
  73 /**
  74  * method to format localized floating point numbers without
  75  * ever using scientific notation
  76  */
  77 QString formatLocFPNumber(double d);
  78
  79 /// Method to sort QStrings locale-aware (e.g. in combo widgets)
  80 bool SortLocaleAware(QString const & lhs, QString const & rhs);
  81
  82 /// Method to sort colors by GUI name in combo widgets
  83 bool ColorSorter(ColorCode lhs, ColorCode rhs);
  84
  85 /// colors a widget red if invalid
  86 void setValid(QWidget * widget, bool valid);
  87
  88 // set focus and highlight the current item if there is no selection already
  89 void focusAndHighlight(QAbstractItemView * w);
  90
  91 // Sets all widget in highlighted in highlighted colour, and their children in
  92 // plain in standard colours.
  93 void setMessageColour(std::list<QWidget *> highlighted,
  94                       std::list<QWidget *> plain);
  95
  96 /// Qt5 changed setSectionMode to setSectionResizeMode
  97 /// These wrappers work for Qt4 and Qt5
  98 void setSectionResizeMode(QHeaderView * view,
  99     int logicalIndex, QHeaderView::ResizeMode mode);
 100 void setSectionResizeMode(QHeaderView * view,
 101         QHeaderView::ResizeMode mode);
 102
 103 } // namespace frontend
 104
 105
 106 /**
 107  * qt_ - i18nize string and convert to QString
 108  *
 109  * Use this in qt/ instead of _()
 110  */
 111 QString const qt_(std::string const & str);
 112 QString const qt_(QString const & qstr);
 113
 114
 115 ///
 116 support::FileName libFileSearch(QString const & dir, QString const & name,
 117                                 QString const & ext = QString(),
 118                                 support::search_mode mode = support::must_exist);
 119
 120 ///
 121 support::FileName imageLibFileSearch(QString & dir, QString const & name,
 122                                 QString const & ext = QString(),
 123                                 support::search_mode mode = support::must_exist);
 124
 125 /** Wrappers around browseFile which try to provide a filename
 126         relative to relpath.
 127
 128 \param title: title for dialog
 129
 130 \param filters: *.ps, etc
 131
 132 \param save: whether to save dialog info (current path, etc) for next use.
 133
 134 The \param labelN and \param dirN arguments provide for extra buttons
 135 in the dialog (e.g., "Templates" and a path to that directory).
 136
 137 The difference between the functions concerns when we think we have a
 138 relative path.
 139
 140 In \c browseRelToParent, we return a relative path only if it IS NOT of
 141         the form "../../foo.txt".
 142
 143 In \c browseRelToSub, we return a relative path only if it IS of the
 144  form "../../foo.txt".
 145 */
 146 QString browseRelToParent(QString const & filename,
 147         QString const & relpath,
 148         QString const & title,
 149         QStringList const & filters,
 150         bool save = false,
 151         QString const & label1 = QString(),
 152         QString const & dir1 = QString(),
 153         QString const & label2 = QString(),
 154         QString const & dir2 = QString());
 155
 156 QString browseRelToSub(QString const & filename,
 157         QString const & relpath,
 158         QString const & title,
 159         QStringList const & filters,
 160         bool save = false,
 161         QString const & label1 = QString(),
 162         QString const & dir1 = QString(),
 163         QString const & label2 = QString(),
 164         QString const & dir2 = QString());
 165
 166 /** Build filelists of all available bst/cls/sty-files. Done through
 167 *  kpsewhich and an external script, saved in *Files.lst.
 168 *  \param arg: cls, sty, bst, or bib, as required by TeXFiles.py.
 169 *         Can be a list of these, too.
 170 */
 171 void rescanTexStyles(std::string const & arg = empty_string());
 172
 173 /** Fill \c contents from one of the three texfiles.
 174  *  Each entry in the file list is returned as a name_with_path
 175  */
 176 QStringList texFileList(QString const & filename);
 177
 178 /// Convert internal line endings to line endings as expected by the OS
 179 QString const externalLineEnding(docstring const & str);
 180
 181 /// Convert line endings in any formnat to internal line endings
 182 docstring const internalLineEnding(QString const & str);
 183
 184 // wrapper around the docstring versions
 185 QString internalPath(QString const &);
 186 QString onlyFileName(QString const & str);
 187 QString onlyPath(QString const & str);
 188 QStringList fileFilters(QString const & description);
 189
 190 QString changeExtension(QString const & oldname, QString const & extension);
 191
 192 /// Remove the extension from \p name
 193 QString removeExtension(QString const & name);
 194
 195 /** Add the extension \p ext to \p name.
 196  Use this instead of changeExtension if you know that \p name is without
 197  extension, because changeExtension would wrongly interpret \p name if it
 198  contains a dot.
 199  */
 200 QString addExtension(QString const & name, QString const & extension);
 201
 202 /// Return the extension of the file (not including the .)
 203 QString getExtension(QString const & name);
 204 QString makeAbsPath(QString const & relpath, QString const & base);
 205 QString changeExtension(QString const & oldname, QString const & ext);
 206
 207 /// Format \param text for display as a ToolTip, breaking at lines of \param
 208 /// width ems. Note: this function is expensive. Better call it in a delayed
 209 /// manner, i.e. not to fill in a model (see for instance the function
 210 /// ToolTipFormatter::eventFilter).
 211 ///
 212 /// When is it called automatically? Whenever the tooltip is not already rich
 213 /// text beginning with <html>, and is defined by the following functions:
 214 ///  - QWidget::setToolTip(),
 215 ///  - QAbstractItemModel::setData(..., Qt::ToolTipRole),
 216 ///  - Inset::toolTip()
 217 ///
 218 /// In other words, tooltips can use Qt html, and the tooltip will still be
 219 /// correctly broken. Moreover, it is possible to specify an entirely custom
 220 /// tooltip (not subject to automatic formatting) by giving it in its entirety,
 221 /// i.e. starting with <html>.
 222 QString formatToolTip(QString text, int width = 30);
 223
 224
 225 #if QT_VERSION < 0x050300
 226 // Very partial implementation of QSignalBlocker for archaic qt versions.
 227 class QSignalBlocker {
 228 public:
 229         explicit QSignalBlocker(QObject * o)
 230                 : obj(o), init_state(obj && obj->blockSignals(true)) {}
 231
 232         ~QSignalBlocker() {
 233                 if (obj)
 234                         obj->blockSignals(init_state);
 235         }
 236 private:
 237         QObject * obj;
 238         bool init_state;
 239 };
 240 #endif
 241
 242
 243 // Check if qstr is understood as rich text (Qt HTML) and if so, produce a
 244 // rendering in plain text.
 245 QString qtHtmlToPlainText(QString const & qstr);
 246
 247
 248 } // namespace lyx
 249
 250 #endif // QTHELPERS_H