KDE 4.2 PyKDE API Reference for Marble

- KDE's Python API

# MarbleRenderPluginInterface Class Reference

`from PyKDE4.marble import *`

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 class that specifies the Marble layer interface of a plugin.

## Methods

QStringList | backendTypes (self)
QString | description (self)
QString | guiString (self)
QIcon | icon (self)
| initialize (self)
bool | isInitialized (self)
QString | name (self)
QString | nameId (self)
bool | render (self, Marble.GeoPainter painter, Marble.ViewportParams viewport, QString renderPos="NONE", GeoSceneLayer layer=0)
QString | renderPolicy (self)
QStringList | renderPosition (self)

## Method Documentation

QStringList backendTypes | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Returns the name(s) of the backend that the plugin can render . This method should return the name of the backend that the plugin can render. The string has to be the same one that is given for the attribute in the layer element of the DGML file that backend is able to process. Examples to replace available default backends would be "vector" or "texture". To provide a completely new kind of functionality please choose your own unique string.

QString description | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Returns a user description of the plugin.

QString guiString | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Returns the string that should appear in the UI / in the menu. . Using a "&" you can suggest key shortcuts

Example: "&Stars"

QIcon icon | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Returns an icon for the plugin.

initialize | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

bool isInitialized | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

QString name | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Returns the "real name" of the backend. . Example: "Starry Sky Plugin"

QString nameId | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Returns the name ID of the backend. . Example: "starrysky"

bool render | ( | self, |
|  | Marble.GeoPainter | painter,
|  | Marble.ViewportParams | viewport,
|  | QString | renderPos="NONE",
|  | GeoSceneLayer | layer=0
| ) |  |  |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Renders the content provided by the plugin on the viewport.

Returns:
  true Returns whether the rendering has been successful

QString renderPolicy | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Return how the plugin settings should be used.

FIXME: Document this . Possible Values: "ALWAYS" -- the plugin renders at the preferred posion no matter what got specified in the DGML file. "SPECIFIED" -- renders only in case it got specified in the DGML file. "SPECIFIED_ALWAYS" -- In case it got specified in the DGML file render according to the specification otherwise choose the preferred position

QStringList renderPosition | ( |  | self ) |

Abstract method:
  This method is abstract and can be overridden but not called directly.

Preferred level in the layer stack for the rendering

Gives a preferred level in the existing layer stack where the render() method of this plugin should get executed. . Possible Values: "NONE" "STARS" "BEHIND_TARGET" "SURFACE" "ATMOSPHERE" "ORBIT" "ALWAYS_ON_TOP" "FLOAT_ITEM"