hydroqguielementutil::GuiElement Class Reference

A basic GUI component with a type and a unique ID. More...

#include <guielement.h>

Inherits hydroutil::Uncopyable.

Inherited by hydroqguielementutil::GuiElement2d, orcaqguielementutil::IceStormGuiElement< orca::WifiData, orca::WifiPrx, orca::WifiConsumer, orca::WifiConsumerPrx >, orcaqgui2d::ButtonElement, orcaqgui2d::VelocityControl2dElement, orcaqgui3d::GuiElement3d, and orcaqguielementutil::IceStormGuiElement< DataType, ProxyType, ConsumerType, ConsumerPrxType >.

List of all members.

Public Member Functions
virtual bool	isInGlobalCS ()
virtual bool	isPermanentElement () const
	If FALSE (default), the user can remove this GUI element from the set.
virtual void	update ()
virtual QStringList	contextMenu ()
virtual void	execute (int action)
virtual void	setColor (QColor color)
virtual void	setUseTransparency (bool useTransparency)
	Tell the GuiElement whether to paint itself using transparent colors.
virtual void	setFocus (bool inFocus)
virtual void	noLongerMouseEventReceiver ()
QString	platform ()
	Access function for platform name.
QString	uniqueId ()
	Access function for unique ID string displayed in table, e.g. ogmap/ogmaploader.
QString	type ()
	Access function for type string displayed in table, e.g. OgMap.

---

Detailed Description

A basic GUI component with a type and a unique ID.

A GuiElement may receive or send data and may paint itself. It is allocated to a physical (robotic) platform. The GuiElementModel holds a list of these and periodically updates them.

Author:

Tobias Kaupp

---

Member Function Documentation

virtual QStringList hydroqguielementutil::GuiElement::contextMenu

(

)

[inline, virtual]

Optional function to populate the menu list on right-click. Default implementation does nothing.

Reimplemented in orcaqgui2d::ButtonElement, orcaqgui2d::FeatureMap2dElement, orcaqgui2d::GridElement, orcaqgui3d::FeatureMap2dElement, orcaqgui3d::GridElement, orcaqgui3d::LaserScanner2dElement, orcaqgui3d::PointCloudElement, and orcaqgui3d::RangeScanner2dElement.

virtual void hydroqguielementutil::GuiElement::execute

(

int

action

)

[inline, virtual]

Optional callback function which will be called when one of the context menu items is selected. Default implementation does nothing.

Reimplemented in orcaqgui2d::ButtonElement, orcaqgui2d::FeatureMap2dElement, orcaqgui2d::GridElement, orcaqgui3d::FeatureMap2dElement, orcaqgui3d::GridElement, orcaqgui3d::LaserScanner2dElement, orcaqgui3d::PointCloudElement, and orcaqgui3d::RangeScanner2dElement.

virtual bool hydroqguielementutil::GuiElement::isInGlobalCS

(

)

[inline, virtual]

Determines whether the element should be painted in the global coordinate system. If returns FALSE (default), we will search for a localization element on the same platform.

Reimplemented in orcaqgui2d::FeatureMap2dElement, orcaqgui2d::GridElement, orcaqgui3d::FeatureMap2dElement, orcaqgui3d::GridElement, orcaqgui3d::LaserScanner2dElement, orcaqgui3d::PointCloudElement, and orcaqgui3d::RangeScanner2dElement.

virtual void hydroqguielementutil::GuiElement::noLongerMouseEventReceiver

(

)

[inline, virtual]

Called when the GuiElement ceases to be the owner of the global user-input mode NOTE: This is not called if the GuiElement voluntarily relinquishes the mode.

virtual void hydroqguielementutil::GuiElement::setColor

(

QColor

color

)

[inline, virtual]

Set the colour of the element. This sets the general colour scheme, not necessarily the colour of the entire element. In fact, the guiElement is free to ignore this colour.

Reimplemented in orcaqgui3d::LaserScanner2dElement, and orcaqgui3d::RangeScanner2dElement.

virtual void hydroqguielementutil::GuiElement::setFocus

(

bool

inFocus

)

[inline, virtual]

Optional function to set focus of element. Default implementation does nothing. Focus determines how the element is painted (color or gray) and whether users can interact with it (buttons or no buttons)

Reimplemented in orcaqgui3d::LaserScanner2dElement, and orcaqgui3d::RangeScanner2dElement.

virtual void hydroqguielementutil::GuiElement::update

(

)

[inline, virtual]

Update is called periodically. All processing different from paint can be done here. Default implementation does nothing.

---

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

• guielement.h
• guielement.cpp