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