• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

Plasma

  • plasma
  • extenders
extenderitem.h
Go to the documentation of this file.
1/*
2 * Copyright 2008, 2009 by Rob Scheepmaker <r.scheepmaker@student.utwente.nl>
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301 USA
18 */
19
20#ifndef PLASMA_EXTENDERITEM_H
21#define PLASMA_EXTENDERITEM_H
22
23#include <QtGui/QGraphicsWidget>
24
25#include <kconfiggroup.h>
26#include <kicon.h>
27
28#include "plasma/plasma_export.h"
29
30namespace Plasma
31{
32
33class Applet;
34class Extender;
35class ExtenderGroup;
36class ExtenderItemPrivate;
37
80class PLASMA_EXPORT ExtenderItem : public QGraphicsWidget
81{
82 Q_OBJECT
83 Q_PROPERTY(QGraphicsItem * widget READ widget WRITE setWidget)
84 Q_PROPERTY(QString title READ title WRITE setTitle)
85 Q_PROPERTY(QString name READ name WRITE setName)
86 Q_PROPERTY(QIcon icon READ icon WRITE setIcon)
87 Q_PROPERTY(Extender * extender READ extender WRITE setExtender)
88 Q_PROPERTY(bool collapsed READ isCollapsed WRITE setCollapsed)
89 Q_PROPERTY(bool detached READ isDetached)
90 Q_PROPERTY(uint autoExpireDelay READ autoExpireDelay WRITE setAutoExpireDelay)
91
92 public:
99 explicit ExtenderItem(Extender *hostExtender, uint extenderItemId = 0);
100
101 ~ExtenderItem();
102
107 KConfigGroup config() const;
108
113 void setWidget(QGraphicsItem *widget);
114
118 QGraphicsItem *widget() const;
119
125 void setTitle(const QString &title);
126
130 QString title() const;
131
138 void setName(const QString &name);
139
143 QString name() const;
144
151 void setIcon(const QString &icon);
152
157 void setIcon(const QIcon &icon);
158
162 QIcon icon() const;
163
169 void setExtender(Extender *extender, const QPointF &pos = QPointF(-1, -1));
170
174 Extender *extender() const;
175
181 void setGroup(ExtenderGroup *group);
182
191 void setGroup(ExtenderGroup *group, const QPointF &pos);
192
197 ExtenderGroup *group() const;
198
203 bool isGroup() const;
204
209 void setAutoExpireDelay(uint time);
210
214 uint autoExpireDelay() const;
215
219 bool isDetached() const;
220
224 bool isCollapsed() const;
225
231 void addAction(const QString &name, QAction *action);
232
238 QAction *action(const QString &name) const;
239
249 void setTransient(const bool transient);
250
255 bool isTransient() const;
256
257 public Q_SLOTS:
262 void destroy();
263
267 void setCollapsed(bool collapsed);
268
272 void returnToSource();
273
278 void showCloseButton();
279
283 void hideCloseButton();
284
285 Q_SIGNALS:
290 void destroyed(Plasma::ExtenderItem *item);
291
292 protected:
293 void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget);
294
295 void moveEvent(QGraphicsSceneMoveEvent *event);
296 void resizeEvent(QGraphicsSceneResizeEvent *event);
297
298 void mousePressEvent(QGraphicsSceneMouseEvent *event);
299 void mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event);
300 void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
301 void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);
302
303 void hoverMoveEvent(QGraphicsSceneHoverEvent *event);
304 void hoverLeaveEvent(QGraphicsSceneHoverEvent *event);
305
306 bool sceneEventFilter(QGraphicsItem *watched, QEvent *event);
307
308 QSizeF sizeHint(Qt::SizeHint which, const QSizeF &constraint) const;
309
310 private:
311 Q_PRIVATE_SLOT(d, void toggleCollapse())
312 Q_PRIVATE_SLOT(d, void updateToolBox())
313 Q_PRIVATE_SLOT(d, void themeChanged())
314 Q_PRIVATE_SLOT(d, void sourceAppletRemoved())
315 Q_PRIVATE_SLOT(d, void actionDestroyed(QObject*))
316
317 ExtenderItemPrivate * const d;
318
319 friend class Applet;
320 friend class Extender;
321 friend class ExtenderPrivate;
322 friend class ExtenderItemPrivate;
323};
324} // namespace Plasma
325#endif // PLASMA_EXTENDERITEM_H
Plasma::Applet
The base Applet class.
Definition applet.h:78
Plasma::ExtenderGroup
Allows for grouping of extender items.
Definition extendergroup.h:51
Plasma::ExtenderItem::Applet
friend class Applet
Definition extenderitem.h:319
Plasma::ExtenderItem::widget
QGraphicsItem * widget
Definition extenderitem.h:83
Plasma::ExtenderItem::isDetached
bool isDetached() const
Definition extenderitem.cpp:531
Plasma::ExtenderItem::isTransient
bool isTransient() const
Definition extenderitem.cpp:811
Plasma::ExtenderItem::setAutoExpireDelay
void setAutoExpireDelay(uint time)
Definition extenderitem.cpp:498
Plasma::ExtenderItem::isCollapsed
bool isCollapsed() const
Definition extenderitem.cpp:493
Plasma::ExtenderItem::setIcon
void setIcon(const QString &icon)
Definition extenderitem.cpp:334
Plasma::ExtenderItem::collapsed
bool collapsed
Definition extenderitem.h:88
Plasma::ExtenderItem::mouseDoubleClickEvent
void mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event)
Definition extenderitem.cpp:775
Plasma::ExtenderItem::title
QString title
Definition extenderitem.h:84
Plasma::ExtenderItem::mouseMoveEvent
void mouseMoveEvent(QGraphicsSceneMouseEvent *event)
Definition extenderitem.cpp:677
Plasma::ExtenderItem::name
QString name
Definition extenderitem.h:85
Plasma::ExtenderItem::ExtenderItem
ExtenderItem(Extender *hostExtender, uint extenderItemId=0)
The constructor takes care of adding this item to an extender.
Definition extenderitem.cpp:128
Plasma::ExtenderItem::Extender
friend class Extender
Definition extenderitem.h:320
Plasma::ExtenderItem::config
KConfigGroup config() const
fetch the configuration of this widget.
Definition extenderitem.cpp:240
Plasma::ExtenderItem::addAction
void addAction(const QString &name, QAction *action)
Definition extenderitem.cpp:540
Plasma::ExtenderItem::action
QAction * action(const QString &name) const
Definition extenderitem.cpp:554
Plasma::ExtenderItem::paint
void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
Definition extenderitem.cpp:644
Plasma::ExtenderItem::sceneEventFilter
bool sceneEventFilter(QGraphicsItem *watched, QEvent *event)
Definition extenderitem.cpp:782
Plasma::ExtenderItem::icon
QIcon icon
Definition extenderitem.h:86
Plasma::ExtenderItem::hoverMoveEvent
void hoverMoveEvent(QGraphicsSceneHoverEvent *event)
Definition extenderitem.cpp:793
Plasma::ExtenderItem::autoExpireDelay
uint autoExpireDelay
Definition extenderitem.h:90
Plasma::ExtenderItem::sizeHint
QSizeF sizeHint(Qt::SizeHint which, const QSizeF &constraint) const
Definition extenderitem.cpp:801
Plasma::ExtenderItem::isGroup
bool isGroup() const
Definition extenderitem.cpp:488
Plasma::ExtenderItem::returnToSource
void returnToSource()
Returns the extender item to its source applet.
Definition extenderitem.cpp:633
Plasma::ExtenderItem::setTitle
void setTitle(const QString &title)
Definition extenderitem.cpp:277
Plasma::ExtenderItem::setName
void setName(const QString &name)
You can assign names to extender items to look them up through the item() function.
Definition extenderitem.cpp:291
Plasma::ExtenderItem::setWidget
void setWidget(QGraphicsItem *widget)
Definition extenderitem.cpp:302
Plasma::ExtenderItem::hoverLeaveEvent
void hoverLeaveEvent(QGraphicsSceneHoverEvent *event)
Definition extenderitem.cpp:797
Plasma::ExtenderItem::setTransient
void setTransient(const bool transient)
Set the ExtenderItem as transient: won't be saved in the Plasma config and won't be restored.
Definition extenderitem.cpp:806
Plasma::ExtenderItem::group
ExtenderGroup * group() const
Definition extenderitem.cpp:483
Plasma::ExtenderItem::detached
bool detached
Definition extenderitem.h:89
Plasma::ExtenderItem::destroyed
void destroyed(Plasma::ExtenderItem *item)
Emitted when the extender item is destroyed.
Plasma::ExtenderItem::hideCloseButton
void hideCloseButton()
Hides the close button in this item's drag handle.
Definition extenderitem.cpp:569
Plasma::ExtenderItem::showCloseButton
void showCloseButton()
Shows a close button in this item's drag handle.
Definition extenderitem.cpp:559
Plasma::ExtenderItem::destroy
void destroy()
Destroys the extender item.
Definition extenderitem.cpp:579
Plasma::ExtenderItem::ExtenderPrivate
friend class ExtenderPrivate
Definition extenderitem.h:321
Plasma::ExtenderItem::setGroup
void setGroup(ExtenderGroup *group)
Definition extenderitem.cpp:442
Plasma::ExtenderItem::moveEvent
void moveEvent(QGraphicsSceneMoveEvent *event)
Definition extenderitem.cpp:654
Plasma::ExtenderItem::resizeEvent
void resizeEvent(QGraphicsSceneResizeEvent *event)
Definition extenderitem.cpp:660
Plasma::ExtenderItem::mouseReleaseEvent
void mouseReleaseEvent(QGraphicsSceneMouseEvent *event)
Definition extenderitem.cpp:787
Plasma::ExtenderItem::ExtenderItemPrivate
friend class ExtenderItemPrivate
Definition extenderitem.h:322
Plasma::ExtenderItem::setCollapsed
void setCollapsed(bool collapsed)
Collapse or expand the extender item.
Definition extenderitem.cpp:602
Plasma::ExtenderItem::extender
Extender * extender
Definition extenderitem.h:87
Plasma::ExtenderItem::setExtender
void setExtender(Extender *extender, const QPointF &pos=QPointF(-1, -1))
Definition extenderitem.cpp:348
Plasma::ExtenderItem::mousePressEvent
void mousePressEvent(QGraphicsSceneMouseEvent *event)
Definition extenderitem.cpp:668
Plasma::Extender
Extends applets to allow detachable parts.
Definition extender.h:66
QGraphicsWidget
QObject
QStyleOptionGraphicsItem
QWidget
Plasma
Namespace for everything in libplasma.
Definition abstractdialogmanager.cpp:25
plasma_export.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Tue Mar 25 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Plasma

Skip menu "Plasma"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal