/* * Copyright 2006-2007 by Aaron Seigo * Copyright 2007 by Riccardo Iaconelli * Copyright 2008 by Ménard Alexis * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU Library General Public License as * published by the Free Software Foundation; either version 2, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details * * You should have received a copy of the GNU Library General Public * License along with this program; if not, write to the * Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ #ifndef PLASMA_PLASMOID_H #define PLASMA_PLASMOID_H namespace Plasma { class PlasmoidPrivate; class Containment; class Context; class DataEngine; class Extender; class ExtenderItem; class Package; /** * @class Plasmoid plasma/applet.h * * @short The base Plasmoid class * * Plasmoid provides several important roles for add-ons widgets in Plasma. * * First, it is the base class for the plugin system and therefore is the * interface to applets for host applications. It also handles the life time * management of data engines (e.g. all data engines accessed via * Plasmoid::dataEngine(const QString&) are properly deref'd on Plasmoid * destruction), background painting (allowing for consistent and complex * look and feel in just one line of code for applets), loading and starting * of scripting support for each applet, providing access to the associated * plasmoid package (if any) and access to configuration data. * * See techbase.kde.org for tutorials on writing Plasmoids using this class. */ class PLASMA_EXPORT Plasmoid : public QGraphicsWidget { Q_OBJECT Q_PROPERTY(bool hasConfigurationInterface READ hasConfigurationInterface) Q_PROPERTY(QString name READ name) Q_PROPERTY(QString pluginName READ pluginName) Q_PROPERTY(QString category READ category) Q_PROPERTY(ImmutabilityType immutability READ immutability WRITE setImmutability) Q_PROPERTY(bool hasFailedToLaunch READ hasFailedToLaunch WRITE setFailedToLaunch) Q_PROPERTY(bool busy READ isBusy WRITE setBusy) Q_PROPERTY(bool configurationRequired READ configurationRequired WRITE setConfigurationRequired) Q_PROPERTY(QRectF geometry READ geometry WRITE setGeometry) Q_PROPERTY(bool shouldConserveResources READ shouldConserveResources) Q_PROPERTY(uint id READ id) Q_PROPERTY(bool userConfiguring READ isUserConfiguring) public: typedef QList List; typedef QHash Dict; /** * Description on how draw a background for the applet */ enum BackgroundHint { NoBackground = 0, /**< Not drawing a background under the applet, the applet has its own implementation */ StandardBackground = 1, /**< The standard background from the theme is drawn */ TranslucentBackground = 2, /**< An alternate version of the background is drawn, usually more translucent */ DefaultBackground = StandardBackground /**< Default settings: both standard background */ }; Q_DECLARE_FLAGS(BackgroundHints, BackgroundHint) ~Plasmoid(); /** * @return a package structure representing a Plasmoid */ static PackageStructure::Ptr packageStructure(); /** * @return the id of this applet */ uint id() const; /** * Returns the KConfigGroup to access the applets configuration. * * This config object will write to an instance * specific config file named \\rc * in the Plasma appdata directory. **/ KConfigGroup config() const; /** * Returns a config group with the name provided. This ensures * that the group name is properly namespaced to avoid collision * with other applets that may be sharing this config file * * @param group the name of the group to access **/ KConfigGroup config(const QString &group) const; /** * Saves state information about this applet that will * be accessed when next instantiated in the restore(KConfigGroup&) method. * * This method does not need to be reimplmented by Plasmoid * subclasses, but can be useful for Plasmoid specializations * (such as Containment) to do so. * * Plasmoid subclasses may instead want to reimplement saveState(). **/ virtual void save(KConfigGroup &group) const; /** * Restores state information about this applet saved previously * in save(KConfigGroup&). * * This method does not need to be reimplmented by Plasmoid * subclasses, but can be useful for Plasmoid specializations * (such as Containment) to do so. **/ virtual void restore(KConfigGroup &group); /** * Returns a KConfigGroup object to be shared by all applets of this * type. * * This config object will write to an applet-specific config object * named plasma_\rc in the local config directory. */ KConfigGroup globalConfig() const; /** * Returns the config skeleton object from this applet's package, * if any. * TODO: still keep both kconfiggroup and kconfigskeleton? * @return config skeleton object, or 0 if none **/ ConfigLoader *configScheme() const; /** * Accessor for the associated Package object if any. * Generally, only Plasmoids come in a Package. * * @return the Package object, or 0 if none **/ const Package *package() const; /** * Called when any of the geometry constraints have been updated. * This method calls constraintsEvent, which may be reimplemented, * once the Plasmoid has been prepared for updating the constraints. * TODO: KEEP? * @param constraints the type of constraints that were updated */ void updateConstraints(Plasma::Constraints constraints = Plasma::AllConstraints); /** * Returns the current form factor the applet is being displayed in. * TODO: qproperty with notify? * @see Plasma::FormFactor */ virtual FormFactor formFactor() const; /** * Returns the location of the scene which is displaying applet. * TODO: qproperty with notify? * @see Plasma::Location */ virtual Location location() const; /** * Returns the workspace context which the applet is operating in */ Context *context() const; /** * @return the preferred aspect ratio mode for placement and resizing * TODO: should still be there since this shouldn't be graphical? */ Plasma::AspectRatioMode aspectRatioMode() const; /** * Sets the preferred aspect ratio mode for placement and resizing */ void setAspectRatioMode(Plasma::AspectRatioMode); /** * Returns the user-visible name for the applet, as specified in the * .desktop file. * * @return the user-visible name for the applet. **/ QString name() const; /** * Returns the plugin name for the applet */ QString pluginName() const; /** * Whether the applet should conserve resources. If true, try to avoid doing stuff which * is computationally heavy. Try to conserve power and resources. * * @return true if it should conserve resources, false if it does not. */ bool shouldConserveResources() const; /** * Returns the icon related to this applet **/ QString icon() const; /** * @return The type of immutability of this applet */ ImmutabilityType immutability() const; /** * If for some reason, the applet fails to get up on its feet (the * library couldn't be loaded, necessary hardware support wasn't found, * etc..) this method returns true **/ bool hasFailedToLaunch() const; /** * @return true if the applet is busy and is showing an indicator widget for that */ bool isBusy() const; /** * @return true if the applet currently needs to be configured, * otherwise, false */ bool configurationRequired() const; /** * @return true if this plasmoid provides a GUI configuration **/ bool hasConfigurationInterface() const; /** * Returns a list of context-related QAction instances. * * This is used e.g. within the \a DesktopView to display a * contextmenu. * * @return A list of actions. The default implementation returns an * empty list. **/ virtual QList contextualActions(); /** * Returns the QAction with the given name from our collection */ Q_INVOKABLE QAction *action(QString name) const; /** * Adds the action to our collection under the given name * TODO: QList or QHash of QActions instead? */ void addAction(QString name, QAction *action); /** * Sets the BackgroundHints for this applet @see BackgroundHint * * @param hints the BackgroundHint combination for this applet */ void setBackgroundHints(const BackgroundHints hints); /** * @return BackgroundHints flags combination telling if the standard background is shown * and if it has a drop shadow */ BackgroundHints backgroundHints() const; /** * @return true if this Plasmoid is currently being used as a Containment, false otherwise */ bool isContainment() const; /** * @return the Containment, if any, this applet belongs to **/ Containment *containment() const; /** * Sets the global shorcut to associate with this widget. * TODO: globalActions instead? */ void setGlobalShortcut(const KShortcut &shortcut); /** * @return the global shortcut associated with this wiget, or * an empty shortcut if no global shortcut is associated. */ KShortcut globalShortcut() const; /** * associate actions with this widget, including ones added after this call. * needed to make keyboard shortcuts work. * TODO: can this be internal/private? */ virtual void addAssociatedWidget(QWidget *widget); /** * un-associate actions from this widget, including ones added after this call. * needed to make keyboard shortcuts work. */ virtual void removeAssociatedWidget(QWidget *widget); /** * @param parent the QGraphicsItem this applet is parented to * @param serviceId the name of the .desktop file containing the * information about the widget * @param appletId a unique id used to differentiate between multiple * instances of the same Plasmoid type */ explicit Plasmoid(QGraphicsItem *parent = 0, const QString &serviceId = QString(), uint appletId = 0); /** * @param parent the QGraphicsItem this applet is parented to * @param info the plugin information object for this Plasmoid * @param appletId a unique id used to differentiate between multiple * instances of the same Plasmoid type * @since 4.6 */ explicit Plasmoid(const KPluginInfo &info, QGraphicsItem *parent = 0, uint appletId = 0); /** * @param parent the QGraphicsItem this applet is parented to * @param serviceId the name of the .desktop file containing the * information about the widget * @param appletId a unique id used to differentiate between multiple * instances of the same Plasmoid type * @param args a list of strings containing two entries: the service id * and the applet id * @since 4.3 */ explicit Plasmoid(QGraphicsItem *parent, const QString &serviceId, uint appletId, const QVariantList &args); /** * @return true if destroy() was called; useful for Plasmoids which should avoid * certain tasks if they are about to be deleted permanently */ bool destroyed() const; /** * Reimplement this method so provide a configuration interface, * parented to the supplied widget. Ownership of the widgets is passed * to the parent widget. * * Typically one would add custom pages to the config dialog @p parent * and then connect to the applyClicked() and okClicked() signals * or @p parent to react on config changes: * * @code * connect(parent, SIGNAL(applyClicked()), this, SLOT(myConfigAccepted())); * connect(parent, SIGNAL(okClicked()), this, SLOT(myConfigAccepted())); * @endcode * * With this approach it makes sense to store the custom pages in member * variables to make their fields accessible from the myConfigAccepted() * slot. * * Use config() to store your configuration. * * @param parent the dialog which is the parent of the configuration * widgets */ virtual void createConfigurationInterface(KConfigDialog *parent); /** * Returns true if the applet is allowed to perform functions covered by the given constraint * eg. hasAuthorization("FileDialog") returns true if applets are allowed to show filedialogs. * @since 4.3 */ bool hasAuthorization(const QString &constraint) const; /** * Sets an application associated to this applet, that will be * regarded as a full view of what is represented in the applet * * @param string the name of the application. it can be * \li a name understood by KService::serviceByDesktopName * (e.g. "konqueror") * \li a command in $PATH * \li or an absolute path to an executable * @since 4.4 */ void setAssociatedApplication(const QString &string); /** * Sets a list of urls associated to this application, * they will be used as parameters for the associated application * @see setAssociatedApplication() * * @param urls */ void setAssociatedApplicationUrls(const KUrl::List &urls); /** * @return the application associated to this applet * @since 4.4 */ QString associatedApplication() const; /** * @return the urls associated to this applet * @since 4.4 */ KUrl::List associatedApplicationUrls() const; /** * @return true if the applet has a valid associated application or urls * @since 4.4 */ bool hasValidAssociatedApplication() const; Q_SIGNALS: /** * This signal indicates that an application launch, window * creation or window focus event was triggered. This is used, for instance, * to ensure that the Dashboard view in Plasma Desktop hides when such an event is * triggered by an item it is displaying. */ void releaseVisualFocus(); Q_SIGNALS: /** * Emitted when the user completes a transformation of the applet. */ void appletTransformedByUser(); /** * Emitted when the applet changes its own geometry or transform. */ void appletTransformedItself(); /** * Emitted by Plasmoid subclasses when they change a sizeHint and wants to announce the change */ void sizeHintChanged(Qt::SizeHint which); /** * Emitted when an applet has changed values in its configuration * and wishes for them to be saved at the next save point. As this implies * disk activity, this signal should be used with care. * * @note This does not need to be emitted from saveState by individual * applets. */ void configNeedsSaving(); /** * Emitted when activation is requested due to, for example, a global * keyboard shortcut. By default the wiget is given focus. */ void activate(); /** * Emitted when the user clicked on a button of the message overlay * * @see showMessage * @see Plasma::MessageButton * @since 4.3 */ void messageButtonPressed(const Plasma::MessageButton button); /** * Emitted when the applet is deleted */ void appletDestroyed(Plasma::Plasmoid *applet); /** * Emitted when the applet status changes * @since 4.4 */ void newStatus(Plasma::ItemStatus status); /** * Emitted when an ExtenderItem in a scripting applet needs to be initialized */ void extenderItemRestored(Plasma::ExtenderItem *item); /** * Emitted when the immutability changes * @since 4.4 */ void immutabilityChanged(Plasma::ImmutabilityType immutable); public Q_SLOTS: /** * Sets the immutability type for this applet (not immutable, * user immutable or system immutable) * @arg immutable the new immutability type of this applet */ void setImmutability(const ImmutabilityType immutable); /** * Destroys the applet; it will be removed nicely and deleted. * Its configuration will also be deleted. */ virtual void destroy(); /** * Lets the user interact with the plasmoid options. * Called when the user selects the configure entry * from the context menu. * * Unless there is good reason for overriding this method, * Plasmoid subclasses should actually override createConfigurationInterface * instead. A good example of when this isn't plausible is * when using a dialog prepared by another library, such * as KPropertiesDialog from libkfile. * You probably want to call showConfigurationInterface(QWidget*) * with the custom widget you created to actually show your interface */ virtual void showConfigurationInterface(); /** * Actually show your custom configuration interface * Use this only if you reimplemented showConfigurationInterface() * * @arg widget the widget representing your configuration interface * * @since 4.5 */ void showConfigurationInterface(QWidget *widget); /** * @return true when the configuration interface is being shown * @since 4.5 */ bool isUserConfiguring() const; /** * Causes this applet to raise above all other applets. */ void raise(); /** * Causes this applet to lower below all the other applets. */ void lower(); /** * Sends all pending contraints updates to the applet. Will usually * be called automatically, but can also be called manually if needed. */ void flushPendingConstraintsEvents(); /** * This method is called once the applet is loaded and added to a Corona. * If the applet requires a QGraphicsScene or has an particularly intensive * set of initialization routines to go through, consider implementing it * in this method instead of the constructor. * * Note: paintInterface may get called before init() depending on initialization * order. Painting is managed by the canvas (QGraphisScene), and may schedule a * paint event prior to init() being called. **/ virtual void init(); /** * Called when applet configuration values have changed. */ virtual void configChanged(); /** * Shows a busy indicator that overlays the applet * @param busy show or hide the busy indicator */ void setBusy(bool busy); /** * @return the list of arguments which the applet was called with * @since KDE4.3 */ QVariantList startupArguments() const; /** * @return the status of the applet * @since 4.4 */ ItemStatus status() const; /** * sets the status for this applet * @since 4.4 */ void setStatus(const ItemStatus stat); /** * Publishes and optionally announces this applet on the network for remote access. * @param methods the methods to use for announcing this applet. * @param resourceName the name under which this applet will be published (has to be unique * for each machine) */ void publish(Plasma::AnnouncementMethods methods, const QString &resourceName); void unpublish(); bool isPublished() const; /** * Open the application associated to this applet, if it's not set * but some urls are, open those urls with the proper application * for their mimetype * @see setAssociatedApplication() * @see setAssociatedApplicationUrls() * @since 4.4 */ void runAssociatedApplication(); protected: /** * This constructor is to be used with the plugin loading systems * found in KPluginInfo and KService. The argument list is expected * to have two elements: the KService service ID for the desktop entry * and an applet ID which must be a base 10 number. * * @param parent a QObject parent; you probably want to pass in 0 * @param args a list of strings containing two entries: the service id * and the applet id */ Plasmoid(QObject *parent, const QVariantList &args); /** * Call this method when the applet fails to launch properly. An * optional reason can be provided. * * Not that all children items will be deleted when this method is * called. If you have pointers to these items, you will need to * reset them after calling this method. * * @param failed true when the applet failed, false when it succeeded * @param reason an optional reason to show the user why the applet * failed to launch **/ void setFailedToLaunch(bool failed, const QString &reason = QString()); /** * When called, the Plasmoid should write any information needed as part * of the Plasmoid's running state to the configuration object in config() * and/or globalConfig(). * * Plasmoids that always sync their settings/state with the config * objects when these settings/states change do not need to reimplement * this method. **/ virtual void saveState(KConfigGroup &config) const; /** * Sets whether or not this applet provides a user interface for * configuring the applet. * * It defaults to false, and if true is passed in you should * also reimplement createConfigurationInterface() * * @param hasInterface whether or not there is a user interface available **/ void setHasConfigurationInterface(bool hasInterface); /** * When the applet needs to be configured before being usable, this * method can be called to show a standard interface prompting the user * to configure the applet * * @param needsConfiguring true if the applet needs to be configured, * or false if it doesn't * @param reason a translated message for the user explaining that the * applet needs configuring; this should note what needs * to be configured */ void setConfigurationRequired(bool needsConfiguring, const QString &reason = QString()); /** * Shows a message as an overlay of the applet: the message has an * icon, text and (optional) buttons * * @param icon the icon that will be shown * @param message the message string that will be shown. * If the message is empty nothng will be shown * and if there was a message already it will be hidden * @param buttons an OR combination of all the buttons needed * * @see Plasma::MessageButtons * @see messageButtonPressed * @since 4.3 */ void showMessage(const QIcon &icon, const QString &message, const Plasma::MessageButtons buttons); /** * Called when any of the geometry constraints have been updated. * * This is always called prior to painting and should be used as an * opportunity to layout the widget, calculate sizings, etc. * * Do not call update() from this method; an update() will be triggered * at the appropriate time for the applet. * * @param constraints the type of constraints that were updated * @property constraint */ virtual void constraintsEvent(Plasma::Constraints constraints); /** * Register the widgets that manage mouse clicks but you still want * to be able to drag the applet around when holding the mouse pointer * on that widget. * * Calling this results in an eventFilter being places on the widget. * * @param item the item to watch for mouse move */ void registerAsDragHandle(QGraphicsItem *item); /** * Unregister a widget registered with registerAsDragHandle. * * @param item the item to unregister */ void unregisterAsDragHandle(QGraphicsItem *item); /** * @param item the item to look for if it is registered or not * @return true if it is registered, false otherwise */ bool isRegisteredAsDragHandle(QGraphicsItem *item); /** * @return the extender of this applet. */ Extender *extender() const; /** * @internal event filter; used for focus watching **/ bool eventFilter(QObject *o, QEvent *e); /** * @internal scene event filter; used to manage applet dragging */ bool sceneEventFilter (QGraphicsItem *watched, QEvent *event); /** * @internal manage the mouse movement to drag the applet around */ void mouseMoveEvent(QGraphicsSceneMouseEvent *event); /** * Reimplemented from QGraphicsItem */ void focusInEvent(QFocusEvent *event); /** * Reimplemented from QGraphicsItem */ void resizeEvent(QGraphicsSceneResizeEvent *event); /** * Reimplemented from QGraphicsItem */ QVariant itemChange(GraphicsItemChange change, const QVariant &value); /** * Reimplemented from QGraphicsItem */ QPainterPath shape() const; /** * Reimplemented from QGraphicsLayoutItem */ QSizeF sizeHint(Qt::SizeHint which, const QSizeF & constraint = QSizeF()) const; /** * Reimplemented from QGraphicsLayoutItem */ void hoverEnterEvent(QGraphicsSceneHoverEvent *event); /** * Reimplemented from QGraphicsLayoutItem */ void hoverLeaveEvent(QGraphicsSceneHoverEvent *event); /** * Reimplemented from QObject */ void timerEvent (QTimerEvent *event); private: /** * @internal This constructor is to be used with the Package loading system. * * @param parent a QObject parent; you probably want to pass in 0 * @param args a list of strings containing two entries: the service id * and the applet id * @since 4.3 */ Plasmoid(const QString &packagePath, uint appletId, const QVariantList &args); Q_PRIVATE_SLOT(d, void setFocus()) Q_PRIVATE_SLOT(d, void themeChanged()) Q_PRIVATE_SLOT(d, void cleanUpAndDelete()) Q_PRIVATE_SLOT(d, void selectItemToDestroy()) Q_PRIVATE_SLOT(d, void updateRect(const QRectF& rect)) Q_PRIVATE_SLOT(d, void destroyMessageOverlay()) Q_PRIVATE_SLOT(d, void clearShortcutEditorPtr()) Q_PRIVATE_SLOT(d, void configDialogFinished()) Q_PRIVATE_SLOT(d, void updateShortcuts()) Q_PRIVATE_SLOT(d, void publishCheckboxStateChanged(int state)) Q_PRIVATE_SLOT(d, void globalShortcutChanged()) Q_PRIVATE_SLOT(d, void propagateConfigChanged()) /** * Reimplemented from QGraphicsItem **/ void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0); PlasmoidPrivate *const d; //Corona needs to access setFailedToLaunch and init friend class Corona; friend class CoronaPrivate; friend class Containment; friend class ContainmentPrivate; friend class PlasmoidScript; friend class PlasmoidHandle; friend class PlasmoidPrivate; friend class AccessPlasmoidJobPrivate; friend class PluginLoader; friend class PopupPlasmoid; friend class PopupPlasmoidPrivate; friend class AssociatedApplicationManager; friend class Extender; friend class ExtenderGroup; friend class ExtenderGroupPrivate; friend class ExtenderPrivate; friend class ExtenderItem; }; } // Plasma namespace Q_DECLARE_OPERATORS_FOR_FLAGS(Plasma::Plasmoid::BackgroundHints) /** * Register an applet when it is contained in a loadable module */ #define K_EXPORT_PLASMA_APPLET(libname, classname) \ K_PLUGIN_FACTORY(factory, registerPlugin();) \ K_EXPORT_PLUGIN(factory("plasma_applet_" #libname)) \ K_EXPORT_PLUGIN_VERSION(PLASMA_VERSION) #endif // multiple inclusion guard