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_DocumentUi.h"
24 #include "ui_FontUi.h"
25 #include "ui_LanguageUi.h"
26 #include "ui_LaTeXUi.h"
27 #include "ui_ListingsSettingsUi.h"
28 #include "ui_LocalLayoutUi.h"
29 #include "ui_MarginsUi.h"
30 #include "ui_MasterChildUi.h"
31 #include "ui_MathsUi.h"
32 #include "ui_ModulesUi.h"
33 #include "ui_NumberingUi.h"
34 #include "ui_OutputUi.h"
35 #include "ui_PageLayoutUi.h"
36 #include "ui_PDFSupportUi.h"
37 #include "ui_PreambleUi.h"
38 #include "ui_TextLayoutUi.h"
43 class LayoutModuleList;
52 class ModuleSelectionManager;
58 typedef void const * BufferId;
61 class UiWidget : public QWidget, public UI
64 UiWidget(QWidget * parent) : QWidget(parent) { UI::setupUi(this); }
68 class GuiDocument : public GuiDialog, public Ui::DocumentUi
72 GuiDocument(GuiView & lv);
74 void paramsToDialog();
75 void updateFontsize(std::string const &, std::string const &);
76 void updateFontlist();
77 void updateDefaultFormat();
78 void updateCiteStyles(std::vector<std::string> const &,
79 CiteEngineType const & sel = ENGINE_TYPE_AUTHORYEAR);
80 void updateEngineType(std::string const &, CiteEngineType const &);
81 void updatePagestyle(std::string const &, std::string const &);
82 bool isChildIncluded(std::string const &);
85 BufferParams const & params() const { return bp_; }
88 void onBufferViewChanged();//override
91 void updateNumbering();
92 void change_adaptor();
93 void includeonlyClicked(QTreeWidgetItem * item, int);
94 void setListingsMessage();
95 void saveDefaultClicked();
96 void useDefaultsClicked();
97 void setLSpacing(int);
99 void papersizeChanged(int);
101 void setCustomMargins(bool);
102 void fontencChanged(int);
103 void romanChanged(int);
104 void sansChanged(int);
106 void fontOsfToggled(bool state);
107 void fontScToggled(bool state);
109 void enableIndent(bool);
111 void enableSkip(bool);
115 void classChanged_adaptor();
116 void languagePackageChanged(int);
117 void biblioChanged();
118 void rescanBibFiles();
119 void resetDefaultBibfile(std::string const & which = std::string());
120 void resetDefaultBbxBibfile();
121 void resetDefaultCbxBibfile();
122 void citeEngineChanged(int);
123 void citeStyleChanged();
124 void bibtexChanged(int);
125 void updateResetDefaultBiblio();
126 void matchBiblatexStyles();
127 void updateEngineDependends();
128 void updateModuleInfo();
129 void modulesChanged();
130 void changeBackgroundColor();
131 void deleteBackgroundColor();
132 void changeFontColor();
133 void deleteFontColor();
134 void changeNoteFontColor();
135 void deleteNoteFontColor();
136 void changeBoxBackgroundColor();
137 void deleteBoxBackgroundColor();
138 void languageChanged(int);
139 void osFontsChanged(bool);
140 void mathFontChanged(int);
141 void branchesRename(docstring const &, docstring const &);
142 void allPackagesAuto();
143 void allPackagesAlways();
144 void allPackagesNot();
146 /// validate listings parameters and return an error message, if any
147 QString validateListingsParameters();
149 UiWidget<Ui::TextLayoutUi> *textLayoutModule;
150 UiWidget<Ui::MasterChildUi> *masterChildModule;
151 FontModule *fontModule;
152 UiWidget<Ui::PageLayoutUi> *pageLayoutModule;
153 UiWidget<Ui::MarginsUi> *marginsModule;
154 UiWidget<Ui::LanguageUi> *langModule;
155 UiWidget<Ui::ColorUi> *colorModule;
156 UiWidget<Ui::NumberingUi> *numberingModule;
157 UiWidget<Ui::BiblioUi> *biblioModule;
158 UiWidget<Ui::MathsUi> *mathsModule;
159 UiWidget<Ui::LaTeXUi> *latexModule;
160 UiWidget<Ui::PDFSupportUi> *pdfSupportModule;
161 UiWidget<Ui::ModulesUi> *modulesModule;
162 UiWidget<Ui::OutputUi> *outputModule;
163 UiWidget<Ui::ListingsSettingsUi> *listingsModule;
164 PreambleModule * preambleModule;
165 LocalLayout * localLayout;
167 GuiBranches * branchesModule;
168 GuiIndices * indicesModule;
170 BulletsModule * bulletsModule;
171 FloatPlacement * floatModule;
173 ModuleSelectionManager * selectionManager;
175 /// Available modules
176 GuiIdListModel * availableModel() { return &modules_av_model_; }
178 GuiIdListModel * selectedModel() { return &modules_sel_model_; }
183 void updateContents();
185 void updateAvailableModules();
187 void updateSelectedModules();
189 void updateIncludeonlys();
191 void updateDefaultBiblio(std::string const & style,
192 std::string const & which = std::string());
193 /// save as default template
194 void saveDocDefault();
195 /// reset to default params
196 void useClassDefaults();
198 void setLayoutComboByIDString(std::string const & idString);
199 /// Update quotes styles combo, indicating the current language's default
200 void updateQuoteStyles(bool const set = false);
202 /// available modules
203 GuiIdListModel modules_av_model_;
205 GuiIdListModel modules_sel_model_;
207 /// return false if validate_listings_params returns error
210 /// font family names for BufferParams::fonts_default_family
211 static char const * const fontfamilies[5];
212 /// GUI names corresponding fontfamilies
213 static char const * fontfamilies_gui[5];
215 bool initialiseParams(std::string const & data);
219 void dispatchParams();
221 void modulesToParams(BufferParams &);
223 bool isBufferDependent() const { return true; }
224 /// always true since we don't manipulate document contents
225 bool canApply() const { return true; }
227 DocumentClass const & documentClass() const;
229 BufferParams & params() { return bp_; }
233 struct modInfoStruct {
239 static modInfoStruct modInfo(LyXModule const & mod);
240 /// List of available modules
241 std::list<modInfoStruct> const & getModuleInfo();
242 /// Modules in use in current buffer
243 std::list<modInfoStruct> const getSelectedModules();
245 std::list<modInfoStruct> const getProvidedModules();
247 std::list<modInfoStruct> const
248 makeModuleInfo(LayoutModuleList const & mods);
250 void setLanguage() const;
252 void saveAsDefault() const;
253 /// does this font provide Old Style figures?
254 bool providesOSF(QString const & font) const;
255 /// does this font provide true Small Caps?
256 bool providesSC(QString const & font) const;
257 /** does this font provide OSF and Small Caps only via
258 * a single, undifferentiated expert option?
260 bool hasMonolithicExpertSet(QString const & font) const;
261 /// does this font provide size adjustment?
262 bool providesScale(QString const & font) const;
263 /// does this font provide an alternative without math?
264 bool providesNoMath(QString const & font) const;
266 void executeBranchRenaming() const;
268 void setCustomPapersize(bool custom);
271 void loadModuleInfo();
273 void updateUnknownBranches();
275 void updateTexFonts();
277 void updateMathFonts(QString const & rm);
279 void updateFontOptions();
283 bool completeFontset() const;
285 bool noMathFont() const;
287 void allPackages(int);
289 bool isBiblatex() const;
292 /// List of names of available modules
293 std::list<modInfoStruct> moduleNames_;
295 std::map<docstring, docstring> changedBranches_;
297 std::list<std::string> includeonlys_;
300 /// Track if a non-module document param changed
301 bool nonModuleChanged_;
305 class PreambleModule : public UiWidget<Ui::PreambleUi>
309 PreambleModule(QWidget * parent);
310 void update(BufferParams const & params, BufferId id);
311 void apply(BufferParams & params);
314 /// signal that something's changed in the Widget.
318 void closeEvent(QCloseEvent *);
319 void on_preambleTE_textChanged() { changed(); }
322 typedef std::map<BufferId, std::pair<int,int> > Coords;
323 Coords preamble_coords_;
324 BufferId current_id_;
328 class LocalLayout : public UiWidget<Ui::LocalLayoutUi>
332 LocalLayout(QWidget * parent);
333 void update(BufferParams const & params, BufferId id);
334 void apply(BufferParams & params);
335 bool isValid() const { return validated_; }
338 /// signal that something's changed in the Widget.
347 void validatePressed();
348 void convertPressed();
351 BufferId current_id_;
356 class FontModule : public UiWidget<Ui::FontUi>
360 FontModule(QWidget * parent) : UiWidget<Ui::FontUi>(parent),
361 font_sf_scale(100), font_tt_scale(100) {}
362 /// The roman font currently not selected by osFontsCB->isChecked()
364 /// The sans font currently not selected by osFontsCB->isChecked()
366 /// The typewriter font currently not selected by osFontsCB->isChecked()
367 QString font_typewriter;
368 /// The math font currently not selected by osFontsCB->isChecked()
370 /// The sans font scale currently not selected by osFontsCB->isChecked()
372 /// The typewriter font scale currently not selected by osFontsCB->isChecked()
377 } // namespace frontend
380 #endif // GUIDOCUMENT_H