MainWindow Class Reference

#include <MainWindow.hh>

Inherits QMainWindow.

Public Slots
void	Pause ()
	Pause simulation. More...
void	Play ()
	Play simulation. More...

Signals
void	AddPlugins ()
	A signal to trigger loading of GUI plugins. More...
void	Close ()
	A signal to indicate the main window is about to close. More...

Public Member Functions
	MainWindow ()
	Constructor. More...
virtual	~MainWindow ()
	Destructor. More...
void	AddMenu (QMenu *_menu)
	Add a menu to the main window menu bar. More...
void	AddToLeftColumn (const std::string &_name, QWidget *_widget)
	Add a widget to the left column stack of widgets. More...
QAction *	CloneAction (QAction *_action, QObject *_parent)
	Create a new action with information from the given action, such as text and tooltip. More...
gui::Editor *	Editor (const std::string &_name) const
	Get an editor by name. More...
unsigned int	EntityId (const std::string &_name)
	Get an entity id. More...
gui::Editor *	GetEditor (const std::string &_name) const GAZEBO_DEPRECATED(7.0)
	Get an editor by name. More...
gui::RenderWidget *	GetRenderWidget () const GAZEBO_DEPRECATED(7.0)
	Get a pointer to the render widget. More...
bool	HasEntityName (const std::string &_name)
	Has an entity name. More...
void	Init ()
	Initialization. More...
bool	IsPaused () const
	Returns the state of the simulation, true if paused. More...
void	Load ()
	Load the mainwindow. More...
gui::RenderWidget *	RenderWidget () const
	Get a pointer to the render widget. More...
void	SetLeftPaneVisibility (bool _on)
	Set whether the left pane is visible. More...
void	ShowLeftColumnWidget (const std::string &_name="default")
	Show a widget in the left column. More...
void	ShowMenuBar (QMenuBar *_bar=NULL)
	Show a custom menubar. More...

Protected Member Functions
void	closeEvent (QCloseEvent *_event)

Constructor & Destructor Documentation

MainWindow()

MainWindow

(

)

Constructor.

~MainWindow()

virtual ~MainWindow ( )

virtual

Destructor.

Member Function Documentation

AddMenu()

void AddMenu

(

QMenu *

_menu

)

Add a menu to the main window menu bar.

Parameters

[in]

_menu

Menu to be added.

AddPlugins

void AddPlugins ( )

signal

A signal to trigger loading of GUI plugins.

AddToLeftColumn()

void AddToLeftColumn	(	const std::string &	_name,
		QWidget *	_widget
	)

Add a widget to the left column stack of widgets.

Parameters

[in]	_name	Name of the widget
[in]	_widget	Pointer to the widget to add.

CloneAction()

QAction* CloneAction	(	QAction *	_action,
		QObject *	_parent
	)

Create a new action with information from the given action, such as text and tooltip.

The new action triggers the original action and follows its checked state. This is used for example to have the "same" action on the main window menu and the model editor menu, since an action can't be added to 2 different menus.

Parameters

[in]	_action	Action to be cloned.
[in]	_parent	Parent for the new action.

Returns

The new action.

Close

void Close ( )

signal

A signal to indicate the main window is about to close.

closeEvent()

void closeEvent ( QCloseEvent *  _event )

protected

Editor()

gui::Editor* Editor

(

const std::string &

_name

)

const

Get an editor by name.

Parameters

[in]

_name

Name of the editor.

Returns

Pointer to the editor.

EntityId()

unsigned int EntityId

(

const std::string &

_name

)

Get an entity id.

Parameters

[in]

_name

The name of the entity

Returns

The entity id

GetEditor()

gui::Editor* GetEditor

(

const std::string &

_name

)

const

Get an editor by name.

Parameters

[in]

_name

Name of the editor.

Returns

Pointer to the editor.

Deprecated:

See Editor(const std::string &_name) const.

GetRenderWidget()

gui::RenderWidget* GetRenderWidget

(

)

const

Get a pointer to the render widget.

Returns

A pointer to the render widget.

Deprecated:

See RenderWidget() const.

HasEntityName()

bool HasEntityName

(

const std::string &

_name

)

Has an entity name.

Parameters

[in]

_name

The entity name

Returns

True if the entity has a name

Init()

void Init

(

)

Initialization.

IsPaused()

bool IsPaused

(

)

const

Returns the state of the simulation, true if paused.

Returns

True if paused, false otherwise.

Load()

void Load

(

)

Load the mainwindow.

Pause

void Pause ( )

slot

Pause simulation.

Play

void Play ( )

slot

Play simulation.

RenderWidget()

gui::RenderWidget* RenderWidget

(

)

const

Get a pointer to the render widget.

Returns

A pointer to the render widget.

SetLeftPaneVisibility()

void SetLeftPaneVisibility

(

bool

_on

)

Set whether the left pane is visible.

Parameters

[in]

_on

True to show the left pane, false to hide.

ShowLeftColumnWidget()

void ShowLeftColumnWidget

(

const std::string &

_name = "default"

)

Show a widget in the left column.

See also

AddToLeftColumn

Parameters

[in]

_name

Name of the widge to show. The widget must have been added using AddToLeftColumn. The string "default" will show the main tab.

ShowMenuBar()

void ShowMenuBar

(

QMenuBar *

_bar = NULL

)

Show a custom menubar.

If NULL is used, the default menubar is shown.

Parameters

[in]

_bar

The menubar to show. NULL will show the default menubar.

---

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

• MainWindow.hh