Public Member Functions | Protected Member Functions | List of all members
gazebo::gui::SaveDialog Class Reference

Dialog for saving to file. More...

#include <gui/gui.hh>

Inheritance diagram for gazebo::gui::SaveDialog:
Inheritance graph
[legend]

Public Member Functions

 SaveDialog (QWidget *_parent=0)
 Constructor. More...
 
 ~SaveDialog ()
 Destructor. More...
 
std::string GetSaveLocation () const
 Get the save location. More...
 
std::string GetSaveName () const
 Get name of file. More...
 
void SetFileExtension (const std::string &_extension)
 Set the file extension. More...
 
void SetMessage (const std::string &_msg)
 Set the message to be displayed. More...
 
void SetSaveLocation (const std::string &_location)
 Set the save location. More...
 
void SetSaveName (const std::string &_name)
 Set the name to save as. More...
 
void SetTitle (const std::string &_title)
 Set the tile of the dialog. More...
 

Protected Member Functions

virtual void showEvent (QShowEvent *_event)
 Qt event emitted showing the dialog. More...
 

Detailed Description

Dialog for saving to file.

Constructor & Destructor Documentation

gazebo::gui::SaveDialog::SaveDialog ( QWidget *  _parent = 0)

Constructor.

Parameters
[in]_parentParent QWidget.
gazebo::gui::SaveDialog::~SaveDialog ( )

Destructor.

Member Function Documentation

std::string gazebo::gui::SaveDialog::GetSaveLocation ( ) const

Get the save location.

Returns
Path of the save location.
std::string gazebo::gui::SaveDialog::GetSaveName ( ) const

Get name of file.

Returns
The name of file.
void gazebo::gui::SaveDialog::SetFileExtension ( const std::string &  _extension)

Set the file extension.

Parameters
[in]_extensionFile extension.
void gazebo::gui::SaveDialog::SetMessage ( const std::string &  _msg)

Set the message to be displayed.

Parameters
[in]_msgMessage to be displayed.
void gazebo::gui::SaveDialog::SetSaveLocation ( const std::string &  _location)

Set the save location.

Parameters
[in]_locationLocation to save to.
void gazebo::gui::SaveDialog::SetSaveName ( const std::string &  _name)

Set the name to save as.

Parameters
[in]_nameName of file.
void gazebo::gui::SaveDialog::SetTitle ( const std::string &  _title)

Set the tile of the dialog.

Parameters
[in]_titleTitle of dialog.
virtual void gazebo::gui::SaveDialog::showEvent ( QShowEvent *  _event)
protectedvirtual

Qt event emitted showing the dialog.


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