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