4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
10 * Full author contact details are available in file CREDITS.
18 #include "support/qstring_helpers.h"
19 #include "support/filetools.h"
22 #include <QHeaderView>
29 template <class T> class QList;
33 namespace support { class FileName; }
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);
46 /// method to set widgets from a Length
47 //FIXME Remove default_unit argument for the first form. FIXME Change
48 // all the code to remove default_unit argument when equal to the
50 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
52 Length::UNIT default_unit = Length::defaultUnit());
53 /// method to set widgets from a string
54 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
55 std::string const & len,
56 Length::UNIT default_unit = Length::defaultUnit());
57 /// method to set widgets from a docstring
58 void lengthToWidgets(QLineEdit * input, LengthCombo * combo,
59 docstring const & len, Length::UNIT default_unit);
61 /// method to get a double value from a localized widget (QLineEdit)
62 double widgetToDouble(QLineEdit const * input);
63 /// method to get a double value from a localized widget (QLineEdit)
64 std::string widgetToDoubleStr(QLineEdit const * input);
65 /// method to set a (localized) double value in a widget (QLineEdit)
66 void doubleToWidget(QLineEdit * input, double const & value,
67 char f = 'g', int prec = 6);
68 /// method to set a (localized) double value in a widget (QLineEdit)
69 void doubleToWidget(QLineEdit * input, std::string const & value,
70 char f = 'g', int prec = 6);
72 * method to format localized floating point numbers without
73 * ever using scientific notation
75 QString formatLocFPNumber(double d);
77 /// Method to sort colors by GUI name in combo widgets
78 bool ColorSorter(ColorCode lhs, ColorCode rhs);
80 /// colors a widget red if invalid
81 void setValid(QWidget * widget, bool valid);
83 /// Qt5 changed setSectionMode to setSectionResizeMode
84 /// These wrappers work for Qt4 and Qt5
85 void setSectionResizeMode(QHeaderView * view,
86 int logicalIndex, QHeaderView::ResizeMode mode);
87 void setSectionResizeMode(QHeaderView * view,
88 QHeaderView::ResizeMode mode);
90 } // namespace frontend
94 * qt_ - i18nize string and convert to QString
96 * Use this in qt4/ instead of _()
98 QString const qt_(std::string const & str);
99 QString const qt_(QString const & qstr);
103 support::FileName libFileSearch(QString const & dir, QString const & name,
104 QString const & ext = QString(),
105 support::search_mode mode = support::must_exist);
108 support::FileName imageLibFileSearch(QString & dir, QString const & name,
109 QString const & ext = QString(),
110 support::search_mode mode = support::must_exist);
112 /** Wrappers around browseFile which try to provide a filename
115 \param title: title for dialog
117 \param filters: *.ps, etc
119 \param save: whether to save dialog info (current path, etc) for next use.
121 The \param labelN and \param dirN arguments provide for extra buttons
122 in the dialog (e.g., "Templates" and a path to that directory).
124 The difference between the functions concerns when we think we have a
127 In \c browseRelToParent, we return a relative path only if it IS NOT of
128 the form "../../foo.txt".
130 In \c browseRelToSub, we return a relative path only if it IS of the
131 form "../../foo.txt".
133 QString browseRelToParent(QString const & filename,
134 QString const & relpath,
135 QString const & title,
136 QStringList const & filters,
138 QString const & label1 = QString(),
139 QString const & dir1 = QString(),
140 QString const & label2 = QString(),
141 QString const & dir2 = QString());
143 QString browseRelToSub(QString const & filename,
144 QString const & relpath,
145 QString const & title,
146 QStringList const & filters,
148 QString const & label1 = QString(),
149 QString const & dir1 = QString(),
150 QString const & label2 = QString(),
151 QString const & dir2 = QString());
153 /** Build filelists of all availabe bst/cls/sty-files. Done through
154 * kpsewhich and an external script, saved in *Files.lst.
155 * \param arg: cls, sty, bst, or bib, as required by TeXFiles.py.
156 * Can be a list of these, too.
158 void rescanTexStyles(std::string const & arg = empty_string());
160 /** Fill \c contents from one of the three texfiles.
161 * Each entry in the file list is returned as a name_with_path
163 QStringList texFileList(QString const & filename);
165 /// Convert internal line endings to line endings as expected by the OS
166 QString const externalLineEnding(docstring const & str);
168 /// Convert line endings in any formnat to internal line endings
169 docstring const internalLineEnding(QString const & str);
171 // wrapper around the docstring versions
172 QString internalPath(QString const &);
173 QString onlyFileName(QString const & str);
174 QString onlyPath(QString const & str);
175 QStringList fileFilters(QString const & description);
177 QString changeExtension(QString const & oldname, QString const & extension);
179 /// Remove the extension from \p name
180 QString removeExtension(QString const & name);
182 /** Add the extension \p ext to \p name.
183 Use this instead of changeExtension if you know that \p name is without
184 extension, because changeExtension would wrongly interpret \p name if it
187 QString addExtension(QString const & name, QString const & extension);
189 /// Return the extension of the file (not including the .)
190 QString getExtension(QString const & name);
191 QString makeAbsPath(QString const & relpath, QString const & base);
192 QString changeExtension(QString const & oldname, QString const & ext);
194 /// \return the display string associated with given type and buffer
196 QString guiName(std::string const & type, BufferParams const & bp);
198 /// Format \param text for display as a ToolTip, breaking at lines of \param
199 /// width ems. Note: this function is expensive. Better call it in a delayed
200 /// manner, i.e. not to fill in a model (see for instance the function
201 /// ToolTipFormatter::eventFilter).
203 /// When is it called automatically? Whenever the tooltip is not already rich
204 /// text beginning with <html>, and is defined by the following functions:
205 /// - QWidget::setToolTip(),
206 /// - QAbstractItemModel::setData(..., Qt::ToolTipRole),
207 /// - Inset::toolTip()
209 /// In other words, tooltips can use Qt html, and the tooltip will still be
210 /// correctly broken. Moreover, it is possible to specify an entirely custom
211 /// tooltip (not subject to automatic formatting) by giving it in its entirety,
212 /// i.e. starting with <html>.
213 QString formatToolTip(QString text, int width = 30);
218 #endif // QTHELPERS_H