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