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