src/frontends/qt/GuiToc.h

   1 // -*- C++ -*-
   2 /**
   3  * \file GuiToc.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author John Levon
   8  * \author Kalle Dalheimer
   9  * \author Angus Leeming
  10  * \author Abdelrazak Younes
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef GUITOC_H
  16 #define GUITOC_H
  17
  18 #include "DockView.h"
  19
  20 namespace lyx {
  21 namespace frontend {
  22
  23 class TocWidget;
  24
  25 class GuiToc : public DockView
  26 {
  27         Q_OBJECT
  28
  29 public:
  30         ///
  31         GuiToc(
  32                 GuiView & parent, ///< the main window where to dock.
  33                 Qt::DockWidgetArea area = Qt::LeftDockWidgetArea, ///< Position of the dock (and also drawer)
  34                         Qt::WindowFlags flags = {});
  35
  36         ///
  37         bool initialiseParams(std::string const & data) override;
  38         void updateView() override;
  39         void enableView(bool enable) override;
  40         bool wantInitialFocus() const override { return false; }
  41         void closeEvent(QCloseEvent * event) override;
  42         bool isClosing() const override { return is_closing_; }
  43
  44 public:
  45         /// clean-up on hide.
  46         void clearParams() override {}
  47         ///
  48         void dispatchParams() override;
  49         ///
  50         bool isBufferDependent() const override { return true; }
  51         ///
  52         void doDispatch(Cursor & cur, FuncRequest const & fr, DispatchResult & dr);
  53         ///
  54         bool getStatus(Cursor & cur, FuncRequest const & fr, FuncStatus & fs) const;
  55
  56 private:
  57         ///
  58         TocWidget * widget_;
  59         ///
  60         bool is_closing_;
  61 };
  62
  63 } // namespace frontend
  64 } // namespace lyx
  65
  66 #endif // GUITOC_H