src/frontends/qt4/TocWidget.h

   1 // -*- C++ -*-
   2 /**
   3  * \file TocWidget.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 Abdelrazak Younes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef TOC_WIDGET_H
  14 #define TOC_WIDGET_H
  15
  16 #include "ui_TocUi.h"
  17
  18 #include "Cursor.h"
  19 #include "FuncCode.h"
  20
  21 #include <QWidget>
  22
  23 class QModelIndex;
  24 class QString;
  25
  26 namespace lyx {
  27 namespace frontend {
  28
  29 class GuiView;
  30
  31 class TocWidget : public QWidget, public Ui::TocUi
  32 {
  33         Q_OBJECT
  34 public:
  35         ///
  36         TocWidget(GuiView & gui_view, QWidget * parent = 0);
  37
  38         /// Initialise GUI.
  39         void init(QString const & str);
  40         ///
  41         void doDispatch(Cursor & cur, FuncRequest const & fr);
  42         ///
  43         bool getStatus(Cursor & cur, FuncRequest const & fr, FuncStatus & status)
  44                 const;
  45
  46 public Q_SLOTS:
  47         /// Update the display of the dialog whilst it is still visible.
  48         void updateView();
  49
  50 protected Q_SLOTS:
  51         ///
  52         void select(QModelIndex const & index);
  53         ///
  54         void goTo(QModelIndex const &);
  55
  56         void on_tocTV_activated(QModelIndex const &);
  57         void on_tocTV_pressed(QModelIndex const &);
  58         void on_updateTB_clicked();
  59         void on_sortCB_stateChanged(int state);
  60         void on_persistentCB_stateChanged(int state);
  61         void on_depthSL_valueChanged(int depth);
  62         void on_typeCO_currentIndexChanged(int value);
  63         void on_moveUpTB_clicked();
  64         void on_moveDownTB_clicked();
  65         void on_moveInTB_clicked();
  66         void on_moveOutTB_clicked();
  67         void filterContents();
  68
  69         void showContextMenu(const QPoint & pos);
  70
  71 private:
  72         ///
  73         void enableControls(bool enable = true);
  74         ///
  75         bool canOutline()
  76                 { return current_type_ == "tableofcontents"; }
  77         /// It is not possible to have synchronous navigation in a correct
  78         /// and efficient way with the label and change type because Toc::item()
  79         /// does a linear search. Even when fixed, it might even not be desirable
  80         /// to do so if we want to support drag&drop of labels and references.
  81         bool canNavigate()
  82                 { return current_type_ != "label" && current_type_ != "change"; }
  83         ///
  84         bool isSortable()
  85                 { return current_type_ != "tableofcontents"; }
  86         ///
  87         void setTreeDepth(int depth);
  88         ///
  89         void outline(FuncCode func_code);
  90         /// finds the inset that is connected to the current item,
  91         /// if any, otherwise return null
  92         Inset * itemInset() const;
  93         ///
  94         QString current_type_;
  95
  96         /// depth of list shown
  97         int depth_;
  98         /// persistence of uncollapsed nodes in toc view
  99         bool persistent_;
 100         ///
 101         GuiView & gui_view_;
 102 };
 103
 104 } // namespace frontend
 105 } // namespace lyx
 106
 107 #endif // TOC_WIDGET_H