ot::PropertyGridView Class Reference

#include "PropertyGridView.h"

Inheritance diagram for ot::PropertyGridView:

Public Member Functions
	PropertyGridView ()
virtual	~PropertyGridView ()
virtual QWidget *	getViewWidget (void) override
	Returns the widget that is set to this widget view.
Public Member Functions inherited from ot::PropertyGrid
	PropertyGrid (QObject *_parentObject=(QObject *) nullptr)
virtual	~PropertyGrid ()
virtual QWidget *	getQWidget (void) override
	Returns a pointer to the root widget of this object.
TreeWidget *	getTreeWidget (void) const
void	setupGridFromConfig (const PropertyGridCfg &_config)
void	addGroup (PropertyGridGroup *_group)
PropertyGridGroup *	findGroup (const std::string &_groupName) const
PropertyGridGroup *	findGroup (const std::list< std::string > &_groupPath) const
PropertyGridItem *	findItem (const std::string &_groupName, const std::string &_itemName) const
PropertyGridItem *	findItem (const std::list< std::string > &_groupPath, const std::string &_itemName) const
void	clear (void)
void	focusProperty (const std::string &_groupName, const std::string &_itemName)
void	focusProperty (const std::list< std::string > &_groupPath, const std::string &_itemName)
Public Member Functions inherited from ot::QWidgetInterface
	QWidgetInterface ()
virtual	~QWidgetInterface ()
void	setOTWidgetFlags (const WidgetFlags &_flags)
const WidgetFlags &	otWidgetFlags (void) const
virtual void	otWidgetFlagsChanged (const WidgetFlags &_flags)
void	centerOnParent (const QWidget *const _parentWidget)
	Centers this widget on the parent. If no parent is provided the widget will center on the screen.
QPoint	calculateCenterOnParentPos (const QWidget *const _parentWidget)
	Calculates the top left corner of this widget centered on the parent widget. If no parent is provided the widget will center on the screen.
Public Member Functions inherited from ot::WidgetView
	WidgetView (WidgetViewBase::ViewType _viewType)
virtual	~WidgetView ()
virtual void	setViewWidgetFocus (void)
	Sets the input focus to the view widget. Custom widget views with nested widgets can override this method to set the focus to the correct widget. By default the root widget (widget returned by WidgetView::getViewWidget()) will get the focus set.
void	setViewData (const WidgetViewBase &_data)
WidgetViewBase &	getViewData (void)
const WidgetViewBase &	getViewData (void) const
ads::CDockWidget *	getViewDockWidget (void) const
	Returns the dock widget that belongs to this widget view.
QAction *	getViewToggleAction (void) const
	Returns the dock widget toggle visibility action. Returns 0 if no widget view is set.
void	setViewIsPermanent (bool _permanent=true)
	Permanent views wont be removed from the widget view manager when calling remove view.
bool	getViewIsPermanent (void) const
	Permanent views wont be removed from the widget view manager when calling remove view.
void	setViewContentModified (bool _isModified)
	Set the view modified state. Modified views will change the title to display an unsaved change.
bool	getViewContentModified (void) const
QString	getCurrentViewTitle (void) const
	Returns the widget view title that is currently displayed.
void	setAsCurrentViewTab (void)
bool	isCurrentViewTab (void) const

Additional Inherited Members
Public Types inherited from ot::WidgetView
enum	InsertFlag { NoInsertFlags = 0 << 0 , KeepCurrentFocus = 1 << 0 }
typedef ot::Flags< InsertFlag >	InsertFlags
Signals inherited from ot::PropertyGrid
void	propertyChanged (const Property *const _property)
void	propertyDeleteRequested (const Property *const _property)
Static Public Member Functions inherited from ot::WidgetView
static std::string	createStoredViewName (const WidgetViewBase &_view)
static std::string	createStoredViewName (const std::string &_entityName, WidgetViewBase::ViewType _viewType)
	Creates the name that should be used in the view management logic. The resulted name has the following syntax: <entityName>$<viewTypeString>
Protected Member Functions inherited from ot::WidgetView
void	addWidgetToDock (QWidget *_widget)
	Call this function as soon as the widget for this view is created to add it to the dock.
Protected Attributes inherited from ot::QWidgetInterface
WidgetFlags	m_widgetFlags

Constructor & Destructor Documentation

PropertyGridView()

ot::PropertyGridView::PropertyGridView

(

)

~PropertyGridView()

ot::PropertyGridView::~PropertyGridView ( )

virtual

Member Function Documentation

getViewWidget()

QWidget * ot::PropertyGridView::getViewWidget ( void )

overridevirtual

Returns the widget that is set to this widget view.

Implements ot::WidgetView.

---

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

• Libraries/OTWidgets/include/OTWidgets/PropertyGridView.h
• Libraries/OTWidgets/src/PropertyGridView.cpp