415 lines
14 KiB
C++
415 lines
14 KiB
C++
/*
|
|
* Copyright 2007 by Aaron Seigo <aseigo@kde.org>
|
|
* Copyright 2008 by Ménard Alexis <darktears31@gmail.com>
|
|
*
|
|
* 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_CONTAINMENT_H
|
|
#define PLASMA_CONTAINMENT_H
|
|
|
|
#include <QtGui/QGraphicsItem>
|
|
#include <QtGui/QWidget>
|
|
#include <QtGui/QStyleOptionGraphicsItem>
|
|
|
|
#include <kplugininfo.h>
|
|
#include <ksharedconfig.h>
|
|
#include <kgenericfactory.h>
|
|
|
|
#include <plasma/applet.h>
|
|
#include <plasma/animator.h>
|
|
|
|
#include "widgets/icon.h"
|
|
|
|
namespace Plasma
|
|
{
|
|
|
|
class AppletHandle;
|
|
class DataEngine;
|
|
class Package;
|
|
class Corona;
|
|
class View;
|
|
|
|
/**
|
|
* @short The base class for plugins that provide backgrounds and applet grouping containers
|
|
*
|
|
* Containment objects provide the means to group applets into functional sets.
|
|
* They also provide the following:
|
|
*
|
|
* creation of focussing event
|
|
* - drawing of the background image (which can be interactive)
|
|
* - form factors (e.g. panel, desktop, full screen, etc)
|
|
* - applet layout management
|
|
*
|
|
* Since containment is actually just a Plasma::Applet, all the techniques used
|
|
* for writing the visual presentation of Applets is applicable to Containtments.
|
|
* Containments are differentiated from Applets by being marked with the ServiceType
|
|
* of Plasma/Containment. Plugins registered with both the Applet and the Containment
|
|
* ServiceTypes can be loaded for us in either situation.
|
|
*
|
|
* See techbase.kde.org for a tutorial on writing Containments using this class.
|
|
*/
|
|
class PLASMA_EXPORT Containment : public Applet
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
class StyleOption : public QStyleOptionGraphicsItem
|
|
{
|
|
public:
|
|
explicit StyleOption();
|
|
explicit StyleOption(const StyleOption &other);
|
|
explicit StyleOption(const QStyleOptionGraphicsItem &other);
|
|
|
|
/**
|
|
* The View, if any, that this containment is currently
|
|
* being rendered into. Note: this may be NULL, so be
|
|
* sure to check it before using it!
|
|
*/
|
|
Plasma::View *view;
|
|
};
|
|
|
|
enum Type { NoContainmentType = -1 /**< @internal */,
|
|
DesktopContainment = 0 /**< A desktop containment */,
|
|
PanelContainment /**< A desktop panel */,
|
|
CustomContainment = 127 /**< A containment that is neither a desktop nor a panel,
|
|
but something application specific */
|
|
};
|
|
|
|
/**
|
|
* @param parent the QGraphicsItem this applet is parented to
|
|
* @param serviceId the name of the .desktop file containing the
|
|
* information about the widget
|
|
* @param containmentId a unique id used to differentiate between multiple
|
|
* instances of the same Applet type
|
|
*/
|
|
explicit Containment(QGraphicsItem *parent = 0,
|
|
const QString &serviceId = QString(),
|
|
uint containmentId = 0);
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
Containment(QObject *parent, const QVariantList &args);
|
|
|
|
~Containment();
|
|
|
|
/**
|
|
* Reimplemented from Applet
|
|
*/
|
|
void init();
|
|
|
|
/**
|
|
* Returns the type of containment
|
|
*/
|
|
Type containmentType() const;
|
|
|
|
/**
|
|
* Returns the Corona (if any) that this Containment is hosted by
|
|
*/
|
|
Corona* corona() const;
|
|
|
|
/**
|
|
* Returns a list of all known containments.
|
|
*
|
|
* @param category Only applets matchin this category will be returned.
|
|
* Useful in conjunction with knownCategories.
|
|
* If "Misc" is passed in, then applets without a
|
|
* Categories= entry are also returned.
|
|
* If an empty string is passed in, all applets are
|
|
* returned.
|
|
* @param parentApp the application to filter applets on. Uses the
|
|
* X-KDE-ParentApp entry (if any) in the plugin info.
|
|
* The default value of QString() will result in a
|
|
* list containing only applets not specifically
|
|
* registered to an application.
|
|
* @return list of applets
|
|
**/
|
|
static KPluginInfo::List listContainments(const QString &category = QString(),
|
|
const QString &parentApp = QString());
|
|
|
|
/**
|
|
* Returns a list of all known applets associated with a certain mimetype
|
|
*
|
|
* @return list of applets
|
|
**/
|
|
static KPluginInfo::List listContainmentsForMimetype(const QString &mimetype);
|
|
|
|
/**
|
|
* Adds an applet to this Containment
|
|
*
|
|
* @param name the plugin name for the applet, as given by
|
|
* KPluginInfo::pluginName()
|
|
* @param args argument list to pass to the plasmoid
|
|
* @param id to assign to this applet, or 0 to auto-assign it a new id
|
|
* @param geometry where to place the applet, or to auto-place it if an invalid
|
|
* is provided
|
|
* @param delayedInit if true, init() will not be called on the applet
|
|
*
|
|
* @return a pointer to the applet on success, or 0 on failure
|
|
*/
|
|
Applet* addApplet(const QString &name, const QVariantList &args = QVariantList(),
|
|
const QRectF &geometry = QRectF(-1, -1, -1, -1));
|
|
|
|
/**
|
|
* add existing applet to this containment at pos
|
|
* @param applet the applet that should be added
|
|
* @param pos the containment-relative position
|
|
* @param dontInit if true, init() will not be called on the applet
|
|
*/
|
|
void addApplet(Applet *applet, const QPointF &pos = QPointF(-1, -1), bool dontInit = true);
|
|
|
|
/**
|
|
* @return the applets currently in this Containment
|
|
*/
|
|
Applet::List applets() const;
|
|
|
|
/**
|
|
* Removes all applets from this Containment
|
|
*/
|
|
void clearApplets();
|
|
|
|
/**
|
|
* Sets the physical screen this Containment is associated with.
|
|
*
|
|
* @param screen the screen number this containment is the desktop for, or -1
|
|
* if it is not serving as the desktop for any screen
|
|
*/
|
|
void setScreen(int screen);
|
|
|
|
/**
|
|
* @return the screen number this containment is serving as the desktop for
|
|
* or -1 if none
|
|
*/
|
|
int screen() const;
|
|
|
|
/**
|
|
* @return where top left corner of the containment maps to for the currently
|
|
* set screen. If no screen is associated, it will return QPoint()
|
|
*/
|
|
QPoint effectiveScreenPos() const;
|
|
|
|
/**
|
|
* @reimplemented from Applet
|
|
*/
|
|
void save(KConfigGroup &group) const;
|
|
|
|
/**
|
|
* @reimplemented from Applet
|
|
*/
|
|
void restore(KConfigGroup &group);
|
|
|
|
/**
|
|
* convenience function - enables or disables an action by name
|
|
*
|
|
* @param name the name of the action in our collection
|
|
* @param enable true to enable, false to disable
|
|
*/
|
|
void enableAction(const QString &name, bool enable);
|
|
|
|
/**
|
|
* Add an action to the toolbox
|
|
*/
|
|
void addToolBoxTool(QAction *action);
|
|
|
|
/**
|
|
* Remove an action from the toolbox
|
|
*/
|
|
void removeToolBoxTool(QAction *action);
|
|
|
|
/**
|
|
* Sets the open or closed state of the Containment's toolbox
|
|
*
|
|
* @arg open true to open the ToolBox, false to close it
|
|
*/
|
|
void setToolBoxOpen(bool open);
|
|
|
|
/**
|
|
* Open the Containment's toolbox
|
|
*/
|
|
void openToolBox();
|
|
|
|
/**
|
|
* Closes Containment's toolbox
|
|
*/
|
|
void closeToolBox();
|
|
|
|
/**
|
|
* associate actions with this widget, including ones added after this call.
|
|
* needed to make keyboard shortcuts work.
|
|
*/
|
|
void addAssociatedWidget(QWidget *widget);
|
|
|
|
/**
|
|
* un-associate actions from this widget, including ones added after this call.
|
|
* needed to make keyboard shortcuts work.
|
|
*/
|
|
void removeAssociatedWidget(QWidget *widget);
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* This signal is emitted when a new applet is created by the containment
|
|
*/
|
|
void appletAdded(Plasma::Applet *applet, const QPointF &pos);
|
|
|
|
/**
|
|
* This signal is emitted when an applet is destroyed
|
|
*/
|
|
void appletRemoved(Plasma::Applet *applet);
|
|
|
|
/**
|
|
* Emitted when the containment requests zooming in or out one step.
|
|
*/
|
|
void zoomRequested(Plasma::Containment *containment, Plasma::ZoomDirection direction);
|
|
|
|
/**
|
|
* Emitted when the user clicks on the toolbox
|
|
*/
|
|
void toolBoxToggled();
|
|
|
|
/**
|
|
* Emitted when the containment wants a new containment to be created.
|
|
* Usually only used for desktop containments.
|
|
*/
|
|
void addSiblingContainment(Plasma::Containment *);
|
|
|
|
/**
|
|
* Emitted when the containment requests an add widgets dialog is shown.
|
|
* Usually only used for desktop containments.
|
|
*
|
|
* @param pos where in the containment this request was made from, or
|
|
* an invalid position (QPointF()) is not location specific
|
|
*/
|
|
void showAddWidgetsInterface(const QPointF &pos);
|
|
|
|
/**
|
|
* This signal indicates that a containment has been newly
|
|
* associated (or dissociated) with a physical screen.
|
|
*
|
|
* @param wasScreen the screen it was associated with
|
|
* @param isScreen the screen it is now associated with
|
|
* @param containment the containment switching screens
|
|
*/
|
|
void screenChanged(int wasScreen, int isScreen, Plasma::Containment *containment);
|
|
|
|
/**
|
|
* Emitted when the containment wants to become active.
|
|
* Usually only used for desktop containments.
|
|
*/
|
|
void focusRequested(Plasma::Containment *containment);
|
|
|
|
public Q_SLOTS:
|
|
/**
|
|
* Informs the Corona as to what position it is in. This is informational
|
|
* only, as the Corona doesn't change it's actual location. This is,
|
|
* however, passed on to Applets that may be managed by this Corona.
|
|
*
|
|
* @param location the new location of this Corona
|
|
*/
|
|
void setLocation(Plasma::Location location);
|
|
|
|
/**
|
|
* Sets the form factor for this Corona. This may cause changes in both
|
|
* the arrangement of Applets as well as the display choices of individual
|
|
* Applets.
|
|
*/
|
|
void setFormFactor(Plasma::FormFactor formFactor);
|
|
|
|
/**
|
|
* Tells the corona to create a new desktop containment
|
|
*/
|
|
void addSiblingContainment();
|
|
|
|
/**
|
|
* switch keyboard focus to the next of our applets
|
|
*/
|
|
void focusNextApplet();
|
|
|
|
/**
|
|
* switch keyboard focus to the previous one of our applets
|
|
*/
|
|
void focusPreviousApplet();
|
|
|
|
/**
|
|
* Destroys this containment and all its applets (after a confirmation dialog);
|
|
* it will be removed nicely and deleted.
|
|
* Its configuration will also be deleted.
|
|
*/
|
|
void destroy();
|
|
|
|
protected:
|
|
/**
|
|
* Sets the type of this containment.
|
|
*/
|
|
void setContainmentType(Containment::Type type);
|
|
|
|
/**
|
|
* Called when the contents of the containment should be saved. By default this saves
|
|
* all loaded Applets
|
|
*
|
|
* @param group the KConfigGroup to save settings under
|
|
*/
|
|
virtual void saveContents(KConfigGroup &group) const;
|
|
|
|
/**
|
|
* Called when the contents of the containment should be loaded. By default this loads
|
|
* all previously saved Applets
|
|
*
|
|
* @param group the KConfigGroup to save settings under
|
|
*/
|
|
virtual void restoreContents(KConfigGroup &group);
|
|
|
|
|
|
void contextMenuEvent(QGraphicsSceneContextMenuEvent *event);
|
|
void hoverEnterEvent(QGraphicsSceneHoverEvent *event);
|
|
void hoverLeaveEvent(QGraphicsSceneHoverEvent *event);
|
|
void keyPressEvent(QKeyEvent *event);
|
|
bool sceneEventFilter(QGraphicsItem *watched, QEvent *event);
|
|
QVariant itemChange(GraphicsItemChange change, const QVariant &value);
|
|
|
|
protected Q_SLOTS:
|
|
/**
|
|
* @internal
|
|
*/
|
|
void dropEvent(QGraphicsSceneDragDropEvent *event);
|
|
|
|
private:
|
|
Q_PRIVATE_SLOT(d, void appletDestroyed(QObject*))
|
|
Q_PRIVATE_SLOT(d, void containmentAppletAnimationComplete(QGraphicsItem *item, Plasma::Animator::Animation anim))
|
|
Q_PRIVATE_SLOT(d, void triggerShowAddWidgets())
|
|
Q_PRIVATE_SLOT(d, void handleDisappeared(AppletHandle *handle))
|
|
Q_PRIVATE_SLOT(d, void positionToolBox())
|
|
Q_PRIVATE_SLOT(d, void zoomIn())
|
|
Q_PRIVATE_SLOT(d, void zoomOut())
|
|
Q_PRIVATE_SLOT(d, void toggleDesktopImmutability())
|
|
|
|
friend class Applet;
|
|
class Private;
|
|
Private* const d;
|
|
};
|
|
|
|
} // Plasma namespace
|
|
|
|
|
|
#endif // multiple inclusion guard
|