ContentPane Class Reference

Content Pane class. More...

Inheritance diagram for ContentPane:

Collaboration diagram for ContentPane:

Public Slots
void	headerClicked ()
	Slot that is called when the header has been triggered. More...

Signals
void	clicked ()
	Clicked signal is emitted when the header is clicked. More...
void	isActive ()
	Signal will be emitted after the open animation finished. More...
void	isInactive ()
	Signal will be emitted after the close animation finished. More...

Public Member Functions
	ContentPane (QString header, QFrame *content, QWidget *parent=0)
	ContentPane constructor. More...
	ContentPane (QString header, QWidget *parent=0)
	ContentPane constructor. More...
bool	getActive ()
	Check if this Content pane is active. More...
uint	getAnimationDuration ()
	Get the duration of the open, close animation. More...
int	getContainerFrameStyle ()
	Get the container frame style. More...
QFrame *	getContentFrame ()
	Get the content frame of the content pane. More...
QString	getHeader ()
	Return the header of the content pane. More...
int	getHeaderFrameStyle ()
	Get the header frame style. More...
QString	getHeaderHoverStylesheet ()
	Get the mouse over header style sheet. More...
QString	getHeaderStylesheet ()
	Get the current header style sheet. More...
QString	getHeaderTooltip ()
	Get the header tooltip. More...
int	getMaximumHeight ()
	Get the maximum height of the content pane container frame. More...
void	setAnimationDuration (uint duration)
	Set the duration for the open and close animation. More...
void	setContainerFrameStyle (int style)
	Set the container frame style. More...
void	setContentFrame (QFrame *content)
	Set the content frame. More...
void	setHeader (QString header)
	Set the header of the content pane. More...
void	setHeaderFrameStyle (int style)
	Set the header frame style. More...
void	setHeaderHoverStylesheet (QString stylesheet)
	Set a stylesheet for the header frame when the mouse hovers over it. More...
void	setHeaderStylesheet (QString stylesheet)
	Set a stylesheet for the header frame. More...
void	setHeaderTooltip (QString tooltip)
	Set header tooltip. More...
void	setMaximumHeight (int maxHeight)
	Set the maximum height of the content pane container. More...

Protected Member Functions
void	paintEvent (ATTR_UNUSED QPaintEvent *event)
	paintEvent Reimplement paintEvent to use stylesheets in derived Widgets More...

Private Slots
void	closeContentPane ()
	Close the content pane. More...
void	openContentPane ()
	Open the content pane. More...

Private Member Functions
void	initAnimations ()
void	initContainerContentFrame ()
void	initDefaults (QString header)
void	initHeaderFrame (QString header)

Private Attributes
bool	active
std::unique_ptr< QPropertyAnimation >	closeAnimation
QFrame *	container
int	containerAnimationMaxHeight
QFrame *	content
int	contentPaneFrameStyle
ClickableFrame *	header
int	headerFrameStyle
std::unique_ptr< QPropertyAnimation >	openAnimation

Friends
class	AccordionWidget

Detailed Description

Content Pane class.

Content Panes are part of a QAccordion object. They represent a clickable Header and can be expanded or retracted.

When a ContentPane is created you have to provide a Header (ContentPane(QString, QWidget*)) and, if you want, a QFrame* (ContentPane(QString, QFrame*, QWidget*)) with the content that should be displayed when the ContentPane is expanded.

Managing the content is pretty straight forward use getContentFrame() and setContentFrame() to manage the content. You are absolutely free to do anything what you like with this QFrame. Just keep in mind there is a maximumHeight for the container in which the content frame is placed (currently 150). If your content exceeds this height you have to either increase it with setMaximumHeight() or add a QScrollArea to the content frame. You may use setContainerFrameStyle() to change the frame style of the container.

The Header can be changed after the creation of the ContentPane with setHeader(). Additionally you can set a tooltip, a standard stylesheet and a mouseover stylesheet, and the frame style.

See also

setHeaderTooltip(), setHeaderStylesheet(), setHeaderHoverStylesheet(), setHeaderFrameStyle()

The animation speed is influenceable setAnimationDuration().

Definition at line 75 of file ContentPane.h.

Constructor & Destructor Documentation

ContentPane() [1/2]

ContentPane::ContentPane ( QString  header, QWidget *  parent = 0  )

explicit

ContentPane constructor.

Parameters

header	The Header of the content pane
parent	Parent widget or 0

