Gazebo Gui

API Reference

3.12.0

Event called to spawn a resource, which takes the path to its file. More...

#include <GuiEvents.hh>

Public Member Functions

 SpawnFromPath (const std::string &_filePath)
 Constructor. More...
 
const std::stringFilePath () const
 Get the path of the file. More...
 
- Public Member Functions inherited from QEvent
 QEvent (Type type)
 
virtual ~QEvent ()
 
void accept ()
 
void ignore ()
 
bool isAccepted () const
 
void setAccepted (bool accepted)
 
bool spontaneous () const
 
Type type () const
 

Public Attributes

std::string filePath
 The path of file to be previewed. More...
 

Static Public Attributes

static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 3)
 Unique type for this event. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QEvent
int registerEventType (int hint)
 
- Properties inherited from QEvent
 accepted
 

Detailed Description

Event called to spawn a resource, which takes the path to its file.

Constructor & Destructor Documentation

◆ SpawnFromPath()

SpawnFromPath ( const std::string _filePath)
inlineexplicit

Constructor.

Parameters
[in]_filePathThe path to a file.

Member Function Documentation

◆ FilePath()

const std::string& FilePath ( ) const
inline

Get the path of the file.

Returns
The file path.

References SpawnFromPath::filePath.

Member Data Documentation

◆ filePath

std::string filePath

The path of file to be previewed.

Referenced by SpawnFromPath::FilePath().

◆ kType

const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 3)
static

Unique type for this event.


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