KDE 4.4 API Reference Plasma
Plasma::Corona Class Reference
A QGraphicsScene for Plasma::Applets. More...
#include <Plasma/Corona>
Detailed Description
A QGraphicsScene for Plasma::Applets.
Definition at line 47 of file corona.h.
Constructor & Destructor Documentation
| Plasma::Corona::Corona | ( | QObject * | parent = 0 |
) | [explicit] |
Definition at line 268 of file corona.cpp.
| Plasma::Corona::~Corona | ( | ) |
Definition at line 277 of file corona.cpp.
Member Function Documentation
Returns the QAction with the given name from our collection.
Definition at line 765 of file corona.cpp.
Returns all the actions in our collection.
Definition at line 780 of file corona.cpp.
| KAction * Plasma::Corona::addAction | ( | QString | name | ) |
- Since:
- 4.3 Creates an action in our collection under the given name
- Returns:
- the new action FIXME I'm wrapping so much of kactioncollection API now, maybe I should just expose the collection itself :P
Definition at line 775 of file corona.cpp.
Adds the action to our collection under the given name.
Definition at line 770 of file corona.cpp.
| Containment * Plasma::Corona::addContainment | ( | const QString & | name, | |
| const QVariantList & | args = QVariantList() | |||
| ) |
Adds a Containment to the Corona.
- Parameters:
-
name the plugin name for the containment, as given by KPluginInfo::pluginName(). If an empty string is passed in, the defalt containment plugin will be used (usually DesktopContainment). If the string literal "null" is passed in, then no plugin will be loaded and a simple Containment object will be created instead. args argument list to pass to the containment
- Returns:
- a pointer to the containment on success, or 0 on failure
Definition at line 465 of file corona.cpp.
| Containment * Plasma::Corona::addContainmentDelayed | ( | const QString & | name, | |
| const QVariantList & | args = QVariantList() | |||
| ) | [protected] |
Loads a containment with delayed initialization, primarily useful for implementations of loadDefaultLayout.
The caller is responsible for all initializating, saving and notification of a new containment.
- Parameters:
-
name the plugin name for the containment, as given by KPluginInfo::pluginName(). If an empty string is passed in, the defalt containment plugin will be used (usually DesktopContainment). If the string literal "null" is passed in, then no plugin will be loaded and a simple Containment object will be created instead. args argument list to pass to the containment
- Returns:
- a pointer to the containment on success, or 0 on failure
Definition at line 470 of file corona.cpp.
| void Plasma::Corona::addOffscreenWidget | ( | QGraphicsWidget * | widget | ) |
Adds a widget in the topleft quadrant in the scene.
Widgets in the topleft quadrant are normally never shown unless you specifically aim a view at it, which makes it ideal for toplevel views etc.
- Parameters:
-
widget the widget to add.
Definition at line 475 of file corona.cpp.
| void Plasma::Corona::addShortcuts | ( | KActionCollection * | newShortcuts | ) |
- Since:
- 4.3 Adds a set of actions to the shortcut config dialog. don't use this on actions in the corona's own actioncollection, those are handled automatically. this is for stuff outside of that.
Definition at line 800 of file corona.cpp.
| QString Plasma::Corona::appletMimeType | ( | ) |
The current mime type of Drag/Drop items.
Definition at line 294 of file corona.cpp.
| QRegion Plasma::Corona::availableScreenRegion | ( | int | id | ) | const [virtual] |
Returns the available region for a given screen.
The available region excludes panels and similar windows. Valid screen ids are 0 to numScreens()-1. By default this method returns a rectangular region equal to screenGeometry(id); subclasses that need another behavior should override this method.
Definition at line 550 of file corona.cpp.
| void Plasma::Corona::availableScreenRegionChanged | ( | ) | [signal] |
This signal inicates that a change in available screen goemetry occurred.
| void Plasma::Corona::clearContainments | ( | ) |
Clear the Corona from all applets.
Definition at line 449 of file corona.cpp.
| KSharedConfigPtr Plasma::Corona::config | ( | ) | const |
Returns the config file used to store the configuration for this Corona.
Definition at line 456 of file corona.cpp.
| void Plasma::Corona::configSynced | ( | ) | [signal] |
This signal indicates that the configuration file was flushed to disc.
| ContainmentActionsPluginsConfig Plasma::Corona::containmentActionsDefaults | ( | Containment::Type | containmentType | ) |
- Since:
- 4.4 Returns the default containmentactions plugins for the given containment type
Definition at line 810 of file corona.cpp.
| void Plasma::Corona::containmentAdded | ( | Plasma::Containment * | containment | ) | [signal] |
This signal indicates a new containment has been added to the Corona.
| Containment * Plasma::Corona::containmentForScreen | ( | int | screen, | |
| int | desktop = -1 | |||
| ) | const |
Returns the Containment, if any, for a given physical screen.
- Parameters:
-
screen number of the physical screen to locate desktop the virtual desktop) to locate; if < 0 then it will simply return the first Containment associated with screen
Definition at line 430 of file corona.cpp.
| QList< Containment * > Plasma::Corona::containments | ( | ) | const |
- Returns:
- all containments on this Corona
Definition at line 444 of file corona.cpp.
| void Plasma::Corona::dragEnterEvent | ( | QGraphicsSceneDragDropEvent * | event | ) | [protected] |
Reimplemented from QGraphicsScene.
Definition at line 693 of file corona.cpp.
| void Plasma::Corona::dragLeaveEvent | ( | QGraphicsSceneDragDropEvent * | event | ) | [protected] |
Reimplemented from QGraphicsScene.
Definition at line 698 of file corona.cpp.
| void Plasma::Corona::dragMoveEvent | ( | QGraphicsSceneDragDropEvent * | event | ) | [protected] |
Reimplemented from QGraphicsScene.
Definition at line 703 of file corona.cpp.
| void Plasma::Corona::enableAction | ( | const QString & | name, | |
| bool | enable | |||
| ) |
convenience function - enables or disables an action by name
- Parameters:
-
name the name of the action in our collection enable true to enable, false to disable
Definition at line 785 of file corona.cpp.
| QList< Plasma::Location > Plasma::Corona::freeEdges | ( | int | screen | ) | const |
This method is useful in order to retrieve the list of available screen edges for panel type containments.
- Parameters:
-
screen the id of the screen to look for free edges.
- Returns:
- a list of free edges not filled with panel type containments.
Definition at line 749 of file corona.cpp.
| ImmutabilityType Plasma::Corona::immutability | ( | ) | const [slot] |
- Returns:
- The type of immutability of this Corona
Definition at line 708 of file corona.cpp.
| void Plasma::Corona::immutabilityChanged | ( | Plasma::ImmutabilityType | immutability | ) | [signal] |
emitted when immutability changes.
this is for use by things that don't get contraints events, like plasmaapp. it's NOT for containments or applets or any of the other stuff on the scene. if your code's not in shells/ it probably shouldn't be using it.
Initializes the layout from a config file.
This will first clear any existing Containments, load a layout from the requested configuration file, request the default layout if needed and update immutability.
- Parameters:
-
config the name of the config file to load from, or the default config file if QString()
Definition at line 331 of file corona.cpp.
| void Plasma::Corona::loadDefaultLayout | ( | ) | [protected, virtual] |
Loads the default (system wide) layout for this user.
Definition at line 689 of file corona.cpp.
Load applet layout from a config file.
The results will be added to the current set of Containments.
- Parameters:
-
config the name of the config file to load from, or the default config file if QString()
Definition at line 351 of file corona.cpp.
| int Plasma::Corona::numScreens | ( | ) | const [virtual] |
Returns the number of screens available to plasma.
Subclasses should override this method as the default implementation returns a meaningless value.
Definition at line 532 of file corona.cpp.
| QList< QGraphicsWidget * > Plasma::Corona::offscreenWidgets | ( | ) | const |
| QPoint Plasma::Corona::popupPosition | ( | const QGraphicsItem * | item, | |
| const QSize & | size, | |||
| Qt::AlignmentFlag | alignment | |||
| ) |
- Since:
- 4.4 Recommended position for a popup window like a menu or a tooltip given its size
- Parameters:
-
item the item that the popup should appear adjacent to (an applet, say) size size of the popup alignment alignment of the popup, valid flags are Qt::AlignLeft, Qt::AlignRight and Qt::AlignCenter
- Returns:
- reccomended position
Definition at line 560 of file corona.cpp.
| QPoint Plasma::Corona::popupPosition | ( | const QGraphicsItem * | item, | |
| const QSize & | size | |||
| ) |
Recommended position for a popup window like a menu or a tooltip given its size.
- Parameters:
-
item the item that the popup should appear adjacent to (an applet, say) size size of the popup
- Returns:
- reccomended position
Definition at line 555 of file corona.cpp.
| void Plasma::Corona::releaseVisualFocus | ( | ) | [signal] |
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 hides when such an event is triggered by an item it is displaying.
| void Plasma::Corona::removeOffscreenWidget | ( | QGraphicsWidget * | widget | ) |
Removes a widget from the topleft quadrant in the scene.
- Parameters:
-
widget the widget to remove.
Definition at line 506 of file corona.cpp.
| void Plasma::Corona::requestConfigSync | ( | ) | [slot] |
Schedules a flush-to-disk synchronization of the configuration state at the next convenient moment.
Definition at line 312 of file corona.cpp.
| void Plasma::Corona::requireConfigSync | ( | ) | [slot] |
Schedules a time sensitive flush-to-disk synchronization of the configuration state.
Since this method does not provide any sort of event compression, it should only be used when an *immediate* disk sync is *absolutely* required. Otherwise, use
- See also:
- requestConfigSync() which does do event compression.
Definition at line 326 of file corona.cpp.
Save applets layout to file.
- config the file to save to, or the default config file if QString()
Definition at line 299 of file corona.cpp.
| QRect Plasma::Corona::screenGeometry | ( | int | id | ) | const [virtual] |
Returns the geometry of a given screen.
Valid screen ids are 0 to numScreen()-1, or -1 for the full desktop geometry. Subclasses should override this method as the default implementation returns a meaningless value.
Definition at line 537 of file corona.cpp.
| void Plasma::Corona::screenOwnerChanged | ( | int | wasScreen, | |
| int | isScreen, | |||
| Plasma::Containment * | containment | |||
| ) | [signal] |
This signal indicates that a containment has been newly associated (or dissociated) with a physical screen.
- Parameters:
-
wasScreen the screen it was associated with isScreen the screen it is now associated with containment the containment switching screens
| void Plasma::Corona::setAppletMimeType | ( | const QString & | mimetype | ) |
Sets the mimetype of Drag/Drop items.
Default is text/x-plasmoidservicename
Definition at line 289 of file corona.cpp.
| void Plasma::Corona::setContainmentActionsDefaults | ( | Containment::Type | containmentType, | |
| const ContainmentActionsPluginsConfig & | config | |||
| ) |
- Since:
- 4.4 Sets the default containmentactions plugins for the given containment type
Definition at line 805 of file corona.cpp.
| void Plasma::Corona::setImmutability | ( | const ImmutabilityType | immutable | ) | [slot] |
Sets the immutability type for this Corona (not immutable, user immutable or system immutable).
- immutable the new immutability type of this applet
Definition at line 713 of file corona.cpp.
| void Plasma::Corona::shortcutsChanged | ( | ) | [signal] |
- Since:
- 4.3 emitted when the user changes keyboard shortcut settings connect to this if you've put some extra shortcuts in your app that are NOT in corona's actioncollection. if your code's not in shells/ it probably shouldn't be using this function.
- See also:
- addShortcuts
| void Plasma::Corona::updateShortcuts | ( | ) |
- Since:
- 4.3 Updates keyboard shortcuts for all the corona's actions. If you've added actions to the corona you'll need to call this for them to be configurable.
Definition at line 794 of file corona.cpp.
The documentation for this class was generated from the following files:
