4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Richard Heck (modules)
10 * Full author contact details are available in file CREDITS.
16 #include "BufferParams.h"
17 #include "BulletsModule.h"
18 #include "GuiDialog.h"
19 #include "GuiIdListModel.h"
21 #include "ui_BiblioUi.h"
22 #include "ui_ColorUi.h"
23 #include "ui_ChangeTrackingUi.h"
24 #include "ui_DocumentUi.h"
25 #include "ui_FontUi.h"
26 #include "ui_LanguageUi.h"
27 #include "ui_LaTeXUi.h"
28 #include "ui_ListingsSettingsUi.h"
29 #include "ui_LocalLayoutUi.h"
30 #include "ui_MarginsUi.h"
31 #include "ui_MasterChildUi.h"
32 #include "ui_MathsUi.h"
33 #include "ui_ModulesUi.h"
34 #include "ui_NumberingUi.h"
35 #include "ui_OutputUi.h"
36 #include "ui_PageLayoutUi.h"
37 #include "ui_PDFSupportUi.h"
38 #include "ui_PreambleUi.h"
39 #include "ui_TextLayoutUi.h"
41 #include <QStandardItemModel>
46 class LayoutModuleList;
59 class ModuleSelectionManager;
65 typedef Buffer const * BufferId;
68 class UiWidget : public QWidget, public UI
71 UiWidget(QWidget * parent) : QWidget(parent) { UI::setupUi(this); }
75 class GuiDocument : public GuiDialog, public Ui::DocumentUi
79 GuiDocument(GuiView & lv);
81 void paramsToDialog();
82 void updateFontsize(std::string const &, std::string const &);
83 void updateFontlist();
84 void updateDefaultFormat();
85 void updateCiteStyles(std::vector<std::string> const &,
86 CiteEngineType const & sel = ENGINE_TYPE_AUTHORYEAR);
87 void updateEngineType(std::string const &, CiteEngineType const &);
88 void updatePagestyle(std::string const &, std::string const &);
89 bool isChildIncluded(std::string const &);
92 BufferParams const & params() const { return bp_; }
95 void onBufferViewChanged();//override
98 // Apply button clicked
100 void slotButtonBox(QAbstractButton *);
103 void updateNumbering();
104 void change_adaptor();
105 void shellescapeChanged();
106 void includeonlyClicked(QTreeWidgetItem * item, int);
107 void setListingsMessage();
108 void listingsPackageChanged(int);
109 void saveDefaultClicked();
110 void useDefaultsClicked();
111 void setLSpacing(int);
113 void papersizeChanged(int);
115 void setCustomMargins(bool);
116 void fontencChanged(int);
117 void romanChanged(int);
118 void sansChanged(int);
120 void fontOsfToggled(bool state);
121 void fontScToggled(bool state);
123 void enableIndent(bool);
125 void enableSkip(bool);
126 void allowMathIndent();
127 void enableMathIndent(int);
131 void classChanged_adaptor();
132 void languagePackageChanged(int);
133 void biblioChanged();
134 void rescanBibFiles();
135 void resetDefaultBibfile(std::string const & which = std::string());
136 void resetDefaultBbxBibfile();
137 void resetDefaultCbxBibfile();
138 void citeEngineChanged(int);
139 void citeStyleChanged();
140 void bibtexChanged(int);
141 void updateResetDefaultBiblio();
142 void matchBiblatexStyles();
143 void updateEngineDependends();
144 void updateModuleInfo();
145 void modulesChanged();
146 void changeBackgroundColor();
147 void deleteBackgroundColor();
148 void changeFontColor();
149 void deleteFontColor();
150 void changeNoteFontColor();
151 void deleteNoteFontColor();
152 void changeBoxBackgroundColor();
153 void deleteBoxBackgroundColor();
154 void languageChanged(int);
155 void osFontsChanged(bool);
156 void encodingSwitched(int);
157 void inputencodingToDialog();
158 void mathFontChanged(int);
159 void branchesRename(docstring const &, docstring const &);
160 void allPackagesAuto();
161 void allPackagesAlways();
162 void allPackagesNot();
163 void moduleFilterPressed();
164 void moduleFilterChanged(const QString & text);
165 void resetModuleFilter();
166 void linenoToggled(bool);
168 /// validate listings parameters and return an error message, if any
169 QString validateListingsParameters();
171 UiWidget<Ui::TextLayoutUi> *textLayoutModule;
172 UiWidget<Ui::MasterChildUi> *masterChildModule;
173 FontModule *fontModule;
174 UiWidget<Ui::PageLayoutUi> *pageLayoutModule;
175 UiWidget<Ui::MarginsUi> *marginsModule;
176 UiWidget<Ui::LanguageUi> *langModule;
177 UiWidget<Ui::ColorUi> *colorModule;
178 UiWidget<Ui::ChangeTrackingUi> *changesModule;
179 UiWidget<Ui::NumberingUi> *numberingModule;
180 UiWidget<Ui::BiblioUi> *biblioModule;
181 UiWidget<Ui::MathsUi> *mathsModule;
182 UiWidget<Ui::LaTeXUi> *latexModule;
183 UiWidget<Ui::PDFSupportUi> *pdfSupportModule;
184 UiWidget<Ui::ModulesUi> *modulesModule;
185 UiWidget<Ui::OutputUi> *outputModule;
186 UiWidget<Ui::ListingsSettingsUi> *listingsModule;
187 PreambleModule * preambleModule;
188 LocalLayout * localLayout;
190 GuiBranches * branchesModule;
191 GuiIndices * indicesModule;
193 BulletsModule * bulletsModule;
194 FloatPlacement * floatModule;
196 ModuleSelectionManager * selectionManager;
198 /// Available modules
199 QStandardItemModel * availableModel() { return &modules_av_model_; }
201 GuiIdListModel * selectedModel() { return &modules_sel_model_; }
206 void updateContents();
208 void updateAvailableModules();
210 void updateSelectedModules();
212 void updateIncludeonlys();
214 void updateDefaultBiblio(std::string const & style,
215 std::string const & which = std::string());
216 /// save as default template
217 void saveDocDefault();
218 /// reset to default params
219 void useClassDefaults();
221 void setLayoutComboByIDString(std::string const & idString);
222 /// Update quotes styles combo, indicating the current language's default
223 void updateQuoteStyles(bool const set = false);
225 void getTableStyles();
227 /// available modules
228 QStandardItemModel modules_av_model_;
230 GuiIdListModel modules_sel_model_;
233 FancyLineEdit * filter_;
235 /// return false if validate_listings_params returns error
238 /// font family names for BufferParams::fonts_default_family
239 static char const * const fontfamilies[5];
240 /// GUI names corresponding fontfamilies
241 static char const * fontfamilies_gui[5];
243 bool initialiseParams(std::string const & data);
247 void dispatchParams();
249 void modulesToParams(BufferParams &);
251 bool isBufferDependent() const { return true; }
252 /// always true since we don't manipulate document contents
253 bool canApply() const { return true; }
255 DocumentClass const & documentClass() const;
257 BufferParams & params() { return bp_; }
261 struct modInfoStruct {
270 static modInfoStruct modInfo(LyXModule const & mod);
271 /// List of available modules
272 std::list<modInfoStruct> const & getModuleInfo();
273 /// Modules in use in current buffer
274 std::list<modInfoStruct> const getSelectedModules();
276 std::list<modInfoStruct> const getProvidedModules();
278 std::list<modInfoStruct> const
279 makeModuleInfo(LayoutModuleList const & mods);
281 void setLanguage() const;
283 void saveAsDefault() const;
284 /// does this font provide Old Style figures?
285 bool providesOSF(QString const & font) const;
286 /// does this font provide true Small Caps?
287 bool providesSC(QString const & font) const;
288 /** does this font provide OSF and Small Caps only via
289 * a single, undifferentiated expert option?
291 bool hasMonolithicExpertSet(QString const & font) const;
292 /// does this font provide size adjustment?
293 bool providesScale(QString const & font) const;
294 /// does this font provide extra options?
295 bool providesExtraOpts(QString const & font) const;
296 /// does this font provide an alternative without math?
297 bool providesNoMath(QString const & font) const;
299 void executeBranchRenaming() const;
301 void setCustomPapersize(bool custom);
304 void loadModuleInfo();
306 void updateUnknownBranches();
308 void updateTexFonts();
310 void updateMathFonts(QString const & rm);
312 void updateExtraOpts();
314 void updateFontOptions();
318 bool completeFontset() const;
320 bool noMathFont() const;
322 void allPackages(int);
324 bool isBiblatex() const;
326 void checkPossibleCiteEngines();
328 void filterModules(QString const & string);
331 /// List of names of available modules
332 std::list<modInfoStruct> moduleNames_;
334 std::map<docstring, docstring> changedBranches_;
336 std::list<std::string> includeonlys_;
339 /// Track if a non-module document param changed
340 bool nonModuleChanged_;
341 /// Track if used modules changed
342 bool modulesChanged_;
343 /// Track if the shellescape param changed
344 bool shellescapeChanged_;
348 class PreambleModule : public UiWidget<Ui::PreambleUi>
352 PreambleModule(QWidget * parent);
353 void update(BufferParams const & params, BufferId id);
354 void apply(BufferParams & params);
355 bool editing() const { return (bool)tempfile_; }
358 /// signal that something's changed in the Widget.
362 void closeEvent(QCloseEvent *);
363 void on_preambleTE_textChanged() { changed(); }
365 typedef std::map<BufferId, std::pair<int,int> > Coords;
366 Coords preamble_coords_;
367 BufferId current_id_;
368 unique_ptr<support::TempFile> tempfile_;
372 void checkFindButton();
378 class LocalLayout : public UiWidget<Ui::LocalLayoutUi>
382 LocalLayout(QWidget * parent);
383 void update(BufferParams const & params, BufferId id);
384 void apply(BufferParams & params);
385 bool isValid() const { return validated_; }
386 bool editing() const { return (bool)tempfile_; }
389 /// signal that something's changed in the Widget.
398 void validatePressed();
399 void convertPressed();
403 BufferId current_id_;
405 unique_ptr<support::TempFile> tempfile_;
409 class FontModule : public UiWidget<Ui::FontUi>
413 FontModule(QWidget * parent) : UiWidget<Ui::FontUi>(parent),
414 font_sf_scale(100), font_tt_scale(100) {}
415 /// The roman font currently not selected by osFontsCB->isChecked()
417 /// The sans font currently not selected by osFontsCB->isChecked()
419 /// The typewriter font currently not selected by osFontsCB->isChecked()
420 QString font_typewriter;
421 /// The math font currently not selected by osFontsCB->isChecked()
423 /// The sans font scale currently not selected by osFontsCB->isChecked()
425 /// The typewriter font scale currently not selected by osFontsCB->isChecked()
430 } // namespace frontend
433 #endif // GUIDOCUMENT_H