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 = 0) : 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();
120 void citeEngineChanged(int);
121 void citeStyleChanged();
122 void bibtexChanged(int);
123 void updateResetDefaultBiblio();
124 void updateModuleInfo();
125 void modulesChanged();
126 void changeBackgroundColor();
127 void deleteBackgroundColor();
128 void changeFontColor();
129 void deleteFontColor();
130 void changeNoteFontColor();
131 void deleteNoteFontColor();
132 void changeBoxBackgroundColor();
133 void deleteBoxBackgroundColor();
134 void languageChanged(int);
135 void osFontsChanged(bool);
136 void mathFontChanged(int);
137 void branchesRename(docstring const &, docstring const &);
138 void allPackagesAuto();
139 void allPackagesAlways();
140 void allPackagesNot();
142 /// validate listings parameters and return an error message, if any
143 QString validateListingsParameters();
145 UiWidget<Ui::TextLayoutUi> *textLayoutModule;
146 UiWidget<Ui::MasterChildUi> *masterChildModule;
147 FontModule *fontModule;
148 UiWidget<Ui::PageLayoutUi> *pageLayoutModule;
149 UiWidget<Ui::MarginsUi> *marginsModule;
150 UiWidget<Ui::LanguageUi> *langModule;
151 UiWidget<Ui::ColorUi> *colorModule;
152 UiWidget<Ui::NumberingUi> *numberingModule;
153 UiWidget<Ui::BiblioUi> *biblioModule;
154 UiWidget<Ui::MathsUi> *mathsModule;
155 UiWidget<Ui::LaTeXUi> *latexModule;
156 UiWidget<Ui::PDFSupportUi> *pdfSupportModule;
157 UiWidget<Ui::ModulesUi> *modulesModule;
158 UiWidget<Ui::OutputUi> *outputModule;
159 UiWidget<Ui::ListingsSettingsUi> *listingsModule;
160 PreambleModule * preambleModule;
161 LocalLayout * localLayout;
163 GuiBranches * branchesModule;
164 GuiIndices * indicesModule;
166 BulletsModule * bulletsModule;
167 FloatPlacement * floatModule;
169 ModuleSelectionManager * selectionManager;
171 /// Available modules
172 GuiIdListModel * availableModel() { return &modules_av_model_; }
174 GuiIdListModel * selectedModel() { return &modules_sel_model_; }
179 void updateContents();
181 void updateAvailableModules();
183 void updateSelectedModules();
185 void updateIncludeonlys();
187 void updateDefaultBiblio(std::string const & style);
188 /// save as default template
189 void saveDocDefault();
190 /// reset to default params
191 void useClassDefaults();
193 void setLayoutComboByIDString(std::string const & idString);
195 /// available modules
196 GuiIdListModel modules_av_model_;
198 GuiIdListModel modules_sel_model_;
200 /// return false if validate_listings_params returns error
203 /// font family names for BufferParams::fonts_default_family
204 static char const * const fontfamilies[5];
205 /// GUI names corresponding fontfamilies
206 static char const * fontfamilies_gui[5];
208 bool initialiseParams(std::string const & data);
212 void dispatchParams();
214 void modulesToParams(BufferParams &);
216 bool isBufferDependent() const { return true; }
217 /// always true since we don't manipulate document contents
218 bool canApply() const { return true; }
220 DocumentClass const & documentClass() const;
222 BufferParams & params() { return bp_; }
226 struct modInfoStruct {
232 static modInfoStruct modInfo(LyXModule const & mod);
233 /// List of available modules
234 std::list<modInfoStruct> const & getModuleInfo();
235 /// Modules in use in current buffer
236 std::list<modInfoStruct> const getSelectedModules();
238 std::list<modInfoStruct> const getProvidedModules();
240 std::list<modInfoStruct> const
241 makeModuleInfo(LayoutModuleList const & mods);
243 void setLanguage() const;
245 void saveAsDefault() const;
246 /// does this font provide Old Style figures?
247 bool providesOSF(QString const & font) const;
248 /// does this font provide true Small Caps?
249 bool providesSC(QString const & font) const;
250 /** does this font provide OSF and Small Caps only via
251 * a single, undifferentiated expert option?
253 bool hasMonolithicExpertSet(QString const & font) const;
254 /// does this font provide size adjustment?
255 bool providesScale(QString const & font) const;
256 /// does this font provide an alternative without math?
257 bool providesNoMath(QString const & font) const;
259 void executeBranchRenaming() const;
261 void setCustomPapersize(bool custom);
264 void loadModuleInfo();
266 void updateUnknownBranches();
268 void updateTexFonts();
270 void updateMathFonts(QString const & rm);
272 void updateFontOptions();
276 bool completeFontset() const;
278 bool noMathFont() const;
280 void allPackages(int);
283 /// List of names of available modules
284 std::list<modInfoStruct> moduleNames_;
286 std::map<docstring, docstring> changedBranches_;
288 std::list<std::string> includeonlys_;
291 /// Track if a non-module document param changed
292 bool nonModuleChanged_;
296 class PreambleModule : public UiWidget<Ui::PreambleUi>
301 void update(BufferParams const & params, BufferId id);
302 void apply(BufferParams & params);
305 /// signal that something's changed in the Widget.
309 void closeEvent(QCloseEvent *);
310 void on_preambleTE_textChanged() { changed(); }
313 typedef std::map<BufferId, std::pair<int,int> > Coords;
314 Coords preamble_coords_;
315 BufferId current_id_;
319 class LocalLayout : public UiWidget<Ui::LocalLayoutUi>
324 void update(BufferParams const & params, BufferId id);
325 void apply(BufferParams & params);
326 bool isValid() const { return validated_; }
329 /// signal that something's changed in the Widget.
338 void validatePressed();
339 void convertPressed();
342 BufferId current_id_;
347 class FontModule : public UiWidget<Ui::FontUi>
351 /// The roman font currently not selected by osFontsCB->isChecked()
353 /// The sans font currently not selected by osFontsCB->isChecked()
355 /// The typewriter font currently not selected by osFontsCB->isChecked()
356 QString font_typewriter;
357 /// The math font currently not selected by osFontsCB->isChecked()
359 /// The sans font scale currently not selected by osFontsCB->isChecked()
361 /// The typewriter font scale currently not selected by osFontsCB->isChecked()
366 } // namespace frontend
369 #endif // GUIDOCUMENT_H