RenderPlugin Class Reference
from PyKDE4.marble import *
Inherits: QObject,Marble.RenderPluginInterface → Marble.PluginInterface
Namespace: Marble
Detailed Description
- Abstract class:
- This class can be used as a base class for new classes, but can not be instantiated directly.
The abstract class that creates a renderable Item.
Enumerations |
ItemDataRole | { NameId, AboutDialogAvailable, ConfigurationDialogAvailable, BackendTypes } |
RenderType | { Unknown, Online } |
Signals |
| actionGroupsChanged () |
| enabledChanged (bool enable) |
| repaintNeeded (QRegion dirtyRegion=QRegion()) |
| settingsChanged (QString nameId) |
| visibilityChanged (QString nameId, bool visible) |
Methods |
| __init__ (self) |
QDialog | aboutDialog (self) |
QAction | action (self) |
[QActionGroup] | actionGroups (self) |
| applyItemState (self) |
QDialog | configDialog (self) |
bool | enabled (self) |
bool | eventFilter (self, QObject a0, QEvent a1) |
QStandardItem | item (self) |
Marble.MarbleModel | marbleModel (self) |
Marble.RenderPlugin.RenderType | renderType (self) |
| restoreDefaultSettings (self) |
| retrieveItemState (self) |
| setEnabled (self, bool enabled) |
| setMarbleModel (self, Marble.MarbleModel a0) |
| setSettings (self, {QString:QVariant} settings) |
| setVisible (self, bool visible) |
{QString:QVariant} | settings (self) |
[QActionGroup] | toolbarActionGroups (self) |
bool | visible (self) |
Signal Documentation
This signal is emitted if the actions that the plugin supports change in
any way
- Signal syntax:
QObject.connect(source, SIGNAL("actionGroupsChanged()"), target_slot)
enabledChanged |
( |
bool |
enable |
|
) |
|
|
|
- Signal syntax:
QObject.connect(source, SIGNAL("enabledChanged(bool)"), target_slot)
repaintNeeded |
( |
QRegion |
dirtyRegion=QRegion() |
|
) |
|
|
|
This signal is emitted if an update of the view is needed. If available with the
dirtyRegion which is the region the view will change in. If dirtyRegion.isEmpty() returns
true, the whole viewport has to be repainted.
- Signal syntax:
QObject.connect(source, SIGNAL("repaintNeeded(QRegion)"), target_slot)
settingsChanged |
( |
QString |
nameId |
|
) |
|
|
|
This signal is emitted if the settings of the RenderPlugin changed.
- Signal syntax:
QObject.connect(source, SIGNAL("settingsChanged(QString)"), target_slot)
visibilityChanged |
( |
QString |
nameId, |
|
|
bool |
visible |
|
) |
|
|
|
This signal is emitted if the visibility is changed with setVisible.
- Signal syntax:
QObject.connect(source, SIGNAL("visibilityChanged(QString, bool)"), target_slot)
Method Documentation
QDialog aboutDialog |
( |
|
self ) |
|
Function for getting a pointer to the about dialog of the plugin.
@return: The about dialog or, if no about dialog exists, 0.
[QActionGroup] actionGroups |
( |
|
self ) |
|
This method is used by the main window to get all of the actions that this
plugin defines. There is no guarantee where the main window will place the
actions but it will generally be in a Menu. The returned QList should
also contain all of the actions returned by
- See also:
- toolbarActions().
- Returns:
- A QList of grouped actions
QDialog configDialog |
( |
|
self ) |
|
Function for getting a pointer to the configuration dialog of the plugin.
@return: The configuration dialog or, if no configuration dialog exists, 0.
bool eventFilter |
( |
self, |
|
|
|
QObject |
a0, |
|
|
QEvent |
a1 |
|
) |
|
|
|
QStandardItem item |
( |
|
self ) |
|
Function for returning the type of plugin this is for.
This affects where in the menu tree the action() is placed.
@return: The type of render plugin this is.
restoreDefaultSettings |
( |
|
self ) |
|
retrieveItemState |
( |
|
self ) |
|
setEnabled |
( |
self, |
|
|
|
bool |
enabled |
|
) |
|
|
|
setSettings |
( |
self, |
|
|
|
{QString:QVariant} |
settings |
|
) |
|
|
|
Set the settings of the item.
setVisible |
( |
self, |
|
|
|
bool |
visible |
|
) |
|
|
|
{QString:QVariant} settings |
( |
|
self ) |
|
@return: The settings of the item.
[QActionGroup] toolbarActionGroups |
( |
|
self ) |
|
This method returns a subset of the actions returned by
- See also:
- actions() which
are intended to be placed in a more prominent place such as a toolbar above
the Marble Widget. You are not guaranteed that they will be in an actual
toolbar but they will be visible and discoverable
- Returns:
- A QList of grouped toolbar actions
Enumeration Documentation
This enum contains the data roles for the QStandardItem that is returned by item().
TODO: This should get moved into PluginInterface.h
- Enumerator:
-
NameId = Qt::UserRole+2 | |
AboutDialogAvailable | |
ConfigurationDialogAvailable | |
BackendTypes | |