Marble::AbstractFloatItem
#include <AbstractFloatItem.h>
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) |
Protected Member Functions | |
QMenu * | contextMenu () |
virtual void | contextMenuEvent (QWidget *w, QContextMenuEvent *e) |
bool | eventFilter (QObject *object, QEvent *e) override |
virtual void | toolTipEvent (QHelpEvent *e) |
Protected Member Functions inherited from Marble::RenderPlugin | |
bool | eventFilter (QObject *, QEvent *) override |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
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 39 of file AbstractFloatItem.h.
Constructor & Destructor Documentation
◆ AbstractFloatItem()
|
explicit |
Definition at line 51 of file AbstractFloatItem.cpp.
◆ ~AbstractFloatItem()
|
override |
Definition at line 63 of file AbstractFloatItem.cpp.
Member Function Documentation
◆ contextMenu()
|
protected |
Definition at line 229 of file AbstractFloatItem.cpp.
◆ contextMenuEvent()
|
protectedvirtual |
Definition at line 198 of file AbstractFloatItem.cpp.
◆ eventFilter()
|
overrideprotectedvirtual |
Reimplemented from QObject.
Definition at line 167 of file AbstractFloatItem.cpp.
◆ font()
QFont Marble::AbstractFloatItem::font | ( | ) | const |
◆ hide
|
slot |
Hide the item.
If the item was shown this function will hide it
Definition at line 224 of file AbstractFloatItem.cpp.
◆ pen()
QPen Marble::AbstractFloatItem::pen | ( | ) | const |
◆ positionLocked()
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 162 of file AbstractFloatItem.cpp.
◆ render()
|
override |
Paints the float item on the map.
- Deprecated
- Do not override this method since it won't be called any longer. Override one of FrameGraphicsItem's paint methods instead.
Definition at line 208 of file AbstractFloatItem.cpp.
◆ renderPolicy()
|
overridevirtual |
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 124 of file AbstractFloatItem.cpp.
◆ renderPosition()
|
override |
Returns the rendering position of this float item.
- Deprecated
- The return value of method is ignored. The float item's rendering position will always be "FLOAT_ITEM".
Definition at line 129 of file AbstractFloatItem.cpp.
◆ renderType()
|
overridevirtual |
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 97 of file AbstractFloatItem.cpp.
◆ setFont()
setting current font for rendering
- Parameters
-
font
Definition at line 118 of file AbstractFloatItem.cpp.
◆ setPen()
setting current pen for rendering
- Parameters
-
pen
Definition at line 107 of file AbstractFloatItem.cpp.
◆ setPositionLocked
|
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 148 of file AbstractFloatItem.cpp.
◆ setSettings()
|
overridevirtual |
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.
Definition at line 79 of file AbstractFloatItem.cpp.
◆ settings()
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.
Definition at line 68 of file AbstractFloatItem.cpp.
◆ setVisible()
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 134 of file AbstractFloatItem.cpp.
◆ show
|
slot |
Show the item.
If the item was hidden this function will show it
Definition at line 219 of file AbstractFloatItem.cpp.
◆ toolTipEvent()
|
protectedvirtual |
Definition at line 203 of file AbstractFloatItem.cpp.
◆ visible()
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 141 of file AbstractFloatItem.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:18:18 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.