pqViewFrame is used to represent a frame for any ParaView view shown in the pqMultiViewWidget. More...

#include <pqViewFrame.h>

Public Types
enum	StandardButton { NoButton = 0x0000, SplitVertical = 0x0001, SplitHorizontal = 0x0002, Maximize = 0x0004, Restore = 0x0008, Close = 0x0010 }
Public Slots
void	setBorderVisibility (bool val)
	set whether the border is visible.
void	setTitleBarVisibility (bool val)
	set whether the title-bar is visible.
void	setDecorationsVisibility (bool val)
virtual bool	eventFilter (QObject , QEvent )
	event filter to handle drag/drop events.
Signals
void	buttonPressed (int button)
	fired when a standard button is pressed.
void	actionTriggered (QAction *action)
	fired when one of the custom title-bar actions is triggered.
void	swapPositions (const QString &other)
	Fired to indicate the positions for the two frames need to be swapped.
Public Member Functions
	pqViewFrame (QWidget *parent=0)
virtual	~pqViewFrame ()
void	setTitle (const QString &text)
	Get/Set the window title.
const QString &	title () const
void	setCentralWidget (QWidget *widget)
	Get/Set the central widget shown in this frame.
QWidget *	centralWidget () const
void	setBorderColor (const QColor &clr)
	Get/Set the border BorderColor.
const QColor &	borderColor () const
bool	isBorderVisible () const
	Get/Set the border visibility.
bool	isTitleBarVisible () const
	Get whether the title-bar is shown.
	Q_DECLARE_FLAGS (StandardButtons, StandardButton)
void	setStandardButtons (StandardButtons buttons)
	This holds the collection of standard buttons the frame should show in the title-bar.
StandardButtons	standardButtons () const
void	addTitleBarAction (QAction *action)
	One can add arbitrary actions to be shown on the title bar.
QAction *	addTitleBarAction (const QString &title)
QAction *	addTitleBarAction (const QIcon &icon, const QString &title)
void	removeTitleBarActions ()
	remove all added custom title-bar actions.
QMenu *	contextMenu () const
	Provides access to the context menu.
QUuid	uniqueID () const
	provides access to the unique id assigned to the frame.
Protected Slots
void	buttonClicked ()
void	contextMenuRequested (const QPoint &)
Protected Member Functions
void	updateLayout ()
	updates the layout.
void	updateTitleBar ()
void	paintEvent (QPaintEvent *event)
void	drag ()
	methods to manage drag-drop.
void	dragEnter (QDragEnterEvent *)
void	dragMove (QDragMoveEvent *)
void	drop (QDropEvent *)
Protected Attributes
bool	DecorationsVisible
bool	TitleBarVisible
bool	BorderVisible
QColor	BorderColor
QString	Title
StandardButtons	Buttons
QPointer< QWidget >	CentralWidget
QPointer< QWidget >	TitleBar
QMenu *	ContextMenu
QUuid	UniqueID
QPoint	DragStartPosition
QList< QToolButton * >	ToolButtons
QMap< StandardButton, QPointer < QToolButton > >	StandardToolButtons

Detailed Description

pqViewFrame is used to represent a frame for any ParaView view shown in the pqMultiViewWidget.

A frame has title-bar that can be used to show arbitrary buttons, as well as a border that can be used to indicate if the frame is active.

Definition at line 51 of file pqViewFrame.h.

Member Enumeration Documentation

enum pqViewFrame::StandardButton

Enumerator:

NoButton
SplitVertical
SplitHorizontal
Maximize
Restore
Close

Definition at line 79 of file pqViewFrame.h.

Constructor & Destructor Documentation

pqViewFrame::pqViewFrame ( QWidget * parent = 0 )

virtual pqViewFrame::~pqViewFrame ( ) [virtual]

Member Function Documentation

void pqViewFrame::setTitle ( const QString & text ) [inline]

Get/Set the window title.

If not empty, the title is shown in the title-bar.

Definition at line 61 of file pqViewFrame.h.

const QString& pqViewFrame::title ( ) const [inline]

Definition at line 62 of file pqViewFrame.h.

void pqViewFrame::setCentralWidget ( QWidget * widget )

Get/Set the central widget shown in this frame.

QWidget* pqViewFrame::centralWidget ( ) const

void pqViewFrame::setBorderColor ( const QColor & clr ) [inline]

Get/Set the border BorderColor.

The border is only drawn when the borderVisibility is set to true.

Definition at line 70 of file pqViewFrame.h.

const QColor& pqViewFrame::borderColor ( ) const [inline]

Definition at line 71 of file pqViewFrame.h.

bool pqViewFrame::isBorderVisible ( ) const [inline]

