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
  37 #include <list>
  38 #include <map>
  39
  40 namespace lyx {
  41
  42 class BufferParams;
  43 class FloatPlacement;
  44 class LayoutModuleList;
  45 class TextClass;
  46
  47 namespace frontend {
  48
  49 class GuiBranches;
  50 class ModuleSelectionManager;
  51 class PreambleModule;
  52
  53 ///
  54 typedef void const * BufferId;
  55
  56 template<class UI>
  57 class UiWidget : public QWidget, public UI
  58 {
  59 public:
  60         UiWidget(QWidget * parent = 0) : QWidget(parent) { UI::setupUi(this); }
  61 };
  62
  63
  64 class GuiDocument : public GuiDialog, public Ui::DocumentUi
  65 {
  66         Q_OBJECT
  67 public:
  68         GuiDocument(GuiView & lv);
  69
  70         void paramsToDialog();
  71         void updateFontsize(std::string const &, std::string const &);
  72         void updateFontlist();
  73         void updatePagestyle(std::string const &, std::string const &);
  74
  75         void showPreamble();
  76         ///
  77         BufferParams const & params() const { return bp_; }
  78
  79 private Q_SLOTS:
  80         void updateNumbering();
  81         void change_adaptor();
  82         void setListingsMessage();
  83         void saveDefaultClicked();
  84         void useDefaultsClicked();
  85         void setLSpacing(int);
  86         void setMargins(bool);
  87         void setCustomPapersize(int);
  88         void setColSep();
  89         void setCustomMargins(bool);
  90         void romanChanged(int);
  91         void sansChanged(int);
  92         void ttChanged(int);
  93         void setSkip(int);
  94         void enableSkip(bool);
  95         void portraitChanged();
  96         void browseLayout();
  97         void browseMaster();
  98         void classChanged();
  99         void updateModuleInfo();
 100         void modulesChanged();
 101         void xetexChanged(bool);
 102 private:
 103         /// validate listings parameters and return an error message, if any
 104         QString validateListingsParameters();
 105
 106         UiWidget<Ui::TextLayoutUi> *textLayoutModule;
 107         UiWidget<Ui::FontUi> *fontModule;
 108         UiWidget<Ui::PageLayoutUi> *pageLayoutModule;
 109         UiWidget<Ui::MarginsUi> *marginsModule;
 110         UiWidget<Ui::LanguageUi> *langModule;
 111         UiWidget<Ui::NumberingUi> *numberingModule;
 112         UiWidget<Ui::BiblioUi> *biblioModule;
 113         UiWidget<Ui::MathsUi> *mathsModule;
 114         UiWidget<Ui::LaTeXUi> *latexModule;
 115         UiWidget<Ui::PDFSupportUi> *pdfSupportModule;
 116         UiWidget<Ui::ModulesUi> *modulesModule;
 117         PreambleModule *preambleModule;
 118
 119         GuiBranches *branchesModule;
 120
 121         BulletsModule * bulletsModule;
 122         FloatPlacement * floatModule;
 123
 124         ModuleSelectionManager * selectionManager;
 125
 126         /// Available modules
 127         GuiIdListModel * availableModel() { return &modules_av_model_; }
 128         /// Selected modules
 129         GuiIdListModel * selectedModel() { return &modules_sel_model_; }
 130
 131         /// Apply changes
 132         void applyView();
 133         /// update
 134         void updateContents();
 135         ///
 136         void updateAvailableModules();
 137         ///
 138         void updateSelectedModules();
 139         /// save as default template
 140         void saveDocDefault();
 141         /// reset to default params
 142         void useClassDefaults();
 143         ///
 144         void setLayoutComboByIDString(std::string const & idString);
 145         /// available classes
 146         GuiIdListModel classes_model_;
 147         /// available modules
 148         GuiIdListModel modules_av_model_;
 149         /// selected modules
 150         GuiIdListModel modules_sel_model_;
 151         /// current buffer
 152         BufferId current_id_;
 153
 154         /// return false if validate_listings_params returns error
 155         bool isValid();
 156
 157         /// font family names for BufferParams::fontsDefaultFamily
 158         static char const * const fontfamilies[5];
 159         /// GUI names corresponding fontfamilies
 160         static char const * fontfamilies_gui[5];
 161         ///
 162         bool initialiseParams(std::string const & data);
 163         ///
 164         void clearParams();
 165         ///
 166         void dispatchParams();
 167         ///
 168         void modulesToParams(BufferParams &);
 169         ///
 170         bool isBufferDependent() const { return true; }
 171         /// always true since we don't manipulate document contents
 172         bool canApply() const { return true; }
 173         ///
 174         DocumentClass const & documentClass() const;
 175         ///
 176         BufferParams & params() { return bp_; }
 177         ///
 178         BufferId id() const;
 179         ///
 180         struct modInfoStruct {
 181                 QString name;
 182                 std::string id;
 183                 QString description;
 184         };
 185         /// List of available modules
 186         std::list<modInfoStruct> const & getModuleInfo();
 187         /// Modules in use in current buffer
 188         std::list<modInfoStruct> const getSelectedModules();
 189         ///
 190         std::list<modInfoStruct> const getProvidedModules();
 191         ///
 192         std::list<modInfoStruct> const
 193                         makeModuleInfo(LayoutModuleList const & mods);
 194         ///
 195         void setLanguage() const;
 196         ///
 197         void saveAsDefault() const;
 198         ///
 199         bool isFontAvailable(std::string const & font) const;
 200         /// does this font provide Old Style figures?
 201         bool providesOSF(std::string const & font) const;
 202         /// does this font provide true Small Caps?
 203         bool providesSC(std::string const & font) const;
 204         /// does this font provide size adjustment?
 205         bool providesScale(std::string const & font) const;
 206 private:
 207         ///
 208         void loadModuleInfo();
 209         ///
 210         BufferParams bp_;
 211         /// List of names of available modules
 212         std::list<modInfoStruct> moduleNames_;
 213 };
 214
 215
 216 class PreambleModule : public UiWidget<Ui::PreambleUi>
 217 {
 218         Q_OBJECT
 219 public:
 220         PreambleModule();
 221         void update(BufferParams const & params, BufferId id);
 222         void apply(BufferParams & params);
 223
 224 Q_SIGNALS:
 225         /// signal that something's changed in the Widget.
 226         void changed();
 227
 228 private:
 229         void closeEvent(QCloseEvent *);
 230         void on_preambleTE_textChanged() { changed(); }
 231
 232 private:
 233         typedef std::map<BufferId, std::pair<int,int> > Coords;
 234         Coords preamble_coords_;
 235         BufferId current_id_;
 236 };
 237
 238
 239 } // namespace frontend
 240 } // namespace lyx
 241
 242 #endif // GUIDOCUMENT_H