ClickableFrame Class Reference

The ClickableFrame class. More...

Inheritance diagram for ClickableFrame:

Collaboration diagram for ClickableFrame:

Public Slots
void	setCaretPixmap (QString pixmapPath)
	Set the caret pixmap. More...

Signals
void	singleClick (QPoint pos)
	Signal that is emitted upon a singleclick. More...

Public Member Functions
	ClickableFrame (QString header, QWidget *parent=0, Qt::WindowFlags f={})
	ClickableFrame constructor. More...
bool	getClickable ()
	Check if the frame is clickable. More...
QString	getHeader ()
	Get the header string. More...
QString	getHoverStylesheet ()
	Get mouseover stylesheet. More...
QString	getNormalStylesheet ()
	Get the default stylesheet. More...
void	setClickable (bool status)
	Change clickable status. More...
void	setHeader (QString header)
	Set the header string. More...
void	setHoverStylesheet (QString stylesheet)
	Set mouseover stylesheet. More...
void	setNormalStylesheet (QString stylesheet)
	Set the default stylesheet. More...

Protected Member Functions
void	enterEvent (QEvent *event)
	Enter event for mouse over effects. More...
void	leaveEvent (QEvent *event)
	Leave effect for mouse over effects. More...
void	mousePressEvent (QMouseEvent *event)
	Reimplemented function to QMouseEvents. More...

Private Member Functions
void	initFrame ()

Private Attributes
QLabel *	caretLabel
bool	clickable
QString	header
QString	hoverStylesheet
QLabel *	nameLabel
QString	normalStylesheet
QString	tooltip

Detailed Description

The ClickableFrame class.

This class represents a clickable QFrame. It is used by a ContentPane. The class is used internally.

Definition at line 64 of file ClickableFrame.h.

Constructor & Destructor Documentation

ClickableFrame()

ClickableFrame::ClickableFrame ( QString  header, QWidget *  parent = 0, Qt::WindowFlags  f = {}  )

explicit

ClickableFrame constructor.

Parameters

header	Header of the frame
parent	Parent widget or 0
f	Qt::WindowFlags

Definition at line 36 of file ClickableFrame.cpp.

    : QFrame(parent, f), header(header)
{
    this->setAttribute(Qt::WA_Hover, true);
    this->clickable = true;
    this->setCursor(Qt::PointingHandCursor);
    QColor background = this->palette().color(QPalette::Window);
    QColor lighter = background.lighter(110);
    this->normalStylesheet = "";
    this->hoverStylesheet = "QFrame {background-color: " + lighter.name() + ";}";
    this->initFrame();
}

References clickable, hoverStylesheet, initFrame(), and normalStylesheet.

Here is the call graph for this function:

Member Function Documentation

enterEvent()

void ClickableFrame::enterEvent ( QEvent *  event )

protected

Enter event for mouse over effects.

Parameters

event

Definition at line 129 of file ClickableFrame.cpp.

{
    if (this->clickable) {
        this->setStyleSheet(this->hoverStylesheet);
    }
}

References clickable, and hoverStylesheet.

getClickable()

bool ClickableFrame::getClickable

(

)

Check if the frame is clickable.

Returns

bool

Definition at line 59 of file ClickableFrame.cpp.

{
    return this->clickable;
}

References clickable.

getHeader()

QString ClickableFrame::getHeader

(

)

Get the header string.

Returns

QString

Definition at line 70 of file ClickableFrame.cpp.

{
    return this->header;
}

References header.

Referenced by ContentPane::getHeader().

getHoverStylesheet()

QString ClickableFrame::getHoverStylesheet

(

)

Get mouseover stylesheet.

Returns

Definition at line 91 of file ClickableFrame.cpp.

{
    return this->hoverStylesheet;
}

References hoverStylesheet.

Referenced by ContentPane::getHeaderHoverStylesheet().

getNormalStylesheet()

QString ClickableFrame::getNormalStylesheet

(

)

Get the default stylesheet.

Returns

QString

Definition at line 81 of file ClickableFrame.cpp.

{
    return this->normalStylesheet;
}

References normalStylesheet.

Referenced by ContentPane::getHeaderStylesheet().

initFrame()

void ClickableFrame::initFrame ( )

private

Definition at line 101 of file ClickableFrame.cpp.

{
    this->setSizePolicy(QSizePolicy::Policy::Preferred, QSizePolicy::Policy::Fixed);
    this->setLayout(new QHBoxLayout());
 
    this->caretLabel = new QLabel();
    this->caretLabel->setPixmap(QPixmap(":/qAccordionIcons/caret-right.png"));
    this->layout()->addWidget(this->caretLabel);
 
    this->nameLabel = new QLabel();
    nameLabel->setText(this->header);
    this->layout()->addWidget(nameLabel);
 
    dynamic_cast<QHBoxLayout*>(this->layout())->addStretch();
 
    this->setStyleSheet(this->normalStylesheet);
}

