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