PanelFrame Class Reference

Class for panel widgets to contain view and other widgets. More...

#include <PanelFrame.h>

Collaboration diagram for PanelFrame:

[legend]

List of all members.

Signals
void	panelTypeChanged (const QString &panelTypeName)
	Signal that is emitted when the type of the panel has changed.
void	duplicateRequested (PanelFrame *panelFrame)
	Signal that is emitted when the given panel frame should be duplicated.
void	extractRequested (PanelFrame *panelFrame)
	Signal that is emitted when the given panel should be extracted to a new window.
void	closeRequested (PanelFrame *panelFrame)
	Signal that is emitted when the given panel should be closed.
void	viewPanelCreated (ViewPanel *viewPanel)
	Signal that is emitted when a ViewPanel-derived widget has been created for the panel frame.
Public Member Functions
	PanelFrame (::Panel::Type panelType, QWidget *parent=0, Qt::WindowFlags flags=0, bool showToolBars=true)
	Constructor of the PanelFrame class.
virtual	~PanelFrame ()
	Destructor of the PanelFrame class.
::Panel *	getPanel ()
	Returns the the panel.
Panel::Type	getPanelType ()
	Returns the type of the panel.
void	toggleToolBars (bool visible)
	Toggles the display of tool bars in the panel frame.
Protected Member Functions
virtual void	focusInEvent (QFocusEvent *event)
	Event handler that is called when the widget receives keyboard focus.
virtual void	resizeEvent (QResizeEvent *event)
	Event handler that is called when the widget is resized.
Private Slots
void	on_ui_panelTypeComboBox_currentIndexChanged (int index)
	Fills the panel frame with a panel according to the given panel type index.
void	on_ui_splitHorizontallyAction_triggered ()
	Splits the panel frame horizontally.
void	on_ui_splitVerticallyAction_triggered ()
	Splits the panel frame vertically.
void	on_ui_maximizeAction_triggered ()
	Maximizes the panel frame.
void	on_ui_maximizeHorizontallyAction_triggered ()
	Maximizes the panel frame in its row.
void	on_ui_maximizeVerticallyAction_triggered ()
	Maximizes the panel frame in its column.
void	on_ui_minimizeAction_triggered ()
	Minimizes the panel frame.
void	on_ui_duplicateAction_triggered ()
	Duplicates the panel frame by creating a new window.
void	on_ui_extractAction_triggered ()
	Extracts the panel frame to a new window.
void	on_ui_closeAction_triggered ()
	Closes the panel frame.
Private Member Functions
void	setPanelType (::Panel::Type panelType)
	Sets the panel type of the panel frame to the given value.
void	split (Qt::Orientation orientation)
	Splits the panel frame according to the given orientation.
void	maximizeWidget (QWidget *widget)
	Maximizes the given widget inside its parent widget.
void	minimizeWidget (QWidget *widget)
	Minimizes the given widget inside its parent widget.
Private Attributes
QToolBar *	m_mainToolBar
	The panel frame's main tool bar.
QToolBar *	m_panelToolBar
	The panel frame's panel tool bar.
::Panel::Type	m_panelType
	The type of the panel.
::Panel *	m_panel
	The panel that will be contained in the panel frame's main layout.
QLabel *	m_label
	The label that will becontained in the panel frame's main layout.

---

Detailed Description

Class for panel widgets to contain view and other widgets.

When referencing the Panel class in this class the namespace :: has to be used in order to differentiate between Panel and QFrame::Shape::Panel.

Inheritance Diagram

[legend]

---

Constructor & Destructor Documentation

PanelFrame::PanelFrame	(	::Panel::Type	panelType,
		QWidget *	parent = 0,
		Qt::WindowFlags	flags = 0,
		bool	showToolBars = true
	)

Constructor of the PanelFrame class.

Parameters:

	panelType	The type of panel to create.
	parent	A widget the created instance will be child of.
	flags	Extra widget options.
	showToolBars	Flag to control whether to display tool bars in the panel frame.

PanelFrame::~PanelFrame

(

)

[virtual]

Destructor of the PanelFrame class.

Defined virtual to guarantee that the destructor of a derived class will be called if the instance of the derived class is saved in a variable of its parent class type.

---

Member Function Documentation

Panel * PanelFrame::getPanel

(

)

Returns the the panel.

Public Functions.

Returns:

The panel.

Returns the the panel.

Returns:

The panel.

Panel::Type PanelFrame::getPanelType

(

)

Returns the type of the panel.

Returns the type of the panel frame.

Returns:

The type of the panel.

The type of the panel frame.

void PanelFrame::toggleToolBars

(

bool

visible

)

Toggles the display of tool bars in the panel frame.

Parameters:

visible

Flag to control whether to display tool bars in the panel frame.

void PanelFrame::panelTypeChanged

(

const QString &

panelTypeName

)

[signal]

Signal that is emitted when the type of the panel has changed.

Parameters:

panelTypeName

The name of the new panel type.

