pqViewFrame.h

Go to the documentation of this file.

/*=========================================================================

   Program: ParaView
   Module:    $RCSfile$

   Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

========================================================================*/
#ifndef pqViewFrame_h
#define pqViewFrame_h

#include "pqComponentsModule.h"
#include <QMap>
#include <QPointer>
#include <QScopedPointer>
#include <QUuid>
#include <QWidget>

class QDragEnterEvent;
class QDragMoveEvent;
class QDropEvent;
class QFrame;
class QLabel;
class QMenu;
class QToolBar;
class QToolButton;
class pqServerManagerModelItem;
class pqView;

class PQCOMPONENTS_EXPORT pqViewFrame : public QWidget
{
  Q_OBJECT
  typedef QWidget Superclass;

public:
  pqViewFrame(QWidget* parent = 0);
  ~pqViewFrame() override;

  void setTitle(const QString& text);
  QString title() const;

  void setCentralWidget(QWidget* widget, pqView* view = 0);
  QWidget* centralWidget() const;

  void setBorderColor(const QColor& clr);
  const QColor& borderColor() const { return this->BorderColor; }

  bool isBorderVisible() const { return this->BorderVisible; }

  bool isTitleBarVisible() const { return this->TitleBarVisible; }

  enum StandardButton
  {
    NoButton = 0x0000,
    SplitHorizontal = 0x0001,
    SplitVertical = 0x0002,
    Maximize = 0x0004,
    Restore = 0x0008,
    Close = 0x0010
  };

  Q_DECLARE_FLAGS(StandardButtons, StandardButton);

  void setStandardButtons(StandardButtons buttons);
  StandardButtons standardButtons() const { return this->Buttons; }

  void addTitleBarAction(QAction* action);
  QAction* addTitleBarAction(const QString& title);
  QAction* addTitleBarAction(const QIcon& icon, const QString& title);

  QAction* addTitleBarSeparator();

  void removeTitleBarActions();

  QMenu* contextMenu() const;

  QUuid uniqueID() const { return this->UniqueID; }

Q_SIGNALS:
  void buttonPressed(int button);

  void actionTriggered(QAction* action);

  void swapPositions(const QString& other);

  void finishDrag(pqViewFrame* source);

public Q_SLOTS:
  void setBorderVisibility(bool val)
  {
    this->BorderVisible = val;
    this->updateComponentVisibilities();
  }

  void setTitleBarVisibility(bool val)
  {
    this->TitleBarVisible = val;
    this->updateComponentVisibilities();
  }

  void setDecorationsVisibility(bool val)
  {
    this->DecorationsVisible = val;
    this->updateComponentVisibilities();
  }

  void onViewNameChanged(pqServerManagerModelItem*);

  bool eventFilter(QObject*, QEvent*) override;

protected:
  virtual void updateComponentVisibilities();

  void drag();
  void dragEnter(QDragEnterEvent*);
  void drop(QDropEvent*);

protected Q_SLOTS:
  void buttonClicked();
  void contextMenuRequested(const QPoint&);

protected:
  bool DecorationsVisible;
  bool TitleBarVisible;
  bool BorderVisible;
  QColor BorderColor;
  StandardButtons Buttons;
  QPointer<QToolBar> ToolBar;
  QPointer<QWidget> CentralWidget;
  QPointer<QMenu> ContextMenu;
  QUuid UniqueID;
  QPoint DragStartPosition;
  typedef QMap<StandardButton, QPointer<QToolButton> > StandardToolButtonsMap;
  StandardToolButtonsMap StandardToolButtons;
  QPalette PaletteWithBorder;
  QPalette PaletteWithoutBorder;
  QString PlainTitle;

private:
  Q_DISABLE_COPY(pqViewFrame)

  
  QToolButton* createButton(QAction* action);

  class pqInternals;
  const QScopedPointer<pqInternals> Internals;
private Q_SLOTS:
  void finishedDrag(pqViewFrame* source);
};

Q_DECLARE_OPERATORS_FOR_FLAGS(pqViewFrame::StandardButtons);

#endif