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