QGIS API Documentation  2.99.0-Master (8ec3eaf)
Public Slots | Public Member Functions | List of all members
QgsRasterHistogramWidget Class Reference

Histogram widget. More...

#include <qgsrasterhistogramwidget.h>

Inheritance diagram for QgsRasterHistogramWidget:
Inheritance graph
[legend]

Public Slots

void apply () override
 
void on_mSaveAsImageButton_clicked ()
 This slot lets you save the histogram as an image to disk. More...
 
void refreshHistogram ()
 slot executed when user wishes to refresh raster histogramwidget More...
 
- Public Slots inherited from QgsMapLayerConfigWidget
virtual void apply ()=0
 Called when changes to the layer need to be made. 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...
 

Public Member Functions

 QgsRasterHistogramWidget (QgsRasterLayer *lyr, QWidget *parent=nullptr)
 
 ~QgsRasterHistogramWidget ()
 
bool computeHistogram (bool forceComputeFlag)
 Compute the histogram on demand. More...
 
void histoAction (const QString &actionName, bool actionFlag=true)
 Apply a histoActionTriggered() event. More...
 
bool histoSaveAsImage (const QString &theFilename, int width=600, int height=600, int quality=-1)
 Save the histogram as an image to disk. More...
 
void setActive (bool theActiveFlag)
 Activate the histogram widget. More...
 
void setRendererWidget (const QString &name, QgsRasterRendererWidget *rendererWidget=nullptr)
 Set the renderer widget (or just its name if there is no widget) More...
 
void setSelectedBand (int index)
 Apply a histoActionTriggered() event. More...
 
- Public Member Functions inherited from QgsMapLayerConfigWidget
 QgsMapLayerConfigWidget (QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent=0)
 A panel widget that can be shown in the map style dock. 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...
 

Additional Inherited Members

- 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...
 
- 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...
 
- Protected Attributes inherited from QgsMapLayerConfigWidget
QgsMapLayermLayer
 
QgsMapCanvasmMapCanvas
 

Detailed Description

Histogram widget.

Author
Etienne Tourigny

Definition at line 40 of file qgsrasterhistogramwidget.h.

Constructor & Destructor Documentation

§ QgsRasterHistogramWidget()

QgsRasterHistogramWidget::QgsRasterHistogramWidget ( QgsRasterLayer lyr,
QWidget *  parent = nullptr 
)

Definition at line 58 of file qgsrasterhistogramwidget.cpp.

§ ~QgsRasterHistogramWidget()

QgsRasterHistogramWidget::~QgsRasterHistogramWidget ( )

Definition at line 247 of file qgsrasterhistogramwidget.cpp.

Member Function Documentation

§ apply

void QgsRasterHistogramWidget::apply ( )
overrideslot

Definition at line 1254 of file qgsrasterhistogramwidget.cpp.

§ computeHistogram()

bool QgsRasterHistogramWidget::computeHistogram ( bool  forceComputeFlag)

Compute the histogram on demand.

Definition at line 285 of file qgsrasterhistogramwidget.cpp.

§ histoAction()

void QgsRasterHistogramWidget::histoAction ( const QString &  actionName,
bool  actionFlag = true 
)

Apply a histoActionTriggered() event.

Definition at line 785 of file qgsrasterhistogramwidget.cpp.

§ histoSaveAsImage()

bool QgsRasterHistogramWidget::histoSaveAsImage ( const QString &  theFilename,
int  width = 600,
int  height = 600,
int  quality = -1 
)

Save the histogram as an image to disk.

Definition at line 696 of file qgsrasterhistogramwidget.cpp.

§ on_mSaveAsImageButton_clicked

void QgsRasterHistogramWidget::on_mSaveAsImageButton_clicked ( )
slot

This slot lets you save the histogram as an image to disk.

Definition at line 683 of file qgsrasterhistogramwidget.cpp.

§ refreshHistogram

void QgsRasterHistogramWidget::refreshHistogram ( )
slot

slot executed when user wishes to refresh raster histogramwidget

Definition at line 330 of file qgsrasterhistogramwidget.cpp.

§ setActive()

void QgsRasterHistogramWidget::setActive ( bool  theActiveFlag)

Activate the histogram widget.

Definition at line 259 of file qgsrasterhistogramwidget.cpp.

§ setRendererWidget()

void QgsRasterHistogramWidget::setRendererWidget ( const QString &  name,
QgsRasterRendererWidget rendererWidget = nullptr 
)

Set the renderer widget (or just its name if there is no widget)

Definition at line 251 of file qgsrasterhistogramwidget.cpp.

§ setSelectedBand()

void QgsRasterHistogramWidget::setSelectedBand ( int  index)

Apply a histoActionTriggered() event.

Definition at line 748 of file qgsrasterhistogramwidget.cpp.


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