QGIS API Documentation  2.99.0-Master (19b062c)
Public Member Functions | List of all members
QgsOptionsWidgetFactory Class Referenceabstract

A factory class for creating custom options pages. More...

#include <qgsoptionswidgetfactory.h>

Inheritance diagram for QgsOptionsWidgetFactory:
Inheritance graph
[legend]

Public Member Functions

 QgsOptionsWidgetFactory ()=default
 Constructor. More...
 
 QgsOptionsWidgetFactory (const QString &title, const QIcon &icon)
 Constructor. More...
 
virtual QgsOptionsPageWidgetcreateWidget (QWidget *parent=nullptr) const =0
 Factory function to create the widget on demand as needed by the options dialog. More...
 
virtual QIcon icon () const
 The icon that will be shown in the UI for the panel. More...
 
void setIcon (const QIcon &icon)
 Set the icon to show in the interface for the factory object. More...
 
void setTitle (const QString &title)
 Set the title for the interface. More...
 
virtual QString title () const
 The title of the panel. More...
 

Detailed Description

A factory class for creating custom options pages.

Since
QGIS 3.0

Definition at line 72 of file qgsoptionswidgetfactory.h.

Constructor & Destructor Documentation

◆ QgsOptionsWidgetFactory() [1/2]

QgsOptionsWidgetFactory::QgsOptionsWidgetFactory ( )
default

Constructor.

◆ QgsOptionsWidgetFactory() [2/2]

QgsOptionsWidgetFactory::QgsOptionsWidgetFactory ( const QString &  title,
const QIcon &  icon 
)
inline

Constructor.

Definition at line 82 of file qgsoptionswidgetfactory.h.

Member Function Documentation

◆ createWidget()

virtual QgsOptionsPageWidget* QgsOptionsWidgetFactory::createWidget ( QWidget *  parent = nullptr) const
pure virtual

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

Parameters
parentThe parent of the widget.
Returns
A new widget to show as a page in the options dialog.

◆ icon()

virtual QIcon QgsOptionsWidgetFactory::icon ( ) const
inlinevirtual

The icon that will be shown in the UI for the panel.

Returns
A QIcon for the panel icon.
See also
setIcon()

Definition at line 92 of file qgsoptionswidgetfactory.h.

◆ setIcon()

void QgsOptionsWidgetFactory::setIcon ( const QIcon &  icon)
inline

Set the icon to show in the interface for the factory object.

See also
icon()

Definition at line 98 of file qgsoptionswidgetfactory.h.

◆ setTitle()

void QgsOptionsWidgetFactory::setTitle ( const QString &  title)
inline

Set the title for the interface.

See also
title()

Definition at line 110 of file qgsoptionswidgetfactory.h.

◆ title()

virtual QString QgsOptionsWidgetFactory::title ( ) const
inlinevirtual

The title of the panel.

See also
setTitle()

Definition at line 104 of file qgsoptionswidgetfactory.h.


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