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