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 /// Shows a directory in OSs file browser
 103 void showDirectory(support::FileName const & directory);
 104 /// handle request for showing citation content - shows pdf or
 105 /// web page in target; external script can be used for pdf view
 106 void showTarget(std::string const & target);
 107
 108 } // namespace frontend
 109
 110
 111 /**
 112  * qt_ - i18nize string and convert to QString
 113  *
 114  * Use this in qt/ instead of _()
 115  */
 116 QString const qt_(std::string const & str);
 117 QString const qt_(QString const & qstr);
 118
 119
 120 ///
 121 support::FileName libFileSearch(QString const & dir, QString const & name,
 122                                 QString const & ext = QString(),
 123                                 support::search_mode mode = support::must_exist);
 124
 125 ///
 126 support::FileName imageLibFileSearch(QString & dir, QString const & name,
 127                                 QString const & ext = QString(),
 128                                 support::search_mode mode = support::must_exist);
 129
 130 /** Wrappers around browseFile which try to provide a filename
 131         relative to relpath.
 132
 133 \param title: title for dialog
 134
 135 \param filters: *.ps, etc
 136
 137 \param save: whether to save dialog info (current path, etc) for next use.
 138
 139 The \param labelN and \param dirN arguments provide for extra buttons
 140 in the dialog (e.g., "Templates" and a path to that directory).
 141
 142 The difference between the functions concerns when we think we have a
 143 relative path.
 144
 145 In \c browseRelToParent, we return a relative path only if it IS NOT of
 146         the form "../../foo.txt".
 147
 148 In \c browseRelToSub, we return a relative path only if it IS of the
 149  form "../../foo.txt".
 150 */
 151 QString browseRelToParent(QString const & filename,
 152         QString const & relpath,
 153         QString const & title,
 154         QStringList const & filters,
 155         bool save = false,
 156         QString const & label1 = QString(),
 157         QString const & dir1 = QString(),
 158         QString const & label2 = QString(),
 159         QString const & dir2 = QString());
 160
 161 QString browseRelToSub(QString const & filename,
 162         QString const & relpath,
 163         QString const & title,
 164         QStringList const & filters,
 165         bool save = false,
 166         QString const & label1 = QString(),
 167         QString const & dir1 = QString(),
 168         QString const & label2 = QString(),
 169         QString const & dir2 = QString());
 170
 171 /** Build filelists of all available bst/cls/sty-files. Done through
 172 *  kpsewhich and an external script, saved in *Files.lst.
 173 *  \param arg: cls, sty, bst, or bib, as required by TeXFiles.py.
 174 *         Can be a list of these, too.
 175 */
 176 void rescanTexStyles(std::string const & arg = empty_string());
 177
 178 /** Fill \c contents from one of the three texfiles.
 179  *  Each entry in the file list is returned as a name_with_path
 180  */
 181 QStringList texFileList(QString const & filename);
 182
 183 /// Convert internal line endings to line endings as expected by the OS
 184 QString const externalLineEnding(docstring const & str);
 185
 186 /// Convert line endings in any formnat to internal line endings
 187 docstring const internalLineEnding(QString const & str);
 188
 189 // wrapper around the docstring versions
 190 QString internalPath(QString const &);
 191 QString onlyFileName(QString const & str);
 192 QString onlyPath(QString const & str);
 193 QStringList fileFilters(QString const & description);
 194
 195 QString changeExtension(QString const & oldname, QString const & extension);
 196
 197 /// Remove the extension from \p name
 198 QString removeExtension(QString const & name);
 199
 200 /** Add the extension \p ext to \p name.
 201  Use this instead of changeExtension if you know that \p name is without
 202  extension, because changeExtension would wrongly interpret \p name if it
 203  contains a dot.
 204  */
 205 QString addExtension(QString const & name, QString const & extension);
 206
 207 /// Return the extension of the file (not including the .)
 208 QString getExtension(QString const & name);
 209 QString makeAbsPath(QString const & relpath, QString const & base);
 210 QString changeExtension(QString const & oldname, QString const & ext);
 211
 212 /// Format \param text for display as a ToolTip, breaking at lines of \param
 213 /// width ems. Note: this function is expensive. Better call it in a delayed
 214 /// manner, i.e. not to fill in a model (see for instance the function
 215 /// ToolTipFormatter::eventFilter).
 216 ///
 217 /// When is it called automatically? Whenever the tooltip is not already rich
 218 /// text beginning with <html>, and is defined by the following functions:
 219 ///  - QWidget::setToolTip(),
 220 ///  - QAbstractItemModel::setData(..., Qt::ToolTipRole),
 221 ///  - Inset::toolTip()
 222 ///
 223 /// In other words, tooltips can use Qt html, and the tooltip will still be
 224 /// correctly broken. Moreover, it is possible to specify an entirely custom
 225 /// tooltip (not subject to automatic formatting) by giving it in its entirety,
 226 /// i.e. starting with <html>.
 227 QString formatToolTip(QString text, int width = 30);
 228
 229
 230 #if QT_VERSION < 0x050300
 231 // Very partial implementation of QSignalBlocker for archaic qt versions.
 232 class QSignalBlocker {
 233 public:
 234         explicit QSignalBlocker(QObject * o)
 235                 : obj(o), init_state(obj && obj->blockSignals(true)) {}
 236
 237         ~QSignalBlocker() {
 238                 if (obj)
 239                         obj->blockSignals(init_state);
 240         }
 241 private:
 242         QObject * obj;
 243         bool init_state;
 244 };
 245 #endif
 246
 247
 248 // Check if qstr is understood as rich text (Qt HTML) and if so, produce a
 249 // rendering in plain text.
 250 QString qtHtmlToPlainText(QString const & qstr);
 251
 252
 253 } // namespace lyx
 254
 255 #endif // QTHELPERS_H