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 #include "GuiSelectionManager.h"
  23
  24 #include "ui_DocumentUi.h"
  25 #include "ui_EmbeddedFilesUi.h"
  26 #include "ui_FontUi.h"
  27 #include "ui_TextLayoutUi.h"
  28 #include "ui_MathsUi.h"
  29 #include "ui_LaTeXUi.h"
  30 #include "ui_PageLayoutUi.h"
  31 #include "ui_LanguageUi.h"
  32 #include "ui_BiblioUi.h"
  33 #include "ui_NumberingUi.h"
  34 #include "ui_MarginsUi.h"
  35 #include "ui_PreambleUi.h"
  36 #include "ui_PDFSupportUi.h"
  37
  38 #include <map>
  39 #include <vector>
  40
  41 class FloatPlacement;
  42
  43 namespace lyx {
  44
  45 class BufferParams;
  46 class TextClass;
  47
  48 namespace frontend {
  49
  50 class GuiBranches;
  51 class PreambleModule;
  52
  53 ///
  54 QModelIndex getSelectedIndex(QListView * lv);
  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 /// SelectionManager for use with modules
  68 class ModuleSelMan : public GuiSelectionManager
  69 {
  70 public:
  71         ModuleSelMan(
  72                 QListView * availableLV,
  73                 QListView * selectedLV,
  74                 QPushButton * addPB,
  75                 QPushButton * delPB,
  76                 QPushButton * upPB,
  77                 QPushButton * downPB,
  78                 GuiIdListModel * availableModel,
  79                 GuiIdListModel * selectedModel);
  80 private:
  81         ///
  82         virtual void updateAddPB();
  83         ///
  84         virtual void updateUpPB();
  85         ///
  86         virtual void updateDownPB();
  87         ///
  88         virtual void updateDelPB();
  89         /// returns availableModel as a GuiIdListModel
  90         GuiIdListModel * getAvailableModel()
  91         {
  92                 return dynamic_cast<GuiIdListModel *>(availableModel);
  93         };
  94         /// returns selectedModel as a GuiIdListModel
  95         GuiIdListModel * getSelectedModel()
  96         {
  97                 return dynamic_cast<GuiIdListModel *>(selectedModel);
  98         };
  99 };
 100
 101
 102 class GuiDocument : public GuiDialog, public Ui::DocumentUi
 103 {
 104         Q_OBJECT
 105 public:
 106         GuiDocument(GuiView & lv);
 107
 108         void updateParams(BufferParams const & params);
 109         void apply(BufferParams & params);
 110
 111         void updateFontsize(std::string const &, std::string const &);
 112         void updatePagestyle(std::string const &, std::string const &);
 113
 114         void showPreamble();
 115         /// validate listings parameters and return an error message, if any
 116         docstring validate_listings_params();
 117
 118 public Q_SLOTS:
 119         void updateNumbering();
 120         void change_adaptor();
 121         void set_listings_msg();
 122         void saveDefaultClicked();
 123         void useDefaultsClicked();
 124
 125 private Q_SLOTS:
 126         void updateParams();
 127         void setLSpacing(int);
 128         void setMargins(bool);
 129         void setCustomPapersize(int);
 130         void setColSep();
 131         void setCustomMargins(bool);
 132         void romanChanged(int);
 133         void sansChanged(int);
 134         void ttChanged(int);
 135         void setSkip(int);
 136         void enableSkip(bool);
 137         void portraitChanged();
 138         void browseLayout();
 139         void classChanged();
 140         void updateModuleInfo();
 141         void setExtraEmbeddedFileList();
 142         void addExtraEmbeddedFile();
 143         void removeExtraEmbeddedFile();
 144
 145 private:
 146         UiWidget<Ui::TextLayoutUi> *textLayoutModule;
 147         UiWidget<Ui::FontUi> *fontModule;
 148         UiWidget<Ui::PageLayoutUi> *pageLayoutModule;
 149         UiWidget<Ui::MarginsUi> *marginsModule;
 150         UiWidget<Ui::LanguageUi> *langModule;
 151         UiWidget<Ui::NumberingUi> *numberingModule;
 152         UiWidget<Ui::BiblioUi> *biblioModule;
 153         UiWidget<Ui::MathsUi> *mathsModule;
 154         UiWidget<Ui::LaTeXUi> *latexModule;
 155         UiWidget<Ui::PDFSupportUi> *pdfSupportModule;
 156         UiWidget<Ui::EmbeddedFilesUi> *embeddedFilesModule;
 157         PreambleModule *preambleModule;
 158
 159         GuiBranches *branchesModule;
 160
 161         BulletsModule * bulletsModule;
 162         FloatPlacement * floatModule;
 163
 164         GuiSelectionManager * selectionManager;
 165
 166         ///
 167         QStringList lang_;
 168
 169         /// Available modules
 170         GuiIdListModel * availableModel() { return &modules_av_model_; }
 171         /// Selected modules
 172         GuiIdListModel * selectedModel() { return &modules_sel_model_; }
 173 private:
 174         /// Apply changes
 175         void applyView();
 176         /// update
 177         void updateContents();
 178         /// force content update
 179         void forceUpdate();
 180         ///
 181         void updateAvailableModules();
 182         ///
 183         void updateSelectedModules();
 184         /// save as default template
 185         void saveDocDefault();
 186         /// reset to default params
 187         void useClassDefaults();
 188         ///
 189         void setLayoutComboByIDString(std::string const & idString);
 190         /// available classes
 191         GuiIdListModel classes_model_;
 192         /// available modules
 193         GuiIdListModel modules_av_model_;
 194         /// selected modules
 195         GuiIdListModel modules_sel_model_;
 196         /// current buffer
 197         BufferId current_id_;
 198
 199 protected:
 200         /// return false if validate_listings_params returns error
 201         bool isValid();
 202
 203         /// font family names for BufferParams::fontsDefaultFamily
 204         static char const * const fontfamilies[5];
 205         /// GUI names corresponding fontfamilies
 206         static char const * fontfamilies_gui[5];
 207         ///
 208         bool initialiseParams(std::string const & data);
 209         ///
 210         void clearParams();
 211         ///
 212         void dispatchParams();
 213         ///
 214         bool isBufferDependent() const { return true; }
 215         /// always true since we don't manipulate document contents
 216         bool canApply() const { return true; }
 217         ///
 218         DocumentClass const & documentClass() const;
 219         ///
 220         BufferParams & params() { return bp_; }
 221         ///
 222         BufferParams const & params() const { return bp_; }
 223         ///
 224         BufferId id() const;
 225         ///
 226         struct modInfoStruct {
 227                 std::string name;
 228                 std::string id;
 229         };
 230         /// List of available modules
 231         std::vector<modInfoStruct> const & getModuleInfo();
 232         /// Modules in use in current buffer
 233         std::vector<modInfoStruct> const getSelectedModules();
 234         ///
 235         void setLanguage() const;
 236         ///
 237         void saveAsDefault() const;
 238         ///
 239         bool isFontAvailable(std::string const & font) const;
 240         /// does this font provide Old Style figures?
 241         bool providesOSF(std::string const & font) const;
 242         /// does this font provide true Small Caps?
 243         bool providesSC(std::string const & font) const;
 244         /// does this font provide size adjustment?
 245         bool providesScale(std::string const & font) const;
 246 private:
 247         ///
 248         void loadModuleInfo();
 249         ///
 250         BufferParams bp_;
 251         /// List of names of available modules
 252         std::vector<modInfoStruct> moduleNames_;
 253 };
 254
 255
 256 class PreambleModule : public UiWidget<Ui::PreambleUi>
 257 {
 258         Q_OBJECT
 259 public:
 260         PreambleModule();
 261         void update(BufferParams const & params, BufferId id);
 262         void apply(BufferParams & params);
 263
 264 Q_SIGNALS:
 265         /// signal that something's changed in the Widget.
 266         void changed();
 267
 268 private:
 269         void closeEvent(QCloseEvent *);
 270         void on_preambleTE_textChanged() { changed(); }
 271
 272 private:
 273         typedef std::map<BufferId, std::pair<int,int> > Coords;
 274         Coords preamble_coords_;
 275         BufferId current_id_;
 276 };
 277
 278
 279 } // namespace frontend
 280 } // namespace lyx
 281
 282 #endif // GUIDOCUMENT_H