Developer Documentation
SideArea Class Reference

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

Inheritance diagram for SideArea:

Public Member Functions

 SideArea (QWidget *_parent=0)
 
void addItem (QObject const *const _plugin, QWidget *_w, QString _name, QIcon *_icon=0, QWidget *_headerAreaWidget=0)
 
void clear ()
 clears the whole tool widget area More...
 
void expandAll ()
 
void expand (QWidget *sideElementWidget, bool expand)
 
void saveState (QSettings &_settings)
 returns the current state More...
 
void saveViewModeState (const QString &_viewMode)
 saves the active state of _viewMode More...
 
void restoreState (QSettings &_settings)
 restores the state More...
 
void restoreViewModeState (const QString &_viewMode)
 restores the active state of _viewMode More...
 
void setElementActive (const QString &_name, bool _active)
 set the active state of given element More...
 
void moveItemToPosition (const QString &_name, int _position)
 Move a toolbox widget to a given position. More...
 
void moveItemToPosition (QObject const *const _plugin, const QString &_name, int _position)
 Move a toolbox widget to a given position. More...
 
int getNumberOfWidgets () const
 Get number of widgets. More...
 
const QList< const QObject * > & plugins ()
 Get plugins in side area. More...
 
const QStringList & names ()
 Get item names. More...
 

Public Attributes

int lastPos_
 

Private Attributes

QVector< SideElement * > items_
 
QList< const QObject * > plugins_
 
QStringList itemNames_
 
QMap< QString, bool > sideElementState_
 
QVBoxLayout * layout_
 

Detailed Description

A widget that holds the different plugin tool widgets

Definition at line 74 of file SideArea.hh.

Constructor & Destructor Documentation

◆ SideArea()

SideArea::SideArea ( QWidget *  _parent = 0)
explicit

Create a SideElement

Parameters
_parentParent widget

Definition at line 54 of file SideArea.cc.

Member Function Documentation

◆ addItem()

void SideArea::addItem ( QObject const *const  _plugin,
QWidget *  _w,
QString  _name,
QIcon *  _icon = 0,
QWidget *  _headerAreaWidget = 0 
)

Adds a plugin tool widget

Parameters
_pluginplugin corresponding to the widget
_wPlugin widget
_namePlugin name
_iconan icon
_headerAreaWidget

Definition at line 72 of file SideArea.cc.

◆ clear()

void SideArea::clear ( void  )

clears the whole tool widget area

Definition at line 138 of file SideArea.cc.

◆ expand()

void SideArea::expand ( QWidget *  sideElementWidget,
bool  expand 
)

Definition at line 161 of file SideArea.cc.

◆ expandAll()

void SideArea::expandAll ( )

Definition at line 153 of file SideArea.cc.

◆ getNumberOfWidgets()

int SideArea::getNumberOfWidgets ( ) const

Get number of widgets.

Definition at line 132 of file SideArea.cc.

◆ moveItemToPosition() [1/2]

void SideArea::moveItemToPosition ( const QString &  _name,
int  _position 
)

Move a toolbox widget to a given position.

Definition at line 84 of file SideArea.cc.

◆ moveItemToPosition() [2/2]

void SideArea::moveItemToPosition ( QObject const *const  _plugin,
const QString &  _name,
int  _position 
)

Move a toolbox widget to a given position.

Definition at line 105 of file SideArea.cc.

◆ names()

const QStringList & SideArea::names ( )

Get item names.

Definition at line 230 of file SideArea.cc.

◆ plugins()

const QList< const QObject * > & SideArea::plugins ( )

Get plugins in side area.

Definition at line 224 of file SideArea.cc.

◆ restoreState()

void SideArea::restoreState ( QSettings &  _settings)

restores the state

Definition at line 184 of file SideArea.cc.

◆ restoreViewModeState()

void SideArea::restoreViewModeState ( const QString &  _viewMode)

restores the active state of _viewMode

Definition at line 204 of file SideArea.cc.

◆ saveState()

void SideArea::saveState ( QSettings &  _settings)

returns the current state

Definition at line 172 of file SideArea.cc.

◆ saveViewModeState()

void SideArea::saveViewModeState ( const QString &  _viewMode)

saves the active state of _viewMode

Definition at line 196 of file SideArea.cc.

◆ setElementActive()

void SideArea::setElementActive ( const QString &  _name,
bool  _active 
)

set the active state of given element

Definition at line 212 of file SideArea.cc.

Member Data Documentation

◆ itemNames_

QStringList SideArea::itemNames_
private

Definition at line 141 of file SideArea.hh.

◆ items_

QVector<SideElement *> SideArea::items_
private

Definition at line 135 of file SideArea.hh.

◆ lastPos_

int SideArea::lastPos_

Definition at line 131 of file SideArea.hh.

◆ layout_

QVBoxLayout* SideArea::layout_
private

Definition at line 147 of file SideArea.hh.

◆ plugins_

QList<const QObject *> SideArea::plugins_
private

Definition at line 138 of file SideArea.hh.

◆ sideElementState_

QMap<QString, bool> SideArea::sideElementState_
private

Definition at line 144 of file SideArea.hh.


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