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