QGIS API Documentation  3.0.2-Girona (307d082)
qgsmultiedittoolbutton.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsmultiedittoolbutton.h
3  ------------------------
4  Date : March 2016
5  Copyright : (C) 2016 Nyall Dawson
6  Email : nyall dot dawson at gmail.com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSMULTIEDITTOOLBUTTON_H
17 #define QGSMULTIEDITTOOLBUTTON_H
18 
19 #include "qgsfields.h"
20 #include "qgis.h"
21 #include <QToolButton>
22 #include "qgis_gui.h"
23 
32 class GUI_EXPORT QgsMultiEditToolButton : public QToolButton
33 {
34  Q_OBJECT
35 
36  public:
37 
39  enum State
40  {
44  };
45 
50  explicit QgsMultiEditToolButton( QWidget *parent SIP_TRANSFERTHIS = nullptr );
51 
55  State state() const { return mState; }
56 
62  void setField( const QgsField &field ) { mField = field; }
63 
64  public slots:
65 
73  void setIsMixed( bool mixed ) { mIsMixedValues = mixed; updateState(); }
74 
82  void setIsChanged( bool changed ) { mIsChanged = changed; updateState(); }
83 
90  void resetChanges() { mIsChanged = false; updateState(); }
91 
96  void changesCommitted() { mIsMixedValues = false; mIsChanged = false; updateState(); }
97 
98  signals:
99 
101  void setFieldValueTriggered();
102 
104  void resetFieldValueTriggered();
105 
106  private slots:
107 
108  void aboutToShowMenu();
109  void setFieldTriggered();
110  void resetFieldTriggered();
111 
112  private:
113 
114  bool mIsMixedValues = false;
115  bool mIsChanged = false;
116  State mState = Default;
117  QgsField mField;
118 
119  QMenu *mMenu = nullptr;
120 
121  void updateState();
122 
123 };
124 
125 #endif // QGSMULTIEDITTOOLBUTTON_H
void resetChanges()
Resets the changed state for the field.
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:46
A tool button widget which is displayed next to editor widgets in attribute forms, and allows for controlling how the widget behaves and interacts with the form while in multi edit mode.
void changesCommitted()
Called when field values have been changed and field now contains all the same values.
State state() const
Returns the current displayed state of the button.
Encapsulate a field in an attribute table or data source.
Definition: qgsfield.h:48
void setIsChanged(bool changed)
Sets whether the associated field has changed.
Mixed state, some features have different values for the widget.
void setField(const QgsField &field)
Sets the field associated with this button.
void setIsMixed(bool mixed)
Sets whether the associated field contains mixed values.
Value for widget has changed but changes have not yet been committed.
Default state, all features have same value for widget.