src/frontends/qt4/GuiView.h

   1 // -*- C++ -*-
   2 /**
   3  * \file GuiView.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjornes
   8  * \author John Levon
   9  * \author Abdelrazak Younes
  10  * \author Peter Kümmel
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef GUI_VIEW_H
  16 #define GUI_VIEW_H
  17
  18 #include "frontends/Delegates.h"
  19 #include "frontends/LyXView.h"
  20
  21 #include "support/strfwd.h"
  22
  23 #include <QMainWindow>
  24
  25 class QCloseEvent;
  26 class QDragEnterEvent;
  27 class QDropEvent;
  28 class QMenu;
  29 class QShowEvent;
  30
  31
  32 namespace lyx {
  33
  34 class Cursor;
  35
  36 namespace frontend {
  37
  38 class Dialog;
  39 class GuiLayoutBox;
  40 class GuiToolbar;
  41 class GuiWorkArea;
  42 class TabWorkArea;
  43 class TocModels;
  44 class ToolbarInfo;
  45
  46 /**
  47  * GuiView - Qt4 implementation of LyXView
  48  *
  49  * qt4-private implementation of the main LyX window.
  50  *
  51  * Note: a QObject emits a destroyed(QObject *) Qt signal when it
  52  * is deleted. This might be useful for closing other dialogs
  53  * depending on a given GuiView.
  54  */
  55 class GuiView : public QMainWindow, public LyXView, public GuiBufferViewDelegate,
  56         public GuiBufferDelegate
  57 {
  58         Q_OBJECT
  59 public:
  60         /// create a main window of the given dimensions
  61         GuiView(int id);
  62
  63         ~GuiView();
  64
  65         ///
  66         int id() const { return id_; }
  67         void setFocus();
  68         void setBusy(bool);
  69         /// returns true if this view has the focus.
  70         bool hasFocus() const;
  71
  72         /// add toolbar, if newline==true, add a toolbar break before the toolbar
  73         GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
  74         virtual void updateStatusBar();
  75         virtual void message(docstring const & str);
  76
  77         /// updates the possible layouts selectable
  78         void updateLayoutList();
  79         void updateToolbars();
  80         QMenu * createPopupMenu();
  81         bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
  82         bool dispatch(FuncRequest const & cmd);
  83
  84         ///
  85         void setLayoutDialog(GuiLayoutBox *);
  86
  87         /// \return the buffer currently shown in this window
  88         Buffer * buffer();
  89         Buffer const * buffer() const;
  90         /// set a buffer to the current workarea.
  91         void setBuffer(Buffer * b); ///< \c Buffer to set.
  92         ///
  93         bool closeBuffer();
  94         /// load a document into the current workarea.
  95         Buffer * loadDocument(support::FileName const &  name, ///< File to load.
  96                 bool tolastfiles = true);  ///< append to the "Open recent" menu?
  97         ///
  98         void openDocument(std::string const & filename);
  99         ///
 100         void importDocument(std::string const &);
 101         ///
 102         void newDocument(std::string const & filename, bool fromTemplate);
 103
 104         /// GuiBufferDelegate.
 105         ///@{
 106         void resetAutosaveTimers();
 107         void errors(std::string const &);
 108         void structureChanged();
 109         void updateTocItem(std::string const &, DocIterator const &);
 110         ///@}
 111
 112         ///
 113         TocModels & tocModels();
 114
 115         /// called on timeout
 116         void autoSave();
 117
 118         /// \return the current buffer view.
 119         BufferView * view();
 120
 121         /** redraw \c inset in all the BufferViews in which it is currently
 122          *  visible. If successful return a pointer to the owning Buffer.
 123          */
 124         Buffer const * updateInset(Inset const *);
 125         ///
 126         void restartCursor();
 127
 128         /// \return the \c Workarea associated to \p  Buffer
 129         /// \retval 0 if no \c WorkArea is found.
 130         GuiWorkArea * workArea(Buffer & buffer);
 131
 132         /// Add a \c WorkArea
 133         /// \return the \c Workarea associated to \p  Buffer
 134         /// \retval 0 if no \c WorkArea is found.
 135         GuiWorkArea * addWorkArea(Buffer & buffer);
 136         ///
 137         void setCurrentWorkArea(GuiWorkArea * work_area);
 138         ///
 139         void removeWorkArea(GuiWorkArea * work_area);
 140         /// return the current WorkArea (the one that has the focus).
 141         GuiWorkArea const * currentWorkArea() const;
 142
 143 Q_SIGNALS:
 144         void closing(int);
 145
 146 public Q_SLOTS:
 147         /// idle timeout.
 148         /// clear any temporary message and replace with current status.
 149         void clearMessage();
 150
 151 private Q_SLOTS:
 152         ///
 153         void updateWindowTitle(GuiWorkArea * wa);
 154         ///
 155         void resetWindowTitleAndIconText();
 156
 157         ///
 158         void on_currentWorkAreaChanged(GuiWorkArea *);
 159         ///
 160         void on_lastWorkAreaRemoved();
 161
 162         /// slots to change the icon size
 163         void smallSizedIcons();
 164         void normalSizedIcons();
 165         void bigSizedIcons();
 166
 167 private:
 168         ///
 169         TabWorkArea * addTabWorkArea();
 170
 171         /// connect to signals in the given BufferView
 172         void connectBufferView(BufferView & bv);
 173         /// disconnect from signals in the given BufferView
 174         void disconnectBufferView();
 175         /// connect to signals in the given buffer
 176         void connectBuffer(Buffer & buf);
 177         /// disconnect from signals in the given buffer
 178         void disconnectBuffer();
 179         ///
 180         void dragEnterEvent(QDragEnterEvent * ev);
 181         ///
 182         void dropEvent(QDropEvent * ev);
 183         /// make sure we quit cleanly
 184         void closeEvent(QCloseEvent * e);
 185         ///
 186         void showEvent(QShowEvent *);
 187
 188         /// in order to catch Tab key press.
 189         bool event(QEvent * e);
 190         bool focusNextPrevChild(bool);
 191
 192         ///
 193         struct GuiViewPrivate;
 194         GuiViewPrivate & d;
 195
 196 public:
 197         ///
 198         /// dialogs for this view
 199         ///
 200
 201         ///
 202         void resetDialogs();
 203
 204         /// Hide all visible dialogs
 205         void hideAll() const;
 206
 207         /// Update all visible dialogs.
 208         /**
 209          *  Check the status of all visible dialogs and disable or reenable
 210          *  them as appropriate.
 211          *
 212          *  Disabling is needed for example when a dialog is open and the
 213          *  cursor moves to a position where the corresponding inset is not
 214          *  allowed.
 215          */
 216         void updateDialogs();
 217
 218         /** \param name == "bibtex", "citation" etc; an identifier used to
 219             launch a particular dialog.
 220             \param data is a string representation of the Inset contents.
 221             It is often little more than the output from Inset::write.
 222             It is passed to, and parsed by, the frontend dialog.
 223             Several of these dialogs do not need any data,
 224             so it defaults to string().
 225             \param inset ownership is _not_ passed to the frontend dialog.
 226             It is stored internally and used by the kernel to ascertain
 227             what to do with the FuncRequest dispatched from the frontend
 228             dialog on 'Apply'; should it be used to create a new inset at
 229             the current cursor position or modify an existing, 'open' inset?
 230         */
 231         void showDialog(std::string const & name,
 232                 std::string const & data, Inset * inset = 0);
 233
 234         /** \param name == "citation", "bibtex" etc; an identifier used
 235             to reset the contents of a particular dialog with \param data.
 236             See the comments to 'show', above.
 237         */
 238         void updateDialog(std::string const & name, std::string const & data);
 239
 240         /** All Dialogs of the given \param name will be closed if they are
 241             connected to the given \param inset.
 242         */
 243         void hideDialog(std::string const & name, Inset * inset);
 244         ///
 245         void disconnectDialog(std::string const & name);
 246
 247         ///
 248         void updateCompletion(Cursor & cur, bool start, bool keep);
 249
 250 private:
 251         ///
 252         void saveLayout() const;
 253         ///
 254         bool restoreLayout();
 255         ///
 256         GuiToolbar * toolbar(std::string const & name);
 257         ///
 258         void constructToolbars();
 259         ///
 260         void initToolbars();
 261         ///
 262         void lfunUiToggle(FuncRequest const & cmd);
 263         ///
 264         void toggleFullScreen();
 265         ///
 266         void insertLyXFile(docstring const & fname);
 267         ///
 268         void insertPlaintextFile(docstring const & fname,
 269                 bool asParagraph);
 270
 271         /// Save a buffer as a new file.
 272         /**
 273         Write a buffer to a new file name and rename the buffer
 274     according to the new file name.
 275
 276     This function is e.g. used by menu callbacks and
 277     LFUN_BUFFER_WRITE_AS.
 278
 279     If 'newname' is empty, the user is asked via a
 280     dialog for the buffer's new name and location.
 281
 282     If 'newname' is non-empty and has an absolute path, that is used.
 283     Otherwise the base directory of the buffer is used as the base
 284     for any relative path in 'newname'.
 285         */
 286         bool renameBuffer(Buffer & b, docstring const & newname);
 287         ///
 288         bool saveBuffer(Buffer & b);
 289         ///
 290         bool closeBuffer(Buffer & buf, bool tolastopened = false);
 291
 292         ///
 293         Inset * getOpenInset(std::string const & name) const;
 294
 295         /// Is the dialog currently visible?
 296         bool isDialogVisible(std::string const & name) const;
 297         ///
 298         Dialog * findOrBuild(std::string const & name, bool hide_it);
 299         ///
 300         Dialog * build(std::string const & name);
 301
 302         /// This view ID.
 303         int id_;
 304
 305         /// flag to avoid two concurrent close events.
 306         bool closing_;
 307 };
 308
 309 } // namespace frontend
 310 } // namespace lyx
 311
 312 #endif // GUIVIEW_H