src/frontends/qt4/TocWidget.cpp

   1 /**
   2  * \file TocWidget.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  * \author Abdelrazak Younes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "TocWidget.h"
  15
  16 #include "GuiView.h"
  17 #include "qt_helpers.h"
  18 #include "TocModel.h"
  19
  20 #include "FuncRequest.h"
  21 #include "LyXFunc.h"
  22
  23 #include "support/debug.h"
  24
  25 #include <QHeaderView>
  26 #include <QTimer>
  27
  28 #include <vector>
  29
  30 using namespace std;
  31
  32 namespace lyx {
  33 namespace frontend {
  34
  35 TocWidget::TocWidget(GuiView & gui_view, QWidget * parent)
  36         : QWidget(parent), depth_(0), gui_view_(gui_view)
  37 {
  38         setupUi(this);
  39
  40         moveOutTB->setIcon(QIcon(":/images/promote.png"));
  41         moveInTB->setIcon(QIcon(":/images/demote.png"));
  42         moveUpTB->setIcon(QIcon(":/images/up.png"));
  43         moveDownTB->setIcon(QIcon(":/images/down.png"));
  44         updateTB->setIcon(QIcon(":/images/reload.png"));
  45
  46         // avoid flickering
  47         tocTV->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
  48
  49         tocTV->showColumn(0);
  50
  51         // hide the pointless QHeader for now
  52         // in the future, new columns may appear
  53         // like labels, bookmarks, etc...
  54         // tocTV->header()->hide();
  55         tocTV->header()->setVisible(false);
  56
  57         // Only one item selected at a time.
  58         tocTV->setSelectionMode(QAbstractItemView::SingleSelection);
  59 }
  60
  61
  62 void TocWidget::on_tocTV_activated(QModelIndex const & index)
  63 {
  64         goTo(index);
  65 }
  66
  67
  68 void TocWidget::on_tocTV_clicked(QModelIndex const & index)
  69 {
  70         goTo(index);
  71         gui_view_.setFocus();
  72 }
  73
  74
  75 void TocWidget::goTo(QModelIndex const & index)
  76 {
  77         LYXERR(Debug::GUI, "goto " << index.row()
  78                 << ", " << index.column());
  79
  80         gui_view_.tocModels().goTo(typeCO->currentIndex(), index);
  81 }
  82
  83
  84 void TocWidget::on_updateTB_clicked()
  85 {
  86         // The backend update can take some time so we disable
  87         // the controls while waiting.
  88         enableControls(false);
  89         gui_view_.tocModels().updateBackend();
  90 }
  91
  92 /* FIXME (Ugras 17/11/06):
  93 I have implemented a getIndexDepth function to get the model indices. In my
  94 opinion, somebody should derive a new qvariant class for tocModelItem
  95 which saves the string data and depth information. that will save the
  96 depth calculation.
  97 */
  98 int TocWidget::getIndexDepth(QModelIndex const & index, int depth)
  99 {
 100         ++depth;
 101         return (index.parent() == QModelIndex())
 102                 ? depth : getIndexDepth(index.parent(),depth);
 103 }
 104
 105
 106 void TocWidget::on_depthSL_valueChanged(int depth)
 107 {
 108         if (depth == depth_)
 109                 return;
 110         setTreeDepth(depth);
 111         gui_view_.setFocus();
 112 }
 113
 114
 115 void TocWidget::setTreeDepth(int depth)
 116 {
 117         depth_ = depth;
 118
 119         // expanding and then collapsing is probably better,
 120         // but my qt 4.1.2 doesn't have expandAll()..
 121         //tocTV->expandAll();
 122         QModelIndexList indices = tocTV->model()->match(
 123                 tocTV->model()->index(0,0),
 124                 Qt::DisplayRole, "*", -1,
 125                 Qt::MatchFlags(Qt::MatchWildcard|Qt::MatchRecursive));
 126
 127         int size = indices.size();
 128         for (int i = 0; i < size; i++) {
 129                 QModelIndex index = indices[i];
 130                 tocTV->setExpanded(index, getIndexDepth(index) < depth_);
 131         }
 132 }
 133
 134
 135 void TocWidget::on_typeCO_currentIndexChanged(int value)
 136 {
 137         setTocModel(value);
 138 }
 139
 140
 141 void TocWidget::outline(int func_code)
 142 {
 143         enableControls(false);
 144         QModelIndexList const & list = tocTV->selectionModel()->selectedIndexes();
 145         if (list.isEmpty())
 146                 return;
 147         enableControls(false);
 148         goTo(list[0]);
 149         dispatch(FuncRequest(static_cast<FuncCode>(func_code)));
 150         enableControls(true);
 151         gui_view_.setFocus();
 152 }
 153
 154
 155 void TocWidget::on_moveUpTB_clicked()
 156 {
 157         outline(LFUN_OUTLINE_UP);
 158 }
 159
 160
 161 void TocWidget::on_moveDownTB_clicked()
 162 {
 163         outline(LFUN_OUTLINE_DOWN);
 164 }
 165
 166
 167 void TocWidget::on_moveInTB_clicked()
 168 {
 169         outline(LFUN_OUTLINE_IN);
 170 }
 171
 172
 173 void TocWidget::on_moveOutTB_clicked()
 174 {
 175         outline(LFUN_OUTLINE_OUT);
 176 }
 177
 178
 179 void TocWidget::select(QModelIndex const & index)
 180 {
 181         if (!index.isValid()) {
 182                 LYXERR(Debug::GUI, "TocWidget::select(): QModelIndex is invalid!");
 183                 return;
 184         }
 185
 186         tocTV->scrollTo(index);
 187         tocTV->clearSelection();
 188         tocTV->setCurrentIndex(index);
 189 }
 190
 191
 192 void TocWidget::enableControls(bool enable)
 193 {
 194         updateTB->setEnabled(enable);
 195
 196         if (!gui_view_.tocModels().canOutline(typeCO->currentIndex()))
 197                 enable = false;
 198
 199         moveUpTB->setEnabled(enable);
 200         moveDownTB->setEnabled(enable);
 201         moveInTB->setEnabled(enable);
 202         moveOutTB->setEnabled(enable);
 203
 204         depthSL->setEnabled(enable);
 205 }
 206
 207
 208 void TocWidget::updateView()
 209 {
 210         LYXERR(Debug::GUI, "In TocWidget::updateView()");
 211         setTreeDepth(depth_);
 212         select(gui_view_.tocModels().currentIndex(typeCO->currentIndex()));
 213 }
 214
 215
 216 void TocWidget::init(QString const & str)
 217 {
 218         QStringList const & type_names = gui_view_.tocModels().typeNames();
 219         if (type_names.isEmpty()) {
 220                 enableControls(false);
 221                 typeCO->clear();
 222                 tocTV->setModel(new QStandardItemModel);
 223                 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
 224                 return;
 225         }
 226
 227         int selected_type = gui_view_.tocModels().decodeType(str);
 228
 229         QString const current_text = typeCO->currentText();
 230         typeCO->blockSignals(true);
 231         typeCO->clear();
 232         for (int i = 0; i != type_names.size(); ++i)
 233                 typeCO->addItem(type_names[i]);
 234         if (!str.isEmpty())
 235                 typeCO->setCurrentIndex(selected_type);
 236         else {
 237                 int const new_index = typeCO->findText(current_text);
 238                 if (new_index != -1)
 239                         typeCO->setCurrentIndex(new_index);
 240                 else
 241                         typeCO->setCurrentIndex(selected_type);
 242         }
 243
 244         typeCO->blockSignals(false);
 245
 246         setTocModel(typeCO->currentIndex());
 247 }
 248
 249
 250 void TocWidget::setTocModel(size_t type)
 251 {
 252         bool controls_enabled = false;
 253         QStandardItemModel * toc_model = gui_view_.tocModels().model(type);
 254         if (toc_model) {
 255                 controls_enabled = toc_model->rowCount() > 0;
 256                 tocTV->setModel(toc_model);
 257                 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
 258                 LYXERR(Debug::GUI, "tocModel()->rowCount "
 259                         << toc_model->rowCount()
 260                         << "\nform_->tocModel()->columnCount "
 261                         << toc_model->columnCount());
 262         }
 263
 264         enableControls(controls_enabled);
 265
 266         if (controls_enabled) {
 267                 depthSL->setMaximum(gui_view_.tocModels().depth(type));
 268                 depthSL->setValue(depth_);
 269         }
 270
 271         // setTocModel produce QTreeView reset and setting depth again
 272         // is needed. That must be done after all Qt updates are processed.
 273         QTimer::singleShot(0, this, SLOT(updateView()));
 274 }
 275
 276 } // namespace frontend
 277 } // namespace lyx
 278
 279 #include "TocWidget_moc.cpp"