pqProxyWidgetItem.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#include <QObject>

#include <QPointer> // for QPointer members

class pqPropertyWidget;
class pqProxyWidget;
class vtkSMProxy;

class QFrame;
class QGridLayout;

class pqProxyWidgetItem : public QObject
{
  typedef QObject Superclass;

public:
  ~pqProxyWidgetItem() override;

  static pqProxyWidgetItem* newItem(pqPropertyWidget* widget, const QString& label, bool advanced,
    bool informationOnly, const QStringList& searchTags, pqProxyWidget* parentObj);

  static pqProxyWidgetItem* newGroupItem(pqPropertyWidget* widget, const QString& label,
    bool showSeparators, bool advanced, const QStringList& searchTags, pqProxyWidget* parentObj);

  static pqProxyWidgetItem* newMultiItemGroupItem(const QString& group_label,
    pqPropertyWidget* widget, const QString& widget_label, bool showSeparators, bool advanced,
    bool informationOnly, const QStringList& searchTags, pqProxyWidget* parentObj);

  static QFrame* newHLine(QWidget* parent);

  static QWidget* newGroupSeparator(QWidget* parent);

  pqPropertyWidget* propertyWidget() const;

  void appendToDefaultVisibilityForRepresentations(const QString& repr);

  void apply() const;
  void reset() const;
  void select() const;
  void deselect() const;

  bool canShowWidget(bool show_advanced, const QString& filterText, vtkSMProxy* proxy) const;

  bool enableWidget() const;

  bool isAdvanced(vtkSMProxy* proxy) const;

  void show(const pqProxyWidgetItem* prevVisibleItem, bool enabled = true,
    bool show_advanced = false) const;

  void hide() const;

  void appendToLayout(QGridLayout* glayout, bool singleColumn);

private:
  Q_DISABLE_COPY(pqProxyWidgetItem);

  // Regular expression with tags used to match search text.
  QStringList SearchTags;
  bool Advanced = false;
  bool InformationOnly = false;

  QPointer<QWidget> GroupHeader;
  QPointer<QWidget> GroupFooter;
  QPointer<QWidget> LabelWidget;
  QPointer<pqPropertyWidget> PropertyWidget;
  QStringList DefaultVisibilityForRepresentations;
  bool Group = false;
  QString GroupTag;

  pqProxyWidgetItem(
    QObject* parentObj, bool advanced, bool informationOnly, const QStringList& searchTags);
};