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