pqTabbedMultiViewWidget.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 pqTabbedMultiViewWidget_h
#define pqTabbedMultiViewWidget_h
 
#include "pqComponentsModule.h"
#include "vtkType.h" // needed for vtkIdType
#include <QCoreApplication>
#include <QStyle>     // needed for QStyle:StandardPixmap
#include <QTabBar>    // needed for QTabBar::ButtonPosition
#include <QTabWidget> // needed for QTabWidget.
 
class pqMultiViewWidget;
class pqProxy;
class pqServer;
class pqServerManagerModelItem;
class pqView;
class vtkImageData;
class vtkSMViewLayoutProxy;
 
class PQCOMPONENTS_EXPORT pqTabbedMultiViewWidget : public QWidget
{
  Q_OBJECT
  typedef QWidget Superclass;
  Q_PROPERTY(bool readOnly READ readOnly WRITE setReadOnly)
public:
  pqTabbedMultiViewWidget(QWidget* parent = nullptr);
  ~pqTabbedMultiViewWidget() override;
 
  virtual QSize clientSize() const;
 
  void setReadOnly(bool val);
  bool readOnly() const;
 
  void setTabVisibility(bool visible);
  bool tabVisibility() const;
 
  vtkSMViewLayoutProxy* layoutProxy() const;
 
  bool decorationsVisibility() const;
 
  pqMultiViewWidget* findTab(vtkSMViewLayoutProxy*) const;
 
 
  void enableAnnotationFilter(const QString& annotationKey);
  void disableAnnotationFilter();
  void setAnnotationFilterMatching(bool matching);
 
  void updateVisibleTabs();
 
  QList<QString> visibleTabLabels() const;
 
Q_SIGNALS:
  void viewSizeLocked(bool);
 
public Q_SLOTS:
  virtual int createTab();
  virtual int createTab(pqServer*);
  virtual int createTab(vtkSMViewLayoutProxy*);
  virtual void closeTab(int);
 
  void setCurrentTab(int index);
 
 
  void setDecorationsVisibility(bool);
  void showDecorations() { this->setDecorationsVisibility(true); }
  void hideDecorations() { this->setDecorationsVisibility(false); }
 
  virtual void toggleFullScreen();
 
  virtual void toggleWidgetDecoration();
 
  virtual void lockViewSize(const QSize&);
 
  virtual void reset();
 
  QSize preview(const QSize& previewSize = QSize());
 
protected Q_SLOTS:
  virtual void proxyAdded(pqProxy*);
  virtual void proxyRemoved(pqProxy*);
  virtual void serverRemoved(pqServer*);
 
  virtual void currentTabChanged(int);
 
  virtual void onStateLoaded();
 
  void contextMenuRequested(const QPoint&);
 
  void onLayoutNameChanged(pqServerManagerModelItem*);
 
protected: // NOLINT(readability-redundant-access-specifiers)
  bool eventFilter(QObject* obj, QEvent* event) override;
 
  class pqTabWidget : public QTabWidget
  {
    typedef QTabWidget Superclass;
 
    Q_DECLARE_TR_FUNCTIONS(pqTabWidget);
 
  public:
    pqTabWidget(QWidget* parentWdg = nullptr);
    ~pqTabWidget() override;
 
    virtual void setTabButton(int index, QTabBar::ButtonPosition position, QWidget* wdg);
 
    virtual int tabButtonIndex(QWidget* wdg, QTabBar::ButtonPosition position) const;
 
    virtual int addAsTab(pqMultiViewWidget* wdg, pqTabbedMultiViewWidget* self);
 
    static QString popoutLabelText(bool popped_out);
 
    static QStyle::StandardPixmap popoutLabelPixmap(bool popped_out);
 
    void setReadOnly(bool val);
    bool readOnly() const { return this->ReadOnly; }
 
    QSize preview(const QSize&);
 
 
    void setTabBarVisibility(bool);
    bool tabBarVisibility() const { return this->TabBarVisibility; }
  protected:
    void createViewSelectorTabIfNeeded(int tabIndex);
 
  private:
    Q_DISABLE_COPY(pqTabWidget)
    bool ReadOnly;
    bool TabBarVisibility;
    friend class pqTabbedMultiViewWidget;
  };
 
private:
  Q_DISABLE_COPY(pqTabbedMultiViewWidget)
 
  class pqInternals;
  pqInternals* Internals;
  friend class pqInternals;
};
 
#endif