Definition at line 35 of file ContentPane.cpp.

                                                        : QWidget(parent)
{
    this->content = nullptr;
 
    this->initDefaults(std::move(header));
}

References content, header, and initDefaults().

Here is the call graph for this function:

ContentPane() [2/2]

ContentPane::ContentPane ( QString  header, QFrame *  content, QWidget *  parent = 0  )

explicit

ContentPane constructor.

Parameters

header	The Header of the content pane
content	Content to display when expanded
parent	Parent widget or 0

Definition at line 42 of file ContentPane.cpp.

    : QWidget(parent), content(content)
{
    this->initDefaults(std::move(header));
}

References header, and initDefaults().

Here is the call graph for this function:

Member Function Documentation

clicked

void ContentPane::clicked ( )

signal

Clicked signal is emitted when the header is clicked.

Referenced by headerClicked(), AccordionWidget::internalAddContentPane(), and AccordionWidget::internalInsertContentPane().

closeContentPane

void ContentPane::closeContentPane ( )

privateslot

Close the content pane.

This will close the content pane if it is currently open.

Definition at line 151 of file ContentPane.cpp.

{
    if (!this->getActive())
        return;
    this->closeAnimation->start();
    this->header->setCaretPixmap(clickcon::CARRET_ICON_CLOSED);
    this->active = false;
}

References active, ClickableFrame_constants::CARRET_ICON_CLOSED, closeAnimation, getActive(), header, and ClickableFrame::setCaretPixmap().

Referenced by AccordionWidget::handleClickedSignal().

Here is the call graph for this function:

getActive()

bool ContentPane::getActive

(

)

Check if this Content pane is active.

Returns

boolean True if active

Definition at line 48 of file ContentPane.cpp.

{
    return this->active;
}

References active.

Referenced by closeContentPane(), AccordionWidget::handleClickedSignal(), openContentPane(), and setMaximumHeight().

getAnimationDuration()

uint ContentPane::getAnimationDuration

(

)

Get the duration of the open, close animation.

Returns

Duration in milliseconds

getContainerFrameStyle()

int ContentPane::getContainerFrameStyle

(

)

Get the container frame style.

Returns

int

See also

setHeaderFrameStyle() for additional information

Definition at line 137 of file ContentPane.cpp.

{
    return this->container->frameStyle();
}

References container.

getContentFrame()

QFrame * ContentPane::getContentFrame

(

)

Get the content frame of the content pane.

Returns

QFrame*

Use this method to get a pointer to a QFrame where you can place your content. The widget lifetime is managed by qAccordion.

Definition at line 53 of file ContentPane.cpp.

{
    return this->content;
}

References content.

Referenced by MaskEditorPropertyPanel::setup_MaskProperties(), MaskEditorPropertyPanel::setup_MaskStack(), MaskEditorPropertyPanel::setup_PlotProperties(), and TestView::test_AccordionWidget().

getHeader()

QString ContentPane::getHeader

(

)

Return the header of the content pane.

Returns

QString

Definition at line 87 of file ContentPane.cpp.

{
    return this->header->getHeader();
}

References ClickableFrame::getHeader(), and header.

Here is the call graph for this function:

getHeaderFrameStyle()

int ContentPane::getHeaderFrameStyle

(

)

Get the header frame style.

Returns

int

See also

setHeaderFrameStyle() for additional information.

Definition at line 127 of file ContentPane.cpp.

{
    return this->header->frameStyle();
}

References header.

getHeaderHoverStylesheet()

QString ContentPane::getHeaderHoverStylesheet

(

)

Get the mouse over header style sheet.

Returns

CSS Style Sheet as string

Returns the mouse over header style sheet.

Definition at line 117 of file ContentPane.cpp.

{
    return this->header->getHoverStylesheet();
}

References ClickableFrame::getHoverStylesheet(), and header.

Here is the call graph for this function:

getHeaderStylesheet()

QString ContentPane::getHeaderStylesheet

(

)

Get the current header style sheet.

Returns

CSS string

Get the css of the content pane header as QString.

Definition at line 107 of file ContentPane.cpp.

{
    return this->header->getNormalStylesheet();
}

References ClickableFrame::getNormalStylesheet(), and header.

Here is the call graph for this function:

getHeaderTooltip()

QString ContentPane::getHeaderTooltip

(

)

Get the header tooltip.

Returns

Tooltip as QString

Get the header tooltip as QString.

Definition at line 97 of file ContentPane.cpp.

{
    return this->header->toolTip();
}

References header.

getMaximumHeight()

int ContentPane::getMaximumHeight