Get/Set the border visibility.

Definition at line 74 of file pqViewFrame.h.

bool pqViewFrame::isTitleBarVisible ( ) const [inline]

Get whether the title-bar is shown.

Definition at line 77 of file pqViewFrame.h.

pqViewFrame::Q_DECLARE_FLAGS	(	StandardButtons	,
		StandardButton
	)

void pqViewFrame::setStandardButtons ( StandardButtons buttons )

This holds the collection of standard buttons the frame should show in the title-bar.

StandardButtons pqViewFrame::standardButtons ( ) const [inline]

Definition at line 94 of file pqViewFrame.h.

void pqViewFrame::addTitleBarAction ( QAction * action )

One can add arbitrary actions to be shown on the title bar.

QAction* pqViewFrame::addTitleBarAction ( const QString & title )

QAction* pqViewFrame::addTitleBarAction	(	const QIcon &	icon,
		const QString &	title
	)

void pqViewFrame::removeTitleBarActions ( )

remove all added custom title-bar actions.

QMenu* pqViewFrame::contextMenu ( ) const [inline]

Provides access to the context menu.

Definition at line 105 of file pqViewFrame.h.

QUuid pqViewFrame::uniqueID ( ) const [inline]

provides access to the unique id assigned to the frame.

Definition at line 109 of file pqViewFrame.h.

void pqViewFrame::buttonPressed ( int button ) [signal]

fired when a standard button is pressed.

void pqViewFrame::actionTriggered ( QAction * action ) [signal]

fired when one of the custom title-bar actions is triggered.

void pqViewFrame::swapPositions ( const QString & other ) [signal]

Fired to indicate the positions for the two frames need to be swapped.

void pqViewFrame::setBorderVisibility ( bool val ) [inline, slot]

set whether the border is visible.

Definition at line 124 of file pqViewFrame.h.

void pqViewFrame::setTitleBarVisibility ( bool val ) [inline, slot]

set whether the title-bar is visible.

Definition at line 131 of file pqViewFrame.h.

void pqViewFrame::setDecorationsVisibility ( bool val ) [inline, slot]

Definition at line 137 of file pqViewFrame.h.

virtual bool pqViewFrame::eventFilter	(	QObject *	,
		QEvent *
	)		`[virtual, slot]`

event filter to handle drag/drop events.

void pqViewFrame::updateLayout ( ) [protected]

updates the layout.

void pqViewFrame::updateTitleBar ( ) [protected]

void pqViewFrame::paintEvent ( QPaintEvent * event ) [protected]

void pqViewFrame::drag ( ) [protected]

methods to manage drag-drop.

void pqViewFrame::dragEnter ( QDragEnterEvent * ) [protected]

void pqViewFrame::dragMove ( QDragMoveEvent * ) [protected]

void pqViewFrame::drop ( QDropEvent * ) [protected]

void pqViewFrame::buttonClicked ( ) [protected, slot]

void pqViewFrame::contextMenuRequested ( const QPoint & ) [protected, slot]

Member Data Documentation

bool pqViewFrame::DecorationsVisible [protected]

Definition at line 163 of file pqViewFrame.h.

bool pqViewFrame::TitleBarVisible [protected]

Definition at line 164 of file pqViewFrame.h.

bool pqViewFrame::BorderVisible [protected]

Definition at line 165 of file pqViewFrame.h.

QColor pqViewFrame::BorderColor [protected]

Definition at line 166 of file pqViewFrame.h.

QString pqViewFrame::Title [protected]

Definition at line 167 of file pqViewFrame.h.

StandardButtons pqViewFrame::Buttons [protected]

Definition at line 168 of file pqViewFrame.h.

QPointer<QWidget> pqViewFrame::CentralWidget [protected]

Definition at line 169 of file pqViewFrame.h.

QPointer<QWidget> pqViewFrame::TitleBar [protected]

Definition at line 170 of file pqViewFrame.h.

QMenu* pqViewFrame::ContextMenu [protected]

Definition at line 171 of file pqViewFrame.h.

QUuid pqViewFrame::UniqueID [protected]

Definition at line 172 of file pqViewFrame.h.

QPoint pqViewFrame::DragStartPosition [protected]

Definition at line 173 of file pqViewFrame.h.

QList<QToolButton*> pqViewFrame::ToolButtons [protected]

Definition at line 174 of file pqViewFrame.h.

QMap<StandardButton, QPointer<QToolButton> > pqViewFrame::StandardToolButtons [protected]

Definition at line 175 of file pqViewFrame.h.

The documentation for this class was generated from the following file:

/home/kitware/Dashboards/My Tests/ParaView/Qt/Components/pqViewFrame.h

Public Types

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation