src/frontends/qt4/GuiDocument.h

   1 // -*- C++ -*-
   2 /**
   3  * \file GuiDocument.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Edwin Leuven
   8  * \author Richard Heck (modules)
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef GUIDOCUMENT_H
  14 #define GUIDOCUMENT_H
  15
  16 #include <QDialog>
  17
  18 #include "BufferParams.h"
  19 #include "BulletsModule.h"
  20 #include "GuiDialog.h"
  21 #include "GuiIdListModel.h"
  22
  23 #include "ui_DocumentUi.h"
  24 #include "ui_FontUi.h"
  25 #include "ui_TextLayoutUi.h"
  26 #include "ui_MathsUi.h"
  27 #include "ui_LaTeXUi.h"
  28 #include "ui_PageLayoutUi.h"
  29 #include "ui_LanguageUi.h"
  30 #include "ui_BiblioUi.h"
  31 #include "ui_NumberingUi.h"
  32 #include "ui_MarginsUi.h"
  33 #include "ui_PreambleUi.h"
  34 #include "ui_PDFSupportUi.h"
  35 #include "ui_ModulesUi.h"
  36 #include "ui_OutputUi.h"
  37 #include "ui_ListingsSettingsUi.h"
  38
  39 #include <list>
  40 #include <map>
  41
  42 namespace lyx {
  43
  44 class BufferParams;
  45 class FloatPlacement;
  46 class LayoutModuleList;
  47 class TextClass;
  48
  49 namespace frontend {
  50
  51 class GuiBranches;
  52 class GuiIndices;
  53 class ModuleSelectionManager;
  54 class PreambleModule;
  55
  56 ///
  57 typedef void const * BufferId;
  58
  59 template<class UI>
  60 class UiWidget : public QWidget, public UI
  61 {
  62 public:
  63         UiWidget(QWidget * parent = 0) : QWidget(parent) { UI::setupUi(this); }
  64 };
  65
  66
  67 class GuiDocument : public GuiDialog, public Ui::DocumentUi
  68 {
  69         Q_OBJECT
  70 public:
  71         GuiDocument(GuiView & lv);
  72
  73         void paramsToDialog();
  74         void updateFontsize(std::string const &, std::string const &);
  75         void updateFontlist();
  76         void updateDefaultFormat();
  77         void updatePagestyle(std::string const &, std::string const &);
  78
  79         void showPreamble();
  80         ///
  81         BufferParams const & params() const { return bp_; }
  82
  83 private Q_SLOTS:
  84         void updateNumbering();
  85         void change_adaptor();
  86         void setListingsMessage();
  87         void saveDefaultClicked();
  88         void useDefaultsClicked();
  89         void setLSpacing(int);
  90         void setMargins(bool);
  91         void papersizeChanged(int);
  92         void setColSep();
  93         void setCustomMargins(bool);
  94         void romanChanged(int);
  95         void sansChanged(int);
  96         void ttChanged(int);
  97         void setIndent(int);
  98         void enableIndent(bool);
  99         void setSkip(int);
 100         void enableSkip(bool);
 101         void portraitChanged();
 102         void browseLayout();
 103         void browseMaster();
 104         void classChanged();
 105         void bibtexChanged(int);
 106         void updateModuleInfo();
 107         void modulesChanged();
 108         void changeBackgroundColor();
 109         void deleteBackgroundColor();
 110         void xetexChanged(bool);
 111         void branchesRename(docstring const &, docstring const &);
 112 private:
 113         /// validate listings parameters and return an error message, if any
 114         QString validateListingsParameters();
 115
 116         UiWidget<Ui::TextLayoutUi> *textLayoutModule;
 117         UiWidget<Ui::FontUi> *fontModule;
 118         UiWidget<Ui::PageLayoutUi> *pageLayoutModule;
 119         UiWidget<Ui::MarginsUi> *marginsModule;
 120         UiWidget<Ui::LanguageUi> *langModule;
 121         UiWidget<Ui::NumberingUi> *numberingModule;
 122         UiWidget<Ui::BiblioUi> *biblioModule;
 123         UiWidget<Ui::MathsUi> *mathsModule;
 124         UiWidget<Ui::LaTeXUi> *latexModule;
 125         UiWidget<Ui::PDFSupportUi> *pdfSupportModule;
 126         UiWidget<Ui::ModulesUi> *modulesModule;
 127         UiWidget<Ui::OutputUi> *outputModule;
 128         UiWidget<Ui::ListingsSettingsUi> *listingsModule;
 129         PreambleModule * preambleModule;
 130
 131         GuiBranches * branchesModule;
 132         GuiIndices * indicesModule;
 133
 134         BulletsModule * bulletsModule;
 135         FloatPlacement * floatModule;
 136
 137         ModuleSelectionManager * selectionManager;
 138
 139         /// Available modules
 140         GuiIdListModel * availableModel() { return &modules_av_model_; }
 141         /// Selected modules
 142         GuiIdListModel * selectedModel() { return &modules_sel_model_; }
 143
 144         /// Apply changes
 145         void applyView();
 146         /// update
 147         void updateContents();
 148         ///
 149         void updateAvailableModules();
 150         ///
 151         void updateSelectedModules();
 152         /// save as default template
 153         void saveDocDefault();
 154         /// reset to default params
 155         void useClassDefaults();
 156         ///
 157         void setLayoutComboByIDString(std::string const & idString);
 158         /// available classes
 159         GuiIdListModel classes_model_;
 160         /// available modules
 161         GuiIdListModel modules_av_model_;
 162         /// selected modules
 163         GuiIdListModel modules_sel_model_;
 164         /// current buffer
 165         BufferId current_id_;
 166
 167         /// return false if validate_listings_params returns error
 168         bool isValid();
 169
 170         /// font family names for BufferParams::fontsDefaultFamily
 171         static char const * const fontfamilies[5];
 172         /// GUI names corresponding fontfamilies
 173         static char const * fontfamilies_gui[5];
 174         ///
 175         bool initialiseParams(std::string const & data);
 176         ///
 177         void clearParams();
 178         ///
 179         void dispatchParams();
 180         ///
 181         void modulesToParams(BufferParams &);
 182         ///
 183         bool isBufferDependent() const { return true; }
 184         /// always true since we don't manipulate document contents
 185         bool canApply() const { return true; }
 186         ///
 187         DocumentClass const & documentClass() const;
 188         ///
 189         BufferParams & params() { return bp_; }
 190         ///
 191         BufferId id() const;
 192         ///
 193         struct modInfoStruct {
 194                 QString name;
 195                 std::string id;
 196                 QString description;
 197         };
 198         /// List of available modules
 199         std::list<modInfoStruct> const & getModuleInfo();
 200         /// Modules in use in current buffer
 201         std::list<modInfoStruct> const getSelectedModules();
 202         ///
 203         std::list<modInfoStruct> const getProvidedModules();
 204         ///
 205         std::list<modInfoStruct> const
 206                         makeModuleInfo(LayoutModuleList const & mods);
 207         ///
 208         void setLanguage() const;
 209         ///
 210         void saveAsDefault() const;
 211         ///
 212         bool isFontAvailable(std::string const & font) const;
 213         /// does this font provide Old Style figures?
 214         bool providesOSF(std::string const & font) const;
 215         /// does this font provide true Small Caps?
 216         bool providesSC(std::string const & font) const;
 217         /// does this font provide size adjustment?
 218         bool providesScale(std::string const & font) const;
 219         ///
 220         void executeBranchRenaming() const;
 221         ///
 222         void setCustomPapersize(bool custom);
 223 private:
 224         ///
 225         void loadModuleInfo();
 226         ///
 227         void updateUnknownBranches();
 228         ///
 229         BufferParams bp_;
 230         /// List of names of available modules
 231         std::list<modInfoStruct> moduleNames_;
 232         ///
 233         std::map<docstring, docstring> changedBranches_;
 234 };
 235
 236
 237 class PreambleModule : public UiWidget<Ui::PreambleUi>
 238 {
 239         Q_OBJECT
 240 public:
 241         PreambleModule();
 242         void update(BufferParams const & params, BufferId id);
 243         void apply(BufferParams & params);
 244
 245 Q_SIGNALS:
 246         /// signal that something's changed in the Widget.
 247         void changed();
 248
 249 private:
 250         void closeEvent(QCloseEvent *);
 251         void on_preambleTE_textChanged() { changed(); }
 252
 253 private:
 254         typedef std::map<BufferId, std::pair<int,int> > Coords;
 255         Coords preamble_coords_;
 256         BufferId current_id_;
 257 };
 258
 259
 260 } // namespace frontend
 261 } // namespace lyx
 262
 263 #endif // GUIDOCUMENT_H