#include <extender.h>

Inheritance diagram for Plasma::Extender:

Public Types
enum	Appearance { NoBorders = 0, BottomUpStacked = 1, TopDownStacked = 2 }

Signals
void	geometryChanged ()

void	itemAttached (Plasma::ExtenderItem *)

void	itemDetached (Plasma::ExtenderItem *)

Public Member Functions
	Extender (Applet *applet)

	~Extender ()

Appearance	appearance () const

Applet *	applet () const

QList< ExtenderItem * >	attachedItems () const

QList< ExtenderItem * >	detachedItems () const

QString	emptyExtenderMessage () const

Q_INVOKABLE ExtenderGroup *	group (const QString &name) const

QList< ExtenderGroup * >	groups () const

Q_INVOKABLE bool	hasItem (const QString &name) const

bool	isEmpty () const

Q_INVOKABLE ExtenderItem *	item (const QString &name) const

QList< ExtenderItem * >	items () const

void	setAppearance (Appearance appearance)

void	setEmptyExtenderMessage (const QString &message)

Public Member Functions inherited from QGraphicsWidget
	QGraphicsWidget (QGraphicsItem *parent, QFlags< Qt::WindowType > wFlags)

	~QGraphicsWidget ()

QList< QAction * >	actions () const

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

virtual QRectF	boundingRect () const

bool	close ()

Qt::FocusPolicy	focusPolicy () const

QGraphicsWidget *	focusWidget () const

QFont	font () const

void	geometryChanged ()

virtual void	getContentsMargins (qreal left, qreal top, qreal right, qreal bottom) const

void	getWindowFrameMargins (qreal left, qreal top, qreal right, qreal bottom) const

int	grabShortcut (const QKeySequence &sequence, Qt::ShortcutContext context)

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

QGraphicsLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

virtual void	paint (QPainter painter, const QStyleOptionGraphicsItem option, QWidget *widget)

virtual void	paintWindowFrame (QPainter painter, const QStyleOptionGraphicsItem option, QWidget *widget)

QPalette	palette () const

QRectF	rect () const

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	resize (const QSizeF &size)

void	resize (qreal w, qreal h)

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setContentsMargins (qreal left, qreal top, qreal right, qreal bottom)

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFont (const QFont &font)

virtual void	setGeometry (const QRectF &rect)

void	setGeometry (qreal x, qreal y, qreal w, qreal h)

