QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
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
[legend]

Public Member Functions

 QgsMeshLayerProperties (QgsMapLayer *lyr, QgsMapCanvas *canvas, QWidget *parent=nullptr, Qt::WindowFlags=QgsGuiUtils::ModalDialogFlags)
 Constructor.
 
Q_DECL_DEPRECATED void loadStyle () SIP_DEPRECATED
 Loads a saved style when appropriate button is pressed.
 
Q_DECL_DEPRECATED void saveDefaultStyle () SIP_DEPRECATED
 Saves the default style when appropriate button is pressed.
 
Q_DECL_DEPRECATED void saveStyleAs () SIP_DEPRECATED
 Saves a style when appriate button is pressed.
 
- Public Member Functions inherited from QgsLayerPropertiesDialog
 QgsLayerPropertiesDialog (QgsMapLayer *layer, QgsMapCanvas *canvas, const QString &settingsKey, QWidget *parent=nullptr, Qt::WindowFlags fl=Qt::WindowFlags(), QgsSettings *settings=nullptr)
 Constructor for QgsLayerPropertiesDialog.
 
virtual void addPropertiesPageFactory (const QgsMapLayerConfigWidgetFactory *factory)
 Adds properties page from a factory.
 
void loadStyle ()
 Triggers a dialog to load a saved style.
 
void saveDefaultStyle ()
 Saves the default style when appropriate button is pressed.
 
void saveStyleAs ()
 Saves a style when appriate button is pressed.
 
void setMetadataWidget (QgsMetadataWidget *widget, QWidget *page)
 Sets the metadata widget and page associated with the dialog.
 
- Public Member Functions inherited from QgsOptionsDialogBase
 QgsOptionsDialogBase (const QString &settingsKey, QWidget *parent=nullptr, Qt::WindowFlags fl=Qt::WindowFlags(), QgsSettings *settings=nullptr)
 Constructor.
 
 ~QgsOptionsDialogBase () override
 
void addPage (const QString &title, const QString &tooltip, const QIcon &icon, QWidget *widget, const QStringList &path=QStringList(), const QString &key=QString())
 Adds a new page to the dialog pages.
 
bool iconOnly ()
 Determine if the options list is in icon only mode.
 
void initOptionsBase (bool restoreUi=true, const QString &title=QString())
 Set up the base ui connections for vertical tabs.
 
void insertPage (const QString &title, const QString &tooltip, const QIcon &icon, QWidget *widget, const QString &before, const QStringList &path=QStringList(), const QString &key=QString())
 Inserts a new page into the dialog pages.
 
void resizeAlltabs (int index)
 Resizes all tabs when the dialog is resized.
 
void restoreLastPage ()
 Refocus the active tab from the last time the dialog was shown.
 
void restoreOptionsBaseUi (const QString &title=QString())
 Restore the base ui.
 
void setCurrentPage (const QString &page)
 Sets the dialog page (by object name) to show.
 
void setSettings (QgsSettings *settings)
 

Protected Slots

void apply () FINAL
 
void rollback () FINAL
 
void syncToLayer () FINAL
 
- Protected Slots inherited from QgsLayerPropertiesDialog
virtual void apply ()=0
 Applies the dialog settings to the layer.
 
void openUrl (const QUrl &url)
 Handles opening a url from the dialog.
 
void optionsStackedWidget_CurrentChanged (int index) override
 
virtual void rollback ()
 Rolls back changes made to the layer.
 
virtual void syncToLayer ()=0
 Resets the dialog to the current layer state.
 
- Protected Slots inherited from QgsOptionsDialogBase
virtual void optionsStackedWidget_CurrentChanged (int index)
 Select relevant tab on current page change.
 
virtual void optionsStackedWidget_WidgetRemoved (int index)
 Remove tab and unregister widgets on page remove.
 
virtual void updateOptionsListVerticalTabs ()
 Update tabs on the splitter move.
 
void warnAboutMissingObjects ()
 

Friends

class TestQgsMeshLayerPropertiesDialog
 

Additional Inherited Members

- Public Types inherited from QgsLayerPropertiesDialog
enum  StyleType { QML , SLD , DatasourceDatabase , UserDatabase }
 Style storage type. More...
 
- Public Slots inherited from QgsLayerPropertiesDialog
void loadDefaultMetadata ()
 Reloads the default layer metadata for the layer.
 
void loadDefaultStyle ()
 Reloads the default style for the layer.
 
void loadMetadataFromFile ()
 Allows the user to load layer metadata from a file.
 
void loadStyleFromFile ()
 Allows the user to load layer style from a file.
 
void saveMetadataAsDefault ()
 Saves the current layer metadata as the default for the layer.
 
void saveMetadataToFile ()
 Allows the user to save the layer's metadata as a file.
 
void saveStyleAsDefault ()
 Saves the current layer style as the default for the layer.
 
void saveStyleToFile ()
 Allows the user to save the layer's style to a file.
 
- 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
 
- Protected Member Functions inherited from QgsLayerPropertiesDialog
void initialize ()
 Initialize the dialog.
 
void refocusDialog ()
 Ensures the dialog is focused and activated.
 
void storeCurrentStyleForUndo ()
 Stores the current layer style so that undo operations can be performed.
 
- 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.
 
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.
 
void showEvent (QShowEvent *e) override
 
virtual void updateWindowTitle ()
 
- Protected Attributes inherited from QgsLayerPropertiesDialog
QPushButton * mBtnMetadata = nullptr
 Metadata button.
 
QPushButton * mBtnStyle = nullptr
 Style button.
 
QgsMapCanvasmCanvas = nullptr
 Associated map canvas.
 
QList< QgsMapLayerConfigWidget * > mConfigWidgets
 Layer config widgets.
 
QgsMapLayerStyle mOldStyle
 Previous layer style.
 
- 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

Since
QGIS 3.16 in the GUI API

Definition at line 42 of file qgsmeshlayerproperties.h.

Constructor & Destructor Documentation

◆ QgsMeshLayerProperties()

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

Constructor.

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

Definition at line 43 of file qgsmeshlayerproperties.cpp.

Member Function Documentation

◆ apply

void QgsMeshLayerProperties::apply ( )
protectedslot

Definition at line 250 of file qgsmeshlayerproperties.cpp.

◆ loadStyle()

void QgsMeshLayerProperties::loadStyle ( )

Loads a saved style when appropriate button is pressed.

Deprecated:
QGIS 3.40. Use loadStyleFromFile() instead.

Definition at line 240 of file qgsmeshlayerproperties.cpp.

◆ rollback

void QgsMeshLayerProperties::rollback ( )
protectedslot

Definition at line 405 of file qgsmeshlayerproperties.cpp.

◆ saveDefaultStyle()

void QgsMeshLayerProperties::saveDefaultStyle ( )

Saves the default style when appropriate button is pressed.

Deprecated:
QGIS 3.40. Use saveStyleAsDefault() instead.

Definition at line 235 of file qgsmeshlayerproperties.cpp.

◆ saveStyleAs()

void QgsMeshLayerProperties::saveStyleAs ( )

Saves a style when appriate button is pressed.

Deprecated:
QGIS 3.40. Use saveStyleToFile() instead.

Definition at line 245 of file qgsmeshlayerproperties.cpp.

◆ syncToLayer

void QgsMeshLayerProperties::syncToLayer ( )
protectedslot

Definition at line 176 of file qgsmeshlayerproperties.cpp.

Friends And Related Symbol Documentation

◆ TestQgsMeshLayerPropertiesDialog

friend class TestQgsMeshLayerPropertiesDialog
friend

Definition at line 115 of file qgsmeshlayerproperties.h.


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