pqFavoritesDialog.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause

#ifndef pqFavoritesDialog_h
#define pqFavoritesDialog_h

#include "pqComponentsModule.h"
#include <QDialog>
#include <QPointer>

#include "vtkParaViewDeprecation.h" // for deprecation

class QVariant;
class QString;
class QTreeWidgetItem;

namespace Ui
{
class pqFavoritesDialog;
}

class PARAVIEW_DEPRECATED_IN_5_13_0(
  "Favorites should be replaced by Categories configuration. See pqConfigureCategories instead.")
  PQCOMPONENTS_EXPORT pqFavoritesDialog : public QDialog
{
  Q_OBJECT
  typedef QDialog Superclass;

public:
  pqFavoritesDialog(const QVariant& filtersList, QWidget* p = nullptr);
  ~pqFavoritesDialog() override;

protected Q_SLOTS:
  void createCategory();

  void onAddFavoritePressed();

  void onRemoveFavoritePressed();

  void onAccepted();

  void onItemChanged(QTreeWidgetItem*, int);

  void onSearchTextChanged(QString pattern);

protected: // NOLINT(readability-redundant-access-specifiers)
  void populateFavoritesTree();

  void populateFiltersTree(const QVariant& filtersList);

  QString populateSettingsValue(const QString& value, QTreeWidgetItem* item);

  QTreeWidgetItem* getSelectedCategory();

  bool eventFilter(QObject* object, QEvent* event) override;

private:
  QScopedPointer<Ui::pqFavoritesDialog> Ui;
};

#endif