mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-28 00:17:30 -05:00
ffaa40edc4
Remove QgsAbstractProperty and subclasses, and instead use a single QgsProperty class which covers the use of QgsAbstractProperty and its subclasses. This simplifies the API and avoids pointer handling. QgsProperty is implicitly shared for memory efficiency and inexpensive copies.
310 lines
9.6 KiB
Plaintext
310 lines
9.6 KiB
Plaintext
/** \ingroup gui
|
|
* \class QgsDataDefinedAssistant
|
|
* An assistant (wizard) dialog, accessible from a QgsDataDefinedButton.
|
|
* Can be used to guide users through creation of an expression for the
|
|
* data defined button.
|
|
* @note added in 2.10
|
|
*/
|
|
class QgsDataDefinedAssistant: QDialog
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgsdatadefinedbutton.h>
|
|
%End
|
|
public:
|
|
QgsDataDefinedAssistant();
|
|
|
|
virtual QgsProperty property() const = 0;
|
|
|
|
/** Sets the map canvas associated with the widget. This allows the widget to retrieve the current
|
|
* map scale and other properties from the canvas.
|
|
* @param canvas map canvas
|
|
* @see mapCanvas()
|
|
* @note added in QGIS 2.12
|
|
*/
|
|
virtual void setMapCanvas( QgsMapCanvas* canvas );
|
|
|
|
/** Returns the map canvas associated with the widget.
|
|
* @see setMapCanvas
|
|
* @note added in QGIS 2.12
|
|
*/
|
|
const QgsMapCanvas* mapCanvas() const;
|
|
|
|
};
|
|
|
|
/** \ingroup gui
|
|
* \class QgsDataDefinedButton
|
|
* A button for defining data source field mappings or expressions.
|
|
*/
|
|
class QgsDataDefinedButton : QToolButton
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgsdatadefinedbutton.h>
|
|
%End
|
|
public:
|
|
enum DataType
|
|
{
|
|
String,
|
|
Int,
|
|
Double,
|
|
AnyType
|
|
};
|
|
typedef QFlags<QgsDataDefinedButton::DataType> DataTypes;
|
|
|
|
/**
|
|
* Construct a new data defined button
|
|
*
|
|
* @param parent The parent QWidget
|
|
* @param vl Pointer to the associated vector layer
|
|
* @param datadefined Data defined property
|
|
* @param datatypes The expected data types to be compared against the variant type of the QgsField from data source and expression result
|
|
* @param description The description of expected input data
|
|
*/
|
|
QgsDataDefinedButton( QWidget* parent /TransferThis/ = 0,
|
|
const QgsVectorLayer* vl = 0,
|
|
const QgsDataDefined* datadefined = 0,
|
|
DataTypes datatypes = AnyType,
|
|
const QString& description = QString() );
|
|
~QgsDataDefinedButton();
|
|
|
|
/**
|
|
* Initialize a newly constructed data defined button (useful if button already included from form layout)
|
|
*
|
|
* @param vl Pointer to the associated vector layer
|
|
* @param datadefined Data defined property
|
|
* @param datatypes The expected data types to be compared against the variant type of the QgsField from data source and expression result
|
|
* @param description The description of expected input data
|
|
*/
|
|
void init( const QgsVectorLayer* vl,
|
|
const QgsDataDefined* datadefined = 0,
|
|
DataTypes datatypes = AnyType,
|
|
const QString& description = QString() );
|
|
|
|
QMap< QString, QString > definedProperty() const;
|
|
|
|
/** Updates a QgsDataDefined with the current settings from the button
|
|
* @param dd QgsDataDefined to update
|
|
* @note added in QGIS 2.9
|
|
*/
|
|
void updateDataDefined( QgsDataDefined* dd ) const;
|
|
|
|
/** Returns a QgsDataDefined which reflects the current settings from the
|
|
* button.
|
|
* @note added in QGIS 2.9
|
|
* @see updateDataDefined
|
|
*/
|
|
QgsDataDefined currentDataDefined() const;
|
|
|
|
/** Sets the vector layer associated with the button. This controls which fields are
|
|
* displayed within the widget's pop up menu.
|
|
* @param layer vector layer
|
|
* @note added in QGIS 3.0
|
|
*/
|
|
void setVectorLayer( QgsVectorLayer* layer );
|
|
|
|
/**
|
|
* Whether the current data definition or expression is to be used
|
|
*/
|
|
bool isActive() const;
|
|
|
|
/**
|
|
* Whether the current expression is to be used instead of field mapping
|
|
*/
|
|
bool useExpression() const;
|
|
|
|
/**
|
|
* The current defined expression
|
|
*/
|
|
QString getExpression() const;
|
|
|
|
/**
|
|
* The current defined field
|
|
*/
|
|
QString getField() const;
|
|
|
|
/**
|
|
* The current definition
|
|
* @returns empty QString if not active, otherwise currently defined expression or field name
|
|
*/
|
|
QString currentDefinition() const;
|
|
|
|
/**
|
|
* The valid data types that will work for the definition (QVariant-coercible to expected type)
|
|
* Compared against the variant type of the QgsField from data source and expression result
|
|
*/
|
|
const DataTypes& validDataTypes() const;
|
|
|
|
/**
|
|
* The full definition description and current definition (internally generated on a contextual basis)
|
|
*/
|
|
QString fullDescription() const;
|
|
|
|
/**
|
|
* The usage information about this data definition
|
|
*/
|
|
QString usageInfo() const;
|
|
|
|
/**
|
|
* Set the usage information about this data definition
|
|
*/
|
|
void setUsageInfo( const QString& info );
|
|
|
|
/**
|
|
* Register list of sibling widgets that get disabled/enabled when data definition or expression is set/unset
|
|
*/
|
|
void registerEnabledWidgets( const QList<QWidget*>& wdgts );
|
|
|
|
/**
|
|
* Register a sibling widget that gets disabled/enabled when data definition or expression is set/unset
|
|
*/
|
|
void registerEnabledWidget( QWidget* wdgt );
|
|
|
|
/**
|
|
* Return widget siblings that get disabled/enabled when data definition or expression is set/unset
|
|
*
|
|
* @return unguarded pointers from guarded ones
|
|
*/
|
|
QList<QWidget*> registeredEnabledWidgets();
|
|
|
|
/**
|
|
* Clears list of sibling widgets
|
|
*/
|
|
void clearEnabledWidgets();
|
|
|
|
/**
|
|
* Register list of sibling widgets that get checked when data definition or expression is active
|
|
*/
|
|
void registerCheckedWidgets( const QList<QWidget*>& wdgts );
|
|
|
|
/**
|
|
* Register a sibling widget that get checked when data definition or expression is active
|
|
*/
|
|
void registerCheckedWidget( QWidget* wdgt );
|
|
|
|
/**
|
|
* Return widget siblings that get checked when data definition or expression is active
|
|
*
|
|
* @return unguarded pointers from guarded ones
|
|
*/
|
|
QList<QWidget*> registeredCheckedWidgets();
|
|
|
|
/**
|
|
* Clears list of checkable sibling widgets
|
|
*/
|
|
void clearCheckedWidgets();
|
|
|
|
/**
|
|
* Register an expression context generator class that will be used to retrieve
|
|
* an expression context for the button.
|
|
* @param generator A QgsExpressionContextGenerator class that will be used to
|
|
* create an expression context when required.
|
|
* @note added in QGIS 3.0
|
|
*/
|
|
void registerExpressionContextGenerator( QgsExpressionContextGenerator* generator );
|
|
|
|
/**
|
|
* Sets an assistant used to define the data defined object properties.
|
|
* Ownership of the assistant is transferred to the widget.
|
|
* @param title menu title for the assistant
|
|
* @param assistant data defined assistant. Set to null to remove the assistant
|
|
* option from the button.
|
|
* @note added in 2.10
|
|
* @see assistant()
|
|
*/
|
|
void setAssistant( const QString& title, QgsDataDefinedAssistant * assistant /Transfer/ );
|
|
|
|
/** Returns the assistant used to defined the data defined object properties, if set.
|
|
* @see setAssistant()
|
|
* @note added in QGIS 2.12
|
|
*/
|
|
QgsDataDefinedAssistant* assistant();
|
|
|
|
/**
|
|
* Common descriptions for expected input values
|
|
*/
|
|
static QString trString();
|
|
static QString charDesc();
|
|
static QString boolDesc();
|
|
static QString anyStringDesc();
|
|
static QString intDesc();
|
|
static QString intPosDesc();
|
|
static QString intPosOneDesc();
|
|
static QString doubleDesc();
|
|
static QString doublePosDesc();
|
|
static QString double0to1Desc();
|
|
static QString doubleXYDesc();
|
|
static QString double180RotDesc();
|
|
static QString intTranspDesc();
|
|
static QString unitsMmMuDesc();
|
|
static QString unitsMmMuPercentDesc();
|
|
static QString colorNoAlphaDesc();
|
|
static QString colorAlphaDesc();
|
|
static QString textHorzAlignDesc();
|
|
static QString textVertAlignDesc();
|
|
static QString penJoinStyleDesc();
|
|
static QString blendModesDesc();
|
|
static QString svgPathDesc();
|
|
static QString filePathDesc();
|
|
static QString paperSizeDesc();
|
|
static QString paperOrientationDesc();
|
|
static QString horizontalAnchorDesc();
|
|
static QString verticalAnchorDesc();
|
|
static QString gradientTypeDesc();
|
|
static QString gradientCoordModeDesc();
|
|
static QString gradientSpreadDesc();
|
|
static QString lineStyleDesc();
|
|
static QString capStyleDesc();
|
|
static QString fillStyleDesc();
|
|
static QString markerStyleDesc();
|
|
static QString customDashDesc();
|
|
|
|
public slots:
|
|
/**
|
|
* Set whether the current data definition or expression is to be used
|
|
*/
|
|
void setActive( bool active );
|
|
|
|
/**
|
|
* Set siblings' enabled property when data definition or expression is set/unset
|
|
*/
|
|
void disableEnabledWidgets( bool disable );
|
|
|
|
/**
|
|
* Set siblings' checked property when data definition or expression is active
|
|
*/
|
|
void checkCheckedWidgets( bool check );
|
|
|
|
signals:
|
|
/**
|
|
* Emitted when data definition or expression is changed
|
|
* @param definition The current definition or expression (empty string if inactive)
|
|
*/
|
|
void dataDefinedChanged( const QString& definition );
|
|
|
|
/**
|
|
* Emitted when active state changed
|
|
* @param active Whether the definition is active
|
|
*/
|
|
void dataDefinedActivated( bool active );
|
|
|
|
protected:
|
|
void mouseReleaseEvent( QMouseEvent *event );
|
|
|
|
/**
|
|
* Set whether the current expression is to be used instead of field mapping
|
|
*/
|
|
void setUseExpression( bool use );
|
|
|
|
/**
|
|
* Set the current defined expression
|
|
*/
|
|
void setExpression( const QString& exp );
|
|
|
|
/**
|
|
* Set the current defined field
|
|
*/
|
|
void setField( const QString& field );
|
|
|
|
};
|
|
|
|
QFlags<QgsDataDefinedButton::DataType> operator|(QgsDataDefinedButton::DataType f1, QFlags<QgsDataDefinedButton::DataType> f2);
|