(

)

Get the maximum height of the content pane container frame.

Returns

int

Definition at line 67 of file ContentPane.cpp.

{
    return this->container->maximumHeight();
}

References container.

headerClicked

void ContentPane::headerClicked ( )

slot

Slot that is called when the header has been triggered.

Parameters

pos	Currently unused

This slot is used to notify the ContentPane widget that the header has been triggered. You can use this slot yourself to open or close the ContentPane. Check the state of the pane before with getActive() as this slot might not do what you intended to do (for example you want to close the ContentPane. If it is already inactive and you call this slot without checking the state it will be opened).

Definition at line 230 of file ContentPane.cpp.

{
    emit this->clicked();
}

References clicked().

Referenced by MaskEditorPropertyPanel::MaskEditorPropertyPanel(), and initHeaderFrame().

initAnimations()

void ContentPane::initAnimations ( )

private

Definition at line 207 of file ContentPane.cpp.

{
    this->openAnimation = std::unique_ptr<QPropertyAnimation>(new QPropertyAnimation());
    this->closeAnimation = std::unique_ptr<QPropertyAnimation>(new QPropertyAnimation());
    // TODO: Currently these animations only animate maximumHeight. This leads to
    // different behaviour depending on whether the Accordion Widget is placed
    // inside a QScollWidget or not. Maybe we also need to animate minimumHeight
    // as well to get the same effect.
    this->openAnimation->setTargetObject(this->container);
    this->openAnimation->setPropertyName("maximumHeight");
    this->closeAnimation->setTargetObject(this->container);
    this->closeAnimation->setPropertyName("maximumHeight");
 
    this->openAnimation->setDuration(100);
    this->closeAnimation->setDuration(100);
    this->openAnimation->setStartValue(0);
    this->closeAnimation->setStartValue(this->containerAnimationMaxHeight);
    this->openAnimation->setEndValue(this->containerAnimationMaxHeight);
    this->closeAnimation->setEndValue(0);
    this->openAnimation->setEasingCurve(QEasingCurve(QEasingCurve::Type::Linear));
    this->closeAnimation->setEasingCurve(QEasingCurve(QEasingCurve::Type::Linear));
}

References closeAnimation, container, containerAnimationMaxHeight, and openAnimation.

Referenced by initDefaults().

initContainerContentFrame()

void ContentPane::initContainerContentFrame ( )

private

Definition at line 189 of file ContentPane.cpp.

{
    this->container = new QFrame();
    this->container->setLayout(new QVBoxLayout());
    this->container->setFrameStyle(this->contentPaneFrameStyle);
    this->container->setMaximumHeight(0);
    this->container->setSizePolicy(QSizePolicy::Policy::Preferred, QSizePolicy::Policy::Preferred);
    this->layout()->addWidget(this->container);
 
    if (this->content == nullptr) {
        this->content = new QFrame();
    }
 
    this->container->layout()->addWidget(this->content);
    this->container->layout()->setSpacing(0);
    this->container->layout()->setContentsMargins(QMargins());
}

References container, content, and contentPaneFrameStyle.

Referenced by initDefaults().

initDefaults()

void ContentPane::initDefaults ( QString  header )

private

Definition at line 160 of file ContentPane.cpp.

{
    this->active = false;
 
    this->headerFrameStyle = QFrame::Shape::StyledPanel | QFrame::Shadow::Raised;
    this->contentPaneFrameStyle = QFrame::Shape::StyledPanel | QFrame::Shadow::Plain;
    this->containerAnimationMaxHeight = 150;
    // TODO: Why do I need to set the vertial policy to Maximum? from the api
    // documentation Minimum would make more sens :/
    this->setSizePolicy(QSizePolicy::Policy::Preferred, QSizePolicy::Policy::Maximum);
 
    this->setLayout(new QVBoxLayout());
    this->layout()->setSpacing(0);
    this->layout()->setContentsMargins(QMargins());
 
    this->initHeaderFrame(std::move(header));
    this->initContainerContentFrame();
    this->initAnimations();
}

References active, containerAnimationMaxHeight, contentPaneFrameStyle, header, headerFrameStyle, initAnimations(), initContainerContentFrame(), and initHeaderFrame().

Referenced by ContentPane().

Here is the call graph for this function:

initHeaderFrame()

void ContentPane::initHeaderFrame ( QString  header )

private

Definition at line 180 of file ContentPane.cpp.

