Plasma::ExtenderGroup Class Reference

Allows for grouping of extender items. More...

#include <extendergroup.h>

Inheritance diagram for Plasma::ExtenderGroup:

[legend]

List of all members.

Public Slots
void	collapseGroup ()
void	expandGroup ()
void	setGroupCollapsed (bool collapsed)
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)
Properties
bool	autoCollapse
bool	autoHide
bool	groupCollapsed

---

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 37 of file extendergroup.cpp.

Plasma::ExtenderGroup::~ExtenderGroup

(

)

Definition at line 83 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 165 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 144 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 117 of file extendergroup.cpp.

bool Plasma::ExtenderGroup::isGroupCollapsed

(

)

const

Returns:

if the group is collapsed

Since:

4.4

Definition at line 130 of file extendergroup.cpp.

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

(

)

const

Returns:

a list of items that belong to this group.

Definition at line 88 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 122 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 105 of file extendergroup.cpp.

void Plasma::ExtenderGroup::setGroupCollapsed

(

bool

collapsed

)

[slot]

expands or collapses this group

Since:

4.4

Definition at line 135 of file extendergroup.cpp.

---

Property Documentation

bool Plasma::ExtenderGroup::autoCollapse [read, write]

Definition at line 55 of file extendergroup.h.

bool Plasma::ExtenderGroup::autoHide [read, write]

Definition at line 53 of file extendergroup.h.

bool Plasma::ExtenderGroup::groupCollapsed [read, write]

Definition at line 54 of file extendergroup.h.

---

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

• extendergroup.h
• extendergroup.cpp