QGIS API Documentation 3.29.0-Master (53715c36dc)
Public Member Functions | Protected Slots | Friends | List of all members
QgsMeshLayerProperties Class Reference

Property sheet for a mesh map layer. More...

#include <qgsmeshlayerproperties.h>

Inheritance diagram for QgsMeshLayerProperties:
Inheritance graph

Public Member Functions

 QgsMeshLayerProperties (QgsMapLayer *lyr, QgsMapCanvas *canvas, QWidget *parent=nullptr, Qt::WindowFlags=QgsGuiUtils::ModalDialogFlags)
 Constructor. More...
void addPropertiesPageFactory (const QgsMapLayerConfigWidgetFactory *factory)
 Adds properties page from a factory. More...
- Public Member Functions inherited from QgsOptionsDialogBase
 QgsOptionsDialogBase (const QString &settingsKey, QWidget *parent=nullptr, Qt::WindowFlags fl=Qt::WindowFlags(), QgsSettings *settings=nullptr)
 Constructor. More...
 ~QgsOptionsDialogBase () override
void addPage (const QString &title, const QString &tooltip, const QIcon &icon, QWidget *widget, const QStringList &path=QStringList())
 Adds a new page to the dialog pages. More...
bool iconOnly ()
 Determine if the options list is in icon only mode. More...
void initOptionsBase (bool restoreUi=true, const QString &title=QString())
 Set up the base ui connections for vertical tabs. More...
void insertPage (const QString &title, const QString &tooltip, const QIcon &icon, QWidget *widget, const QString &before, const QStringList &path=QStringList())
 Inserts a new page into the dialog pages. More...
void resizeAlltabs (int index)
 Resizes all tabs when the dialog is resized. More...
void restoreLastPage ()
 Refocus the active tab from the last time the dialog was shown. More...
void restoreOptionsBaseUi (const QString &title=QString())
 Restore the base ui. More...
void setCurrentPage (const QString &page)
 Sets the dialog page (by object name) to show. More...
void setSettings (QgsSettings *settings)

Protected Slots

void optionsStackedWidget_CurrentChanged (int index) override
- Protected Slots inherited from QgsOptionsDialogBase
virtual void optionsStackedWidget_CurrentChanged (int index)
 Select relevant tab on current page change. More...
virtual void optionsStackedWidget_WidgetRemoved (int index)
 Remove tab and unregister widgets on page remove. More...
virtual void updateOptionsListVerticalTabs ()
 Update tabs on the splitter move. More...
void warnAboutMissingObjects ()


class TestQgsMeshLayerPropertiesDialog

Additional Inherited Members

- Public Slots inherited from QgsOptionsDialogBase
void searchText (const QString &text)
 searchText searches for a text in all the pages of the stacked widget and highlight the results More...
- Protected Member Functions inherited from QgsOptionsDialogBase
QStandardItem * createItem (const QString &name, const QString &tooltip, const QString &icon)
 Creates a new QStandardItem with the specified name, tooltip and icon. More...
void paintEvent (QPaintEvent *e) override
void registerTextSearchWidgets ()
 register widgets in the dialog to search for text in it it is automatically called if a line edit has "mSearchLineEdit" as object name. More...
void showEvent (QShowEvent *e) override
virtual void updateWindowTitle ()
- Protected Attributes inherited from QgsOptionsDialogBase
bool mDelSettings = false
QString mDialogTitle
bool mIconOnly = false
bool mInit = false
QDialogButtonBox * mOptButtonBox = nullptr
QListWidget * mOptListWidget = nullptr
QString mOptsKey
QSplitter * mOptSplitter = nullptr
QStackedWidget * mOptStackedWidget = nullptr
QStandardItemModel * mOptTreeModel = nullptr
QTreeView * mOptTreeView = nullptr
QList< QPair< QgsOptionsDialogHighlightWidget *, int > > mRegisteredSearchWidgets
QgsFilterLineEditmSearchLineEdit = nullptr
QPointer< QgsSettingsmSettings
QgsOptionsProxyModel * mTreeProxyModel = nullptr

Detailed Description

Property sheet for a mesh map layer.

Contains information, source and style tabs

QGIS 3.16 in the GUI API

Definition at line 46 of file qgsmeshlayerproperties.h.

Constructor & Destructor Documentation

◆ QgsMeshLayerProperties()

QgsMeshLayerProperties::QgsMeshLayerProperties ( QgsMapLayer lyr,
QgsMapCanvas canvas,
QWidget *  parent = nullptr,
Qt::WindowFlags  fl = QgsGuiUtils::ModalDialogFlags 


lyrMesh map layer for which properties will be displayed
canvasThe map canvas
parentThe parent widget
flWindow flags

Definition at line 45 of file qgsmeshlayerproperties.cpp.

Member Function Documentation

◆ addPropertiesPageFactory()

void QgsMeshLayerProperties::addPropertiesPageFactory ( const QgsMapLayerConfigWidgetFactory factory)

Adds properties page from a factory.

QGIS 3.16

Definition at line 167 of file qgsmeshlayerproperties.cpp.

◆ optionsStackedWidget_CurrentChanged

void QgsMeshLayerProperties::optionsStackedWidget_CurrentChanged ( int  index)

Definition at line 187 of file qgsmeshlayerproperties.cpp.

Friends And Related Function Documentation

◆ TestQgsMeshLayerPropertiesDialog

friend class TestQgsMeshLayerPropertiesDialog

Definition at line 130 of file qgsmeshlayerproperties.h.

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