void PanelFrame::duplicateRequested

(

PanelFrame *

panelFrame

)

[signal]

Signal that is emitted when the given panel frame should be duplicated.

Parameters:

panelFrame

The panel frame to duplicate.

void PanelFrame::extractRequested

(

PanelFrame *

panelFrame

)

[signal]

Signal that is emitted when the given panel should be extracted to a new window.

Parameters:

panelFrame

The panel frame to extract to a new window.

void PanelFrame::closeRequested

(

PanelFrame *

panelFrame

)

[signal]

Signal that is emitted when the given panel should be closed.

Parameters:

panelFrame

The panel frame to close.

void PanelFrame::viewPanelCreated

(

ViewPanel *

viewPanel

)

[signal]

Signal that is emitted when a ViewPanel-derived widget has been created for the panel frame.

Parameters:

viewPanel

The ViewPanel-derived widget that has been created for the panel frame.

void PanelFrame::focusInEvent

(

QFocusEvent *

event

)

[protected, virtual]

Event handler that is called when the widget receives keyboard focus.

Protected Event Handlers.

Parameters:

event

The object containing details about the event.

Event handler that is called when the widget receives keyboard focus.

Parameters:

event

The object containing details about the event.

void PanelFrame::resizeEvent

(

QResizeEvent *

event

)

[protected, virtual]

Event handler that is called when the widget is resized.

Parameters:

event

The object containing details about the event.

void PanelFrame::setPanelType

(

::Panel::Type

panelType

)

[private]

Sets the panel type of the panel frame to the given value.

Parameters:

panelType

The new panel type for the panel frame.

void PanelFrame::split

(

Qt::Orientation

orientation

)

[private]

Splits the panel frame according to the given orientation.

Parameters:

orientation

The orientation in which to split the panel frame.

void PanelFrame::maximizeWidget

(

QWidget *

widget

)

[private]

Maximizes the given widget inside its parent widget.

The widget can be a panel frame or a splitter widget.

Parameters:

widget

The widget to maximize.

void PanelFrame::minimizeWidget

(

QWidget *

widget

)

[private]

Minimizes the given widget inside its parent widget.

The widget can be a panel frame or a splitter widget.

Parameters:

widget

The widget to minimize.

void PanelFrame::on_ui_panelTypeComboBox_currentIndexChanged

(

int

index

)

[private, slot]

Fills the panel frame with a panel according to the given panel type index.

Private Slots.

Parameters:

index

The new panel type index.

Fills the panel frame with a panel according to the given panel type index.

Parameters:

index

The new panel type index.

void PanelFrame::on_ui_splitHorizontallyAction_triggered

(

)

[private, slot]

Splits the panel frame horizontally.

Splits the panel horizontally.

Convenience function that calls split(Qt::Horizontal).

Convenience function that calls splitPanel(Qt::Horizontal).

void PanelFrame::on_ui_splitVerticallyAction_triggered

(

)

[private, slot]

Splits the panel frame vertically.

Splits the panel vertically.

Convenience function that calls split(Qt::Vertical).

Convenience function that calls splitPanel(Qt::Vertical).

void PanelFrame::on_ui_maximizeAction_triggered

(

)

[private, slot]

Maximizes the panel frame.

Maximizes the panel.

void PanelFrame::on_ui_maximizeHorizontallyAction_triggered

(

)

[private, slot]

Maximizes the panel frame in its row.

Maximizes the panel in its row.

void PanelFrame::on_ui_maximizeVerticallyAction_triggered

(

)

[private, slot]

Maximizes the panel frame in its column.

Maximizes the panel in its column.

void PanelFrame::on_ui_minimizeAction_triggered

(

)

[private, slot]

Minimizes the panel frame.

void PanelFrame::on_ui_duplicateAction_triggered

(

)

[private, slot]

Duplicates the panel frame by creating a new window.

Does not duplicate the panel itself, but notifies connected objects that the panel should be duplicated.

void PanelFrame::on_ui_extractAction_triggered

(

)

[private, slot]

Extracts the panel frame to a new window.

Does not extract the panel frame itself, but notifies connected objects that the panel frame should be extracted.

void PanelFrame::on_ui_closeAction_triggered

(

)

[private, slot]

Closes the panel frame.

Closes the panel.

Does not close the panel frame itself, but notifies connected objects that the panel frame should be closed.

Does not close the panel itself, but notifies connected objects that the panel should be closed.

---

Member Data Documentation

QToolBar* PanelFrame::m_mainToolBar [private]

The panel frame's main tool bar.

QToolBar* PanelFrame::m_panelToolBar [private]

The panel frame's panel tool bar.

::Panel::Type PanelFrame::m_panelType [private]

The type of the panel.

::Panel* PanelFrame::m_panel [private]

The panel that will be contained in the panel frame's main layout.

QLabel* PanelFrame::m_label [private]

The label that will becontained in the panel frame's main layout.

---

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

• PanelFrame.h
• PanelFrame.cpp