{
    this->header = new ClickableFrame(std::move(header));
    this->header->setFrameStyle(this->headerFrameStyle);
    this->layout()->addWidget(this->header);
 
    QObject::connect(this->header, &ClickableFrame::singleClick, this, &ContentPane::headerClicked);
}

References header, headerClicked(), headerFrameStyle, and ClickableFrame::singleClick().

Referenced by initDefaults().

Here is the call graph for this function:

isActive

void ContentPane::isActive ( )

signal

Signal will be emitted after the open animation finished.

isInactive

void ContentPane::isInactive ( )

signal

Signal will be emitted after the close animation finished.

openContentPane

void ContentPane::openContentPane ( )

privateslot

Open the content pane.

This will open the content pane if it is currently closed.

Warning

Currently there is no inbuild mechanism to close an already open Content Pane when you open another one programmatically. Meaning you have to take care of this yourself.

Definition at line 142 of file ContentPane.cpp.

{
    if (this->getActive())
        return;
    this->openAnimation->start();
    this->header->setCaretPixmap(clickcon::CARRET_ICON_OPENED);
    this->active = true;
}

References active, ClickableFrame_constants::CARRET_ICON_OPENED, getActive(), header, openAnimation, and ClickableFrame::setCaretPixmap().

Referenced by AccordionWidget::handleClickedSignal().

Here is the call graph for this function:

paintEvent()

void ContentPane::paintEvent ( ATTR_UNUSED QPaintEvent *  event )

protected

paintEvent Reimplement paintEvent to use stylesheets in derived Widgets

Parameters

event

Definition at line 235 of file ContentPane.cpp.

{
    QStyleOption o;
    o.initFrom(this);
    QPainter p(this);
    style()->drawPrimitive(QStyle::PE_Widget, &o, &p, this);
}

setAnimationDuration()

void ContentPane::setAnimationDuration

(

uint

duration

)

Set the duration for the open and close animation.

Parameters

duration

Duration in milliseconds

Set the duration of the QPropertyAnimation in milliseconds.

setContainerFrameStyle()

void ContentPane::setContainerFrameStyle

(

int

style

)

Set the container frame style.

Parameters

style

See also

setHeaderFrameStyle() for additional information

Definition at line 132 of file ContentPane.cpp.

{
    this->container->setFrameStyle(style);
}

References container.

Referenced by MaskEditorPropertyPanel::setup_MaskProperties(), MaskEditorPropertyPanel::setup_MaskStack(), and MaskEditorPropertyPanel::setup_PlotProperties().

setContentFrame()

void ContentPane::setContentFrame

(

QFrame *

content

)

Set the content frame.

Parameters

content

QFrame* with your content

Set / change the content frame of this content pane with content. The lifecycle

Definition at line 58 of file ContentPane.cpp.

{
    this->container->layout()->removeWidget(this->content);
    if (this->content != nullptr)
        delete (this->content);
    this->content = content;
    dynamic_cast<QVBoxLayout*>(this->container->layout())->insertWidget(0, this->content);
}

References container, and content.

setHeader()

void ContentPane::setHeader

(

QString

header

)

Set the header of the content pane.

Parameters

header

Definition at line 82 of file ContentPane.cpp.

{
    this->header->setHeader(std::move(header));
}

References header.

setHeaderFrameStyle()

void ContentPane::setHeaderFrameStyle

(

int

style

)

Set the header frame style.

Parameters

style

The style is the bitwise OR between a frame shape and a frame shadow style. See the Qt Documentation for additional details.

Definition at line 122 of file ContentPane.cpp.

{
    this->header->setFrameStyle(style);
}

References header.

setHeaderHoverStylesheet()

void ContentPane::setHeaderHoverStylesheet

(

QString

stylesheet

)

Set a stylesheet for the header frame when the mouse hovers over it.

Parameters

stylesheet

CSS Style Sheet as string

Set a stylesheet for the header for a special effect when the mouse hovers over it.

See also

setHeaderStylesheet() for additional details.

Definition at line 112 of file ContentPane.cpp.

{
    this->header->setHoverStylesheet(std::move(stylesheet));
}

References header, and ClickableFrame::setHoverStylesheet().

Here is the call graph for this function:

setHeaderStylesheet()

void ContentPane::setHeaderStylesheet

(

QString

stylesheet

)

Set a stylesheet for the header frame.

Parameters

stylesheet

CSS Style Sheet as string

You can use Cascading Style Sheets as supported by Qt to style the header. This is the standard style sheet. You may also set a style for mouse over with setHeaderHoverStylesheet().

