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