Marble::FITemplateFloatItem Class Reference

#include <FITemplateFloatItem.h>

Inheritance diagram for Marble::FITemplateFloatItem:

Public Member Functions
	FITemplateFloatItem (const QPointF &point=QPointF(-1.0, 10.0), const QSizeF &size=QSizeF(75.0, 75.0))
	~FITemplateFloatItem ()
QStringList	backendTypes () const
QPainterPath	backgroundShape () const
QString	description () const
QString	guiString () const
QIcon	icon () const
void	initialize ()
bool	isInitialized () const
QString	name () const
QString	nameId () const
bool	needsUpdate (ViewportParams *viewport)
bool	renderFloatItem (GeoPainter *painter, ViewportParams *viewport, GeoSceneLayer *layer=0)
Public Member Functions inherited from Marble::AbstractFloatItem
	AbstractFloatItem (const MarbleModel *marbleModel, const QPointF &point=QPointF(10.0, 10.0), const QSizeF &size=QSizeF(150.0, 50.0))
virtual	~AbstractFloatItem ()
QFont	font () const
QPen	pen () const
bool	positionLocked () const
bool	render (GeoPainter *painter, ViewportParams *viewport, const QString &renderPos="FLOAT_ITEM", GeoSceneLayer *layer=0)
virtual QString	renderPolicy () const
virtual QStringList	renderPosition () const
virtual RenderType	renderType () const
void	setFont (const QFont &font)
void	setPen (const QPen &pen)
virtual void	setSettings (const QHash< QString, QVariant > &settings)
virtual QHash< QString, QVariant >	settings () const
void	setVisible (bool visible)
bool	visible () const
Public Member Functions inherited from Marble::RenderPlugin
	RenderPlugin (const MarbleModel *marbleModel)
virtual	~RenderPlugin ()
virtual const QList < QActionGroup * > *	actionGroups () const
bool	enabled () const
bool	isUserCheckable () const
const MarbleModel *	marbleModel () const
virtual RenderPlugin *	newInstance (const MarbleModel *marbleModel) const =0
virtual QString	runtimeTrace () const
virtual const QList < QActionGroup * > *	toolbarActionGroups () const
bool	visible () const
Public Member Functions inherited from Marble::RenderPluginInterface
virtual	~RenderPluginInterface ()
Public Member Functions inherited from Marble::PluginInterface
virtual	~PluginInterface ()
virtual QString	aboutDataText () const
virtual QString	copyrightYears () const =0
virtual QList< PluginAuthor >	pluginAuthors () const =0
virtual QString	version () const =0
Public Member Functions inherited from Marble::LayerInterface
virtual	~LayerInterface ()
virtual qreal	zValue () const
Public Member Functions inherited from Marble::FrameGraphicsItem
	FrameGraphicsItem (MarbleGraphicsItem *parent=0)
virtual	~FrameGraphicsItem ()
QBrush	background () const
QBrush	borderBrush () const
Qt::PenStyle	borderStyle () const
qreal	borderWidth () const
QRectF	contentRect () const
QSizeF	contentSize () const
FrameType	frame () const
qreal	margin () const
qreal	marginBottom () const
qreal	marginLeft () const
qreal	marginRight () const
qreal	marginTop () const
qreal	padding () const
QRectF	paintedRect () const
void	setBackground (const QBrush &background)
void	setBorderBrush (const QBrush &brush)
void	setBorderStyle (Qt::PenStyle style)
void	setBorderWidth (qreal width)
void	setContentSize (const QSizeF &size)
void	setFrame (FrameType type)
void	setMargin (qreal margin)
void	setMarginBottom (qreal marginBottom)
void	setMarginLeft (qreal marginLeft)
void	setMarginRight (qreal marginRight)
void	setMarginTop (qreal marginTop)
void	setPadding (qreal width)
Public Member Functions inherited from Marble::ScreenGraphicsItem
	ScreenGraphicsItem (MarbleGraphicsItem *parent=0)
virtual	~ScreenGraphicsItem ()
QList< QPointF >	absolutePositions () const
GraphicsItemFlags	flags () const
QPointF	position () const
QPointF	positivePosition () const
void	setFlags (GraphicsItemFlags flags)
void	setPosition (const QPointF &position)
Public Member Functions inherited from Marble::MarbleGraphicsItem
virtual	~MarbleGraphicsItem ()
CacheMode	cacheMode () const
bool	contains (const QPointF &point) const
void	hide ()
AbstractMarbleGraphicsLayout *	layout () const
bool	paintEvent (QPainter *painter, const ViewportParams *viewport)
void	setCacheMode (CacheMode mode)
void	setLayout (AbstractMarbleGraphicsLayout *layout)
virtual void	setProjection (const ViewportParams *viewport)
void	setSize (const QSizeF &size)
void	setVisible (bool visible)
void	show ()
QSizeF	size () const
bool	visible () const

