Factory class for creating custom developer/debugging tool pages. More...

#include <qgsdevtoolwidgetfactory.h>

Public Member Functions
	QgsDevToolWidgetFactory (const QString &title=QString(), const QIcon &icon=QIcon())
	Constructor for a QgsDevToolWidgetFactory with the specified title and icon.

virtual	~QgsDevToolWidgetFactory ()=default

virtual QgsDevToolWidget *	createWidget (QWidget *parent=nullptr) const =0
	Factory function to create the widget on demand as needed by the dock.

virtual QIcon	icon () const
	Returns the icon that will be shown in the tool in the panel.

void	setIcon (const QIcon &icon)
	Sets the icon for the factory object, which will be shown for the tool in the panel.

void	setTitle (const QString &title)
	Set the translated title for the tool.

virtual QString	title () const
	Returns the (translated) title of the tool.

Detailed Description

Factory class for creating custom developer/debugging tool pages.

Since: QGIS 3.14

Definition at line 33 of file qgsdevtoolwidgetfactory.h.

Constructor & Destructor Documentation

◆ QgsDevToolWidgetFactory()

QgsDevToolWidgetFactory::QgsDevToolWidgetFactory	(	const QString &	title = `QString()`,
		const QIcon &	icon = `QIcon()`
	)

Constructor for a QgsDevToolWidgetFactory with the specified title and icon.

Definition at line 18 of file qgsdevtoolwidgetfactory.cpp.

◆ ~QgsDevToolWidgetFactory()

virtual QgsDevToolWidgetFactory::~QgsDevToolWidgetFactory ( )

virtualdefault

Member Function Documentation

◆ createWidget()

virtual QgsDevToolWidget * QgsDevToolWidgetFactory::createWidget ( QWidget * parent = nullptr ) const

pure virtual

Factory function to create the widget on demand as needed by the dock.

The parent argument gives the correct parent for the newly created widget.

◆ icon()

virtual QIcon QgsDevToolWidgetFactory::icon ( ) const

inlinevirtual

Returns the icon that will be shown in the tool in the panel.

See also: setIcon()

Definition at line 47 of file qgsdevtoolwidgetfactory.h.

◆ setIcon()

void QgsDevToolWidgetFactory::setIcon ( const QIcon & icon )

inline

Sets the icon for the factory object, which will be shown for the tool in the panel.

See also: icon()

Definition at line 53 of file qgsdevtoolwidgetfactory.h.

◆ setTitle()

void QgsDevToolWidgetFactory::setTitle ( const QString & title )

inline

Set the translated title for the tool.

Definition at line 64 of file qgsdevtoolwidgetfactory.h.

◆ title()

virtual QString QgsDevToolWidgetFactory::title ( ) const