lyx_mirror/src/frontends/qt4/TocWidget.h
Guillaume Munch 1cc14a31ca TocWidget: fix an erroneous collapse and optimise updates based on profiling
TocModels::reset() in GuiView::structureChanged() collapses the TocWidget, and
therefore requires an update right after, which was missing.

In fact, profiling TocWidget::updateView() shows that delaying the update is
good only for fast keypresses (essentially movement). It costs 5% of a
char-forward operation in a document with approx. 100 table of contents
items. The update optimisation has been rewritten to take this data into
account.
2016-05-31 00:14:13 +01:00

117 lines
2.7 KiB
C++

// -*- C++ -*-
/**
* \file TocWidget.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author John Levon
* \author Abdelrazak Younes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef TOC_WIDGET_H
#define TOC_WIDGET_H
#include "ui_TocUi.h"
#include "Cursor.h"
#include "FuncCode.h"
#include <QTimer>
#include <QWidget>
class QModelIndex;
class QString;
namespace lyx {
namespace frontend {
class GuiView;
class TocWidget : public QWidget, public Ui::TocUi
{
Q_OBJECT
public:
///
TocWidget(GuiView & gui_view, QWidget * parent = 0);
/// Initialise GUI.
void init(QString const & str);
///
void doDispatch(Cursor & cur, FuncRequest const & fr);
///
bool getStatus(Cursor & cur, FuncRequest const & fr, FuncStatus & status)
const;
public Q_SLOTS:
/// Schedule an update of the dialog, delaying expensive operations
void updateView();
/// Update completely without delay
void updateViewNow();
protected Q_SLOTS:
///
void select(QModelIndex const & index);
///
void goTo(QModelIndex const &);
void on_tocTV_activated(QModelIndex const &);
void on_tocTV_pressed(QModelIndex const &);
void on_updateTB_clicked();
void on_sortCB_stateChanged(int state);
void on_persistentCB_stateChanged(int state);
void on_depthSL_valueChanged(int depth);
void on_typeCO_currentIndexChanged(int value);
void on_moveUpTB_clicked();
void on_moveDownTB_clicked();
void on_moveInTB_clicked();
void on_moveOutTB_clicked();
void filterContents();
void showContextMenu(const QPoint & pos);
private Q_SLOTS:
/// Perform the expensive update operations
void finishUpdateView();
private:
///
void enableControls(bool enable = true);
///
bool canOutline()
{ return current_type_ == "tableofcontents"; }
/// It is not possible to have synchronous navigation in a correct
/// and efficient way with the label and change type because Toc::item()
/// does a linear search. Even when fixed, it might even not be desirable
/// to do so if we want to support drag&drop of labels and references.
bool canNavigate()
{ return current_type_ != "label" && current_type_ != "change"; }
///
bool isSortable()
{ return current_type_ != "tableofcontents"; }
///
void setTreeDepth(int depth);
///
void outline(FuncCode func_code);
/// finds the inset that is connected to the current item,
/// if any, otherwise return null
Inset * itemInset() const;
///
QString current_type_;
/// depth of list shown
int depth_;
/// persistence of uncollapsed nodes in toc view
bool persistent_;
///
GuiView & gui_view_;
// Timer for scheduling expensive update operations
QTimer * timer_;
};
} // namespace frontend
} // namespace lyx
#endif // TOC_WIDGET_H