QGIS/python/gui/auto_generated/attributetable/qgsfieldconditionalformatwidget.sip.in

97 lines
2.7 KiB
Plaintext
Raw Normal View History

2017-06-08 15:51:05 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/attributetable/qgsfieldconditionalformatwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
2015-08-21 05:45:49 +10:00
class QgsFieldConditionalFormatWidget : QWidget
{
2017-06-08 15:51:05 +02:00
%Docstring
A widget for customizing conditional formatting options.
2017-12-15 10:36:55 -04:00
2017-06-08 15:51:05 +02:00
.. versionadded:: 2.12
2015-08-21 05:45:49 +10:00
%End
2017-06-08 15:51:05 +02:00
%TypeHeaderCode
#include "qgsfieldconditionalformatwidget.h"
%End
2015-08-21 05:45:49 +10:00
public:
explicit QgsFieldConditionalFormatWidget( QWidget *parent /TransferThis/ = 0 );
2017-06-08 15:51:05 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Constructor for QgsFieldConditionalFormatWidget.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param parent: parent widget
2017-06-08 15:51:05 +02:00
%End
2015-08-21 05:45:49 +10:00
void viewRules();
2017-06-08 15:51:05 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Switches the widget to the rules page.
2017-06-08 15:51:05 +02:00
%End
2015-08-21 05:45:49 +10:00
void setLayer( QgsVectorLayer *layer );
2017-06-08 15:51:05 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Sets the vector layer associated with the widget.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param layer: vector layer
2017-06-08 15:51:05 +02:00
%End
2015-08-21 05:45:49 +10:00
void editStyle( int index, const QgsConditionalStyle &style );
2017-06-08 15:51:05 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Switches the widget to the edit style mode for the specified style.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param index: index of conditional style to edit
:param style: initial conditional styling options
2017-06-08 15:51:05 +02:00
%End
2015-08-21 05:45:49 +10:00
void loadStyle( const QgsConditionalStyle &style );
2017-06-08 15:51:05 +02:00
%Docstring
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param style: initial conditional styling options
2017-06-08 15:51:05 +02:00
%End
2015-08-21 05:45:49 +10:00
void reset();
2017-06-08 15:51:05 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Resets the formatting options to their default state.
2017-06-08 15:51:05 +02:00
%End
2015-08-21 05:45:49 +10:00
void setPresets( const QList<QgsConditionalStyle> &styles );
2017-06-08 15:51:05 +02:00
%Docstring
Set the presets that can be used for quick pick
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param styles: A list of styles used as presets
2017-06-08 15:51:05 +02:00
%End
QList<QgsConditionalStyle> defaultPresets() const;
2017-06-08 15:51:05 +02:00
%Docstring
The default presets for the widget. Normally set when the widget is
2017-12-15 10:36:55 -04:00
created however called setPresets will override the default styles.
:return: List of default presets.
2017-06-08 15:51:05 +02:00
%End
2015-08-21 05:45:49 +10:00
signals:
void rulesUpdated( const QString &fieldName );
2017-06-08 15:51:05 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Emitted when the conditional styling rules are updated.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param fieldName: name of field whose rules have been modified.
2017-06-08 15:51:05 +02:00
%End
public slots:
2015-08-21 05:45:49 +10:00
};
2017-06-08 15:51:05 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/attributetable/qgsfieldconditionalformatwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/