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