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 "GuiDialog.h"
  17 #include "BulletsModule.h"
  18 #include "GuiSelectionManager.h"
  19 #include "BufferParams.h"
  20
  21 #include "support/types.h"
  22
  23 #include "ui_DocumentUi.h"
  24 #include "ui_EmbeddedFilesUi.h"
  25 #include "ui_FontUi.h"
  26 #include "ui_TextLayoutUi.h"
  27 #include "ui_MathsUi.h"
  28 #include "ui_LaTeXUi.h"
  29 #include "ui_PageLayoutUi.h"
  30 #include "ui_LanguageUi.h"
  31 #include "ui_BiblioUi.h"
  32 #include "ui_NumberingUi.h"
  33 #include "ui_MarginsUi.h"
  34 #include "ui_PreambleUi.h"
  35 #include "ui_PDFSupportUi.h"
  36
  37 #include <map>
  38 #include <vector>
  39
  40 class FloatPlacement;
  41
  42 namespace lyx {
  43
  44 class BufferParams;
  45 class TextClass;
  46
  47 namespace frontend {
  48
  49 class GuiBranches;
  50 class PreambleModule;
  51
  52 ///
  53 typedef void const * BufferId;
  54
  55 #include <QDialog>
  56 #include <QStringList>
  57 #include <QStringListModel>
  58
  59 #include <vector>
  60 #include <string>
  61
  62 template<class UI>
  63 class UiWidget : public QWidget, public UI
  64 {
  65 public:
  66         UiWidget(QWidget * parent = 0) : QWidget(parent) { UI::setupUi(this); }
  67 };
  68
  69
  70 class GuiDocument : public GuiDialog, public Ui::DocumentUi
  71 {
  72         Q_OBJECT
  73 public:
  74         GuiDocument(GuiView & lv);
  75
  76         void updateParams(BufferParams const & params);
  77         void apply(BufferParams & params);
  78
  79         void updateFontsize(std::string const &, std::string const &);
  80         void updatePagestyle(std::string const &, std::string const &);
  81
  82         void showPreamble();
  83         /// validate listings parameters and return an error message, if any
  84         docstring validate_listings_params();
  85
  86 public Q_SLOTS:
  87         void updateNumbering();
  88         void change_adaptor();
  89         void set_listings_msg();
  90         void saveDefaultClicked();
  91         void useDefaultsClicked();
  92
  93 private Q_SLOTS:
  94         void updateParams();
  95         void setLSpacing(int);
  96         void setMargins(bool);
  97         void setCustomPapersize(int);
  98         void setCustomMargins(bool);
  99         void romanChanged(int);
 100         void sansChanged(int);
 101         void ttChanged(int);
 102         void setSkip(int);
 103         void enableSkip(bool);
 104         void portraitChanged();
 105         void classChanged();
 106         void updateModuleInfo();
 107         void updateEmbeddedFileList();
 108
 109 private:
 110         void closeEvent(QCloseEvent * e);
 111
 112 private:
 113         UiWidget<Ui::TextLayoutUi> *textLayoutModule;
 114         UiWidget<Ui::FontUi> *fontModule;
 115         UiWidget<Ui::PageLayoutUi> *pageLayoutModule;
 116         UiWidget<Ui::MarginsUi> *marginsModule;
 117         UiWidget<Ui::LanguageUi> *langModule;
 118         UiWidget<Ui::NumberingUi> *numberingModule;
 119         UiWidget<Ui::BiblioUi> *biblioModule;
 120         UiWidget<Ui::MathsUi> *mathsModule;
 121         UiWidget<Ui::LaTeXUi> *latexModule;
 122         UiWidget<Ui::PDFSupportUi> *pdfSupportModule;
 123         UiWidget<Ui::EmbeddedFilesUi> *embeddedFilesModule;
 124         PreambleModule *preambleModule;
 125
 126         GuiBranches *branchesModule;
 127
 128         BulletsModule * bulletsModule;
 129         FloatPlacement * floatModule;
 130
 131         GuiSelectionManager * selectionManager;
 132
 133         // FIXME
 134         std::vector<std::string> lang_;
 135
 136         /// Available modules
 137         QStringListModel * availableModel() { return &available_model_; }
 138         /// Selected modules
 139         QStringListModel * selectedModel() { return &selected_model_; }
 140 private:
 141         /// Apply changes
 142         void applyView();
 143         /// update
 144         void updateContents();
 145         /// save as default template
 146         void saveDocDefault();
 147         /// reset to default params
 148         void useClassDefaults();
 149         /// available modules
 150         QStringListModel available_model_;
 151         /// selected modules
 152         QStringListModel selected_model_;
 153
 154 protected:
 155         /// return false if validate_listings_params returns error
 156         bool isValid();
 157
 158         /// font family names for BufferParams::fontsDefaultFamily
 159         static char const * const fontfamilies[5];
 160         /// GUI names corresponding fontfamilies
 161         static char const * fontfamilies_gui[5];
 162         ///
 163         bool initialiseParams(std::string const & data);
 164         ///
 165         void clearParams();
 166         ///
 167         void dispatchParams();
 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         TextClass const & textClass() const;
 174         ///
 175         BufferParams & params() { return bp_; }
 176         ///
 177         BufferParams const & params() const { return bp_; }
 178         ///
 179         BufferId id() const;
 180         /// List of available modules
 181         std::vector<std::string> getModuleNames();
 182         /// Modules in use in current buffer
 183         std::vector<std::string> const & getSelectedModules();
 184         ///
 185         std::string getModuleDescription(std::string const & modName) const;
 186         ///
 187         std::vector<std::string> getPackageList(std::string const & modName) const;
 188         ///
 189         bool isModuleAvailable(std::string const & modName) const;
 190         ///
 191         void setLanguage() const;
 192         ///
 193         void saveAsDefault() const;
 194         ///
 195         bool isFontAvailable(std::string const & font) const;
 196         /// does this font provide Old Style figures?
 197         bool providesOSF(std::string const & font) const;
 198         /// does this font provide true Small Caps?
 199         bool providesSC(std::string const & font) const;
 200         /// does this font provide size adjustment?
 201         bool providesScale(std::string const & font) const;
 202 private:
 203         ///
 204         void loadModuleNames();
 205         ///
 206         BufferParams bp_;
 207         /// List of names of available modules
 208         std::vector<std::string> moduleNames_;
 209 };
 210
 211
 212 typedef void const * BufferId;
 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 // QDOCUMENT_H