Plasma::ExtenderGroup Class Reference

#include <extendergroup.h>

Inheritance diagram for Plasma::ExtenderGroup:

Public Slots
void	collapseGroup ()
void	expandGroup ()
void	setGroupCollapsed (bool collapsed)
Public Slots inherited from Plasma::ExtenderItem
void	destroy ()
void	hideCloseButton ()
void	returnToSource ()
void	setCollapsed (bool collapsed)
void	showCloseButton ()

Public Member Functions
	ExtenderGroup (Extender *parent, uint groupId=0)
	~ExtenderGroup ()
bool	autoHide () const
bool	isAutoCollapse () const
bool	isGroupCollapsed () const
QList< ExtenderItem * >	items () const
void	setAutoCollapse (bool collapse)
void	setAutoHide (bool autoHide)
Public Member Functions inherited from Plasma::ExtenderItem
	ExtenderItem (Extender *hostExtender, uint extenderItemId=0)
	~ExtenderItem ()
QAction *	action (const QString &name) const
void	addAction (const QString &name, QAction *action)
uint	autoExpireDelay () const
KConfigGroup	config () const
Extender *	extender () const
ExtenderGroup *	group () const
QIcon	icon () const
bool	isCollapsed () const
bool	isDetached () const
bool	isGroup () const
bool	isTransient () const
QString	name () const
void	setAutoExpireDelay (uint time)
void	setExtender (Extender *extender, const QPointF &pos=QPointF(-1,-1))
void	setGroup (ExtenderGroup *group)
void	setGroup (ExtenderGroup *group, const QPointF &pos)
void	setIcon (const QString &icon)
void	setIcon (const QIcon &icon)
void	setName (const QString &name)
void	setTitle (const QString &title)
void	setTransient (const bool transient)
void	setWidget (QGraphicsItem *widget)
QString	title () const
QGraphicsItem *	widget () const

Protected Member Functions
void	dragEnterEvent (QGraphicsSceneDragDropEvent *event)
void	dragLeaveEvent (QGraphicsSceneDragDropEvent *event)
void	dragMoveEvent (QGraphicsSceneDragDropEvent *event)
void	dropEvent (QGraphicsSceneDragDropEvent *event)
bool	eventFilter (QObject *watched, QEvent *event)
void	resizeEvent (QGraphicsSceneResizeEvent *event)
Protected Member Functions inherited from Plasma::ExtenderItem
void	hoverLeaveEvent (QGraphicsSceneHoverEvent *event)
void	hoverMoveEvent (QGraphicsSceneHoverEvent *event)
void	mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event)
void	mouseMoveEvent (QGraphicsSceneMouseEvent *event)
void	mousePressEvent (QGraphicsSceneMouseEvent *event)
void	mouseReleaseEvent (QGraphicsSceneMouseEvent *event)
void	moveEvent (QGraphicsSceneMoveEvent *event)
void	paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
void	resizeEvent (QGraphicsSceneResizeEvent *event)
bool	sceneEventFilter (QGraphicsItem *watched, QEvent *event)
QSizeF	sizeHint (Qt::SizeHint which, const QSizeF &constraint) const

Properties
bool	autoCollapse
bool	autoHide
bool	groupCollapsed
Properties inherited from Plasma::ExtenderItem
uint	autoExpireDelay
bool	collapsed
bool	detached
Extender	extender
QIcon	icon
QString	name
QString	title
QGraphicsItem	widget

Additional Inherited Members
Signals inherited from Plasma::ExtenderItem
void	destroyed (Plasma::ExtenderItem *item)

Detailed Description

Allows for grouping of extender items.

To be able to group multiple items together, you'll need to instantiate an ExtenderGroup, and call setGroup() on all extender items you wish to add to this group. This ExtenderGroup is just the same as any other ExtenderItem, except for the expand group and collapse group buttons it provides, and the fact that it will automatically hide itself if less then one item belong to this group and autoHide is set to true.

Since

4.3

Definition at line 50 of file extendergroup.h.

Constructor & Destructor Documentation

Plasma::ExtenderGroup::ExtenderGroup ( Extender *  parent, uint  groupId = 0  )

explicit

Creates a group.

Parameters

applet

The applet this group is part of. Null is not allowed here.

Definition at line 44 of file extendergroup.cpp.

Plasma::ExtenderGroup::~ExtenderGroup

(

)

Definition at line 104 of file extendergroup.cpp.

Member Function Documentation

bool Plasma::ExtenderGroup::autoHide

(

)

const

Returns

whether or not this item hides itself if there are less then 2 items in.

void Plasma::ExtenderGroup::collapseGroup ( )

slot

Collapses this group to hide all ExtenderItems that are contained in this group, and shows the summary item.

Definition at line 190 of file extendergroup.cpp.

void Plasma::ExtenderGroup::dragEnterEvent ( QGraphicsSceneDragDropEvent *  event )

protected

Definition at line 235 of file extendergroup.cpp.

void Plasma::ExtenderGroup::dragLeaveEvent ( QGraphicsSceneDragDropEvent *  event )

protected

Definition at line 300 of file extendergroup.cpp.

void Plasma::ExtenderGroup::dragMoveEvent ( QGraphicsSceneDragDropEvent *  event )

protected

Definition at line 244 of file extendergroup.cpp.

void Plasma::ExtenderGroup::dropEvent ( QGraphicsSceneDragDropEvent *  event )

protected

Definition at line 284 of file extendergroup.cpp.

bool Plasma::ExtenderGroup::eventFilter ( QObject *  watched, QEvent *  event  )

protected

Definition at line 221 of file extendergroup.cpp.

void Plasma::ExtenderGroup::expandGroup ( )

slot

Expands this group to show all ExtenderItems that are contained in this group.

Definition at line 162 of file extendergroup.cpp.

bool Plasma::ExtenderGroup::isAutoCollapse

(

)

const

Returns

whether or not this item collapses itself when the group gets collapsed

Since

4.4

Definition at line 138 of file extendergroup.cpp.

bool Plasma::ExtenderGroup::isGroupCollapsed

(

)

const

Returns

if the group is collapsed

Since

4.4

Definition at line 148 of file extendergroup.cpp.

QList< ExtenderItem * > Plasma::ExtenderGroup::items

(

)

const

Returns

a list of items that belong to this group.

Definition at line 109 of file extendergroup.cpp.

void Plasma::ExtenderGroup::resizeEvent ( QGraphicsSceneResizeEvent *  event )

protected

Definition at line 216 of file extendergroup.cpp.

void Plasma::ExtenderGroup::setAutoCollapse

(

bool

collapse

)

Parameters

autoCollapse

whether or not this item collapses itself when the group gets collapsed, the default value is false

Since

4.4

Definition at line 143 of file extendergroup.cpp.

void Plasma::ExtenderGroup::setAutoHide

(

bool

autoHide

)

Parameters

autoHide

whether or not this item hides itself if less then 2 items belong to this group. The default value is true.

Definition at line 126 of file extendergroup.cpp.

void Plasma::ExtenderGroup::setGroupCollapsed ( bool  collapsed )

slot

expands or collapses this group

Since

4.4

Definition at line 153 of file extendergroup.cpp.

Property Documentation

bool Plasma::ExtenderGroup::autoCollapse

readwrite

Definition at line 55 of file extendergroup.h.

bool Plasma::ExtenderGroup::autoHide

readwrite

Definition at line 53 of file extendergroup.h.

bool Plasma::ExtenderGroup::groupCollapsed

readwrite

Definition at line 54 of file extendergroup.h.

---

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

• extendergroup.h
• extendergroup.cpp