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 LayoutBox;
  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         /// LyXView inherited methods.
  66         ///@{
  67         int id() const { return id_; };
  68         void setBusy(bool);
  69         BufferView * currentBufferView();
  70         BufferView const * currentBufferView() const;
  71         BufferView * documentBufferView();
  72         BufferView const * documentBufferView() const;
  73         void setBuffer(Buffer * b);
  74         bool closeBuffer();
  75         bool closeBufferAll();
  76         bool hasFocus() const;
  77         Buffer * loadDocument(support::FileName const &  name,
  78                 bool tolastfiles = true);
  79         void newDocument(std::string const & filename,
  80                 bool fromTemplate);
  81         void message(docstring const &);
  82         bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
  83         bool dispatch(FuncRequest const & cmd);
  84         void restartCursor();
  85         void updateCompletion(Cursor & cur, bool start, bool keep);
  86         void setFocus();
  87         ///@}
  88
  89         /// add toolbar, if newline==true, add a toolbar break before the toolbar
  90         GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
  91         void updateStatusBar();
  92
  93         /// updates the possible layouts selectable
  94         void updateLayoutList();
  95         void updateToolbars();
  96         QMenu * createPopupMenu();
  97
  98         ///
  99         LayoutBox * getLayoutDialog() const;
 100
 101         /// hides the workarea and makes sure it is clean
 102         bool hideWorkArea(GuiWorkArea * wa);
 103         /// closes the workarea
 104         bool closeWorkArea(GuiWorkArea * wa);
 105         ///
 106         void openDocument(std::string const & filename);
 107         ///
 108         void importDocument(std::string const &);
 109
 110         /// GuiBufferDelegate.
 111         ///@{
 112         void resetAutosaveTimers();
 113         void errors(std::string const &, bool from_master = false);
 114         void structureChanged();
 115         void updateTocItem(std::string const &, DocIterator const &);
 116         ///@}
 117
 118         ///
 119         TocModels & tocModels();
 120
 121         /// called on timeout
 122         void autoSave();
 123
 124         /** redraw \c inset in all the BufferViews in which it is currently
 125          *  visible. If successful return a pointer to the owning Buffer.
 126          */
 127         Buffer const * updateInset(Inset const *);
 128
 129         /// \return the \c Workarea associated to \p  Buffer
 130         /// \retval 0 if no \c WorkArea is found.
 131         GuiWorkArea * workArea(Buffer & buffer);
 132
 133         /// Add a \c WorkArea
 134         /// \return the \c Workarea associated to \p  Buffer
 135         /// \retval 0 if no \c WorkArea is found.
 136         GuiWorkArea * addWorkArea(Buffer & buffer);
 137         /// \param work_area The current \c WorkArea, or \c NULL
 138         void setCurrentWorkArea(GuiWorkArea * work_area);
 139         ///
 140         void removeWorkArea(GuiWorkArea * work_area);
 141         /// return the current WorkArea (the one that has the focus).
 142         GuiWorkArea const * currentWorkArea() const;
 143         /// return the current WorkArea (the one that has the focus).
 144         GuiWorkArea * currentWorkArea();
 145
 146         /// return the current document WorkArea (it may not have the focus).
 147         GuiWorkArea const * currentMainWorkArea() const;
 148         /// return the current document WorkArea (it may not have the focus).
 149         GuiWorkArea * currentMainWorkArea();
 150
 151 Q_SIGNALS:
 152         void closing(int);
 153
 154 public Q_SLOTS:
 155         /// idle timeout.
 156         /// clear any temporary message and replace with current status.
 157         void clearMessage();
 158
 159 private Q_SLOTS:
 160         ///
 161         void updateWindowTitle(GuiWorkArea * wa);
 162         ///
 163         void resetWindowTitleAndIconText();
 164
 165         ///
 166         void on_currentWorkAreaChanged(GuiWorkArea *);
 167         ///
 168         void on_lastWorkAreaRemoved();
 169
 170         /// slots to change the icon size
 171         void smallSizedIcons();
 172         void normalSizedIcons();
 173         void bigSizedIcons();
 174
 175 private:
 176         ///
 177         TabWorkArea * addTabWorkArea();
 178
 179         /// connect to signals in the given BufferView
 180         void connectBufferView(BufferView & bv);
 181         /// disconnect from signals in the given BufferView
 182         void disconnectBufferView();
 183         /// connect to signals in the given buffer
 184         void connectBuffer(Buffer & buf);
 185         /// disconnect from signals in the given buffer
 186         void disconnectBuffer();
 187         ///
 188         void dragEnterEvent(QDragEnterEvent * ev);
 189         ///
 190         void dropEvent(QDropEvent * ev);
 191         /// make sure we quit cleanly
 192         void closeEvent(QCloseEvent * e);
 193         ///
 194         void showEvent(QShowEvent *);
 195
 196         /// in order to catch Tab key press.
 197         bool event(QEvent * e);
 198         bool focusNextPrevChild(bool);
 199
 200         ///
 201         struct GuiViewPrivate;
 202         GuiViewPrivate & d;
 203
 204 public:
 205         ///
 206         /// dialogs for this view
 207         ///
 208
 209         ///
 210         void resetDialogs();
 211
 212         /// Hide all visible dialogs
 213         void hideAll() const;
 214
 215         /// Update all visible dialogs.
 216         /**
 217          *  Check the status of all visible dialogs and disable or reenable
 218          *  them as appropriate.
 219          *
 220          *  Disabling is needed for example when a dialog is open and the
 221          *  cursor moves to a position where the corresponding inset is not
 222          *  allowed.
 223          */
 224         void updateDialogs();
 225
 226         /** \param name == "bibtex", "citation" etc; an identifier used to
 227             launch a particular dialog.
 228             \param data is a string representation of the Inset contents.
 229             It is often little more than the output from Inset::write.
 230             It is passed to, and parsed by, the frontend dialog.
 231             Several of these dialogs do not need any data,
 232             so it defaults to string().
 233             \param inset ownership is _not_ passed to the frontend dialog.
 234             It is stored internally and used by the kernel to ascertain
 235             what to do with the FuncRequest dispatched from the frontend
 236             dialog on 'Apply'; should it be used to create a new inset at
 237             the current cursor position or modify an existing, 'open' inset?
 238         */
 239         void showDialog(std::string const & name,
 240                 std::string const & data, Inset * inset = 0);
 241
 242         /** \param name == "citation", "bibtex" etc; an identifier used
 243             to reset the contents of a particular dialog with \param data.
 244             See the comments to 'show', above.
 245         */
 246         void updateDialog(std::string const & name, std::string const & data);
 247
 248         /** All Dialogs of the given \param name will be closed if they are
 249             connected to the given \param inset.
 250         */
 251         void hideDialog(std::string const & name, Inset * inset);
 252         ///
 253         void disconnectDialog(std::string const & name);
 254
 255 private:
 256         ///
 257         void saveLayout() const;
 258         ///
 259         bool restoreLayout();
 260         ///
 261         GuiToolbar * toolbar(std::string const & name);
 262         ///
 263         void constructToolbars();
 264         ///
 265         void initToolbars();
 266         ///
 267         void lfunUiToggle(FuncRequest const & cmd);
 268         ///
 269         void toggleFullScreen();
 270         ///
 271         void insertLyXFile(docstring const & fname);
 272         ///
 273         void insertPlaintextFile(docstring const & fname,
 274                 bool asParagraph);
 275
 276         /// Save a buffer as a new file.
 277         /**
 278         Write a buffer to a new file name and rename the buffer
 279     according to the new file name.
 280
 281     This function is e.g. used by menu callbacks and
 282     LFUN_BUFFER_WRITE_AS.
 283
 284     If 'newname' is empty, the user is asked via a
 285     dialog for the buffer's new name and location.
 286
 287     If 'newname' is non-empty and has an absolute path, that is used.
 288     Otherwise the base directory of the buffer is used as the base
 289     for any relative path in 'newname'.
 290         */
 291         bool renameBuffer(Buffer & b, docstring const & newname);
 292         ///
 293         bool saveBuffer(Buffer & b);
 294         /// closes a workarea, if close_buffer is true the buffer will
 295         /// also be released, otherwise the buffer will be hidden.
 296         bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
 297         /// closes the tabworkarea and all tabs. If we are in a close event,
 298         /// all buffers will be closed, otherwise they will be hidden.
 299         bool closeTabWorkArea(TabWorkArea * twa);
 300         /// gives the user the possibility to save his work
 301         /// or to discard the changes. If hiding is true, the
 302         /// document will be reloaded.
 303         bool saveBufferIfNeeded(Buffer & buf, bool hiding);
 304         /// closes all workareas
 305         bool closeWorkAreaAll();
 306         /// write all open workareas into the session file
 307         void writeSession() const;
 308         /// is the buffer in this workarea also shown in another tab ?
 309         /// This tab can either be in the same view or in another one.
 310         bool inMultiTabs(GuiWorkArea * wa);
 311         /// is the buffer in this workarea also shown in another view ?
 312         bool inMultiViews(GuiWorkArea * wa);
 313         ///
 314         enum NextOrPrevious {
 315                 NEXTBUFFER,
 316                 PREVBUFFER
 317         };
 318         ///
 319         void gotoNextOrPreviousBuffer(NextOrPrevious np);
 320
 321         ///
 322         Inset * getOpenInset(std::string const & name) const;
 323
 324         /// Is the dialog currently visible?
 325         bool isDialogVisible(std::string const & name) const;
 326         ///
 327         Dialog * findOrBuild(std::string const & name, bool hide_it);
 328         ///
 329         Dialog * build(std::string const & name);
 330         ///
 331         void reloadBuffer();
 332         ///
 333         void dispatchVC(FuncRequest const & cmd);
 334
 335         /// This view ID.
 336         int id_;
 337
 338         /// flag to avoid two concurrent close events.
 339         bool closing_;
 340 };
 341
 342 } // namespace frontend
 343 } // namespace lyx
 344
 345 #endif // GUIVIEW_H