QGIS API Documentation  2.99.0-Master (19b062c)
Public Slots | Signals | Public Member Functions | Properties | List of all members
QgsLimitedRandomColorRampWidget Class Reference

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

#include <qgslimitedrandomcolorrampdialog.h>

Inheritance diagram for QgsLimitedRandomColorRampWidget:
Inheritance graph
[legend]

Public Slots

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

Signals

void changed ()
 Emitted when the dialog settings change. More...
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user. More...
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface. More...
 
void widgetChanged ()
 Emitted when the widget state changes. More...
 

Public Member Functions

 QgsLimitedRandomColorRampWidget (const QgsLimitedRandomColorRamp &ramp, QWidget *parent=0)
 Constructor for QgsLimitedRandomColorRampWidget. More...
 
QgsLimitedRandomColorRamp ramp () const
 Returns a color ramp representing the current settings from the dialog. More...
 
void setRamp (const QgsLimitedRandomColorRamp &ramp)
 Sets the color ramp to show in the dialog. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=0)
 Base class for any widget that can be shown as a inline panel. More...
 
bool autoDelete ()
 The the auto delete property on the widget. More...
 
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. More...
 
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. More...
 
bool dockMode ()
 Return the dock mode state. More...
 
QString panelTitle ()
 The title of the panel. More...
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget. More...
 
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 

Properties

QgsLimitedRandomColorRamp ramp
 

Additional Inherited Members

- Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event)
 Overridden key press event to handle the esc event on the widget. More...
 

Detailed Description

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

Since
QGIS 3.0

Definition at line 32 of file qgslimitedrandomcolorrampdialog.h.

Constructor & Destructor Documentation

◆ QgsLimitedRandomColorRampWidget()

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

Constructor for QgsLimitedRandomColorRampWidget.

Parameters
rampinitial ramp to show in dialog
parentparent widget

Definition at line 25 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 69 of file qgslimitedrandomcolorrampdialog.cpp.

◆ setHue1

void QgsLimitedRandomColorRampWidget::setHue1 ( int  val)
slot

Sets the minimum hue for colors in the ramp.

Definition at line 76 of file qgslimitedrandomcolorrampdialog.cpp.

◆ setHue2

void QgsLimitedRandomColorRampWidget::setHue2 ( int  val)
slot

Sets the maximum hue for colors in the ramp.

Definition at line 83 of file qgslimitedrandomcolorrampdialog.cpp.

◆ setRamp()

void QgsLimitedRandomColorRampWidget::setRamp ( const QgsLimitedRandomColorRamp ramp)

Sets the color ramp to show in the dialog.

Parameters
rampcolor ramp
See also
ramp()

Definition at line 42 of file qgslimitedrandomcolorrampdialog.cpp.

◆ setSat1

void QgsLimitedRandomColorRampWidget::setSat1 ( int  val)
slot

Sets the minimum saturation for colors in the ramp.

Definition at line 90 of file qgslimitedrandomcolorrampdialog.cpp.

◆ setSat2

void QgsLimitedRandomColorRampWidget::setSat2 ( int  val)
slot

Sets the maximum saturation for colors in the ramp.

Definition at line 97 of file qgslimitedrandomcolorrampdialog.cpp.

◆ setVal1

void QgsLimitedRandomColorRampWidget::setVal1 ( int  val)
slot

Sets the minimum value for colors in the ramp.

Definition at line 104 of file qgslimitedrandomcolorrampdialog.cpp.

◆ setVal2

void QgsLimitedRandomColorRampWidget::setVal2 ( int  val)
slot

Sets the maximum value for colors in the ramp.

Definition at line 111 of file qgslimitedrandomcolorrampdialog.cpp.

Property Documentation

◆ ramp

QgsLimitedRandomColorRamp QgsLimitedRandomColorRampWidget::ramp
readwrite

Definition at line 35 of file qgslimitedrandomcolorrampdialog.h.


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