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

#include <qgscolorbrewercolorrampdialog.h>

Inheritance diagram for QgsColorBrewerColorRampWidget:

Signals
void	changed ()
	Emitted when the dialog settings change.

Signals inherited from QgsPanelWidget
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 Member Functions
	QgsColorBrewerColorRampWidget (const QgsColorBrewerColorRamp &ramp, QWidget *parent=nullptr)
	Constructor for QgsColorBrewerColorRampWidget.

QgsColorBrewerColorRamp	ramp () const
	Returns a color ramp representing the current settings from the dialog.

void	setRamp (const QgsColorBrewerColorRamp &ramp)
	Sets the color ramp to show in the dialog.

Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel.

virtual bool	applySizeConstraintsToStack () const
	Returns `true` if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.

bool	autoDelete ()
	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.

bool	dockMode ()
	Returns the dock mode state.

virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or `nullptr` if no menu button is required.

virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.

QString	panelTitle ()
	The title of the panel.

void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.

virtual void	setDockMode (bool dockMode)
	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.

Properties
QgsColorBrewerColorRamp	ramp

Additional Inherited Members
Public Slots inherited from QgsPanelWidget
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.

Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.

Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Detailed Description

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

Since: QGIS 3.0

Definition at line 35 of file qgscolorbrewercolorrampdialog.h.

Constructor & Destructor Documentation

◆ QgsColorBrewerColorRampWidget()

QgsColorBrewerColorRampWidget::QgsColorBrewerColorRampWidget	(	const QgsColorBrewerColorRamp &	ramp,
		QWidget *	parent = `nullptr`
	)

Constructor for QgsColorBrewerColorRampWidget.

Parameters

ramp	initial ramp to show in dialog
parent	parent widget

Definition at line 37 of file qgscolorbrewercolorrampdialog.cpp.

Member Function Documentation

◆ changed

void QgsColorBrewerColorRampWidget::changed ( )

signal

Emitted when the dialog settings change.

◆ ramp()

QgsColorBrewerColorRamp QgsColorBrewerColorRampWidget::ramp ( ) const

inline

Returns a color ramp representing the current settings from the dialog.

See also: setRamp()

Definition at line 53 of file qgscolorbrewercolorrampdialog.h.

◆ setRamp()

void QgsColorBrewerColorRampWidget::setRamp ( const QgsColorBrewerColorRamp & ramp )

Sets the color ramp to show in the dialog.

Parameters

ramp	color ramp

See also: ramp()

Definition at line 63 of file qgscolorbrewercolorrampdialog.cpp.

Property Documentation

◆ ramp

QgsColorBrewerColorRamp QgsColorBrewerColorRampWidget::ramp

readwrite

Definition at line 38 of file qgscolorbrewercolorrampdialog.h.

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

/build/qgis-3.34.0+99sid/src/gui/qgscolorbrewercolorrampdialog.h
/build/qgis-3.34.0+99sid/src/gui/qgscolorbrewercolorrampdialog.cpp

Signals

Public Member Functions

Properties

Additional Inherited Members