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_BiblioUi.h"
  24 #include "ui_ColorUi.h"
  25 #include "ui_DocumentUi.h"
  26 #include "ui_FontUi.h"
  27 #include "ui_LanguageUi.h"
  28 #include "ui_LaTeXUi.h"
  29 #include "ui_ListingsSettingsUi.h"
  30 #include "ui_LocalLayoutUi.h"
  31 #include "ui_MarginsUi.h"
  32 #include "ui_MasterChildUi.h"
  33 #include "ui_MathsUi.h"
  34 #include "ui_ModulesUi.h"
  35 #include "ui_NumberingUi.h"
  36 #include "ui_OutputUi.h"
  37 #include "ui_PageLayoutUi.h"
  38 #include "ui_PDFSupportUi.h"
  39 #include "ui_PreambleUi.h"
  40 #include "ui_TextLayoutUi.h"
  41
  42 namespace lyx {
  43
  44 class BufferParams;
  45 class LayoutModuleList;
  46 class TextClass;
  47
  48 namespace frontend {
  49
  50 class FloatPlacement;
  51 class GuiBranches;
  52 class GuiIndices;
  53 class ModuleSelectionManager;
  54 class PreambleModule;
  55 class LocalLayout;
  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 updateEngineType(std::string const &, CiteEngineType const &);
  79         void updatePagestyle(std::string const &, std::string const &);
  80         bool isChildIncluded(std::string const &);
  81
  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();
  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 browseLayout();
 106         void browseMaster();
 107         void classChanged();
 108         void languagePackageChanged(int);
 109         void biblioChanged();
 110         void bibtexChanged(int);
 111         void setAuthorYear(bool);
 112         void setNumerical(bool);
 113         void updateModuleInfo();
 114         void modulesChanged();
 115         void changeBackgroundColor();
 116         void deleteBackgroundColor();
 117         void changeFontColor();
 118         void deleteFontColor();
 119         void changeNoteFontColor();
 120         void deleteNoteFontColor();
 121         void changeBoxBackgroundColor();
 122         void deleteBoxBackgroundColor();
 123         void languageChanged(int);
 124         void osFontsChanged(bool);
 125         void mathFontChanged(int);
 126         void branchesRename(docstring const &, docstring const &);
 127 private:
 128         /// validate listings parameters and return an error message, if any
 129         QString validateListingsParameters();
 130
 131         UiWidget<Ui::TextLayoutUi> *textLayoutModule;
 132         UiWidget<Ui::MasterChildUi> *masterChildModule;
 133         UiWidget<Ui::FontUi> *fontModule;
 134         UiWidget<Ui::PageLayoutUi> *pageLayoutModule;
 135         UiWidget<Ui::MarginsUi> *marginsModule;
 136         UiWidget<Ui::LanguageUi> *langModule;
 137         UiWidget<Ui::ColorUi> *colorModule;
 138         UiWidget<Ui::NumberingUi> *numberingModule;
 139         UiWidget<Ui::BiblioUi> *biblioModule;
 140         UiWidget<Ui::MathsUi> *mathsModule;
 141         UiWidget<Ui::LaTeXUi> *latexModule;
 142         UiWidget<Ui::PDFSupportUi> *pdfSupportModule;
 143         UiWidget<Ui::ModulesUi> *modulesModule;
 144         UiWidget<Ui::OutputUi> *outputModule;
 145         UiWidget<Ui::ListingsSettingsUi> *listingsModule;
 146         PreambleModule * preambleModule;
 147         LocalLayout * localLayout;
 148
 149         GuiBranches * branchesModule;
 150         GuiIndices * indicesModule;
 151
 152         BulletsModule * bulletsModule;
 153         FloatPlacement * floatModule;
 154
 155         ModuleSelectionManager * selectionManager;
 156
 157         /// Available modules
 158         GuiIdListModel * availableModel() { return &modules_av_model_; }
 159         /// Selected modules
 160         GuiIdListModel * selectedModel() { return &modules_sel_model_; }
 161
 162         /// Apply changes
 163         void applyView();
 164         /// update
 165         void updateContents();
 166         ///
 167         void updateAvailableModules();
 168         ///
 169         void updateSelectedModules();
 170         ///
 171         void updateIncludeonlys();
 172         /// save as default template
 173         void saveDocDefault();
 174         /// reset to default params
 175         void useClassDefaults();
 176         ///
 177         void setLayoutComboByIDString(std::string const & idString);
 178
 179         /// available classes
 180         GuiIdListModel classes_model_;
 181         /// available modules
 182         GuiIdListModel modules_av_model_;
 183         /// selected modules
 184         GuiIdListModel modules_sel_model_;
 185         /// current buffer
 186         BufferId current_id_;
 187
 188         /// return false if validate_listings_params returns error
 189         bool isValid();
 190
 191         /// font family names for BufferParams::fonts_default_family
 192         static char const * const fontfamilies[5];
 193         /// GUI names corresponding fontfamilies
 194         static char const * fontfamilies_gui[5];
 195         ///
 196         bool initialiseParams(std::string const & data);
 197         ///
 198         void clearParams();
 199         ///
 200         void dispatchParams();
 201         ///
 202         void modulesToParams(BufferParams &);
 203         ///
 204         bool isBufferDependent() const { return true; }
 205         /// always true since we don't manipulate document contents
 206         bool canApply() const { return true; }
 207         ///
 208         DocumentClass const & documentClass() const;
 209         ///
 210         BufferParams & params() { return bp_; }
 211         ///
 212         BufferId id() const;
 213         ///
 214         struct modInfoStruct {
 215                 QString name;
 216                 std::string id;
 217                 QString description;
 218         };
 219         /// List of available modules
 220         std::list<modInfoStruct> const & getModuleInfo();
 221         /// Modules in use in current buffer
 222         std::list<modInfoStruct> const getSelectedModules();
 223         ///
 224         std::list<modInfoStruct> const getProvidedModules();
 225         ///
 226         std::list<modInfoStruct> const
 227                         makeModuleInfo(LayoutModuleList const & mods);
 228         ///
 229         void setLanguage() const;
 230         ///
 231         void saveAsDefault() const;
 232         /// does this font provide Old Style figures?
 233         bool providesOSF(QString const & font) const;
 234         /// does this font provide true Small Caps?
 235         bool providesSC(QString const & font) const;
 236         /// does this font provide size adjustment?
 237         bool providesScale(QString const & font) const;
 238         /// does this font provide an alternative without math?
 239         bool providesNoMath(QString const & font) const;
 240         ///
 241         void executeBranchRenaming() const;
 242         ///
 243         void setCustomPapersize(bool custom);
 244 private:
 245         ///
 246         void loadModuleInfo();
 247         ///
 248         void updateUnknownBranches();
 249         ///
 250         void updateTexFonts();
 251         ///
 252         void updateMathFonts(QString const & rm);
 253         ///
 254         void updateFontOptions();
 255         ///
 256         bool ot1() const;
 257         ///
 258         bool completeFontset() const;
 259         ///
 260         bool noMathFont() const;
 261         ///
 262         BufferParams bp_;
 263         /// List of names of available modules
 264         std::list<modInfoStruct> moduleNames_;
 265         ///
 266         std::map<docstring, docstring> changedBranches_;
 267         ///
 268         std::list<std::string> includeonlys_;
 269         ///
 270         bool biblioChanged_;
 271 };
 272
 273
 274 class PreambleModule : public UiWidget<Ui::PreambleUi>
 275 {
 276         Q_OBJECT
 277 public:
 278         PreambleModule();
 279         void update(BufferParams const & params, BufferId id);
 280         void apply(BufferParams & params);
 281
 282 Q_SIGNALS:
 283         /// signal that something's changed in the Widget.
 284         void changed();
 285
 286 private:
 287         void closeEvent(QCloseEvent *);
 288         void on_preambleTE_textChanged() { changed(); }
 289
 290 private:
 291         typedef std::map<BufferId, std::pair<int,int> > Coords;
 292         Coords preamble_coords_;
 293         BufferId current_id_;
 294 };
 295
 296
 297 class LocalLayout : public UiWidget<Ui::LocalLayoutUi>
 298 {
 299         Q_OBJECT
 300 public:
 301         LocalLayout();
 302         void update(BufferParams const & params, BufferId id);
 303         void apply(BufferParams & params);
 304         bool isValid() const { return validated_; }
 305
 306 Q_SIGNALS:
 307         /// signal that something's changed in the Widget.
 308         void changed();
 309
 310 private:
 311         void validate();
 312         void convert();
 313 private Q_SLOTS:
 314         void textChanged();
 315         void validatePressed();
 316         void convertPressed();
 317
 318 private:
 319         BufferId current_id_;
 320         bool validated_;
 321 };
 322
 323
 324 } // namespace frontend
 325 } // namespace lyx
 326
 327 #endif // GUIDOCUMENT_H