QGIS/python/gui/attributetable/qgsfieldconditionalformatwidget.sip
Nyall Dawson 881074b194 Boost coverage of SIP bindings
Now all classes and members are either exposed to bindings or marked
as "not available in Python bindings" in the docs.

Drop test thresholds to 0. Now it should be much easier to determine
what missing members have been added which are causing test
failures.
2016-01-05 11:16:15 +11:00

66 lines
1.9 KiB
Plaintext

/** \ingroup gui
* \class QgsFieldConditionalFormatWidget
* A widget for customising conditional formatting options.
* \note added in QGIS 2.12
*/
class QgsFieldConditionalFormatWidget : QWidget
{
%TypeHeaderCode
#include <attributetable/qgsfieldconditionalformatwidget.h>
%End
public:
/** Constructor for QgsFieldConditionalFormatWidget.
* @param parent parent widget
*/
explicit QgsFieldConditionalFormatWidget( QWidget *parent /TransferThis/ = 0 );
~QgsFieldConditionalFormatWidget();
/** Switches the widget to the rules page.
*/
void viewRules();
/** Sets the vector layer associated with the widget.
* @param theLayer vector layer
*/
void setLayer( QgsVectorLayer* theLayer );
/** Switches the widget to the edit style mode for the specified style.
* @param index index of conditional style to edit
* @param style initial conditional styling options
*/
void editStyle( int index, const QgsConditionalStyle& style );
/**
* @param style initial conditional styling options
*/
void loadStyle( const QgsConditionalStyle& style );
/** Resets the formatting options to their default state.
*/
void reset();
/**
* @brief Set the presets that can be used for quick pick
* @param styles A list of styles used as presets
*/
void setPresets( const QList<QgsConditionalStyle>& styles );
/**
* @brief The default presets for the widget. Normally set when the widget is
* created however called setPresets will override the default styles.
* @return List of default presets.
*/
QList<QgsConditionalStyle> defaultPresets() const;
signals:
/** Emitted when the conditional styling rules are updated.
* @param fieldName name of field whose rules have been modified.
*/
void rulesUpdated( const QString& fieldName );
};