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);
167 void outputChangesToggled(bool);
168 void setOutputSync(bool);
169 void bookmarksopenChanged(bool);
171 /// validate listings parameters and return an error message, if any
172 QString validateListingsParameters();
174 UiWidget<Ui::TextLayoutUi> *textLayoutModule;
175 UiWidget<Ui::MasterChildUi> *masterChildModule;
176 FontModule *fontModule;
177 UiWidget<Ui::PageLayoutUi> *pageLayoutModule;
178 UiWidget<Ui::MarginsUi> *marginsModule;
179 UiWidget<Ui::LanguageUi> *langModule;
180 UiWidget<Ui::ColorUi> *colorModule;
181 UiWidget<Ui::ChangeTrackingUi> *changesModule;
182 UiWidget<Ui::NumberingUi> *numberingModule;
183 UiWidget<Ui::BiblioUi> *biblioModule;
184 UiWidget<Ui::MathsUi> *mathsModule;
185 UiWidget<Ui::LaTeXUi> *latexModule;
186 UiWidget<Ui::PDFSupportUi> *pdfSupportModule;
187 UiWidget<Ui::ModulesUi> *modulesModule;
188 UiWidget<Ui::OutputUi> *outputModule;
189 UiWidget<Ui::ListingsSettingsUi> *listingsModule;
190 PreambleModule * preambleModule;
191 LocalLayout * localLayout;
193 GuiBranches * branchesModule;
194 GuiIndices * indicesModule;
196 BulletsModule * bulletsModule;
197 FloatPlacement * floatModule;
199 ModuleSelectionManager * selectionManager;
201 /// Available modules
202 QStandardItemModel * availableModel() { return &modules_av_model_; }
204 GuiIdListModel * selectedModel() { return &modules_sel_model_; }
209 void updateContents();
211 void updateAvailableModules();
213 void updateSelectedModules();
215 void updateIncludeonlyDisplay();
217 void updateIncludeonlys();
219 void updateDefaultBiblio(std::string const & style,
220 std::string const & which = std::string());
221 /// save as default template
222 void saveDocDefault();
223 /// reset to default params
224 void useClassDefaults();
226 void setLayoutComboByIDString(std::string const & idString);
227 /// Update quotes styles combo, indicating the current language's default
228 void updateQuoteStyles(bool const set = false);
230 void getTableStyles();
232 /// available modules
233 QStandardItemModel modules_av_model_;
235 GuiIdListModel modules_sel_model_;
238 FancyLineEdit * filter_;
240 /// return false if validate_listings_params returns error
243 /// font family names for BufferParams::fonts_default_family
244 static char const * const fontfamilies[5];
245 /// GUI names corresponding fontfamilies
246 static char const * fontfamilies_gui[5];
248 bool initialiseParams(std::string const & data);
252 void dispatchParams();
254 void modulesToParams(BufferParams &);
256 bool isBufferDependent() const { return true; }
257 /// always true since we don't manipulate document contents
258 bool canApply() const { return true; }
260 DocumentClass const & documentClass() const;
262 BufferParams & params() { return bp_; }
266 struct modInfoStruct {
275 static modInfoStruct modInfo(LyXModule const & mod);
276 /// List of available modules
277 std::list<modInfoStruct> const & getModuleInfo();
278 /// Modules in use in current buffer
279 std::list<modInfoStruct> const getSelectedModules();
281 std::list<modInfoStruct> const getProvidedModules();
283 std::list<modInfoStruct> const
284 makeModuleInfo(LayoutModuleList const & mods);
286 void setLanguage() const;
288 void saveAsDefault() const;
289 /// does this font provide Old Style figures?
290 bool providesOSF(QString const & font) const;
291 /// does this font provide true Small Caps?
292 bool providesSC(QString const & font) const;
293 /** does this font provide OSF and Small Caps only via
294 * a single, undifferentiated expert option?
296 bool hasMonolithicExpertSet(QString const & font) const;
297 /// does this font provide size adjustment?
298 bool providesScale(QString const & font) const;
299 /// does this font provide extra options?
300 bool providesExtraOpts(QString const & font) const;
301 /// does this font provide an alternative without math?
302 bool providesNoMath(QString const & font) const;
304 void executeBranchRenaming() const;
306 void setCustomPapersize(bool custom);
309 void loadModuleInfo();
311 void updateUnknownBranches();
313 void updateTexFonts();
315 void updateMathFonts(QString const & rm);
317 void updateExtraOpts();
319 void updateFontOptions();
323 bool completeFontset() const;
325 bool noMathFont() const;
327 void allPackages(int);
329 bool isBiblatex() const;
331 void checkPossibleCiteEngines();
333 void filterModules(QString const & string);
336 /// List of names of available modules
337 std::list<modInfoStruct> moduleNames_;
339 std::map<docstring, docstring> changedBranches_;
341 std::list<std::string> includeonlys_;
344 /// Track if a non-module document param changed
345 bool nonModuleChanged_;
346 /// Track if used modules changed
347 bool modulesChanged_;
348 /// Track if the shellescape param changed
349 bool shellescapeChanged_;
353 class PreambleModule : public UiWidget<Ui::PreambleUi>
357 PreambleModule(QWidget * parent);
358 void update(BufferParams const & params, BufferId id);
359 void apply(BufferParams & params);
360 bool editing() const { return (bool)tempfile_; }
363 /// signal that something's changed in the Widget.
367 void closeEvent(QCloseEvent *);
368 void on_preambleTE_textChanged() { changed(); }
370 typedef std::map<BufferId, std::pair<int,int> > Coords;
371 Coords preamble_coords_;
372 BufferId current_id_;
373 unique_ptr<support::TempFile> tempfile_;
377 void checkFindButton();
383 class LocalLayout : public UiWidget<Ui::LocalLayoutUi>
387 LocalLayout(QWidget * parent);
388 void update(BufferParams const & params, BufferId id);
389 void apply(BufferParams & params);
390 bool isValid() const { return validated_; }
391 bool editing() const { return (bool)tempfile_; }
394 /// signal that something's changed in the Widget.
403 void validatePressed();
404 void convertPressed();
408 BufferId current_id_;
410 unique_ptr<support::TempFile> tempfile_;
414 class FontModule : public UiWidget<Ui::FontUi>
418 FontModule(QWidget * parent) : UiWidget<Ui::FontUi>(parent),
419 font_sf_scale(100), font_tt_scale(100) {}
420 /// The roman font currently not selected by osFontsCB->isChecked()
422 /// The sans font currently not selected by osFontsCB->isChecked()
424 /// The typewriter font currently not selected by osFontsCB->isChecked()
425 QString font_typewriter;
426 /// The math font currently not selected by osFontsCB->isChecked()
428 /// The sans font scale currently not selected by osFontsCB->isChecked()
430 /// The typewriter font scale currently not selected by osFontsCB->isChecked()
435 } // namespace frontend
438 #endif // GUIDOCUMENT_H