rviz::PropertyTreeWidget Class Reference

#include <property_tree_widget.h>

Inheritance diagram for rviz::PropertyTreeWidget:

Signals
void	currentPropertyChanged (const Property *new_current_property)
void	selectionHasChanged ()

Public Member Functions
PropertyTreeModel *	getModel () const
template<class Type >
QList< Type * >	getSelectedObjects ()
	Return the list of objects of a given type which are currently selected. More...
void	load (const Config &config)
	Read state from the given Config. More...
	PropertyTreeWidget (QWidget *parent=nullptr)
void	save (Config config) const
	Write state to the given Config. More...
void	setModel (PropertyTreeModel *model)
	Set the data model this widget should view. More...

Protected Slots
virtual void	propertyHiddenChanged (const Property *property)

Protected Member Functions
void	currentChanged (const QModelIndex &current, const QModelIndex &previous) override
	Called whenever current item changes. Calls QTreeView implementation then emits currentPropertyChanged(). More...
void	selectionChanged (const QItemSelection &selected, const QItemSelection &deselected) override
	Called whenever selection changes. Calls QTreeView implementation then emits selectionHasChanged(). More...

Private Member Functions
void	expandEntries (const QSet< QString > &expanded_full_names, const QModelIndex &parent_index, const QString &prefix)
	Recursively expand entries whose full names appear in expanded_full_names. More...
void	saveExpandedEntries (Config config, const QModelIndex &parent_index, const QString &prefix) const
	Recursively write full names of properties which are expanded in this view to the given Config. More...

Private Attributes
PropertyTreeModel *	model_
SplitterHandle *	splitter_handle_

Detailed Description

Definition at line 55 of file property_tree_widget.h.

Constructor & Destructor Documentation

PropertyTreeWidget()

rviz::PropertyTreeWidget::PropertyTreeWidget

(

QWidget *

parent = nullptr

)

Definition at line 62 of file property_tree_widget.cpp.

Member Function Documentation

currentChanged()

void rviz::PropertyTreeWidget::currentChanged ( const QModelIndex &  current, const QModelIndex &  previous  )

overrideprotected

Called whenever current item changes. Calls QTreeView implementation then emits currentPropertyChanged().

Definition at line 81 of file property_tree_widget.cpp.

currentPropertyChanged

void rviz::PropertyTreeWidget::currentPropertyChanged ( const Property *  new_current_property )

signal

expandEntries()

void rviz::PropertyTreeWidget::expandEntries ( const QSet< QString > &  expanded_full_names, const QModelIndex &  parent_index, const QString &  prefix  )

private

Recursively expand entries whose full names appear in expanded_full_names.

Definition at line 190 of file property_tree_widget.cpp.

getModel()

PropertyTreeModel* rviz::PropertyTreeWidget::getModel ( ) const

inline

Definition at line 71 of file property_tree_widget.h.

getSelectedObjects()

template<class Type >

QList<Type*> rviz::PropertyTreeWidget::getSelectedObjects ( )

inline

Return the list of objects of a given type which are currently selected.

Definition at line 78 of file property_tree_widget.h.

load()

void rviz::PropertyTreeWidget::load

(

const Config &

config

)

Read state from the given Config.

Definition at line 172 of file property_tree_widget.cpp.

propertyHiddenChanged

void rviz::PropertyTreeWidget::propertyHiddenChanged ( const Property *  property )

protectedvirtualslot

Definition at line 122 of file property_tree_widget.cpp.

save()

void rviz::PropertyTreeWidget::save

(

Config

config

)

const

Write state to the given Config.

Definition at line 135 of file property_tree_widget.cpp.

saveExpandedEntries()

void rviz::PropertyTreeWidget::saveExpandedEntries ( Config  config, const QModelIndex &  parent_index, const QString &  prefix  ) const

private

Recursively write full names of properties which are expanded in this view to the given Config.

Definition at line 142 of file property_tree_widget.cpp.

selectionChanged()

void rviz::PropertyTreeWidget::selectionChanged ( const QItemSelection &  selected, const QItemSelection &  deselected  )

overrideprotected

Called whenever selection changes. Calls QTreeView implementation then emits selectionHasChanged().

Definition at line 88 of file property_tree_widget.cpp.

selectionHasChanged

void rviz::PropertyTreeWidget::selectionHasChanged ( )

signal

setModel()

void rviz::PropertyTreeWidget::setModel

(

PropertyTreeModel *

model

)

Set the data model this widget should view.

Definition at line 95 of file property_tree_widget.cpp.

Member Data Documentation

model_

PropertyTreeModel* rviz::PropertyTreeWidget::model_

private

Definition at line 135 of file property_tree_widget.h.

splitter_handle_

SplitterHandle* rviz::PropertyTreeWidget::splitter_handle_

private

Definition at line 136 of file property_tree_widget.h.

---

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

• property_tree_widget.h
• property_tree_widget.cpp