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