#include <AbstractFloatItem.h>

Inheritance diagram for Marble::AbstractFloatItem:

Public Slots
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) const

QStringList	settingKeys () const

void	setUserCheckable (bool isUserCheckable)

void	setVisible (bool visible)

Public Member Functions
	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

virtual QString	guiString () const =0

bool	isUserCheckable () const

const MarbleModel *	marbleModel () const

virtual RenderPlugin *	newInstance (const MarbleModel *marbleModel) const =0

RenderState	renderState () const

virtual QString	runtimeTrace () const

virtual const QList < QActionGroup * > *	toolbarActionGroups () const

bool	visible () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

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

virtual QStringList	backendTypes () const =0

virtual void	initialize ()=0

virtual bool	isInitialized () const =0

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

virtual QString	aboutDataText () const

virtual QString	copyrightYears () const =0

virtual QString	description () const =0

virtual QIcon	icon () const =0

virtual QString	name () const =0

virtual QString	nameId () 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

Protected Member Functions
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 QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from Marble::FrameGraphicsItem
virtual QPainterPath	backgroundShape () const

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

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 }

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)

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

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

Properties inherited from QObject
	objectName

Detailed Description

The abstract class for float item plugins.

Float Item is a variant of Marble render plugins It keeps floating on top of the map at a given screen position

Good examples are Overview Map, License

Definition at line 45 of file AbstractFloatItem.h.

Constructor & Destructor Documentation

Marble::AbstractFloatItem::AbstractFloatItem	(	const MarbleModel *	marbleModel,
		const QPointF &	point = `QPointF( 10.0, 10.0 )`,
		const QSizeF &	size = `QSizeF( 150.0, 50.0 )`
	)

explicit

Definition at line 55 of file AbstractFloatItem.cpp.

Marble::AbstractFloatItem::~AbstractFloatItem ( )

virtual

Definition at line 67 of file AbstractFloatItem.cpp.

Member Function Documentation

QMenu * Marble::AbstractFloatItem::contextMenu ( )

protected

Definition at line 225 of file AbstractFloatItem.cpp.

void Marble::AbstractFloatItem::contextMenuEvent	(	QWidget *	w,
		QContextMenuEvent *	e
	)

protectedvirtual

Reimplemented in Marble::ElevationProfileFloatItem, Marble::NavigationFloatItem, Marble::MapScaleFloatItem, and Marble::License.

Definition at line 194 of file AbstractFloatItem.cpp.

bool Marble::AbstractFloatItem::eventFilter	(	QObject *	object,
		QEvent *	e
	)

protectedvirtual

Reimplemented from QObject.

Reimplemented in Marble::OverviewMap, Marble::ElevationProfileFloatItem, Marble::NavigationFloatItem, Marble::FileViewFloatItem, Marble::RoutingPlugin, and Marble::License.

Definition at line 163 of file AbstractFloatItem.cpp.

QFont Marble::AbstractFloatItem::font ( ) const

current font for rendering

Returns: font

Definition at line 109 of file AbstractFloatItem.cpp.

void Marble::AbstractFloatItem::hide ( )

slot

Hide the item.

If the item was shown this function will hide it

Definition at line 220 of file AbstractFloatItem.cpp.

QPen Marble::AbstractFloatItem::pen ( ) const

current pen for rendering

Returns: pen

Definition at line 98 of file AbstractFloatItem.cpp.

bool Marble::AbstractFloatItem::positionLocked ( ) const

Check is position locked.

Float Item position can be locked. If it is, the item can't be moved with the cursor (in the UI)

To set it use

See also: setPositionLocked

Returns: position locked or not

Definition at line 158 of file AbstractFloatItem.cpp.

bool Marble::AbstractFloatItem::render	(	GeoPainter *	painter,
		ViewportParams *	viewport,
		const QString &	renderPos = `"FLOAT_ITEM"`,
		GeoSceneLayer *	layer = `0`
	)

virtual

Renders the content provided by the layer on the viewport.

Parameters

painter	painter object allowing to paint on the map
viewport	metadata, such as current projection, screen dimension, etc.
renderPos	current render position
layer	deprecated, always zero (NULL)

Returns: true Returns whether the rendering has been successful

Implements Marble::LayerInterface.

Definition at line 204 of file AbstractFloatItem.cpp.

QString Marble::AbstractFloatItem::renderPolicy ( ) const

virtual

Return how the plugin settings should be used.

FIXME: Document this Possible Values: "ALWAYS" – the plugin renders at the preferred position 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

Implements Marble::RenderPluginInterface.

Definition at line 120 of file AbstractFloatItem.cpp.

QStringList Marble::AbstractFloatItem::renderPosition ( ) const

virtual

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" "HOVERS_ABOVE_SURFACE" "ATMOSPHERE" "ORBIT" "ALWAYS_ON_TOP" "FLOAT_ITEM" "USER_TOOLS"

Implements Marble::LayerInterface.

Definition at line 125 of file AbstractFloatItem.cpp.

RenderPlugin::RenderType Marble::AbstractFloatItem::renderType ( ) const

virtual

Render type of the plugin.

Function for returning the type of plugin this is for. This affects where in the menu tree the action() is placed.

See also: RenderType

Returns: : The type of render plugin this is

Reimplemented from Marble::RenderPlugin.

Definition at line 93 of file AbstractFloatItem.cpp.

void Marble::AbstractFloatItem::setFont ( const QFont & font )

setting current font for rendering

Parameters

font

Definition at line 114 of file AbstractFloatItem.cpp.

void Marble::AbstractFloatItem::setPen ( const QPen & pen )

setting current pen for rendering

Parameters

pen

Definition at line 103 of file AbstractFloatItem.cpp.

void Marble::AbstractFloatItem::setPositionLocked ( bool lock )

slot

Set is position locked.

Parameters

lock	is locked?

Float Item position can be locked. If it is, item can't be moved with cursor (in UI)

To check it use

See also: positionLocked

Definition at line 144 of file AbstractFloatItem.cpp.

void Marble::AbstractFloatItem::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::RenderPlugin.

Reimplemented in Marble::OverviewMap, Marble::NavigationFloatItem, Marble::CompassFloatItem, and Marble::RoutingPlugin.

Definition at line 79 of file AbstractFloatItem.cpp.

QHash< QString, QVariant > Marble::AbstractFloatItem::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::RenderPlugin.

Reimplemented in Marble::OverviewMap, Marble::NavigationFloatItem, Marble::CompassFloatItem, and Marble::RoutingPlugin.

Definition at line 72 of file AbstractFloatItem.cpp.

void Marble::AbstractFloatItem::setVisible ( bool visible )

Set visibility of the float item.

Float items can be visible or invisible. It's possible to check visibility with

See also: visible

Parameters

visible visibility of the item

Definition at line 130 of file AbstractFloatItem.cpp.

void Marble::AbstractFloatItem::show ( )

slot

Show the item.

If the item was hidden this function will show it

Definition at line 215 of file AbstractFloatItem.cpp.

void Marble::AbstractFloatItem::toolTipEvent ( QHelpEvent * e )

protectedvirtual

Reimplemented in Marble::MapScaleFloatItem.

Definition at line 199 of file AbstractFloatItem.cpp.

bool Marble::AbstractFloatItem::visible ( ) const

Check visibility of the float item.

Float items can be visible or invisible. It's possible to set visibility with

See also: setVisible

Returns: visible or not

Definition at line 137 of file AbstractFloatItem.cpp.

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

marble

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

marble

kdeedu API Reference

Search