References caretLabel, header, nameLabel, and normalStylesheet.

Referenced by ClickableFrame().

leaveEvent()

void ClickableFrame::leaveEvent ( QEvent *  event )

protected

Leave effect for mouse over effects.

Parameters

event

Definition at line 136 of file ClickableFrame.cpp.

{
    if (this->clickable) {
        this->setStyleSheet(this->normalStylesheet);
    }
}

References clickable, and normalStylesheet.

mousePressEvent()

void ClickableFrame::mousePressEvent ( QMouseEvent *  event )

protected

Reimplemented function to QMouseEvents.

Parameters

event

Definition at line 119 of file ClickableFrame.cpp.

{
    if (this->clickable) {
        emit this->singleClick(event->pos());
        event->accept();
    } else {
        event->ignore();
    }
}

References clickable, and singleClick().

setCaretPixmap

void ClickableFrame::setCaretPixmap ( QString  pixmapPath )

slot

Set the caret pixmap.

Parameters

pixmapPath

Set the carret pixmap according to the state (expanded, retracted) of the ContentPane that this ClickableFrame belongs to.

Definition at line 96 of file ClickableFrame.cpp.

{
    this->caretLabel->setPixmap(QPixmap(pixmapPath));
}

References caretLabel.

Referenced by ContentPane::closeContentPane(), and ContentPane::openContentPane().

setClickable()

void ClickableFrame::setClickable

(

bool

status

)

Change clickable status.

Parameters

status

Warning

This function is currently not exposed by the qAccordion api.

Definition at line 49 of file ClickableFrame.cpp.

{
    this->clickable = status;
    if (status) {
        this->setCursor(Qt::PointingHandCursor);
    } else {
        this->setCursor(Qt::ForbiddenCursor);
    }
}

References clickable.

setHeader()

void ClickableFrame::setHeader

(

QString

header

)

Set the header string.

Parameters

header

Definition at line 64 of file ClickableFrame.cpp.

{
    this->header = header;
    this->nameLabel->setText(this->header);
}

References header, and nameLabel.

setHoverStylesheet()

void ClickableFrame::setHoverStylesheet

(

QString

stylesheet

)

Set mouseover stylesheet.

Parameters

stylesheet

Definition at line 86 of file ClickableFrame.cpp.

{
    this->hoverStylesheet = stylesheet;
}

References hoverStylesheet.

Referenced by ContentPane::setHeaderHoverStylesheet().

setNormalStylesheet()

void ClickableFrame::setNormalStylesheet

(

QString

stylesheet

)

Set the default stylesheet.

Parameters

stylesheet

Definition at line 75 of file ClickableFrame.cpp.

{
    this->normalStylesheet = stylesheet;
    this->setStyleSheet(this->normalStylesheet);
}

References normalStylesheet.

Referenced by ContentPane::setHeaderStylesheet().

singleClick

void ClickableFrame::singleClick ( QPoint  pos )

signal

Signal that is emitted upon a singleclick.

Parameters

pos

Referenced by ContentPane::initHeaderFrame(), and mousePressEvent().

Member Data Documentation

caretLabel

QLabel* ClickableFrame::caretLabel

private

Definition at line 141 of file ClickableFrame.h.

Referenced by initFrame(), and setCaretPixmap().

clickable

bool ClickableFrame::clickable

private

Definition at line 150 of file ClickableFrame.h.

Referenced by ClickableFrame(), enterEvent(), getClickable(), leaveEvent(), mousePressEvent(), and setClickable().

header

QString ClickableFrame::header

private

Definition at line 147 of file ClickableFrame.h.

Referenced by getHeader(), initFrame(), and setHeader().

hoverStylesheet

QString ClickableFrame::hoverStylesheet

private

Definition at line 144 of file ClickableFrame.h.

Referenced by ClickableFrame(), enterEvent(), getHoverStylesheet(), and setHoverStylesheet().

nameLabel

QLabel* ClickableFrame::nameLabel

private

Definition at line 142 of file ClickableFrame.h.

Referenced by initFrame(), and setHeader().

normalStylesheet

QString ClickableFrame::normalStylesheet

private

Definition at line 145 of file ClickableFrame.h.

Referenced by ClickableFrame(), getNormalStylesheet(), initFrame(), leaveEvent(), and setNormalStylesheet().

tooltip

QString ClickableFrame::tooltip

private

Definition at line 148 of file ClickableFrame.h.

---

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

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