QgsPanelWidget class

Derived classes

class QgsColorBrewerColorRampWidget

A widget which allows users to modify the properties of a QgsColorBrewerColorRamp.

class QgsCompoundColorWidget

A custom QGIS widget for selecting a color, including options for selecting colors via hue wheel, color swatches, and a color sampler.

class QgsDataDefinedSizeLegendWidget

Widget for configuration of appearance of legend for marker symbols with data-defined size.

class QgsEffectStackCompactWidget

A small widget consisting of a checkbox for enabling/disabling an effect stack and a button for opening an effect stack customization dialog.

class QgsEffectStackPropertiesWidget

A widget for modifying the properties of a QgsEffectStack, including adding and reordering effects within the stack.

class QgsLayoutItemBaseWidget

A base class for property widgets for layout items.

class QgsLimitedRandomColorRampWidget

A widget which allows users to modify the properties of a QgsLimitedRandomColorRamp.

class QgsMapLayerConfigWidget

A panel widget that can be shown in the map style dock.

class QgsMapUnitScaleWidget

A widget which allows the user to choose the minimum and maximum scale of an object in map units and millimeters.

class QgsPanelWidgetWrapper

Wrapper widget for existing widgets which can't have the inheritance tree changed, e.g dialogs.

class QgsPresetColorRampWidget

A widget which allows users to modify the properties of a QgsPresetSchemeColorRamp.

class QgsPropertyAssistantWidget

Shows a user-friendly assistant guiding users through the creation of QgsProperty overrides.

class QgsRendererWidget

Base class for renderer settings widgets.

class QgsSubstitutionListWidget

A widget which allows users to specify a list of substitutions to apply to a string, with options for exporting and importing substitution lists.

class QgsSymbolLevelsWidget

A widget which allows the user to modify the rendering order of symbol layers.

class QgsSymbolSelectorWidget

Symbol selector widget that can be used to select and build a symbol.

Public static functions

static auto findParentPanel(QWidget* widget) -> QgsPanelWidget*

Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.

Constructors, destructors, conversion operators

QgsPanelWidget(QWidget* parent = nullptr)

Base class for any widget that can be shown as a inline panel.

Public functions

auto autoDelete() -> bool

The the auto delete property on the widget.

void connectChildPanel(QgsPanelWidget* panel)

Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

void connectChildPanels(const QList<QgsPanelWidget*>& panels)

Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

auto dockMode() -> bool

Returns the dock mode state.

auto panelTitle() -> QString

The title of the panel.

void setAutoDelete(bool autoDelete)

The the auto delete property on the widget.

void setDockMode(bool dockMode) virtual

Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

void setPanelTitle(const QString& panelTitle)

Set the title of the panel when shown in the interface.

Signals

void panelAccepted(QgsPanelWidget* panel)

Emitted when the panel is accepted by the user.

void showPanel(QgsPanelWidget* panel)

Emit when you require a panel to be show in the interface.

void widgetChanged()

Emitted when the widget state changes.

Public slots

void acceptPanel()

Accept the panel.

void openPanel(QgsPanelWidget* panel)

Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event.

Protected functions

void keyPressEvent(QKeyEvent* event) override

Overridden key press event to handle the esc event on the widget.

Function documentation