ui/qt/extcap_argument_multiselect.cpp

   1 /* extcap_argument_multiselect.cpp
   2  *
   3  * Wireshark - Network traffic analyzer
   4  * By Gerald Combs <gerald@wireshark.org>
   5  * Copyright 1998 Gerald Combs
   6  *
   7  * SPDX-License-Identifier: GPL-2.0-or-later
   8  */
   9
  10 #include <extcap_argument.h>
  11 #include <extcap_argument_file.h>
  12
  13 #include <wsutil/utf8_entities.h>
  14
  15 #include <QObject>
  16 #include <QWidget>
  17 #include <QLabel>
  18 #include <QLineEdit>
  19 #include <QBoxLayout>
  20 #include <QPushButton>
  21 #include <QVariant>
  22
  23 #include <epan/prefs.h>
  24 #include <ui/qt/utils/color_utils.h>
  25
  26 #include <extcap_parser.h>
  27 #include <extcap_argument_multiselect.h>
  28
  29 ExtArgMultiSelect::ExtArgMultiSelect(extcap_arg * argument, QObject *parent) :
  30         ExtcapArgument(argument, parent), treeView(0), viewModel(0) {}
  31
  32 ExtArgMultiSelect::~ExtArgMultiSelect()
  33 {
  34     if (treeView != 0)
  35         delete treeView;
  36     if (viewModel != 0)
  37         delete viewModel;
  38 }
  39
  40 QList<QStandardItem *> ExtArgMultiSelect::valueWalker(ExtcapValueList list, QStringList &defaults)
  41 {
  42     ExtcapValueList::iterator iter = list.begin();
  43     QList<QStandardItem *> items;
  44
  45     while (iter != list.end())
  46     {
  47         QStandardItem * item = new QStandardItem((*iter).value());
  48         if ((*iter).enabled() == false)
  49         {
  50             item->setCheckable(false);
  51         }
  52         else
  53         {
  54             item->setCheckable(true);
  55         }
  56
  57         item->setData((*iter).call(), Qt::UserRole);
  58         if ((*iter).isDefault())
  59             defaults << (*iter).call();
  60
  61         item->setSelectable(false);
  62         item->setEditable(false);
  63         QList<QStandardItem *> childs = valueWalker((*iter).children(), defaults);
  64         if (childs.length() > 0)
  65             item->appendRows(childs);
  66
  67         items << item;
  68         ++iter;
  69     }
  70
  71     return items;
  72 }
  73
  74 void ExtArgMultiSelect::checkItemsWalker(QStandardItem * item, QStringList defaults)
  75 {
  76     QModelIndexList results;
  77     QModelIndex index;
  78
  79     if (item->hasChildren())
  80     {
  81         for (int row = 0; row < item->rowCount(); row++)
  82         {
  83             QStandardItem * child = item->child(row);
  84             if (child != 0)
  85             {
  86                 checkItemsWalker(child, defaults);
  87             }
  88         }
  89     }
  90
  91     QString data = item->data(Qt::UserRole).toString();
  92
  93     if (defaults.contains(data))
  94     {
  95         item->setCheckState(Qt::Checked);
  96         index = item->index();
  97         while (index.isValid())
  98         {
  99             treeView->setExpanded(index, true);
 100             index = index.parent();
 101         }
 102     } else if (item->isCheckable()) {
 103         item->setCheckState(Qt::Unchecked);
 104     }
 105 }
 106
 107 QWidget * ExtArgMultiSelect::createEditor(QWidget * parent)
 108 {
 109     QStringList checked;
 110
 111     QList<QStandardItem *> items = valueWalker(values, checked);
 112     if (items.length() == 0)
 113         return new QWidget();
 114
 115     /* Value can be empty if no items are checked */
 116     if (_argument->pref_valptr && (*_argument->pref_valptr))
 117     {
 118         checked = QString(*_argument->pref_valptr).split(",", Qt::SkipEmptyParts);
 119     }
 120
 121     viewModel = new QStandardItemModel();
 122     QList<QStandardItem *>::const_iterator iter = items.constBegin();
 123     while (iter != items.constEnd())
 124     {
 125         ((QStandardItemModel *)viewModel)->appendRow((*iter));
 126         ++iter;
 127     }
 128
 129     treeView = new QTreeView(parent);
 130     treeView->setModel(viewModel);
 131
 132     /* Shows at minimum 6 entries at most desktops */
 133     treeView->setMinimumHeight(100);
 134     treeView->setHeaderHidden(true);
 135     treeView->setSelectionMode(QAbstractItemView::ExtendedSelection);
 136     treeView->setEditTriggers(QAbstractItemView::NoEditTriggers);
 137
 138     for (int row = 0; row < viewModel->rowCount(); row++)
 139         checkItemsWalker(((QStandardItemModel*)viewModel)->item(row), checked);
 140
 141     connect (viewModel,
 142             SIGNAL(itemChanged(QStandardItem *)),
 143             SLOT(itemChanged(QStandardItem *)));
 144
 145     return treeView;
 146 }
 147
 148 QString ExtArgMultiSelect::value()
 149 {
 150     if (viewModel == 0)
 151         return QString();
 152
 153     QStringList result;
 154     QModelIndexList checked = viewModel->match(viewModel->index(0, 0), Qt::CheckStateRole, Qt::Checked, -1, Qt::MatchExactly | Qt::MatchRecursive);
 155     if (checked.size() <= 0)
 156         return QString();
 157
 158     QModelIndexList::const_iterator iter = checked.constBegin();
 159     while (iter != checked.constEnd())
 160     {
 161         QModelIndex index = (QModelIndex)(*iter);
 162
 163         result << viewModel->data(index, Qt::UserRole).toString();
 164
 165         ++iter;
 166     }
 167
 168     return result.join(QString(','));
 169 }
 170
 171 void ExtArgMultiSelect::itemChanged(QStandardItem *)
 172 {
 173     emit valueChanged();
 174 }
 175
 176 bool ExtArgMultiSelect::isValid()
 177 {
 178     bool valid = true;
 179
 180     if (isRequired())
 181     {
 182         if (viewModel == 0)
 183             valid = false;
 184         else
 185         {
 186             QModelIndexList checked = viewModel->match(viewModel->index(0, 0), Qt::CheckStateRole, Qt::Checked, -1, Qt::MatchExactly | Qt::MatchRecursive);
 187             if (checked.size() <= 0)
 188                 valid = false;
 189         }
 190     }
 191
 192     QString lblInvalidColor = ColorUtils::fromColorT(prefs.gui_text_invalid).name();
 193     QString txtStyle("QTreeView { background-color: %1; } ");
 194     if (viewModel != 0)
 195         treeView->setStyleSheet(txtStyle.arg(valid ? QString("") : lblInvalidColor));
 196
 197     return valid;
 198 }
 199
 200 QString ExtArgMultiSelect::defaultValue()
 201 {
 202     QStringList checked;
 203
 204     QList<QStandardItem *> items = valueWalker(values, checked);
 205
 206     return checked.join(QString(','));
 207 }
 208
 209 bool ExtArgMultiSelect::isSetDefaultValueSupported()
 210 {
 211     return true;
 212 }
 213
 214 void ExtArgMultiSelect::setDefaultValue()
 215 {
 216     QStringList checked;
 217
 218     checked = defaultValue().split(",", Qt::SkipEmptyParts);
 219     for (int row = 0; row < viewModel->rowCount(); row++)
 220         checkItemsWalker(((QStandardItemModel*)viewModel)->item(row), checked);
 221 }
 222