void	setLayout (QGraphicsLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setPalette (const QPalette &palette)

void	setShortcutAutoRepeat (int id, bool enabled)

void	setShortcutEnabled (int id, bool enabled)

void	setStyle (QStyle *style)

void	setWindowFlags (QFlags< Qt::WindowType > wFlags)

void	setWindowFrameMargins (qreal left, qreal top, qreal right, qreal bottom)

void	setWindowTitle (const QString &title)

virtual QPainterPath	shape () const

QSizeF	size () const

QStyle *	style () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

virtual int	type () const

void	unsetLayoutDirection ()

void	unsetWindowFrameMargins ()

Qt::WindowFlags	windowFlags () const

QRectF	windowFrameGeometry () const

QRectF	windowFrameRect () const

QString	windowTitle () const

Qt::WindowType	windowType () const

Public Member Functions inherited from QGraphicsObject
	QGraphicsObject (QGraphicsItem *parent)

void	enabledChanged ()

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	opacityChanged ()

void	parentChanged ()

void	rotationChanged ()

void	scaleChanged ()

void	ungrabGesture (Qt::GestureType gesture)

void	visibleChanged ()

void	xChanged ()

void	yChanged ()

void	zChanged ()

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QGraphicsItem
	QGraphicsItem (QGraphicsItem *parent)

virtual	~QGraphicsItem ()

bool	acceptDrops () const

Qt::MouseButtons	acceptedMouseButtons () const

bool	acceptHoverEvents () const

bool	acceptsHoverEvents () const

bool	acceptTouchEvents () const

virtual void	advance (int phase)

virtual QRectF	boundingRect () const =0

QRegion	boundingRegion (const QTransform &itemToDeviceTransform) const

qreal	boundingRegionGranularity () const

CacheMode	cacheMode () const

QList< QGraphicsItem * >	childItems () const

QList< QGraphicsItem * >	children () const

QRectF	childrenBoundingRect () const

void	clearFocus ()

QPainterPath	clipPath () const

virtual bool	collidesWithItem (const QGraphicsItem *other, Qt::ItemSelectionMode mode) const

virtual bool	collidesWithPath (const QPainterPath &path, Qt::ItemSelectionMode mode) const

QList< QGraphicsItem * >	collidingItems (Qt::ItemSelectionMode mode) const

QGraphicsItem *	commonAncestorItem (const QGraphicsItem *other) const

virtual bool	contains (const QPointF &point) const

QCursor	cursor () const

QVariant	data (int key) const

QTransform	deviceTransform (const QTransform &viewportTransform) const

qreal	effectiveOpacity () const

void	ensureVisible (const QRectF &rect, int xmargin, int ymargin)

void	ensureVisible (qreal x, qreal y, qreal w, qreal h, int xmargin, int ymargin)

bool	filtersChildEvents () const

GraphicsItemFlags	flags () const

QGraphicsItem *	focusItem () const

QGraphicsItem *	focusProxy () const

void	grabKeyboard ()

void	grabMouse ()

QGraphicsEffect *	graphicsEffect () const

QGraphicsItemGroup *	group () const

bool	handlesChildEvents () const

bool	hasCursor () const

bool	hasFocus () const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const

void	installSceneEventFilter (QGraphicsItem *filterItem)

bool	isActive () const

bool	isAncestorOf (const QGraphicsItem *child) const

bool	isBlockedByModalPanel (QGraphicsItem **blockingPanel) const

bool	isClipped () const

bool	isEnabled () const

bool	isObscured () const

bool	isObscured (const QRectF &rect) const

bool	isObscured (qreal x, qreal y, qreal w, qreal h) const

virtual bool	isObscuredBy (const QGraphicsItem *item) const

bool	isPanel () const

bool	isSelected () const

bool	isUnderMouse () const

bool	isVisible () const

bool	isVisibleTo (const QGraphicsItem *parent) const

bool	isWidget () const

bool	isWindow () const

QTransform	itemTransform (const QGraphicsItem other, bool ok) const

QPointF	mapFromItem (const QGraphicsItem *item, const QPointF &point) const

QPolygonF	mapFromItem (const QGraphicsItem *item, const QRectF &rect) const

QPolygonF	mapFromItem (const QGraphicsItem *item, const QPolygonF &polygon) const

QPainterPath	mapFromItem (const QGraphicsItem *item, const QPainterPath &path) const

QPointF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y) const

QPolygonF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QPointF	mapFromParent (const QPointF &point) const

QPolygonF	mapFromParent (const QRectF &rect) const

QPolygonF	mapFromParent (const QPolygonF &polygon) const

QPainterPath	mapFromParent (const QPainterPath &path) const

QPointF	mapFromParent (qreal x, qreal y) const

