orca-robotics


INTRODUCTION
Overview
Download and Install
Documentation

REPOSITORY
Interfaces
Drivers
Libraries
Utilities
Software Map

DEVELOPER
Dashboard

PEOPLE
Contributors
Users

SourceForge.net Logo
Project
Download
Mailing lists

 

         

hydroqguielementutil::IGuiElement Class Reference

Anyone who wants to get painted should derive from this. More...

#include <iguielement.h>

Inherits hydroutil::Uncopyable.

Inherited by hydroqguielementutil::GuiElement2d.

Inheritance diagram for hydroqguielementutil::IGuiElement:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual bool isInGlobalCS ()=0
virtual void update ()
 Update is called periodically. All processing different from paint can be done here.
virtual QStringList contextMenu ()
virtual void execute (int action)
virtual void setColor (QColor color)
virtual void setFocus (bool inFocus)
virtual void noLongerMouseEventReceiver ()
virtual void setUseTransparency (bool useTransparency)
 Tell the IGuiElement whether to paint itself using transparent colors.
QString platform ()
 Access and set functions for platform name.
QString details ()
 Access and set functions for details string displayed in table, e.g. ogmap/ogmaploader.
QString type ()
 Access and set functions for type string displayed in table, e.g. OgMap.
virtual bool isPermanentElement () const
 If true, the user shouldn't be able to remove this GUI element.
virtual void paint (QPainter *p, int z)=0
 Paint is called periodically to paint the internal state of the guielement.

Detailed Description

Anyone who wants to get painted should derive from this.

IGuiElement is a basic unit which knows how to paint itself. The GuiElementModel holds a list of these and periodically paints and updates them.


Member Function Documentation

virtual QStringList hydroqguielementutil::IGuiElement::contextMenu  )  [inline, virtual]
 

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

virtual void hydroqguielementutil::IGuiElement::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.

virtual bool hydroqguielementutil::IGuiElement::isInGlobalCS  )  [pure virtual]
 

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

virtual void hydroqguielementutil::IGuiElement::noLongerMouseEventReceiver  )  [inline, virtual]
 

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

virtual void hydroqguielementutil::IGuiElement::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.

virtual void hydroqguielementutil::IGuiElement::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)


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

Webmaster: Tobias Kaupp (tobasco at users.sourceforge.net)


Generated for Orca Robotics by  doxygen 1.4.5