Definition at line 102 of file ContentPane.cpp.

{
    this->header->setNormalStylesheet(std::move(stylesheet));
}

References header, and ClickableFrame::setNormalStylesheet().

Here is the call graph for this function:

setHeaderTooltip()

void ContentPane::setHeaderTooltip

(

QString

tooltip

)

Set header tooltip.

Parameters

tooltip

String to show as tooltip

Set a string as header tooltip that will be shown when the mouse hovers over the header area.

Definition at line 92 of file ContentPane.cpp.

{
    this->header->setToolTip(tooltip);
}

References header.

Referenced by MaskEditorPropertyPanel::setup_MaskProperties(), MaskEditorPropertyPanel::setup_MaskStack(), and MaskEditorPropertyPanel::setup_PlotProperties().

setMaximumHeight()

void ContentPane::setMaximumHeight

(

int

maxHeight

)

Set the maximum height of the content pane container.

Parameters

maxHeight

Every content pane has a container frame that defines the visible maximum height. With this function you can change this setting.

Note

This setting does not set the maximum height of the content frame. It is the users responsibilty to make sure everything in the content frame is visible. This can be influenced by either changing the maximum height of the container or for example by adding a QScrollArea.

Definition at line 72 of file ContentPane.cpp.

{
    this->containerAnimationMaxHeight = maxHeight;
 
    if (this->getActive())
        this->container->setMaximumHeight(this->containerAnimationMaxHeight);
    this->openAnimation->setEndValue(this->containerAnimationMaxHeight);
    this->closeAnimation->setStartValue(this->containerAnimationMaxHeight);
}

References closeAnimation, container, containerAnimationMaxHeight, getActive(), and openAnimation.

Referenced by MaskEditorPropertyPanel::setup_MaskProperties(), MaskEditorPropertyPanel::setup_MaskStack(), MaskEditorPropertyPanel::setup_PlotProperties(), and TestView::test_AccordionWidget().

Here is the call graph for this function:

Friends And Related Function Documentation

AccordionWidget

friend class AccordionWidget

friend

Definition at line 281 of file ContentPane.h.

Member Data Documentation

active

bool ContentPane::active

private

Definition at line 291 of file ContentPane.h.

Referenced by closeContentPane(), getActive(), initDefaults(), and openContentPane().

closeAnimation

std::unique_ptr<QPropertyAnimation> ContentPane::closeAnimation

private

Definition at line 294 of file ContentPane.h.

Referenced by closeContentPane(), initAnimations(), and setMaximumHeight().

container

QFrame* ContentPane::container

private

Definition at line 285 of file ContentPane.h.

Referenced by getContainerFrameStyle(), getMaximumHeight(), initAnimations(), initContainerContentFrame(), setContainerFrameStyle(), setContentFrame(), and setMaximumHeight().

containerAnimationMaxHeight

int ContentPane::containerAnimationMaxHeight

private

Definition at line 289 of file ContentPane.h.

Referenced by initAnimations(), initDefaults(), and setMaximumHeight().

content

QFrame* ContentPane::content

private

Definition at line 283 of file ContentPane.h.

Referenced by ContentPane(), getContentFrame(), initContainerContentFrame(), and setContentFrame().

contentPaneFrameStyle

int ContentPane::contentPaneFrameStyle

private

Definition at line 288 of file ContentPane.h.

Referenced by initContainerContentFrame(), and initDefaults().

header

ClickableFrame* ContentPane::header

private

Definition at line 284 of file ContentPane.h.

Referenced by ContentPane(), closeContentPane(), getHeader(), getHeaderFrameStyle(), getHeaderHoverStylesheet(), getHeaderStylesheet(), getHeaderTooltip(), initDefaults(), initHeaderFrame(), openContentPane(), setHeader(), setHeaderFrameStyle(), setHeaderHoverStylesheet(), setHeaderStylesheet(), and setHeaderTooltip().

headerFrameStyle

int ContentPane::headerFrameStyle

private

Definition at line 287 of file ContentPane.h.

Referenced by initDefaults(), and initHeaderFrame().

openAnimation

std::unique_ptr<QPropertyAnimation> ContentPane::openAnimation

private

Definition at line 293 of file ContentPane.h.

Referenced by initAnimations(), openContentPane(), and setMaximumHeight().

---

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

• /home/www/ba/GUI/coregui/Views/AccordionWidget/ContentPane.h
• /home/www/ba/GUI/coregui/Views/AccordionWidget/ContentPane.cpp