Additional Inherited Members
Public Types inherited from Marble::RenderPlugin
enum	RenderType {   UnknownRenderType, TopLevelRenderType, PanelRenderType, OnlineRenderType,   ThemeRenderType }
Public Types inherited from Marble::FrameGraphicsItem
enum	FrameType { NoFrame, RectFrame, RoundedRectFrame, ShadowFrame }
Public Types inherited from Marble::ScreenGraphicsItem
enum	GraphicsItemFlag { ItemIsMovable = 0x1, ItemIsHideable = 0x2 }
Public Types inherited from Marble::MarbleGraphicsItem
enum	CacheMode { NoCache, ItemCoordinateCache, DeviceCoordinateCache }
Public Slots inherited from Marble::AbstractFloatItem
void	hide ()
void	setPositionLocked (bool lock)
void	show ()
Public Slots inherited from Marble::RenderPlugin
QAction *	action () const
void	restoreDefaultSettings ()
void	setEnabled (bool enabled)
bool	setSetting (const QString &key, const QVariant &value)
QVariant	setting (const QString &key)
QStringList	settingKeys ()
void	setUserCheckable (bool isUserCheckable)
void	setVisible (bool visible)
Signals inherited from Marble::RenderPlugin
void	actionGroupsChanged ()
void	enabledChanged (bool enable)
void	repaintNeeded (QRegion dirtyRegion=QRegion())
void	settingsChanged (QString nameId)
void	userCheckableChanged (bool isUserCheckable)
void	visibilityChanged (bool visible, const QString &nameId)
Protected Member Functions inherited from Marble::AbstractFloatItem
virtual void	changeViewport (ViewportParams *viewport)
QMenu *	contextMenu ()
virtual void	contextMenuEvent (QWidget *w, QContextMenuEvent *e)
virtual bool	eventFilter (QObject *object, QEvent *e)
virtual void	toolTipEvent (QHelpEvent *e)
Protected Member Functions inherited from Marble::RenderPlugin
bool	eventFilter (QObject *, QEvent *)
Protected Member Functions inherited from Marble::FrameGraphicsItem
virtual void	paint (QPainter *painter)
virtual void	paintBackground (QPainter *painter)
virtual void	paintContent (QPainter *painter)
Protected Member Functions inherited from Marble::ScreenGraphicsItem
	ScreenGraphicsItem (ScreenGraphicsItemPrivate *d_ptr)
Protected Member Functions inherited from Marble::MarbleGraphicsItem
	MarbleGraphicsItem (MarbleGraphicsItemPrivate *d_ptr)
void	update ()
Protected Attributes inherited from Marble::MarbleGraphicsItem
MarbleGraphicsItemPrivate *const	d
Properties inherited from Marble::RenderPlugin
QString	description
bool	enabled
QString	name
QString	nameId
bool	userCheckable
QString	version
bool	visible

Detailed Description

The class that creates a ...

Float Item

Definition at line 35 of file FITemplateFloatItem.h.

Constructor & Destructor Documentation

Marble::FITemplateFloatItem::FITemplateFloatItem ( const QPointF &  point = QPointF( -1.0, 10.0 ), const QSizeF &  size = QSizeF( 75.0, 75.0 )  )

explicit

Definition at line 31 of file FITemplateFloatItem.cpp.

Marble::FITemplateFloatItem::~FITemplateFloatItem

(

)

Definition at line 41 of file FITemplateFloatItem.cpp.

Member Function Documentation

QStringList Marble::FITemplateFloatItem::backendTypes ( ) const

virtual

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.

Implements Marble::RenderPluginInterface.

Definition at line 46 of file FITemplateFloatItem.cpp.

QPainterPath Marble::FITemplateFloatItem::backgroundShape ( ) const

virtual

Returns the shape of the background.

Reimplemented from Marble::FrameGraphicsItem.

Definition at line 88 of file FITemplateFloatItem.cpp.

QString Marble::FITemplateFloatItem::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 66 of file FITemplateFloatItem.cpp.

QString Marble::FITemplateFloatItem::guiString ( ) const

virtual

String that should be displayed in GUI.

Using a "&" you can suggest key shortcuts

Example: "&Stars"

Returns

string for gui usage

Implements Marble::RenderPlugin.

Definition at line 56 of file FITemplateFloatItem.cpp.

QIcon Marble::FITemplateFloatItem::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 71 of file FITemplateFloatItem.cpp.

void Marble::FITemplateFloatItem::initialize ( )

virtual

Implements Marble::RenderPluginInterface.

Definition at line 77 of file FITemplateFloatItem.cpp.

bool Marble::FITemplateFloatItem::isInitialized ( ) const

virtual

Implements Marble::RenderPluginInterface.

Definition at line 82 of file FITemplateFloatItem.cpp.

QString Marble::FITemplateFloatItem::name ( ) const

virtual

Returns the user-visible name of the plugin.

The user-visible name should be context free, i.e. the name should provide enough information as to what the plugin is about in the context of Marble.

Example: "Starry Sky Background", "OpenRouteService Routing"

Implements Marble::PluginInterface.

Definition at line 51 of file FITemplateFloatItem.cpp.

QString Marble::FITemplateFloatItem::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 61 of file FITemplateFloatItem.cpp.

bool Marble::FITemplateFloatItem::needsUpdate

(

ViewportParams *

viewport

)

Definition at line 94 of file FITemplateFloatItem.cpp.

bool Marble::FITemplateFloatItem::renderFloatItem	(	GeoPainter *	painter,
		ViewportParams *	viewport,
		GeoSceneLayer *	layer = 0
	)

Definition at line 99 of file FITemplateFloatItem.cpp.

---

The documentation for this class was generated from the following files:

• FITemplateFloatItem.h
• FITemplateFloatItem.cpp