QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Signals | Public Member Functions | List of all members
QgsLegendPatchShapeWidget Class Reference

Widget for configuring a custom legend patch shape. More...

#include <qgslegendpatchshapewidget.h>

Inheritance diagram for QgsLegendPatchShapeWidget:
Inheritance graph
[legend]

Signals

void changed ()
 Emitted whenever the patch shape defined by the widget is changed. 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

 QgsLegendPatchShapeWidget (QWidget *parent=nullptr, const QgsLegendPatchShape &shape=QgsLegendPatchShape())
 Constructor for QgsLegendPatchShapeWidget, with the specified parent widget. More...
 
void setShape (const QgsLegendPatchShape &shape)
 Sets the shape to show in the widget. More...
 
QgsLegendPatchShape shape () const
 Returns the legend patch shape as currently defined by the widget. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 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 ()
 Returns the dock mode state. More...
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel. 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

- 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...
 
- 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) override
 Overridden key press event to handle the esc event on the widget. More...
 

Detailed Description

Widget for configuring a custom legend patch shape.

Since
QGIS 3.14

Definition at line 32 of file qgslegendpatchshapewidget.h.

Constructor & Destructor Documentation

◆ QgsLegendPatchShapeWidget()

QgsLegendPatchShapeWidget::QgsLegendPatchShapeWidget ( QWidget *  parent = nullptr,
const QgsLegendPatchShape shape = QgsLegendPatchShape() 
)

Constructor for QgsLegendPatchShapeWidget, with the specified parent widget.

Definition at line 22 of file qgslegendpatchshapewidget.cpp.

Member Function Documentation

◆ changed

void QgsLegendPatchShapeWidget::changed ( )
signal

Emitted whenever the patch shape defined by the widget is changed.

◆ setShape()

void QgsLegendPatchShapeWidget::setShape ( const QgsLegendPatchShape shape)

Sets the shape to show in the widget.

See also
shape()

Definition at line 47 of file qgslegendpatchshapewidget.cpp.

◆ shape()

QgsLegendPatchShape QgsLegendPatchShapeWidget::shape ( ) const

Returns the legend patch shape as currently defined by the widget.

See also
setShape()

Definition at line 41 of file qgslegendpatchshapewidget.cpp.


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