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 #include <QMenu>
  24
  25 class QCloseEvent;
  26 class QDragEnterEvent;
  27 class QDropEvent;
  28 class QLabel;
  29 class QShowEvent;
  30
  31
  32 namespace lyx {
  33
  34 namespace support { class FileName; }
  35
  36 class Buffer;
  37 class BufferView;
  38 class Cursor;
  39 class DispatchResult;
  40 class FuncStatus;
  41 class FuncRequest;
  42 class Inset;
  43
  44 namespace frontend {
  45
  46 class Dialog;
  47 class LayoutBox;
  48 class GuiToolbar;
  49 class GuiWorkArea;
  50 class TabWorkArea;
  51 class TocModels;
  52 class ToolbarInfo;
  53
  54 /**
  55  * GuiView - Qt main LyX window
  56  *
  57  * This class represents the main LyX window and provides
  58  * accessor functions to its content.
  59  *
  60  * Note: a QObject emits a destroyed(QObject *) Qt signal when it
  61  * is deleted. This might be useful for closing other dialogs
  62  * depending on a given GuiView.
  63  */
  64 class GuiView : public QMainWindow, public GuiBufferViewDelegate,
  65         public GuiBufferDelegate
  66 {
  67         Q_OBJECT
  68
  69 public:
  70         /// create a main window of the given dimensions
  71         GuiView(int id);
  72
  73         ~GuiView();
  74
  75         /// closes the view such that the view knows that is closed
  76         /// programmatically and not by the user clicking the x.
  77         bool closeScheduled();
  78
  79         /// Things that need to be done when the OSes session manager
  80         /// requests a log out.
  81         bool prepareAllBuffersForLogout();
  82
  83         int id() const { return id_; }
  84
  85         /// are we busy ?
  86         bool busy() const;
  87
  88         /// Signal that the any "auto" minibuffer can be closed now.
  89         void resetCommandExecute();
  90
  91         /// \name Generic accessor functions
  92         //@{
  93         /// The current BufferView refers to the BufferView that has the focus,
  94         /// including for example the one that is created when you use the
  95         /// advanced search and replace pane.
  96         /// \return the currently selected buffer view.
  97         BufferView * currentBufferView();
  98         BufferView const * currentBufferView() const;
  99
 100         /// The document BufferView always refers to the view's main document
 101         /// BufferView. So, even if the BufferView in e.g., the advanced
 102         /// search and replace pane has the focus.
 103         /// \return the current document buffer view.
 104         BufferView * documentBufferView();
 105         BufferView const * documentBufferView() const;
 106
 107         void newDocument(std::string const & filename,
 108                 bool fromTemplate);
 109
 110         /// display a message in the view
 111         /// could be called from any thread
 112         void message(docstring const &);
 113
 114         bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
 115         /// dispatch command.
 116         /// \return true if the \c FuncRequest has been dispatched.
 117         void dispatch(FuncRequest const & cmd, DispatchResult & dr);
 118
 119         void restartCaret();
 120         /// Update the completion popup and the inline completion state.
 121         /// If \c start is true, then a new completion might be started.
 122         /// If \c keep is true, an active completion will be kept active
 123         /// even though the cursor moved. The update flags of \c cur might
 124         /// be changed.
 125         void updateCompletion(Cursor & cur, bool start, bool keep);
 126
 127         ///
 128         void setFocus();
 129         bool hasFocus() const;
 130
 131         ///
 132         void focusInEvent(QFocusEvent * e);
 133         /// Add a Buffer to the View
 134         /// \param b Buffer to set.
 135         /// \param switch_to Whether to set it to the current workarea.
 136         void setBuffer(Buffer * b, bool switch_to = true);
 137
 138         /// load a document into the current workarea.
 139         Buffer * loadDocument(
 140                 support::FileName const &  name, ///< File to load.
 141                 bool tolastfiles = true  ///< append to the "Open recent" menu?
 142                 );
 143
 144         /// add toolbar, if newline==true, add a toolbar break before the toolbar
 145         GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
 146         void updateStatusBar();
 147
 148         /// updates the possible layouts selectable
 149         void updateLayoutList();
 150         void updateToolbars();
 151
 152         ///
 153         LayoutBox * getLayoutDialog() const;
 154
 155         /// hides the workarea and makes sure it is clean
 156         bool hideWorkArea(GuiWorkArea * wa);
 157         /// closes workarea; close buffer only if no other workareas point to it
 158         bool closeWorkArea(GuiWorkArea * wa);
 159         /// closes the buffer
 160         bool closeBuffer(Buffer & buf);
 161         ///
 162         void openDocument(std::string const & filename);
 163         ///
 164         void importDocument(std::string const &);
 165
 166         /// \name GuiBufferDelegate.
 167         //@{
 168         void resetAutosaveTimers();
 169         // shows an error list (possibly master's)
 170         // even if from_master is false, might show master's error list.
 171         // this function should only be called if there was an error (#11106).
 172         void errors(std::string const &, bool from_master = false);
 173         void structureChanged();
 174         void updateTocItem(std::string const &, DocIterator const &);
 175         //@}
 176
 177         ///
 178         TocModels & tocModels();
 179
 180         /// called on timeout
 181         void autoSave();
 182
 183         /// check for external change of any opened buffer, mainly for svn usage
 184         void checkExternallyModifiedBuffers();
 185
 186         /** redraw \c inset in all the BufferViews in which it is currently
 187          *  visible. If successful return a pointer to the owning Buffer.
 188          */
 189         Buffer const * updateInset(Inset const *);
 190
 191         /// \return the \c Workarea associated to \p  Buffer
 192         /// \retval 0 if no \c WorkArea is found.
 193         GuiWorkArea * workArea(Buffer & buffer);
 194         /// \return the \c Workarea at index \c index
 195         GuiWorkArea * workArea(int index);
 196
 197         /// Add a \c WorkArea
 198         /// \return the \c Workarea associated to \p  Buffer
 199         /// \retval 0 if no \c WorkArea is found.
 200         GuiWorkArea * addWorkArea(Buffer & buffer);
 201         /// \param work_area The current \c WorkArea, or \c NULL
 202         void setCurrentWorkArea(GuiWorkArea * work_area);
 203         ///
 204         void removeWorkArea(GuiWorkArea * work_area);
 205         /// return the current WorkArea (the one that has the focus).
 206         GuiWorkArea const * currentWorkArea() const;
 207         /// return the current WorkArea (the one that has the focus).
 208         GuiWorkArea * currentWorkArea();
 209
 210         /// return the current document WorkArea (it may not have the focus).
 211         GuiWorkArea const * currentMainWorkArea() const;
 212         /// return the current document WorkArea (it may not have the focus).
 213         GuiWorkArea * currentMainWorkArea();
 214
 215         /// Current ratio between physical pixels and device-independent pixels
 216         double pixelRatio() const;
 217
 218 Q_SIGNALS:
 219         void closing(int);
 220         void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
 221         // emitted when the work area or its buffer view changed
 222         void bufferViewChanged();
 223
 224 public Q_SLOTS:
 225         ///
 226         void setBusy(bool);
 227         /// idle timeout.
 228         /// clear any temporary message and replace with current status.
 229         void clearMessage();
 230         ///
 231         void updateWindowTitle(GuiWorkArea * wa);
 232         ///
 233         void disableShellEscape();
 234
 235 private Q_SLOTS:
 236         ///
 237         void resetWindowTitle();
 238
 239         ///
 240         void on_currentWorkAreaChanged(GuiWorkArea *);
 241         ///
 242         void onBufferViewChanged();
 243         ///
 244         void on_lastWorkAreaRemoved();
 245
 246         /// For completion of autosave or export threads.
 247         void processingThreadStarted();
 248         void processingThreadFinished();
 249         void autoSaveThreadFinished();
 250
 251         /// must be called in GUI thread
 252         void doShowDialog(QString const & qname, QString const & qdata,
 253         Inset * inset);
 254
 255         /// must be called from GUI thread
 256         void updateStatusBarMessage(QString const & str);
 257         void clearMessageText();
 258
 259         ///
 260         void toolBarPopup(const QPoint &pos);
 261
 262 private:
 263         /// Open given child document in current buffer directory.
 264         void openChildDocument(std::string const & filename);
 265         /// Close current document buffer.
 266         bool closeBuffer();
 267         /// Close all document buffers.
 268         bool closeBufferAll();
 269         ///
 270         TabWorkArea * addTabWorkArea();
 271
 272         /// connect to signals in the given BufferView
 273         void connectBufferView(BufferView & bv);
 274         /// disconnect from signals in the given BufferView
 275         void disconnectBufferView();
 276         /// connect to signals in the given buffer
 277         void connectBuffer(Buffer & buf);
 278         /// disconnect from signals in the given buffer
 279         void disconnectBuffer();
 280         ///
 281         void dragEnterEvent(QDragEnterEvent * ev);
 282         ///
 283         void dropEvent(QDropEvent * ev);
 284         /// make sure we quit cleanly
 285         void closeEvent(QCloseEvent * e);
 286         ///
 287         void showEvent(QShowEvent *);
 288
 289         /// in order to catch Tab key press.
 290         bool event(QEvent * e);
 291         bool focusNextPrevChild(bool);
 292
 293         ///
 294         bool goToFileRow(std::string const & argument);
 295
 296         ///
 297         class GuiViewPrivate;
 298         GuiViewPrivate & d;
 299
 300 public:
 301         ///
 302         /// dialogs for this view
 303         ///
 304
 305         ///
 306         void resetDialogs();
 307
 308         /// Hide all visible dialogs
 309         void hideAll() const;
 310
 311         /// Update all visible dialogs.
 312         /**
 313          *  Check the status of all visible dialogs and disable or reenable
 314          *  them as appropriate.
 315          *
 316          *  Disabling is needed for example when a dialog is open and the
 317          *  cursor moves to a position where the corresponding inset is not
 318          *  allowed.
 319          */
 320         void updateDialogs();
 321
 322         /** Show dialog could be called from arbitrary threads.
 323             \param name == "bibtex", "citation" etc; an identifier used to
 324             launch a particular dialog.
 325             \param data is a string representation of the Inset contents.
 326             It is often little more than the output from Inset::write.
 327             It is passed to, and parsed by, the frontend dialog.
 328             Several of these dialogs do not need any data,
 329             so it defaults to string().
 330             \param inset ownership is _not_ passed to the frontend dialog.
 331             It is stored internally and used by the kernel to ascertain
 332             what to do with the FuncRequest dispatched from the frontend
 333             dialog on 'Apply'; should it be used to create a new inset at
 334             the current cursor position or modify an existing, 'open' inset?
 335         */
 336         void showDialog(std::string const & name,
 337                 std::string const & data, Inset * inset = 0);
 338
 339         /** \param name == "citation", "bibtex" etc; an identifier used
 340             to reset the contents of a particular dialog with \param data.
 341             See the comments to 'show', above.
 342         */
 343         void updateDialog(std::string const & name, std::string const & data);
 344
 345         /** All Dialogs of the given \param name will be closed if they are
 346             connected to the given \param inset.
 347         */
 348         void hideDialog(std::string const & name, Inset * inset);
 349         ///
 350         void disconnectDialog(std::string const & name);
 351         ///
 352         bool develMode() const { return devel_mode_; }
 353
 354 private:
 355         /// Saves the layout and geometry of the window
 356         void saveLayout() const;
 357         /// Saves the settings of toolbars and all dialogs
 358         void saveUISettings() const;
 359         ///
 360         bool restoreLayout();
 361         ///
 362         GuiToolbar * toolbar(std::string const & name);
 363         ///
 364         void constructToolbars();
 365         ///
 366         void initToolbars();
 367         ///
 368         void initToolbar(std::string const & name);
 369         /// Update lock (all) toolbars position
 370         void updateLockToolbars();
 371         ///
 372         bool lfunUiToggle(std::string const & ui_component);
 373         ///
 374         void toggleFullScreen();
 375         ///
 376         void insertLyXFile(docstring const & fname);
 377         ///
 378         /// Open Export As ... dialog. \p iformat is the format the
 379         /// filter is initially set to.
 380         bool exportBufferAs(Buffer & b, docstring const & iformat);
 381
 382         ///
 383         enum RenameKind { LV_WRITE_AS, LV_VC_RENAME, LV_VC_COPY };
 384         /// Save a buffer as a new file.
 385         /**
 386         Write a buffer to a new file name and rename the buffer
 387     according to the new file name.
 388
 389     This function is e.g. used by menu callbacks and
 390     LFUN_BUFFER_WRITE_AS.
 391
 392     If 'newname' is empty, the user is asked via a
 393     dialog for the buffer's new name and location.
 394
 395     If 'newname' is non-empty and has an absolute path, that is used.
 396     Otherwise the base directory of the buffer is used as the base
 397     for any relative path in 'newname'.
 398
 399          \p kind controls what is done besides the pure renaming:
 400          * LV_WRITE_AS  => The buffer is written without version control actions.
 401          * LV_VC_RENAME => The file is renamed in version control.
 402          * LV_VC_COPY   => The file is copied in version control.
 403          */
 404         bool renameBuffer(Buffer & b, docstring const & newname,
 405                           RenameKind kind = LV_WRITE_AS);
 406         ///
 407         bool saveBuffer(Buffer & b);
 408         /// save and rename buffer to fn. If fn is empty, the buffer
 409         /// is just saved as the filename it already has.
 410         bool saveBuffer(Buffer & b, support::FileName const & fn);
 411         /// closes a workarea, if close_buffer is true the buffer will
 412         /// also be released, otherwise the buffer will be hidden.
 413         bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
 414         /// closes the tabworkarea and all tabs. If we are in a close event,
 415         /// all buffers will be closed, otherwise they will be hidden.
 416         bool closeTabWorkArea(TabWorkArea * twa);
 417         /// gives the user the possibility to save their work
 418         /// or to discard the changes. If hiding is true, the
 419         /// document will be reloaded.
 420         bool saveBufferIfNeeded(Buffer & buf, bool hiding);
 421         /// closes all workareas
 422         bool closeWorkAreaAll();
 423         /// write all open workareas into the session file
 424         void writeSession() const;
 425         /// is the buffer in this workarea also shown in another tab ?
 426         /// This tab can either be in the same view or in another one.
 427         bool inMultiTabs(GuiWorkArea * wa);
 428         /// is the buffer shown in some other view ?
 429         bool inOtherView(Buffer & buf);
 430         ///
 431         enum NextOrPrevious {
 432                 NEXTBUFFER,
 433                 PREVBUFFER
 434         };
 435         ///
 436         void gotoNextOrPreviousBuffer(NextOrPrevious np, bool const move);
 437
 438         /// Is the dialog currently visible?
 439         bool isDialogVisible(std::string const & name) const;
 440         ///
 441         Dialog * findOrBuild(std::string const & name, bool hide_it);
 442         ///
 443         Dialog * build(std::string const & name);
 444         ///
 445         bool reloadBuffer(Buffer & buffer);
 446         ///
 447         void dispatchVC(FuncRequest const & cmd, DispatchResult & dr);
 448         ///
 449         void dispatchToBufferView(FuncRequest const & cmd, DispatchResult & dr);
 450         ///
 451         void showMessage();
 452
 453         /// This view ID.
 454         int id_;
 455
 456         /// flag to avoid two concurrent close events.
 457         bool closing_;
 458         /// if the view is busy the cursor shouldn't blink for instance.
 459         /// This counts the number of times more often we called
 460         /// setBusy(true) compared to setBusy(false), so we can nest
 461         /// functions that call setBusy;
 462         int busy_;
 463
 464         /// Request to open the command toolbar if it is "auto"
 465         bool command_execute_;
 466         /// Request to give focus to minibuffer
 467         bool minibuffer_focus_;
 468
 469         /// Statusbar widget that shows shell-escape status
 470         QLabel * shell_escape_;
 471         /// Statusbar widget that shows read-only status
 472         QLabel * read_only_;
 473         /// Statusbar widget that shows version control status
 474         QLabel * version_control_;
 475
 476         /// The rate from which the actual zoom value is calculated
 477         /// from the default zoom pref
 478         double zoom_ratio_ = 1.0;
 479         /// Minimum zoom percentage
 480         static int const zoom_min_ = 10;
 481
 482         // movability flag of all toolbars
 483         bool toolbarsMovable_;
 484
 485         // developer mode
 486         bool devel_mode_;
 487 };
 488
 489
 490 class SEMenu : public QMenu
 491 {
 492         Q_OBJECT
 493 public:
 494         explicit SEMenu(QWidget * parent);
 495
 496 public Q_SLOTS:
 497         void showMenu(QPoint const &) { exec(QCursor::pos()); }
 498 };
 499
 500 } // namespace frontend
 501 } // namespace lyx
 502
 503 #endif // GUIVIEW_H