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