Public Slots | Signals | Public Member Functions | Protected Member Functions | Private Slots | Private Attributes | List of all members
rviz::PanelDockWidget Class Reference

Dock widget class for docking widgets into VisualizationFrame. More...

#include <panel_dock_widget.h>

Inheritance diagram for rviz::PanelDockWidget:
Inheritance graph
[legend]

Public Slots

virtual void overrideVisibility (bool hide)
 
void setWindowTitle (QString title)
 

Signals

void closed ()
 

Public Member Functions

virtual void load (Config config)
 
 PanelDockWidget (const QString &name)
 
virtual void save (Config config)
 
void setCollapsed (bool collapsed)
 
void setContentWidget (QWidget *child)
 
void setIcon (QIcon icon)
 
void setVisible (bool visible) override
 Override setVisible to respect the visibility override,. More...
 

Protected Member Functions

void closeEvent (QCloseEvent *event) override
 

Private Slots

void onChildDestroyed (QObject *unused)
 

Private Attributes

bool collapsed_
 
bool forced_hidden_
 
QLabel * icon_label_
 
bool requested_visibility_
 
QLabel * title_label_
 

Detailed Description

Dock widget class for docking widgets into VisualizationFrame.

Use setContentWidget() instead of QDockWidget::setWidget() if you want the PanelDockWidget to be destroyed when the content widget is destroyed.

Definition at line 46 of file panel_dock_widget.h.

Constructor & Destructor Documentation

◆ PanelDockWidget()

rviz::PanelDockWidget::PanelDockWidget ( const QString &  name)

Definition at line 41 of file panel_dock_widget.cpp.

Member Function Documentation

◆ closed

void rviz::PanelDockWidget::closed ( )
signal

◆ closeEvent()

void rviz::PanelDockWidget::closeEvent ( QCloseEvent *  event)
overrideprotected

Definition at line 127 of file panel_dock_widget.cpp.

◆ load()

void rviz::PanelDockWidget::load ( Config  config)
virtual

Definition at line 142 of file panel_dock_widget.cpp.

◆ onChildDestroyed

void rviz::PanelDockWidget::onChildDestroyed ( QObject *  unused)
privateslot

Definition at line 132 of file panel_dock_widget.cpp.

◆ overrideVisibility

void rviz::PanelDockWidget::overrideVisibility ( bool  hide)
virtualslot

@ Override the visibility of the widget.

Definition at line 153 of file panel_dock_widget.cpp.

◆ save()

void rviz::PanelDockWidget::save ( Config  config)
virtual

Definition at line 137 of file panel_dock_widget.cpp.

◆ setCollapsed()

void rviz::PanelDockWidget::setCollapsed ( bool  collapsed)

Definition at line 93 of file panel_dock_widget.cpp.

◆ setContentWidget()

void rviz::PanelDockWidget::setContentWidget ( QWidget *  child)

Definition at line 114 of file panel_dock_widget.cpp.

◆ setIcon()

void rviz::PanelDockWidget::setIcon ( QIcon  icon)

Definition at line 80 of file panel_dock_widget.cpp.

◆ setVisible()

void rviz::PanelDockWidget::setVisible ( bool  visible)
override

Override setVisible to respect the visibility override,.

Definition at line 147 of file panel_dock_widget.cpp.

◆ setWindowTitle

void rviz::PanelDockWidget::setWindowTitle ( QString  title)
slot

Definition at line 73 of file panel_dock_widget.cpp.

Member Data Documentation

◆ collapsed_

bool rviz::PanelDockWidget::collapsed_
private

Definition at line 83 of file panel_dock_widget.h.

◆ forced_hidden_

bool rviz::PanelDockWidget::forced_hidden_
private

Definition at line 85 of file panel_dock_widget.h.

◆ icon_label_

QLabel* rviz::PanelDockWidget::icon_label_
private

Definition at line 86 of file panel_dock_widget.h.

◆ requested_visibility_

bool rviz::PanelDockWidget::requested_visibility_
private

Definition at line 84 of file panel_dock_widget.h.

◆ title_label_

QLabel* rviz::PanelDockWidget::title_label_
private

Definition at line 87 of file panel_dock_widget.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Mon Jan 9 2023 03:07:21