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