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

A widget to enter a custom dash space pattern for lines. More...

#include <qgsdashspacedialog.h>

Inheritance diagram for QgsDashSpaceWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsDashSpaceWidget (const QVector< qreal > &vectorPattern, QWidget *parent=nullptr)
 Constructor for QgsDashSpaceWidget. More...
 
QVector< qreal > dashDotVector () const
 Returns the dash pattern as a list of numbers. More...
 
void setUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit type used for the dash space pattern (used to update interface labels) 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...
 
- 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) override
 Overridden key press event to handle the esc event on the widget. More...
 

Detailed Description

A widget to enter a custom dash space pattern for lines.

Since
QGIS 3.8

Definition at line 33 of file qgsdashspacedialog.h.

Constructor & Destructor Documentation

◆ QgsDashSpaceWidget()

QgsDashSpaceWidget::QgsDashSpaceWidget ( const QVector< qreal > &  vectorPattern,
QWidget *  parent = nullptr 
)

Constructor for QgsDashSpaceWidget.

Definition at line 22 of file qgsdashspacedialog.cpp.

Member Function Documentation

◆ dashDotVector()

QVector< qreal > QgsDashSpaceWidget::dashDotVector ( ) const

Returns the dash pattern as a list of numbers.

Definition at line 70 of file qgsdashspacedialog.cpp.

◆ setUnit()

void QgsDashSpaceWidget::setUnit ( QgsUnitTypes::RenderUnit  unit)

Sets the unit type used for the dash space pattern (used to update interface labels)

Parameters
unitthe unit type

Definition at line 85 of file qgsdashspacedialog.cpp.


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