QgsLimitedRandomColorRampWidget Class Reference

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

#include <qgslimitedrandomcolorrampdialog.h>

Inheritance diagram for QgsLimitedRandomColorRampWidget:

Public Slots
void	setCount (int val)
	Sets the number of colors to create in the ramp.
void	setHue1 (int val)
	Sets the minimum hue for colors in the ramp.
void	setHue2 (int val)
	Sets the maximum hue for colors in the ramp.
void	setSat1 (int val)
	Sets the minimum saturation for colors in the ramp.
void	setSat2 (int val)
	Sets the maximum saturation for colors in the ramp.
void	setVal1 (int val)
	Sets the minimum value for colors in the ramp.
void	setVal2 (int val)
	Sets the maximum value for colors in the ramp.
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.

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
	QgsLimitedRandomColorRampWidget (const QgsLimitedRandomColorRamp &ramp, QWidget *parent=nullptr)
	Constructor for QgsLimitedRandomColorRampWidget.
QgsLimitedRandomColorRamp	ramp () const
	Returns a color ramp representing the current settings from the dialog.
void	setRamp (const QgsLimitedRandomColorRamp &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
QgsLimitedRandomColorRamp	ramp

Additional Inherited Members
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 QgsLimitedRandomColorRamp.

Definition at line 33 of file qgslimitedrandomcolorrampdialog.h.

Constructor & Destructor Documentation

QgsLimitedRandomColorRampWidget()

QgsLimitedRandomColorRampWidget::QgsLimitedRandomColorRampWidget	(	const QgsLimitedRandomColorRamp &	ramp,
		QWidget *	parent = nullptr
	)

Constructor for QgsLimitedRandomColorRampWidget.

Parameters

ramp	initial ramp to show in dialog
parent	parent widget

Definition at line 27 of file qgslimitedrandomcolorrampdialog.cpp.

Member Function Documentation

changed

void QgsLimitedRandomColorRampWidget::changed ( )

signal

Emitted when the dialog settings change.

ramp()

QgsLimitedRandomColorRamp QgsLimitedRandomColorRampWidget::ramp ( ) const

inline

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

See also

setRamp()

Definition at line 50 of file qgslimitedrandomcolorrampdialog.h.

setCount

void QgsLimitedRandomColorRampWidget::setCount ( int  val )

slot

Sets the number of colors to create in the ramp.

Definition at line 78 of file qgslimitedrandomcolorrampdialog.cpp.

setHue1

void QgsLimitedRandomColorRampWidget::setHue1 ( int  val )

slot

Sets the minimum hue for colors in the ramp.

Definition at line 85 of file qgslimitedrandomcolorrampdialog.cpp.

setHue2

void QgsLimitedRandomColorRampWidget::setHue2 ( int  val )

slot

Sets the maximum hue for colors in the ramp.

Definition at line 92 of file qgslimitedrandomcolorrampdialog.cpp.

setRamp()

void QgsLimitedRandomColorRampWidget::setRamp

(

const QgsLimitedRandomColorRamp &

ramp

)

Sets the color ramp to show in the dialog.

Parameters

ramp	color ramp

See also

ramp()

Definition at line 51 of file qgslimitedrandomcolorrampdialog.cpp.

setSat1

void QgsLimitedRandomColorRampWidget::setSat1 ( int  val )

slot

Sets the minimum saturation for colors in the ramp.

Definition at line 99 of file qgslimitedrandomcolorrampdialog.cpp.

setSat2

void QgsLimitedRandomColorRampWidget::setSat2 ( int  val )

slot

Sets the maximum saturation for colors in the ramp.

Definition at line 106 of file qgslimitedrandomcolorrampdialog.cpp.

setVal1

void QgsLimitedRandomColorRampWidget::setVal1 ( int  val )

slot

Sets the minimum value for colors in the ramp.

Definition at line 113 of file qgslimitedrandomcolorrampdialog.cpp.

setVal2

void QgsLimitedRandomColorRampWidget::setVal2 ( int  val )

slot

Sets the maximum value for colors in the ramp.

Definition at line 120 of file qgslimitedrandomcolorrampdialog.cpp.

Property Documentation

ramp

QgsLimitedRandomColorRamp QgsLimitedRandomColorRampWidget::ramp

readwrite

Definition at line 36 of file qgslimitedrandomcolorrampdialog.h.

---

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

• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgslimitedrandomcolorrampdialog.h
• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgslimitedrandomcolorrampdialog.cpp