#include <groupingcontainment.h>

Inherits Containment.

Signals
void	groupAdded (AbstractGroup *group, const QPointF &pos)

void	groupRemoved (AbstractGroup *group)

Public Member Functions
	GroupingContainment (QObject *parent, const QVariantList &args)

virtual	~GroupingContainment ()

AbstractGroup *	addGroup (const QString &plugin, const QPointF &pos=QPointF(0, 0), int id=0)

void	addGroup (AbstractGroup *group, const QPointF &pos)

QList< QAction * >	contextualActions ()

QList< AbstractGroup * >	groups () const

void	init ()

QGraphicsWidget *	movingWidget () const

void	raise (QGraphicsWidget *widget)

void	setMovingWidget (QGraphicsWidget *widget)

Protected Slots
virtual void	layoutMainGroup ()

Protected Member Functions
virtual void	constraintsEvent (Plasma::Constraints constraints)

virtual void	contextMenuEvent (QGraphicsSceneContextMenuEvent *event)

virtual void	dropEvent (QGraphicsSceneDragDropEvent *event)

virtual bool	eventFilter (QObject obj, QEvent event)

AbstractGroup *	mainGroup () const

virtual void	restoreContents (KConfigGroup &group)

virtual void	saveContents (KConfigGroup &group) const

virtual bool	sceneEventFilter (QGraphicsItem watched, QEvent event)

void	setMainGroup (AbstractGroup *group)

void	useMainGroup (const QString &type)

Properties
AbstractGroup	mainGroup

Detailed Description

The base Containment class.

GroupingContainment manages all the Groups and must be subclassed to create a new Containment with grouping support.

Definition at line 38 of file groupingcontainment.h.

Constructor & Destructor Documentation

GroupingContainment::GroupingContainment	(	QObject *	parent,
		const QVariantList &	args
	)

Default constructor.

Definition at line 559 of file groupingcontainment.cpp.

GroupingContainment::~GroupingContainment ( )

virtual

Default destructor.

Definition at line 567 of file groupingcontainment.cpp.

Member Function Documentation

AbstractGroup * GroupingContainment::addGroup	(	const QString &	plugin,
		const QPointF &	pos = `QPointF(0, 0)`,
		int	id = `0`
	)

Creates a new Group and it adds it to this Containment.

Parameters

plugin	the name of the type of Group
pos	the position where it should be created
id	the identifier for the Group. Passing 0 will set a unique one

Returns: the newly created Group

See also: addGroup; groups

Definition at line 592 of file groupingcontainment.cpp.

void GroupingContainment::addGroup	(	AbstractGroup *	group,
		const QPointF &	pos
	)

Adds a new Group to this Containment.

Parameters

group	the Group to be added
pos	the position where it should be added

See also: addGroup; groups

Definition at line 597 of file groupingcontainment.cpp.

void GroupingContainment::constraintsEvent ( Plasma::Constraints constraints )

protectedvirtual

Reimplemented from Plasma::Applet.

Definition at line 585 of file groupingcontainment.cpp.

void GroupingContainment::contextMenuEvent ( QGraphicsSceneContextMenuEvent * event )

protectedvirtual

Reimplemented from QGraphicsItem.

Definition at line 922 of file groupingcontainment.cpp.

QList< QAction * > GroupingContainment::contextualActions ( )

Reimplemented from Plasma::Applet.

Definition at line 643 of file groupingcontainment.cpp.

void GroupingContainment::dropEvent ( QGraphicsSceneDragDropEvent * event )

protectedvirtual

Reimplemented from QGraphicsItem.

Definition at line 955 of file groupingcontainment.cpp.

bool GroupingContainment::eventFilter	(	QObject *	obj,
		QEvent *	event
	)

protectedvirtual

Reimplemented from QObject.

Definition at line 740 of file groupingcontainment.cpp.

void GroupingContainment::groupAdded	(	AbstractGroup *	group,
		const QPointF &	pos
	)

signal

Emitted when a new Group is added to this Containment.

Parameters

group	the newly added Group
pos	the position where it has been added

See also: groupRemoved

void GroupingContainment::groupRemoved ( AbstractGroup * group )

signal

Emitted when a Group is removed from this Containment.

Parameters

group the group which was removed

See also: groupAdded

QList< AbstractGroup * > GroupingContainment::groups ( ) const

Returns a list of all the Groups contained in this Containment.

See also: addGroup

Definition at line 638 of file groupingcontainment.cpp.

void GroupingContainment::init ( )

Reimplemented from Plasma::Applet.

Definition at line 572 of file groupingcontainment.cpp.

void GroupingContainment::layoutMainGroup ( )

protectedvirtualslot

Lays out the Main Group.

The default implementation makes it as big as the Containment. You may want to reimplement this in subclasses if you want other behaviours.

Definition at line 672 of file groupingcontainment.cpp.

AbstractGroup* GroupingContainment::mainGroup ( ) const

protected

Returns the Main Group of this Containment.

See also: useMainGroup; AbstractGroup::isMainGroup

QGraphicsWidget * GroupingContainment::movingWidget ( ) const

Returns the widget that is currently being moved by the user, or 0 if there is not any.

Definition at line 991 of file groupingcontainment.cpp.

void GroupingContainment::raise ( QGraphicsWidget * widget )

Raises a widget above all the other Applets or Groups.

Definition at line 996 of file groupingcontainment.cpp.

void GroupingContainment::restoreContents ( KConfigGroup & group )

protectedvirtual

Reimplemented from Plasma::Containment.

Definition at line 869 of file groupingcontainment.cpp.

void GroupingContainment::saveContents ( KConfigGroup & group ) const

protectedvirtual

Reimplemented from Plasma::Containment.

Definition at line 858 of file groupingcontainment.cpp.

bool GroupingContainment::sceneEventFilter	(	QGraphicsItem *	watched,
		QEvent *	event
	)

protectedvirtual

Reimplemented from QGraphicsItem.

Definition at line 686 of file groupingcontainment.cpp.

void GroupingContainment::setMainGroup ( AbstractGroup * group )

protected

Sets a Main Group for this Containment.

Normally you will use useMainGroup instead of this.

Parameters

group the group to be set Main Group

See also: useMainGroup; mainGroup; AbstractGroup::isMainGroup

Definition at line 657 of file groupingcontainment.cpp.

void GroupingContainment::setMovingWidget ( QGraphicsWidget * widget )

Call this function when an Applet or a Group is being moved by the user.

It will be monitored to see if it is placed in a Group. Typically this method will be called by an handle.

Parameters

widget the Applet or Group to be monitored

Definition at line 969 of file groupingcontainment.cpp.

void GroupingContainment::useMainGroup ( const QString & type )

protected

Tells the Containment to use a Main Group of the given type.

It will overlap to the Containment, so it will be the root of the Groups hierarchy.

Warning: every sub class of this MUST set a Main Group, or it will encounter breackages. GroupingContainment sets by default a FloatingGroup.

Parameters

type	the type of the wanted Main Group

See also: setMainGroup; mainGroup; AbstractGroup::isMainGroup

Definition at line 650 of file groupingcontainment.cpp.

Property Documentation

AbstractGroup * GroupingContainment::mainGroup

readwrite

Definition at line 41 of file groupingcontainment.h.

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

GroupingDesktop

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation

GroupingDesktop

workspace API Reference

Search