Gazebo Gui

API Reference

7.2.2
Dialog Class Reference

Gui plugin. More...

#include <Dialog.hh>

Public Member Functions

 Dialog ()
 Constructor. More...
 
virtual ~Dialog ()
 Destructor. More...
 
QQuickWindow * QuickWindow () const
 Get the QtQuick window created by this object. More...
 
std::string ReadConfigAttribute (const std::string &_path, const std::string &_attribute) const
 Gets an attribute value from an XML file. The attribute belongs to a <dialog> element that has a name attribute matching this dialog's name. It will return an empty string if the file or the attribute don't exist. More...
 
QQuickItem * RootItem () const
 Get the root quick item of this window. More...
 
void SetDefaultConfig (const std::string &_config)
 Store dialog default config. More...
 
bool UpdateConfigAttribute (const std::string &_path, const std::string &_attribute, const bool _value) const
 Update an attribute on an XML file. The attribute belongs to a <dialog> element that has a name attrbute matching this dialog's name, i.e. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (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 char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () 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)
 
QThreadthread () const
 

Additional Inherited Members

- 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)
 
- 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
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Gui plugin.

Constructor & Destructor Documentation

◆ Dialog()

Dialog ( )

Constructor.

◆ ~Dialog()

virtual ~Dialog ( )
virtual

Destructor.

Member Function Documentation

◆ QuickWindow()

QQuickWindow* QuickWindow ( ) const

Get the QtQuick window created by this object.

Returns
Pointer to the QtQuick window

◆ ReadConfigAttribute()

std::string ReadConfigAttribute ( const std::string _path,
const std::string _attribute 
) const

Gets an attribute value from an XML file. The attribute belongs to a <dialog> element that has a name attribute matching this dialog's name. It will return an empty string if the file or the attribute don't exist.

Parameters
[in]_pathFile path
[in]_attributeattribute name
Returns
Attribute value as string

◆ RootItem()

QQuickItem* RootItem ( ) const

Get the root quick item of this window.

Returns
Pointer to the item

◆ SetDefaultConfig()

void SetDefaultConfig ( const std::string _config)

Store dialog default config.

Parameters
[in]_configXML config as string
Deprecated:
Introduce deprecation warnings on v7.

◆ UpdateConfigAttribute()

bool UpdateConfigAttribute ( const std::string _path,
const std::string _attribute,
const bool  _value 
) const

Update an attribute on an XML file. The attribute belongs to a <dialog> element that has a name attrbute matching this dialog's name, i.e.

<dialog name="dialog_name" attribute="value"/>

If a dialog element with this dialog's name doesn't exist yet, one will be created.

Parameters
[in]_pathFile path. File must already exist, this function will not create a new file.
[in]_attributeXMLElement attribute name
[in]_valueXMLElement attribute value
Returns
True if written to config file

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