#include <CompassFloatItem.h>

Inheritance diagram for Marble::CompassFloatItem:

Public Member Functions
	CompassFloatItem ()

	CompassFloatItem (const MarbleModel *marbleModel)

	~CompassFloatItem ()

QStringList	backendTypes () const

QPainterPath	backgroundShape () const

void	changeViewport (ViewportParams *viewport)

QDialog *	configDialog ()

QString	copyrightYears () const

QString	description () const

QString	guiString () const

QIcon	icon () const

void	initialize ()

bool	isInitialized () const

QString	name () const

QString	nameId () const

void	paintContent (QPainter *painter)

QList< PluginAuthor >	pluginAuthors () const

void	setSettings (const QHash< QString, QVariant > &settings)

QHash< QString, QVariant >	settings () const

QString	version () const

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)

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

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

Public Member Functions inherited from Marble::DialogConfigurationInterface
virtual	~DialogConfigurationInterface ()

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
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)

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 compass.

Definition at line 33 of file CompassFloatItem.h.

Constructor & Destructor Documentation

Marble::CompassFloatItem::CompassFloatItem ( )

Definition at line 29 of file CompassFloatItem.cpp.

Marble::CompassFloatItem::CompassFloatItem ( const MarbleModel * marbleModel )

explicit

Definition at line 35 of file CompassFloatItem.cpp.

Marble::CompassFloatItem::~CompassFloatItem ( )

Definition at line 47 of file CompassFloatItem.cpp.

Member Function Documentation

QStringList Marble::CompassFloatItem::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 52 of file CompassFloatItem.cpp.

QPainterPath Marble::CompassFloatItem::backgroundShape ( ) const

virtual

Returns the shape of the background.

Reimplemented from Marble::FrameGraphicsItem.

Definition at line 110 of file CompassFloatItem.cpp.

void Marble::CompassFloatItem::changeViewport ( ViewportParams * viewport )

virtual

Reimplemented from Marble::AbstractFloatItem.

Definition at line 123 of file CompassFloatItem.cpp.

QDialog * Marble::CompassFloatItem::configDialog ( )

virtual

Returns a pointer to the configuration dialog of the plugin.

Returns: : Pointer to the configuration dialog, which must be non-zero.

Implements Marble::DialogConfigurationInterface.

Definition at line 181 of file CompassFloatItem.cpp.

QString Marble::CompassFloatItem::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 82 of file CompassFloatItem.cpp.

QString Marble::CompassFloatItem::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 77 of file CompassFloatItem.cpp.

QString Marble::CompassFloatItem::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 62 of file CompassFloatItem.cpp.

QIcon Marble::CompassFloatItem::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 94 of file CompassFloatItem.cpp.

void Marble::CompassFloatItem::initialize ( )

virtual

Implements Marble::RenderPluginInterface.

Definition at line 99 of file CompassFloatItem.cpp.

bool Marble::CompassFloatItem::isInitialized ( ) const

virtual

Implements Marble::RenderPluginInterface.

Definition at line 105 of file CompassFloatItem.cpp.

QString Marble::CompassFloatItem::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 57 of file CompassFloatItem.cpp.

QString Marble::CompassFloatItem::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 67 of file CompassFloatItem.cpp.

void Marble::CompassFloatItem::paintContent ( QPainter * painter )

virtual

Here the items paint their content.

Reimplemented from Marble::FrameGraphicsItem.

Definition at line 132 of file CompassFloatItem.cpp.

QList< PluginAuthor > Marble::CompassFloatItem::pluginAuthors ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 87 of file CompassFloatItem.cpp.

void Marble::CompassFloatItem::setSettings ( const QHash< QString, QVariant > & settings )

virtual

Set the settings of the plugin.

Usually this is called at startup to restore saved settings.

Parameters

new	plugin's settings

See also: settings

Reimplemented from Marble::AbstractFloatItem.

Definition at line 209 of file CompassFloatItem.cpp.

QHash< QString, QVariant > Marble::CompassFloatItem::settings ( ) const

virtual

Settings of the plugin.

Settings is the map (hash table) of plugin's settings This method is called to determine the current settings of the plugin for serialization, e.g. when closing the application.

Returns: plugin's settings

See also: setSettings

Reimplemented from Marble::AbstractFloatItem.

Definition at line 200 of file CompassFloatItem.cpp.

QString Marble::CompassFloatItem::version ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 72 of file CompassFloatItem.cpp.

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

marble

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

marble

kdeedu API Reference

Search