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