src/frontends/qt4/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 TocModel;
  24 class TocWidget;
  25
  26 class GuiToc : public DockView
  27 {
  28         Q_OBJECT
  29
  30 public:
  31         ///
  32         GuiToc(
  33                 GuiView & parent, ///< the main window where to dock.
  34                 Qt::DockWidgetArea area = Qt::LeftDockWidgetArea, ///< Position of the dock (and also drawer)
  35                 Qt::WindowFlags flags = 0);
  36
  37         ///
  38         bool initialiseParams(std::string const & data);
  39         void updateView();
  40         void enableView(bool enable);
  41         bool wantInitialFocus() const { return false; }
  42         void closeEvent(QCloseEvent * event);
  43         bool isClosing() const { return is_closing_; }
  44
  45 public:
  46         /// clean-up on hide.
  47         void clearParams() {}
  48         ///
  49         void dispatchParams();
  50         ///
  51         bool isBufferDependent() const { return true; }
  52         ///
  53         void doDispatch(Cursor & cur, FuncRequest const & fr);
  54         ///
  55         bool getStatus(Cursor & cur, FuncRequest const & fr, FuncStatus & fs) const;
  56
  57 private:
  58         ///
  59         TocWidget * widget_;
  60         ///
  61         bool is_closing_;
  62 };
  63
  64 } // namespace frontend
  65 } // namespace lyx
  66
  67 #endif // GUITOC_H