Developer Documentation
SideElement Class Reference

#include <OpenFlipper/widgets/coreWidget/SideElement.hh>

Inheritance diagram for SideElement:

Classes

class  TopArea
 Clickable area inside of the side element. More...
 

Signals

void toggleActive (bool)
 

Public Member Functions

 SideElement (SideArea *_parent, QWidget *_w, QString _name, QIcon *_icon, QWidget *_headerAreaWidget)
 
 ~SideElement ()
 Destructor. More...
 
void setActive (bool _active)
 Set the element as active. More...
 
void saveState (QSettings &_settings)
 saves the current state More...
 
void restoreState (QSettings &_settings)
 restores the state More...
 
const QString & name ()
 return the name More...
 
bool active ()
 returns if the SideElement is active More...
 
QWidget const * widget ()
 returns the pointer to the plugin tool widget More...
 

Private Slots

void detachPressed (bool _checked)
 Called if the detach button was pressed. More...
 
void dialogClosed ()
 Called if a detached dialog was closed. More...
 

Private Member Functions

void labelPress ()
 Called on mouse press. More...
 

Private Attributes

SideAreaparent_
 
QWidget * widget_
 
QWidget * headerAreaWidget_
 
QString name_
 
QIcon * icon_
 
QVBoxLayout * mainLayout_
 
bool active_
 
QLabel * label_
 
QLabel * iconHolder_
 
QToolButton * detachButton_
 
QAction * detachAction_
 
QDialog * dialog_
 

Detailed Description

A widget that holds the plugin side area widget

Definition at line 79 of file SideElement.hh.

Constructor & Destructor Documentation

◆ SideElement()

SideElement::SideElement ( SideArea _parent,
QWidget *  _w,
QString  _name,
QIcon *  _icon,
QWidget *  _headerAreaWidget 
)

Create a SideElement

Parameters
_parentSideArea widget that holds this widget
_wPlugin tool widget
_namePlugin name
_iconAn icon that should be shown in the title bar of the side element

Definition at line 61 of file SideElement.cc.

◆ ~SideElement()

SideElement::~SideElement ( )

Destructor.

Definition at line 136 of file SideElement.cc.

Member Function Documentation

◆ active()

bool SideElement::active ( )

returns if the SideElement is active

Definition at line 304 of file SideElement.cc.

◆ detachPressed

void SideElement::detachPressed ( bool  _checked)
privateslot

Called if the detach button was pressed.

Definition at line 200 of file SideElement.cc.

◆ dialogClosed

void SideElement::dialogClosed ( )
privateslot

Called if a detached dialog was closed.

Definition at line 239 of file SideElement.cc.

◆ labelPress()

void SideElement::labelPress ( )
private

Called on mouse press.

Definition at line 149 of file SideElement.cc.

◆ name()

const QString & SideElement::name ( void  )

return the name

Definition at line 298 of file SideElement.cc.

◆ restoreState()

void SideElement::restoreState ( QSettings &  _settings)

restores the state

Definition at line 268 of file SideElement.cc.

◆ saveState()

void SideElement::saveState ( QSettings &  _settings)

saves the current state

Definition at line 258 of file SideElement.cc.

◆ setActive()

void SideElement::setActive ( bool  _active)

Set the element as active.

Definition at line 174 of file SideElement.cc.

◆ widget()

QWidget const * SideElement::widget ( )

returns the pointer to the plugin tool widget

Definition at line 310 of file SideElement.cc.

Member Data Documentation

◆ active_

bool SideElement::active_
private

Definition at line 160 of file SideElement.hh.

◆ detachAction_

QAction* SideElement::detachAction_
private

Definition at line 168 of file SideElement.hh.

◆ detachButton_

QToolButton* SideElement::detachButton_
private

Definition at line 167 of file SideElement.hh.

◆ dialog_

QDialog* SideElement::dialog_
private

Definition at line 171 of file SideElement.hh.

◆ headerAreaWidget_

QWidget * SideElement::headerAreaWidget_
private

Definition at line 148 of file SideElement.hh.

◆ icon_

QIcon* SideElement::icon_
private

Definition at line 154 of file SideElement.hh.

◆ iconHolder_

QLabel* SideElement::iconHolder_
private

Definition at line 164 of file SideElement.hh.

◆ label_

QLabel* SideElement::label_
private

Definition at line 163 of file SideElement.hh.

◆ mainLayout_

QVBoxLayout* SideElement::mainLayout_
private

Definition at line 157 of file SideElement.hh.

◆ name_

QString SideElement::name_
private

Definition at line 151 of file SideElement.hh.

◆ parent_

SideArea* SideElement::parent_
private

Definition at line 145 of file SideElement.hh.

◆ widget_

QWidget* SideElement::widget_
private

Definition at line 148 of file SideElement.hh.


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