QPolygonF	mapFromParent (qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapFromScene (const QPolygonF &polygon) const

QPointF	mapFromScene (const QPointF &point) const

QPolygonF	mapFromScene (const QRectF &rect) const

QPainterPath	mapFromScene (const QPainterPath &path) const

QPointF	mapFromScene (qreal x, qreal y) const

QPolygonF	mapFromScene (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromItem (const QGraphicsItem *item, const QRectF &rect) const

QRectF	mapRectFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromParent (const QRectF &rect) const

QRectF	mapRectFromParent (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromScene (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromScene (const QRectF &rect) const

QRectF	mapRectToItem (const QGraphicsItem *item, const QRectF &rect) const

QRectF	mapRectToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectToParent (const QRectF &rect) const

QRectF	mapRectToParent (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectToScene (const QRectF &rect) const

QRectF	mapRectToScene (qreal x, qreal y, qreal w, qreal h) const

QPointF	mapToItem (const QGraphicsItem *item, const QPointF &point) const

QPolygonF	mapToItem (const QGraphicsItem *item, const QRectF &rect) const

QPolygonF	mapToItem (const QGraphicsItem *item, const QPolygonF &polygon) const

QPainterPath	mapToItem (const QGraphicsItem *item, const QPainterPath &path) const

QPointF	mapToItem (const QGraphicsItem *item, qreal x, qreal y) const

QPolygonF	mapToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QPointF	mapToParent (const QPointF &point) const

QPolygonF	mapToParent (const QRectF &rect) const

QPainterPath	mapToParent (const QPainterPath &path) const

QPointF	mapToParent (qreal x, qreal y) const

QPolygonF	mapToParent (qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapToParent (const QPolygonF &polygon) const

QPolygonF	mapToScene (const QRectF &rect) const

QPainterPath	mapToScene (const QPainterPath &path) const

QPointF	mapToScene (qreal x, qreal y) const

QPolygonF	mapToScene (qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapToScene (const QPolygonF &polygon) const

QPointF	mapToScene (const QPointF &point) const

QMatrix	matrix () const

void	moveBy (qreal dx, qreal dy)

qreal	opacity () const

virtual QPainterPath	opaqueArea () const

virtual void	paint (QPainter painter, const QStyleOptionGraphicsItem option, QWidget *widget)=0

QGraphicsItem *	panel () const

PanelModality	panelModality () const

QGraphicsItem *	parentItem () const

QGraphicsObject *	parentObject () const

QGraphicsWidget *	parentWidget () const

QPointF	pos () const

void	removeSceneEventFilter (QGraphicsItem *filterItem)

void	resetMatrix ()

void	resetTransform ()

void	rotate (qreal angle)

qreal	rotation () const

void	scale (qreal sx, qreal sy)

qreal	scale () const

QGraphicsScene *	scene () const

QRectF	sceneBoundingRect () const

QMatrix	sceneMatrix () const

QPointF	scenePos () const

QTransform	sceneTransform () const

void	scroll (qreal dx, qreal dy, const QRectF &rect)

void	setAcceptDrops (bool on)

void	setAcceptedMouseButtons (QFlags< Qt::MouseButton > buttons)

void	setAcceptHoverEvents (bool enabled)

void	setAcceptsHoverEvents (bool enabled)

void	setAcceptTouchEvents (bool enabled)

void	setActive (bool active)

void	setBoundingRegionGranularity (qreal granularity)

void	setCacheMode (CacheMode mode, const QSize &logicalCacheSize)

void	setCursor (const QCursor &cursor)

void	setData (int key, const QVariant &value)

void	setEnabled (bool enabled)

void	setFiltersChildEvents (bool enabled)

void	setFlag (GraphicsItemFlag flag, bool enabled)

void	setFlags (QFlags< QGraphicsItem::GraphicsItemFlag > flags)

void	setFocus (Qt::FocusReason focusReason)

void	setFocusProxy (QGraphicsItem *item)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setGroup (QGraphicsItemGroup *group)

void	setHandlesChildEvents (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setMatrix (const QMatrix &matrix, bool combine)

void	setOpacity (qreal opacity)

void	setPanelModality (PanelModality panelModality)

void	setParentItem (QGraphicsItem *newParent)

void	setPos (const QPointF &pos)

void	setPos (qreal x, qreal y)

void	setRotation (qreal angle)

void	setScale (qreal factor)

void	setSelected (bool selected)

void	setToolTip (const QString &toolTip)

void	setTransform (const QTransform &matrix, bool combine)

void	setTransformations (const QList< QGraphicsTransform * > &transformations)

void	setTransformOriginPoint (qreal x, qreal y)

void	setTransformOriginPoint (const QPointF &origin)

void	setVisible (bool visible)

void	setX (qreal x)

void	setY (qreal y)

void	setZValue (qreal z)

void	shear (qreal sh, qreal sv)

void	show ()

void	stackBefore (const QGraphicsItem *sibling)

QGraphicsObject *	toGraphicsObject ()

const QGraphicsObject *	toGraphicsObject () const

QString	toolTip () const

QGraphicsItem *	topLevelItem () const

QGraphicsWidget *	topLevelWidget () const

QTransform	transform () const

QList< QGraphicsTransform * >	transformations () const

QPointF	transformOriginPoint () const

void	translate (qreal dx, qreal dy)

void	ungrabKeyboard ()

void	ungrabMouse ()

void	unsetCursor ()

void	update (qreal x, qreal y, qreal width, qreal height)

void	update (const QRectF &rect)

QGraphicsWidget *	window () const

qreal	x () const

qreal	y () const

qreal	zValue () const

Public Member Functions inherited from QGraphicsLayoutItem
	QGraphicsLayoutItem (QGraphicsLayoutItem *parent, bool isLayout)

virtual	~QGraphicsLayoutItem ()

QRectF	contentsRect () const

QSizeF	effectiveSizeHint (Qt::SizeHint which, const QSizeF &constraint) const

QRectF	geometry () const

QGraphicsItem *	graphicsItem () const

bool	isLayout () const

qreal	maximumHeight () const

QSizeF	maximumSize () const

qreal	maximumWidth () const

qreal	minimumHeight () const

QSizeF	minimumSize () const

qreal	minimumWidth () const

bool	ownedByLayout () const

QGraphicsLayoutItem *	parentLayoutItem () const

qreal	preferredHeight () const

QSizeF	preferredSize () const

qreal	preferredWidth () const

void	setMaximumHeight (qreal height)

void	setMaximumSize (const QSizeF &size)

void	setMaximumSize (qreal w, qreal h)

void	setMaximumWidth (qreal width)

void	setMinimumHeight (qreal height)

void	setMinimumSize (const QSizeF &size)

void	setMinimumSize (qreal w, qreal h)

void	setMinimumWidth (qreal width)

void	setParentLayoutItem (QGraphicsLayoutItem *parent)

void	setPreferredHeight (qreal height)

void	setPreferredSize (const QSizeF &size)

void	setPreferredSize (qreal w, qreal h)

void	setPreferredWidth (qreal width)

void	setSizePolicy (const QSizePolicy &policy)

void	setSizePolicy (QSizePolicy::Policy hPolicy, QSizePolicy::Policy vPolicy, QSizePolicy::ControlType controlType)

QSizePolicy	sizePolicy () const

Protected Member Functions
void	dragEnterEvent (QGraphicsSceneDragDropEvent *event)

void	dragLeaveEvent (QGraphicsSceneDragDropEvent *event)

void	dragMoveEvent (QGraphicsSceneDragDropEvent *event)

void	dropEvent (QGraphicsSceneDragDropEvent *event)

virtual FrameSvg::EnabledBorders	enabledBordersForItem (ExtenderItem *item) const

virtual void	itemAddedEvent (ExtenderItem *item, const QPointF &pos=QPointF(-1,-1))

QVariant	itemChange (GraphicsItemChange change, const QVariant &value)

virtual void	itemHoverEnterEvent (ExtenderItem *item)

virtual void	itemHoverLeaveEvent (ExtenderItem *item)

virtual void	itemHoverMoveEvent (ExtenderItem *item, const QPointF &pos)

virtual void	itemRemovedEvent (ExtenderItem *item)

void	mousePressEvent (QGraphicsSceneMouseEvent *event)

void	resizeEvent (QGraphicsSceneResizeEvent *event)

virtual void	saveState ()

Protected Member Functions inherited from QGraphicsWidget
virtual void	changeEvent (QEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual bool	event (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	grabKeyboardEvent (QEvent *event)

virtual void	grabMouseEvent (QEvent *event)

virtual void	hideEvent (QHideEvent *event)

virtual void	hoverLeaveEvent (QGraphicsSceneHoverEvent *event)

virtual void	hoverMoveEvent (QGraphicsSceneHoverEvent *event)

virtual void	initStyleOption (QStyleOption *option) const

virtual void	moveEvent (QGraphicsSceneMoveEvent *event)

virtual void	polishEvent ()

virtual bool	sceneEvent (QEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual QSizeF	sizeHint (Qt::SizeHint which, const QSizeF &constraint) const

virtual void	ungrabKeyboardEvent (QEvent *event)

virtual void	ungrabMouseEvent (QEvent *event)

virtual void	updateGeometry ()

virtual bool	windowFrameEvent (QEvent *event)

virtual Qt::WindowFrameSection	windowFrameSectionAt (const QPointF &pos) const

Protected Member Functions inherited from QGraphicsObject
void	updateMicroFocus ()

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QGraphicsItem
virtual void	contextMenuEvent (QGraphicsSceneContextMenuEvent *event)

virtual void	hoverEnterEvent (QGraphicsSceneHoverEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event)

virtual void	mouseMoveEvent (QGraphicsSceneMouseEvent *event)

virtual void	mouseReleaseEvent (QGraphicsSceneMouseEvent *event)

void	prepareGeometryChange ()

virtual bool	sceneEventFilter (QGraphicsItem watched, QEvent event)

void	updateMicroFocus ()

virtual void	wheelEvent (QGraphicsSceneWheelEvent *event)

Protected Member Functions inherited from QGraphicsLayoutItem
void	setGraphicsItem (QGraphicsItem *item)

void	setOwnedByLayout (bool ownership)

virtual QSizeF	sizeHint (Qt::SizeHint which, const QSizeF &constraint) const =0

Properties
QList< ExtenderItem * >	attachedItems

QList< ExtenderItem * >	detachedItems

bool	empty

QString	emptyExtenderMessage

QList< ExtenderGroup * >	groups

QList< ExtenderItem * >	items

Properties inherited from QGraphicsWidget
	autoFillBackground

	focusPolicy

	font

	geometry

	layout

	layoutDirection

	maximumSize

	minimumSize

	palette

	preferredSize

	size

	sizePolicy

	windowFlags

	windowTitle

Properties inherited from QGraphicsObject
	effect

	enabled

	opacity

	parent

	pos

	rotation

	scale

	transformOriginPoint

	visible

	x

	y

	z

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QGraphicsWidget
void	setTabOrder (QGraphicsWidget first, QGraphicsWidget second)

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QGraphicsItem
typedef	GraphicsItemFlags

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Detailed Description

Extends applets to allow detachable parts.

An Extender is a widget that visually extends the normal contents of an applet with additional dynamic widgets called ExtenderItems. These ExtenderItems can be detached by the user and dropped either on another Extender or on the canvas directly.

This widget allows using ExtenderItems in your applet. Extender takes care of the presentation of a collection of ExtenderItems and keeps track of ExtenderItems that originate in it.

The default Extender implementation displays extender items in a vertical layout with spacers that appear when dropping an ExtenderItem over it.

If you wish to have a different presentation of extender items, you can choose to subclass Extender and reimplement the extenderItem* events and, optionally, the saveState function.

To use an Extender in you applet, you'll have to instantiate one. A call to extender() in your applet will create an extender on your applet if you haven't got one already. Every applet can contain only one extender. Think of it as a decorator that adds some functionality to applets that require it. Never instantiate an Extender before init() in your applet. This won't work correctly since a scene is required when an Extender is instantiated.

As soon as an Extender is instantiated, ExtenderItems contained previously in this Extender are restored using the initExtenderItem function from the applet the items originally came from. For more information on how this works and how to use ExtenderItems in general, see the ExtenderItem API documentation.

Definition at line 65 of file extender.h.

Member Enumeration Documentation

enum Plasma::Extender::Appearance

Description on how to render the extender's items.

Enumerator

NoBorders

Draws no borders on the extender's items.

When placed in an applet on the desktop, use this setting and use the standard margins of the applet containing this extender.

BottomUpStacked

Draws no borders on the topmost extenderitem, but draws the left, top and right border on subsequent items.

When margins of the containing dialog are set to 0, except for the top margin, this leads to the 'stacked' look, recommended for extenders of applet's contained in a panel at the bottom of the screen.

TopDownStacked

Draws no borders on the bottom extenderitem, but draws the left, bottom and right border on subsequent items.

When margins of the containing dialog are set to 0, except for the bottom margin, this leads to the 'stacked' look, recommended for extenders of applet's contained in a panel at the top of the screen.

Definition at line 79 of file extender.h.

Constructor & Destructor Documentation

Plasma::Extender::Extender ( Applet * applet )

explicit

Creates an extender.

Note that extender expects applet to have a config(), and needs a scene because of that. So you should only instantiate an extender in init() or later, not in an applet's constructor. The constructor also takes care of restoring ExtenderItems that were contained in this extender before, so ExtenderItems are persistent between sessions. Note that a call to extender() in an applet will instantiate an Extender for you if one isn't already associated with your applet.

Parameters

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

Definition at line 88 of file extender.cpp.

Plasma::Extender::~Extender ( )

Definition at line 133 of file extender.cpp.

Member Function Documentation

Extender::Appearance Plasma::Extender::appearance ( ) const

Returns: the current way of rendering extender items that is used.

Definition at line 339 of file extender.cpp.

Applet * Plasma::Extender::applet ( ) const

Returns: the Applet this Extender is associated with

Since: 4.4

Definition at line 358 of file extender.cpp.

QList<ExtenderItem*> Plasma::Extender::attachedItems ( ) const

Returns: a list of all attached extender items.

QList<ExtenderItem*> Plasma::Extender::detachedItems ( ) const

Returns: a list of all detached extender items.

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

protectedvirtual

Reimplemented from QGraphicsWidget.

Reimplemented from QGraphicsItem.

Definition at line 399 of file extender.cpp.

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

protectedvirtual

Reimplemented from QGraphicsWidget.

Reimplemented from QGraphicsItem.

Definition at line 432 of file extender.cpp.

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

protectedvirtual

Reimplemented from QGraphicsWidget.

Reimplemented from QGraphicsItem.

Definition at line 418 of file extender.cpp.

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

protectedvirtual

Reimplemented from QGraphicsWidget.

Reimplemented from QGraphicsItem.

Definition at line 476 of file extender.cpp.

QString Plasma::Extender::emptyExtenderMessage ( ) const

Returns: The text to be shown whenever the applet's layout is empty.

FrameSvg::EnabledBorders Plasma::Extender::enabledBordersForItem ( ExtenderItem * item ) const

protectedvirtual

This function get's called on every item to determine which background border's to render.

Parameters

item	the item for which its position or extender has changed.

Returns: the borders that have to be enabled on its background.

Definition at line 605 of file extender.cpp.

void Plasma::Extender::geometryChanged ( )

signal

Fires when an extender's preferred size changes.

ExtenderGroup * Plasma::Extender::group ( const QString & name ) const

Extra convenience function for obtaining groups specified by name.

This will avoid needed to call item and casting to ExtenderGroup, which is otherwise quite common.

Returns: the requested group

Since: 4.3

Definition at line 293 of file extender.cpp.

QList<ExtenderGroup*> Plasma::Extender::groups ( ) const

Returns: a list of groups that are contained in this extender.

Since: 4.3

bool Plasma::Extender::hasItem ( const QString & name ) const

This function can be used for easily determining if a certain item is already displayed in an extender item somewhere, so your applet doesn't duplicate this item.

This is needed because ExtenderItems are persistent, so you can't blindly add new extender items in all cases.

Returns: whether or not this item already exists.

Since: 4.3

Definition at line 298 of file extender.cpp.

bool Plasma::Extender::isEmpty ( ) const

Returns: true if the Extender is visually empty (though it may have items such as empty groups or detached items associatd with it)

Definition at line 927 of file extender.cpp.

ExtenderItem * Plasma::Extender::item ( const QString & name ) const

This function can be used for obtaining the extender item specified by name.

For checking whether or not an item already exists, you should use hasItem instead: while plasma is starting up, not all detached items might have been instantiated yet. hasItem returns true even if the requested item isn't instantiated yet.

Returns: the requested item

Definition at line 241 of file extender.cpp.

void Plasma::Extender::itemAddedEvent	(	ExtenderItem *	item,
		const QPointF &	pos = `QPointF(-1, -1)`
	)

protectedvirtual

Get's called after an item has been added to this extender.

The bookkeeping has already been done when this function get's called. The only thing left to do is put it somewhere appropriate. The default implementation adds the extenderItem to the appropriate place in a QGraphicsLinearLayout.

Parameters

item	The item that has just been added.
pos	The location the item has been dropped in local coordinates.

Definition at line 490 of file extender.cpp.

void Plasma::Extender::itemAttached ( Plasma::ExtenderItem * )

signal

Fires when an extender item is added to this extender.

QVariant Plasma::Extender::itemChange	(	GraphicsItemChange	change,
		const QVariant &	value
	)

protectedvirtual

Reimplemented from QGraphicsWidget.

Definition at line 370 of file extender.cpp.

void Plasma::Extender::itemDetached ( Plasma::ExtenderItem * )

signal

Fires when an extender item is removed from this extender.

void Plasma::Extender::itemHoverEnterEvent ( ExtenderItem * item )

protectedvirtual

Get's called when an ExtenderItem that get's dragged enters this extender.

Default implementation does nothing.

Definition at line 552 of file extender.cpp.

void Plasma::Extender::itemHoverLeaveEvent ( ExtenderItem * item )

protectedvirtual

Get's called when an ExtenderItem that was previously hovering over this extender moves away from this extender.

The default implementation removes any spacer from the layout.

Definition at line 589 of file extender.cpp.

void Plasma::Extender::itemHoverMoveEvent	(	ExtenderItem *	item,
		const QPointF &	pos
	)

protectedvirtual

Gets called when an ExtenderItem is hovering over this extender.

Implement this function to give some visual feedback about what will happen when the mouse button is released at that position. The default implementation shows a spacer at the appropriate location in the layout.

Parameters

item	The item that's hovering over this extender. Most useful for obtaining the size of the spacer.
pos	The location the item is hovering.

Definition at line 557 of file extender.cpp.

void Plasma::Extender::itemRemovedEvent ( ExtenderItem * item )

protectedvirtual

Get's called after an item has been removed from this extender.

All bookkeeping has already been done when this function get's called.

Parameters

item	The item that has just been removed.

Definition at line 525 of file extender.cpp.

QList<ExtenderItem*> Plasma::Extender::items ( ) const

Returns: a list of all extender items (attached AND detached) where the source applet is this applet.

void Plasma::Extender::mousePressEvent ( QGraphicsSceneMouseEvent * event )

protectedvirtual

Reimplemented from QGraphicsWidget.

Reimplemented from QGraphicsItem.

Definition at line 385 of file extender.cpp.

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

protectedvirtual

Reimplemented from QGraphicsWidget.

Definition at line 379 of file extender.cpp.

void Plasma::Extender::saveState ( )

protectedvirtual

This function get's called for every extender when plasma exits.

Implement this function to store the current state of this extender (position in a layout for example), so this can be restored when applet starts again. The default implementation stores the y coordinate of every extender item in the config field extenderItemPos.

Definition at line 363 of file extender.cpp.

void Plasma::Extender::setAppearance ( Appearance appearance )

Use this function to instruct the extender on how to render its items.

Usually you will want to call this function in your applet's constraintsEvent, allthough this is already done for you when using PopupApplet as base class for your applet. Defaults to NoBorders.

Parameters

appearance the way this extender should look.

Definition at line 329 of file extender.cpp.

void Plasma::Extender::setEmptyExtenderMessage ( const QString & message )

Parameters

message The text to be shown whenever the applet's extender is empty.

Definition at line 163 of file extender.cpp.

Property Documentation

QList< ExtenderItem * > Plasma::Extender::attachedItems

read

Definition at line 70 of file extender.h.

QList< ExtenderItem * > Plasma::Extender::detachedItems

read

Definition at line 71 of file extender.h.

bool Plasma::Extender::empty

read

Definition at line 73 of file extender.h.

QString Plasma::Extender::emptyExtenderMessage

readwrite

Definition at line 68 of file extender.h.

QList< ExtenderGroup * > Plasma::Extender::groups

read

Definition at line 72 of file extender.h.

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

read

Definition at line 69 of file extender.h.

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

Plasma

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation

Plasma

kdelibs API Reference

Search