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         void saveCursorShapes();
  86         void restoreCursorShapes();
  87         void setCursorShapes(Qt::CursorShape shape);
  88
  89         /// \name Generic accessor functions
  90         //@{
  91         /// The current BufferView refers to the BufferView that has the focus,
  92         /// including for example the one that is created when you use the
  93         /// advanced search and replace pane.
  94         /// \return the currently selected buffer view.
  95         BufferView * currentBufferView();
  96         BufferView const * currentBufferView() const;
  97
  98         /// The document BufferView always refers to the view's main document
  99         /// BufferView. So, even if the BufferView in e.g., the advanced
 100         /// search and replace pane has the focus.
 101         /// \return the current document buffer view.
 102         BufferView * documentBufferView();
 103         BufferView const * documentBufferView() const;
 104
 105         void newDocument(std::string const & filename,
 106                 bool fromTemplate);
 107
 108         /// display a message in the view
 109         /// could be called from any thread
 110         void message(docstring const &);
 111
 112         bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
 113         /// dispatch command.
 114         /// \return true if the \c FuncRequest has been dispatched.
 115         void dispatch(FuncRequest const & cmd, DispatchResult & dr);
 116
 117         void restartCursor();
 118         /// Update the completion popup and the inline completion state.
 119         /// If \c start is true, then a new completion might be started.
 120         /// If \c keep is true, an active completion will be kept active
 121         /// even though the cursor moved. The update flags of \c cur might
 122         /// be changed.
 123         void updateCompletion(Cursor & cur, bool start, bool keep);
 124
 125         ///
 126         void setFocus();
 127
 128         ///
 129         void focusInEvent(QFocusEvent * e);
 130         /// set a buffer to the current workarea.
 131         void setBuffer(Buffer * b); ///< \c Buffer to set.
 132
 133         /// load a document into the current workarea.
 134         Buffer * loadDocument(
 135                 support::FileName const &  name, ///< File to load.
 136                 bool tolastfiles = true  ///< append to the "Open recent" menu?
 137                 );
 138
 139         /// add toolbar, if newline==true, add a toolbar break before the toolbar
 140         GuiToolbar * makeToolbar(ToolbarInfo const & tbinfo, bool newline);
 141         void updateStatusBar();
 142
 143         /// updates the possible layouts selectable
 144         void updateLayoutList();
 145         void updateToolbars();
 146         QMenu * createPopupMenu();
 147
 148         ///
 149         LayoutBox * getLayoutDialog() const;
 150
 151         /// hides the workarea and makes sure it is clean
 152         bool hideWorkArea(GuiWorkArea * wa);
 153         /// closes the workarea
 154         bool closeWorkArea(GuiWorkArea * wa);
 155         /// closes the buffer
 156         bool closeBuffer(Buffer & buf);
 157         ///
 158         void openDocument(std::string const & filename);
 159         ///
 160         void importDocument(std::string const &);
 161
 162         /// \name GuiBufferDelegate.
 163         //@{
 164         void resetAutosaveTimers();
 165         void errors(std::string const &, bool from_master = false);
 166         void structureChanged();
 167         void updateTocItem(std::string const &, DocIterator const &);
 168         //@}
 169
 170         ///
 171         TocModels & tocModels();
 172
 173         /// called on timeout
 174         void autoSave();
 175
 176         /// check for external change of any opened buffer, mainly for svn usage
 177         void checkExternallyModifiedBuffers();
 178
 179         /** redraw \c inset in all the BufferViews in which it is currently
 180          *  visible. If successful return a pointer to the owning Buffer.
 181          */
 182         Buffer const * updateInset(Inset const *);
 183
 184         /// \return the \c Workarea associated to \p  Buffer
 185         /// \retval 0 if no \c WorkArea is found.
 186         GuiWorkArea * workArea(Buffer & buffer);
 187         /// \return the \c Workarea at index \c index
 188         GuiWorkArea * workArea(int index);
 189
 190         /// Add a \c WorkArea
 191         /// \return the \c Workarea associated to \p  Buffer
 192         /// \retval 0 if no \c WorkArea is found.
 193         GuiWorkArea * addWorkArea(Buffer & buffer);
 194         /// \param work_area The current \c WorkArea, or \c NULL
 195         void setCurrentWorkArea(GuiWorkArea * work_area);
 196         ///
 197         void removeWorkArea(GuiWorkArea * work_area);
 198         /// return the current WorkArea (the one that has the focus).
 199         GuiWorkArea const * currentWorkArea() const;
 200         /// return the current WorkArea (the one that has the focus).
 201         GuiWorkArea * currentWorkArea();
 202
 203         /// return the current document WorkArea (it may not have the focus).
 204         GuiWorkArea const * currentMainWorkArea() const;
 205         /// return the current document WorkArea (it may not have the focus).
 206         GuiWorkArea * currentMainWorkArea();
 207
 208 Q_SIGNALS:
 209         void closing(int);
 210         void triggerShowDialog(QString const & qname, QString const & qdata, Inset * inset);
 211
 212 public Q_SLOTS:
 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 indicateProcessing();
 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         ///
 338         void saveLayout() 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 in this workarea also shown in another view ?
 396         bool inMultiViews(GuiWorkArea * wa);
 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