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 QLabel;
  28 class QMenu;
  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 restartCursor();
 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         void errors(std::string const &, bool from_master = false);
 170         void structureChanged();
 171         void updateTocItem(std::string const &, DocIterator const &);
 172         //@}
 173
 174         ///
 175         TocModels & tocModels();
 176
 177         /// called on timeout
 178         void autoSave();
 179
 180         /// check for external change of any opened buffer, mainly for svn usage
 181         void checkExternallyModifiedBuffers();
 182
 183         /** redraw \c inset in all the BufferViews in which it is currently
 184          *  visible. If successful return a pointer to the owning Buffer.
 185          */
 186         Buffer const * updateInset(Inset const *);
 187
 188         /// \return the \c Workarea associated to \p  Buffer
 189         /// \retval 0 if no \c WorkArea is found.
 190         GuiWorkArea * workArea(Buffer & buffer);
 191         /// \return the \c Workarea at index \c index
 192         GuiWorkArea * workArea(int index);
 193
 194         /// Add a \c WorkArea
 195         /// \return the \c Workarea associated to \p  Buffer
 196         /// \retval 0 if no \c WorkArea is found.
 197         GuiWorkArea * addWorkArea(Buffer & buffer);
 198         /// \param work_area The current \c WorkArea, or \c NULL
 199         void setCurrentWorkArea(GuiWorkArea * work_area);
 200         ///
 201         void removeWorkArea(GuiWorkArea * work_area);
 202         /// return the current WorkArea (the one that has the focus).
 203         GuiWorkArea const * currentWorkArea() const;
 204         /// return the current WorkArea (the one that has the focus).
 205         GuiWorkArea * currentWorkArea();
 206
 207         /// return the current document WorkArea (it may not have the focus).
 208         GuiWorkArea const * currentMainWorkArea() const;
 209         /// return the current document WorkArea (it may not have the focus).
 210         GuiWorkArea * currentMainWorkArea();
 211
 212         /// Current ratio between physical pixels and device-independent pixels
 213         double pixelRatio() const;
 214
 215 Q_SIGNALS:
 216         void closing(int);
 217         void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
 218         // emitted when the work area or its buffer view changed
 219         void bufferViewChanged();
 220
 221 public Q_SLOTS:
 222         ///
 223         void setBusy(bool);
 224         /// idle timeout.
 225         /// clear any temporary message and replace with current status.
 226         void clearMessage();
 227         ///
 228         void updateWindowTitle(GuiWorkArea * wa);
 229
 230 private Q_SLOTS:
 231         ///
 232         void resetWindowTitle();
 233
 234         ///
 235         void on_currentWorkAreaChanged(GuiWorkArea *);
 236         ///
 237         void onBufferViewChanged();
 238         ///
 239         void on_lastWorkAreaRemoved();
 240
 241         /// For completion of autosave or export threads.
 242         void processingThreadStarted();
 243         void processingThreadFinished();
 244         void autoSaveThreadFinished();
 245
 246         /// must be called in GUI thread
 247         void doShowDialog(QString const & qname, QString const & qdata,
 248         Inset * inset);
 249
 250         /// must be called from GUI thread
 251         void updateStatusBarMessage(QString const & str);
 252         void clearMessageText();
 253
 254         ///
 255         void toolBarPopup(const QPoint &pos);
 256
 257 private:
 258         /// Open given child document in current buffer directory.
 259         void openChildDocument(std::string const & filename);
 260         /// Close current document buffer.
 261         bool closeBuffer();
 262         /// Close all document buffers.
 263         bool closeBufferAll();
 264         ///
 265         TabWorkArea * addTabWorkArea();
 266
 267         /// connect to signals in the given BufferView
 268         void connectBufferView(BufferView & bv);
 269         /// disconnect from signals in the given BufferView
 270         void disconnectBufferView();
 271         /// connect to signals in the given buffer
 272         void connectBuffer(Buffer & buf);
 273         /// disconnect from signals in the given buffer
 274         void disconnectBuffer();
 275         ///
 276         void dragEnterEvent(QDragEnterEvent * ev);
 277         ///
 278         void dropEvent(QDropEvent * ev);
 279         /// make sure we quit cleanly
 280         void closeEvent(QCloseEvent * e);
 281         ///
 282         void showEvent(QShowEvent *);
 283
 284         /// in order to catch Tab key press.
 285         bool event(QEvent * e);
 286         bool focusNextPrevChild(bool);
 287
 288         ///
 289         bool goToFileRow(std::string const & argument);
 290
 291         ///
 292         class GuiViewPrivate;
 293         GuiViewPrivate & d;
 294
 295 public:
 296         ///
 297         /// dialogs for this view
 298         ///
 299
 300         ///
 301         void resetDialogs();
 302
 303         /// Hide all visible dialogs
 304         void hideAll() const;
 305
 306         /// Update all visible dialogs.
 307         /**
 308          *  Check the status of all visible dialogs and disable or reenable
 309          *  them as appropriate.
 310          *
 311          *  Disabling is needed for example when a dialog is open and the
 312          *  cursor moves to a position where the corresponding inset is not
 313          *  allowed.
 314          */
 315         void updateDialogs();
 316
 317         /** Show dialog could be called from arbitrary threads.
 318             \param name == "bibtex", "citation" etc; an identifier used to
 319             launch a particular dialog.
 320             \param data is a string representation of the Inset contents.
 321             It is often little more than the output from Inset::write.
 322             It is passed to, and parsed by, the frontend dialog.
 323             Several of these dialogs do not need any data,
 324             so it defaults to string().
 325             \param inset ownership is _not_ passed to the frontend dialog.
 326             It is stored internally and used by the kernel to ascertain
 327             what to do with the FuncRequest dispatched from the frontend
 328             dialog on 'Apply'; should it be used to create a new inset at
 329             the current cursor position or modify an existing, 'open' inset?
 330         */
 331         void showDialog(std::string const & name,
 332                 std::string const & data, Inset * inset = 0);
 333
 334         /** \param name == "citation", "bibtex" etc; an identifier used
 335             to reset the contents of a particular dialog with \param data.
 336             See the comments to 'show', above.
 337         */
 338         void updateDialog(std::string const & name, std::string const & data);
 339
 340         /** All Dialogs of the given \param name will be closed if they are
 341             connected to the given \param inset.
 342         */
 343         void hideDialog(std::string const & name, Inset * inset);
 344         ///
 345         void disconnectDialog(std::string const & name);
 346         ///
 347         bool develMode() const { return devel_mode_; }
 348
 349 private:
 350         /// Saves the layout and geometry of the window
 351         void saveLayout() const;
 352         /// Saves the settings of toolbars and all dialogs
 353         void saveUISettings() const;
 354         ///
 355         bool restoreLayout();
 356         ///
 357         GuiToolbar * toolbar(std::string const & name);
 358         ///
 359         void constructToolbars();
 360         ///
 361         void initToolbars();
 362         ///
 363         void initToolbar(std::string const & name);
 364         /// Update lock (all) toolbars position
 365         void updateLockToolbars();
 366         ///
 367         bool lfunUiToggle(std::string const & ui_component);
 368         ///
 369         void toggleFullScreen();
 370         ///
 371         void insertLyXFile(docstring const & fname);
 372         ///
 373         /// Open Export As ... dialog. \p iformat is the format the
 374         /// filter is initially set to.
 375         bool exportBufferAs(Buffer & b, docstring const & iformat);
 376
 377         ///
 378         enum RenameKind { LV_WRITE_AS, LV_VC_RENAME, LV_VC_COPY };
 379         /// Save a buffer as a new file.
 380         /**
 381         Write a buffer to a new file name and rename the buffer
 382     according to the new file name.
 383
 384     This function is e.g. used by menu callbacks and
 385     LFUN_BUFFER_WRITE_AS.
 386
 387     If 'newname' is empty, the user is asked via a
 388     dialog for the buffer's new name and location.
 389
 390     If 'newname' is non-empty and has an absolute path, that is used.
 391     Otherwise the base directory of the buffer is used as the base
 392     for any relative path in 'newname'.
 393
 394          \p kind controls what is done besides the pure renaming:
 395          * LV_WRITE_AS  => The buffer is written without version control actions.
 396          * LV_VC_RENAME => The file is renamed in version control.
 397          * LV_VC_COPY   => The file is copied in version control.
 398          */
 399         bool renameBuffer(Buffer & b, docstring const & newname,
 400                           RenameKind kind = LV_WRITE_AS);
 401         ///
 402         bool saveBuffer(Buffer & b);
 403         /// save and rename buffer to fn. If fn is empty, the buffer
 404         /// is just saved as the filename it already has.
 405         bool saveBuffer(Buffer & b, support::FileName const & fn);
 406         /// closes a workarea, if close_buffer is true the buffer will
 407         /// also be released, otherwise the buffer will be hidden.
 408         bool closeWorkArea(GuiWorkArea * wa, bool close_buffer);
 409         /// closes the tabworkarea and all tabs. If we are in a close event,
 410         /// all buffers will be closed, otherwise they will be hidden.
 411         bool closeTabWorkArea(TabWorkArea * twa);
 412         /// gives the user the possibility to save his work
 413         /// or to discard the changes. If hiding is true, the
 414         /// document will be reloaded.
 415         bool saveBufferIfNeeded(Buffer & buf, bool hiding);
 416         /// closes all workareas
 417         bool closeWorkAreaAll();
 418         /// write all open workareas into the session file
 419         void writeSession() const;
 420         /// is the buffer in this workarea also shown in another tab ?
 421         /// This tab can either be in the same view or in another one.
 422         bool inMultiTabs(GuiWorkArea * wa);
 423         /// is the buffer shown in some other view ?
 424         bool inOtherView(Buffer & buf);
 425         ///
 426         enum NextOrPrevious {
 427                 NEXTBUFFER,
 428                 PREVBUFFER
 429         };
 430         ///
 431         void gotoNextOrPreviousBuffer(NextOrPrevious np, bool const move);
 432
 433         /// Is the dialog currently visible?
 434         bool isDialogVisible(std::string const & name) const;
 435         ///
 436         Dialog * findOrBuild(std::string const & name, bool hide_it);
 437         ///
 438         Dialog * build(std::string const & name);
 439         ///
 440         bool reloadBuffer(Buffer & buffer);
 441         ///
 442         void dispatchVC(FuncRequest const & cmd, DispatchResult & dr);
 443         ///
 444         void dispatchToBufferView(FuncRequest const & cmd, DispatchResult & dr);
 445         ///
 446         void showMessage();
 447
 448         /// This view ID.
 449         int id_;
 450
 451         /// flag to avoid two concurrent close events.
 452         bool closing_;
 453         /// if the view is busy the cursor shouldn't blink for instance.
 454         /// This counts the number of times more often we called
 455         /// setBusy(true) compared to setBusy(false), so we can nest
 456         /// functions that call setBusy;
 457         int busy_;
 458
 459         /// Request to open the command toolbar if it is "auto"
 460         bool command_execute_;
 461         /// Request to give focus to minibuffer
 462         bool minibuffer_focus_;
 463
 464         /// Statusbar widget that shows read-only status
 465         QLabel * read_only_;
 466         /// Statusbar widget that shows version control status
 467         QLabel * version_control_;
 468
 469         /// Minimum zoom percentage
 470         static int const zoom_min_ = 10;
 471
 472         // movability flag of all toolbars
 473         bool toolbarsMovable_;
 474
 475         // developer mode
 476         bool devel_mode_;
 477 };
 478
 479 } // namespace frontend
 480 } // namespace lyx
 481
 482 #endif // GUIVIEW_H