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
  20 #include "support/strfwd.h"
  21
  22 #include <QMainWindow>
  23
  24 class QCloseEvent;
  25 class QDragEnterEvent;
  26 class QDropEvent;
  27 class QMenu;
  28 class QShowEvent;
  29
  30
  31 namespace lyx {
  32
  33 namespace support { class FileName; }
  34
  35 class Buffer;
  36 class BufferView;
  37 class Cursor;
  38 class DispatchResult;
  39 class FuncStatus;
  40 class FuncRequest;
  41 class Inset;
  42
  43 namespace frontend {
  44
  45 class Dialog;
  46 class LayoutBox;
  47 class GuiToolbar;
  48 class GuiWorkArea;
  49 class TabWorkArea;
  50 class TocModels;
  51 class ToolbarInfo;
  52
  53 /**
  54  * GuiView - Qt4 main LyX window
  55  *
  56  * This class represents the main LyX window and provides
  57  * accessor functions to its content.
  58  *
  59  * Note: a QObject emits a destroyed(QObject *) Qt signal when it
  60  * is deleted. This might be useful for closing other dialogs
  61  * depending on a given GuiView.
  62  */
  63 class GuiView : public QMainWindow, public GuiBufferViewDelegate,
  64         public GuiBufferDelegate
  65 {
  66         Q_OBJECT
  67
  68 public:
  69         /// create a main window of the given dimensions
  70         GuiView(int id);
  71
  72         ~GuiView();
  73
  74         /// closes the view such that the view knows that is closed
  75         /// programmatically and not by the user clicking the x.
  76         bool closeScheduled();
  77
  78         int id() const { return id_; }
  79
  80         ///
  81         void setBusy(bool);
  82         /// are we busy ?
  83         bool busy() const;
  84
  85         /// \name Generic accessor functions
  86         //@{
  87         /// The current BufferView refers to the BufferView that has the focus,
  88         /// including for example the one that is created when you use the
  89         /// advanced search and replace pane.
  90         /// \return the currently selected buffer view.
  91         BufferView * currentBufferView();
  92         BufferView const * currentBufferView() const;
  93
  94         /// The document BufferView always refers to the view's main document
  95         /// BufferView. So, even if the BufferView in e.g., the advanced
  96         /// search and replace pane has the focus.
  97         /// \return the current document buffer view.
  98         BufferView * documentBufferView();
  99         BufferView const * documentBufferView() const;
 100
 101         void newDocument(std::string const & filename,
 102                 bool fromTemplate);
 103
 104         /// display a message in the view
 105         /// could be called from any thread
 106         void message(docstring const &);
 107
 108         bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
 109         /// dispatch command.
 110         /// \return true if the \c FuncRequest has been dispatched.
 111         void dispatch(FuncRequest const & cmd, DispatchResult & dr);
 112
 113         void restartCursor();
 114         /// Update the completion popup and the inline completion state.
 115         /// If \c start is true, then a new completion might be started.
 116         /// If \c keep is true, an active completion will be kept active
 117         /// even though the cursor moved. The update flags of \c cur might
 118         /// be changed.
 119         void updateCompletion(Cursor & cur, bool start, bool keep);
 120
 121         ///
 122         void setFocus();
 123
 124         ///
 125         void focusInEvent(QFocusEvent * e);
 126         /// set a buffer to the current workarea.
 127         void setBuffer(Buffer * b); ///< \c Buffer to set.
 128
 129         /// load a document into the current workarea.
 130         Buffer * loadDocument(
 131                 support::FileName const &  name, ///< File to load.
 132                 bool tolastfiles = true  ///< append to the "Open recent" menu?
 133                 );
 134
 135         /// add toolbar, if newline==true, add a toolbar break before the toolbar
 136         GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
 137         void updateStatusBar();
 138
 139         /// updates the possible layouts selectable
 140         void updateLayoutList();
 141         void updateToolbars();
 142         QMenu * createPopupMenu();
 143
 144         ///
 145         LayoutBox * getLayoutDialog() const;
 146
 147         /// hides the workarea and makes sure it is clean
 148         bool hideWorkArea(GuiWorkArea * wa);
 149         /// closes the workarea
 150         bool closeWorkArea(GuiWorkArea * wa);
 151         /// closes the buffer
 152         bool closeBuffer(Buffer & buf);
 153         ///
 154         void openDocument(std::string const & filename);
 155         ///
 156         void importDocument(std::string const &);
 157
 158         /// \name GuiBufferDelegate.
 159         //@{
 160         void resetAutosaveTimers();
 161         void errors(std::string const &, bool from_master = false);
 162         void structureChanged();
 163         void updateTocItem(std::string const &, DocIterator const &);
 164         //@}
 165
 166         ///
 167         TocModels & tocModels();
 168
 169         /// called on timeout
 170         void autoSave();
 171
 172         /// check for external change of any opened buffer, mainly for svn usage
 173         void checkExternallyModifiedBuffers();
 174
 175         /** redraw \c inset in all the BufferViews in which it is currently
 176          *  visible. If successful return a pointer to the owning Buffer.
 177          */
 178         Buffer const * updateInset(Inset const *);
 179
 180         /// \return the \c Workarea associated to \p  Buffer
 181         /// \retval 0 if no \c WorkArea is found.
 182         GuiWorkArea * workArea(Buffer & buffer);
 183
 184         /// Add a \c WorkArea
 185         /// \return the \c Workarea associated to \p  Buffer
 186         /// \retval 0 if no \c WorkArea is found.
 187         GuiWorkArea * addWorkArea(Buffer & buffer);
 188         /// \param work_area The current \c WorkArea, or \c NULL
 189         void setCurrentWorkArea(GuiWorkArea * work_area);
 190         ///
 191         void removeWorkArea(GuiWorkArea * work_area);
 192         /// return the current WorkArea (the one that has the focus).
 193         GuiWorkArea const * currentWorkArea() const;
 194         /// return the current WorkArea (the one that has the focus).
 195         GuiWorkArea * currentWorkArea();
 196
 197         /// return the current document WorkArea (it may not have the focus).
 198         GuiWorkArea const * currentMainWorkArea() const;
 199         /// return the current document WorkArea (it may not have the focus).
 200         GuiWorkArea * currentMainWorkArea();
 201
 202 Q_SIGNALS:
 203         void closing(int);
 204         void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
 205
 206 public Q_SLOTS:
 207         /// idle timeout.
 208         /// clear any temporary message and replace with current status.
 209         void clearMessage();
 210
 211 private Q_SLOTS:
 212         ///
 213         void updateWindowTitle(GuiWorkArea * wa);
 214         ///
 215         void resetWindowTitleAndIconText();
 216
 217         ///
 218         void on_currentWorkAreaChanged(GuiWorkArea *);
 219         ///
 220         void on_lastWorkAreaRemoved();
 221
 222         /// slots to change the icon size
 223         void smallSizedIcons();
 224         void normalSizedIcons();
 225         void bigSizedIcons();
 226
 227         /// For completion of autosave or exporrt threads.
 228         void threadFinished();
 229
 230         /// must be called in GUI thread
 231         void doShowDialog(QString const & qname, QString const & qdata,
 232         Inset * inset);
 233
 234         /// must be called from GUI thread
 235         void updateStatusBarMessage(QString const & str);
 236         void clearMessageText();
 237
 238 private:
 239         /// Open given child document in current buffer directory.
 240         void openChildDocument(std::string const & filename);
 241         /// Close current document buffer.
 242         bool closeBuffer();
 243         /// Close all document buffers.
 244         bool closeBufferAll();
 245         ///
 246         TabWorkArea * addTabWorkArea();
 247
 248         /// connect to signals in the given BufferView
 249         void connectBufferView(BufferView & bv);
 250         /// disconnect from signals in the given BufferView
 251         void disconnectBufferView();
 252         /// connect to signals in the given buffer
 253         void connectBuffer(Buffer & buf);
 254         /// disconnect from signals in the given buffer
 255         void disconnectBuffer();
 256         ///
 257         void dragEnterEvent(QDragEnterEvent * ev);
 258         ///
 259         void dropEvent(QDropEvent * ev);
 260         /// make sure we quit cleanly
 261         void closeEvent(QCloseEvent * e);
 262         ///
 263         void showEvent(QShowEvent *);
 264
 265         /// in order to catch Tab key press.
 266         bool event(QEvent * e);
 267         bool focusNextPrevChild(bool);
 268
 269         ///
 270         bool goToFileRow(std::string const & argument);
 271
 272         ///
 273         struct GuiViewPrivate;
 274         GuiViewPrivate & d;
 275
 276 public:
 277         ///
 278         /// dialogs for this view
 279         ///
 280
 281         ///
 282         void resetDialogs();
 283
 284         /// Hide all visible dialogs
 285         void hideAll() const;
 286
 287         /// Update all visible dialogs.
 288         /**
 289          *  Check the status of all visible dialogs and disable or reenable
 290          *  them as appropriate.
 291          *
 292          *  Disabling is needed for example when a dialog is open and the
 293          *  cursor moves to a position where the corresponding inset is not
 294          *  allowed.
 295          */
 296         void updateDialogs();
 297
 298         /** Show dialog could be called from arbitrary threads.
 299             \param name == "bibtex", "citation" etc; an identifier used to
 300             launch a particular dialog.
 301             \param data is a string representation of the Inset contents.
 302             It is often little more than the output from Inset::write.
 303             It is passed to, and parsed by, the frontend dialog.
 304             Several of these dialogs do not need any data,
 305             so it defaults to string().
 306             \param inset ownership is _not_ passed to the frontend dialog.
 307             It is stored internally and used by the kernel to ascertain
 308             what to do with the FuncRequest dispatched from the frontend
 309             dialog on 'Apply'; should it be used to create a new inset at
 310             the current cursor position or modify an existing, 'open' inset?
 311         */
 312         void showDialog(std::string const & name,
 313                 std::string const & data, Inset * inset = 0);
 314
 315         /** \param name == "citation", "bibtex" etc; an identifier used
 316             to reset the contents of a particular dialog with \param data.
 317             See the comments to 'show', above.
 318         */
 319         void updateDialog(std::string const & name, std::string const & data);
 320
 321         /** All Dialogs of the given \param name will be closed if they are
 322             connected to the given \param inset.
 323         */
 324         void hideDialog(std::string const & name, Inset * inset);
 325         ///
 326         void disconnectDialog(std::string const & name);
 327
 328 private:
 329         ///
 330         void saveLayout() const;
 331         ///
 332         bool restoreLayout();
 333         ///
 334         GuiToolbar * toolbar(std::string const & name);
 335         ///
 336         void constructToolbars();
 337         ///
 338         void initToolbars();
 339         ///
 340         bool lfunUiToggle(std::string const & ui_component);
 341         ///
 342         void toggleFullScreen();
 343         ///
 344         void insertLyXFile(docstring const & fname);
 345         ///
 346         void insertPlaintextFile(docstring const & fname,
 347                 bool asParagraph);
 348
 349         /// Save a buffer as a new file.
 350         /**
 351         Write a buffer to a new file name and rename the buffer
 352     according to the new file name.
 353
 354     This function is e.g. used by menu callbacks and
 355     LFUN_BUFFER_WRITE_AS.
 356
 357     If 'newname' is empty, the user is asked via a
 358     dialog for the buffer's new name and location.
 359
 360     If 'newname' is non-empty and has an absolute path, that is used.
 361     Otherwise the base directory of the buffer is used as the base
 362     for any relative path in 'newname'.
 363         */
 364         bool renameBuffer(Buffer & b, docstring const & newname);
 365         ///
 366         bool saveBuffer(Buffer & b);
 367         /// closes a workarea, if close_buffer is true the buffer will
 368         /// also be released, otherwise the buffer will be hidden.
 369         bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
 370         /// closes the tabworkarea and all tabs. If we are in a close event,
 371         /// all buffers will be closed, otherwise they will be hidden.
 372         bool closeTabWorkArea(TabWorkArea * twa);
 373         /// gives the user the possibility to save his work
 374         /// or to discard the changes. If hiding is true, the
 375         /// document will be reloaded.
 376         bool saveBufferIfNeeded(Buffer & buf, bool hiding);
 377         /// closes all workareas
 378         bool closeWorkAreaAll();
 379         /// write all open workareas into the session file
 380         void writeSession() const;
 381         /// is the buffer in this workarea also shown in another tab ?
 382         /// This tab can either be in the same view or in another one.
 383         bool inMultiTabs(GuiWorkArea * wa);
 384         /// is the buffer in this workarea also shown in another view ?
 385         bool inMultiViews(GuiWorkArea * wa);
 386         ///
 387         enum NextOrPrevious {
 388                 NEXTBUFFER,
 389                 PREVBUFFER
 390         };
 391         ///
 392         void gotoNextOrPreviousBuffer(NextOrPrevious np);
 393
 394         /// Is the dialog currently visible?
 395         bool isDialogVisible(std::string const & name) const;
 396         ///
 397         Dialog * findOrBuild(std::string const & name, bool hide_it);
 398         ///
 399         Dialog * build(std::string const & name);
 400         ///
 401         void reloadBuffer();
 402         ///
 403         void dispatchVC(FuncRequest const & cmd);
 404         ///
 405         void showMessage();
 406
 407         /// This view ID.
 408         int id_;
 409
 410         /// flag to avoid two concurrent close events.
 411         bool closing_;
 412         /// if the view is busy the cursor shouldn't blink for instance.
 413         bool busy_;
 414 };
 415
 416 } // namespace frontend
 417 } // namespace lyx
 418
 419 #endif // GUIVIEW_H