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 class ToolbarInfo;
  36
  37 namespace frontend {
  38
  39 class Dialog;
  40 class GuiLayoutBox;
  41 class GuiToolbar;
  42 class GuiWorkArea;
  43 class TabWorkArea;
  44
  45 /**
  46  * GuiView - Qt4 implementation of LyXView
  47  *
  48  * qt4-private implementation of the main LyX window.
  49  *
  50  * Note: a QObject emits a destroyed(QObject *) Qt signal when it
  51  * is deleted. This might be useful for closing other dialogs
  52  * depending on a given GuiView.
  53  */
  54 class GuiView : public QMainWindow, public LyXView, public GuiBufferViewDelegate,
  55         public GuiBufferDelegate
  56 {
  57         Q_OBJECT
  58 public:
  59         /// create a main window of the given dimensions
  60         GuiView(int id);
  61
  62         ~GuiView();
  63
  64         ///
  65         int id() const { return id_; }
  66         void setFocus();
  67         void setBusy(bool);
  68         /// returns true if this view has the focus.
  69         bool hasFocus() const;
  70
  71         /// add toolbar, if newline==true, add a toolbar break before the toolbar
  72         GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
  73         virtual void updateStatusBar();
  74         virtual void message(docstring const & str);
  75
  76         /// updates the possible layouts selectable
  77         void updateLayoutList();
  78         void updateToolbars();
  79         QMenu * createPopupMenu();
  80         FuncStatus getStatus(FuncRequest const & cmd);
  81         bool dispatch(FuncRequest const & cmd);
  82
  83         ///
  84         void setLayoutDialog(GuiLayoutBox *);
  85
  86         /// \return the buffer currently shown in this window
  87         Buffer * buffer();
  88         Buffer const * buffer() const;
  89         /// set a buffer to the current workarea.
  90         void setBuffer(Buffer * b); ///< \c Buffer to set.
  91         ///
  92         bool closeBuffer();
  93         /// load a document into the current workarea.
  94         Buffer * loadDocument(support::FileName const &  name, ///< File to load.
  95                 bool tolastfiles = true);  ///< append to the "Open recent" menu?
  96         ///
  97         void openDocument(std::string const & filename);
  98         ///
  99         void importDocument(std::string const &);
 100         ///
 101         void newDocument(std::string const & filename, bool fromTemplate);
 102
 103         /// GuiBufferDelegate.
 104         ///@{
 105         void resetAutosaveTimers();
 106         void errors(std::string const &);
 107         void structureChanged() { updateToc(); }
 108         ///@}
 109
 110         /// called on timeout
 111         void autoSave();
 112         ///
 113         void updateEmbeddedFiles();
 114
 115         /// \return the current buffer view.
 116         BufferView * view();
 117
 118         /** redraw \c inset in all the BufferViews in which it is currently
 119          *  visible. If successful return a pointer to the owning Buffer.
 120          */
 121         Buffer const * updateInset(Inset const *);
 122         ///
 123         void restartCursor();
 124
 125         /// \return the \c Workarea associated to \p  Buffer
 126         /// \retval 0 if no \c WorkArea is found.
 127         GuiWorkArea * workArea(Buffer & buffer);
 128
 129         /// Add a \c WorkArea
 130         /// \return the \c Workarea associated to \p  Buffer
 131         /// \retval 0 if no \c WorkArea is found.
 132         GuiWorkArea * addWorkArea(Buffer & buffer);
 133         ///
 134         void setCurrentWorkArea(GuiWorkArea * work_area);
 135         ///
 136         void removeWorkArea(GuiWorkArea * work_area);
 137         /// return the current WorkArea (the one that has the focus).
 138         GuiWorkArea const * currentWorkArea() const;
 139
 140 Q_SIGNALS:
 141         void closing(int);
 142
 143 public Q_SLOTS:
 144         /// idle timeout.
 145         /// clear any temporary message and replace with current status.
 146         void clearMessage();
 147
 148 private Q_SLOTS:
 149         ///
 150         void updateWindowTitle(GuiWorkArea * wa);
 151
 152         ///
 153         void on_currentWorkAreaChanged(GuiWorkArea *);
 154
 155         /// slots to change the icon size
 156         void smallSizedIcons();
 157         void normalSizedIcons();
 158         void bigSizedIcons();
 159
 160 private:
 161         ///
 162         TabWorkArea * addTabWorkArea();
 163
 164         /// connect to signals in the given BufferView
 165         void connectBufferView(BufferView & bv);
 166         /// disconnect from signals in the given BufferView
 167         void disconnectBufferView();
 168         /// connect to signals in the given buffer
 169         void connectBuffer(Buffer & buf);
 170         /// disconnect from signals in the given buffer
 171         void disconnectBuffer();
 172         ///
 173         void updateToc();
 174         ///
 175         void dragEnterEvent(QDragEnterEvent * ev);
 176         ///
 177         void dropEvent(QDropEvent * ev);
 178         /// make sure we quit cleanly
 179         void closeEvent(QCloseEvent * e);
 180         ///
 181         void showEvent(QShowEvent *);
 182
 183         /// in order to catch Tab key press.
 184         bool event(QEvent * e);
 185         bool focusNextPrevChild(bool);
 186
 187         ///
 188         struct GuiViewPrivate;
 189         GuiViewPrivate & d;
 190
 191 public:
 192         ///
 193         /// dialogs for this view
 194         ///
 195
 196         ///
 197         void resetDialogs();
 198
 199         /** Check the status of all visible dialogs and disable or reenable
 200          *  them as appropriate.
 201          *
 202          *  Disabling is needed for example when a dialog is open and the
 203          *  cursor moves to a position where the corresponding inset is not
 204          *  allowed.
 205          */
 206         void checkStatus();
 207
 208         /// Hide all visible dialogs
 209         void hideAll() const;
 210         /// Hide any dialogs that require a buffer for them to operate
 211         void hideBufferDependent() const;
 212         /** Update visible, buffer-dependent dialogs
 213             If the bool is true then a buffer change has occurred
 214             else it is still the same buffer.
 215          */
 216         void updateBufferDependent(bool) const;
 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 update 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 lfunUiToggle(FuncRequest const & cmd);
 253
 254         ///
 255         void insertLyXFile(docstring const & fname);
 256         ///
 257         void insertPlaintextFile(docstring const & fname,
 258                 bool asParagraph);
 259
 260         /// Save a buffer as a new file.
 261         /**
 262         Write a buffer to a new file name and rename the buffer
 263     according to the new file name.
 264
 265     This function is e.g. used by menu callbacks and
 266     LFUN_BUFFER_WRITE_AS.
 267
 268     If 'newname' is empty, the user is asked via a
 269     dialog for the buffer's new name and location.
 270
 271     If 'newname' is non-empty and has an absolute path, that is used.
 272     Otherwise the base directory of the buffer is used as the base
 273     for any relative path in 'newname'.
 274         */
 275         bool renameBuffer(Buffer & b, docstring const & newname);
 276         ///
 277         bool saveBuffer(Buffer & b);
 278         ///
 279         bool closeBuffer(Buffer & buf);
 280
 281         ///
 282         Inset * getOpenInset(std::string const & name) const;
 283
 284         /// Is the dialog currently visible?
 285         bool isDialogVisible(std::string const & name) const;
 286         ///
 287         Dialog * find_or_build(std::string const & name);
 288         ///
 289         Dialog * build(std::string const & name);
 290
 291         /// This view ID.
 292         int id_;
 293 };
 294
 295 } // namespace frontend
 296 } // namespace lyx
 297
 298 #endif // GUIVIEW_H