QGIS API Documentation  2.11.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsDataDefinedButton Class Reference

A button for defining data source field mappings or expressions. More...

#include <qgsdatadefinedbutton.h>

Inheritance diagram for QgsDataDefinedButton:
Inheritance graph
[legend]

Public Types

enum  DataType { String = 1, Int = 2, Double = 4, AnyType = String | Int | Double }
 
typedef QgsExpressionContext(* ExpressionContextCallback )(const void *context)
 Callback function for retrieving the expression context for the button. More...
 

Public Slots

void checkCheckedWidgets (bool check)
 Set siblings' checked property when data definition or expression is active. More...
 
void disableEnabledWidgets (bool disable)
 Set siblings' enabled property when data definition or expression is set/unset. More...
 
void setActive (bool active)
 Set whether the current data definition or expression is to be used. More...
 

Signals

void dataDefinedActivated (bool active)
 Emitted when active state changed. More...
 
void dataDefinedChanged (const QString &definition)
 Emitted when data definition or expression is changed. More...
 

Public Member Functions

 QgsDataDefinedButton (QWidget *parent=0, const QgsVectorLayer *vl=0, const QgsDataDefined *datadefined=0, DataTypes datatypes=AnyType, QString description="")
 Construct a new data defined button. More...
 
 ~QgsDataDefinedButton ()
 
void clearCheckedWidgets ()
 Clears list of checkable sibling widgets. More...
 
void clearEnabledWidgets ()
 Clears list of sibling widgets. More...
 
QgsDataDefined currentDataDefined () const
 Returns a QgsDataDefined which reflects the current settings from the button. More...
 
QString currentDefinition () const
 The current definition. More...
 
QMap< QString, QStringdefinedProperty () const
 
QString fullDescription () const
 The full definition description and current definition (internally generated on a contextual basis) More...
 
QString getExpression () const
 The current defined expression. More...
 
QString getField () const
 The current defined field. More...
 
void init (const QgsVectorLayer *vl, const QgsDataDefined *datadefined=0, DataTypes datatypes=AnyType, QString description=QString(""))
 Initialize a newly constructed data defined button (useful if button already included from form layout) More...
 
bool isActive () const
 Whether the current data definition or expression is to be used. More...
 
void registerCheckedWidget (QWidget *wdgt)
 Register a sibling widget that get checked when data definition or expression is active. More...
 
void registerCheckedWidgets (QList< QWidget * > wdgts)
 Register list of sibling widgets that get checked when data definition or expression is active. More...
 
QList< QWidget * > registeredCheckedWidgets ()
 Return widget siblings that get checked when data definition or expression is active. More...
 
QList< QWidget * > registeredEnabledWidgets ()
 Return widget siblings that get disabled/enabled when data definition or expression is set/unset. More...
 
void registerEnabledWidget (QWidget *wdgt)
 Register a sibling widget that gets disabled/enabled when data definition or expression is set/unset. More...
 
void registerEnabledWidgets (QList< QWidget * > wdgts)
 Register list of sibling widgets that get disabled/enabled when data definition or expression is set/unset. More...
 
void registerGetExpressionContextCallback (ExpressionContextCallback fnGetExpressionContext, const void *context)
 Register callback function for retrieving the expression context for the button. More...
 
void setAssistant (const QString &title, QgsDataDefinedAssistant *assistant)
 Sets an assistant used to define the data defined object properties. More...
 
void setUsageInfo (const QString &info)
 Set the usage information about this data definition. More...
 
void updateDataDefined (QgsDataDefined *dd) const
 Updates a QgsDataDefined with the current settings from the button. More...
 
QString usageInfo () const
 The usage information about this data definition. More...
 
bool useExpression () const
 Whether the current expression is to be used instead of field mapping. More...
 
const DataTypes & validDataTypes () 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. More...
 
- Public Member Functions inherited from QToolButton
 QToolButton (QWidget *parent)
 
 QToolButton (QWidget *parent, const char *name)
 
 QToolButton (Qt::ArrowType type, QWidget *parent, const char *name)
 
 QToolButton (const QIcon &icon, const QString &textLabel, const QString &statusTip, QObject *receiver, const char *slot, QWidget *parent, const char *name)
 
 ~QToolButton ()
 
Qt::ArrowType arrowType () const
 
bool autoRaise () const
 
QActiondefaultAction () const
 
QIcon iconSet () const
 
QIcon iconSet (bool on) const
 
QMenumenu () const
 
virtual QSize minimumSizeHint () const
 
QIcon offIconSet () const
 
QIcon onIconSet () const
 
void openPopup ()
 
QMenupopup () const
 
int popupDelay () const
 
ToolButtonPopupMode popupMode () const
 
void setArrowType (Qt::ArrowType type)
 
void setAutoRaise (bool enable)
 
void setDefaultAction (QAction *action)
 
void setIconSet (const QIcon &icon)
 
void setIconSet (const QIcon &set, bool on)
 
void setMenu (QMenu *menu)
 
void setOffIconSet (const QIcon &set)
 
void setOnIconSet (const QIcon &set)
 
void setPixmap (const QPixmap &pixmap)
 
void setPopup (QMenu *popup)
 
void setPopupDelay (int delay)
 
void setPopupMode (ToolButtonPopupMode mode)
 
void setTextLabel (const QString &text, bool tooltip)
 
void setTextPosition (QToolButton::TextPosition pos)
 
void setToolButtonStyle (Qt::ToolButtonStyle style)
 
void setUsesBigPixmap (bool enable)
 
void setUsesTextLabel (bool enable)
 
void showMenu ()
 
virtual QSize sizeHint () const
 
QString textLabel () const
 
TextPosition textPosition () const
 
Qt::ToolButtonStyle toolButtonStyle () const
 
void triggered (QAction *action)
 
bool usesBigPixmap () const
 
bool usesTextLabel () const
 
- Public Member Functions inherited from QAbstractButton
 QAbstractButton (QWidget *parent)
 
 QAbstractButton (QWidget *parent, const char *name, QFlags< Qt::WindowType > f)
 
 ~QAbstractButton ()
 
QKeySequence accel () const
 
void animateClick (int msec)
 
bool autoExclusive () const
 
bool autoRepeat () const
 
int autoRepeatDelay () const
 
int autoRepeatInterval () const
 
void click ()
 
void clicked (bool checked)
 
QButtonGroupgroup () const
 
QIcon icon () const
 
QIconiconSet () const
 
QSize iconSize () const
 
bool isCheckable () const
 
bool isChecked () const
 
bool isDown () const
 
bool isOn () const
 
bool isToggleButton () const
 
const QPixmappixmap () const
 
void pressed ()
 
void released ()
 
void setAccel (const QKeySequence &key)
 
void setAutoExclusive (bool)
 
void setAutoRepeat (bool)
 
void setAutoRepeatDelay (int)
 
void setAutoRepeatInterval (int)
 
void setCheckable (bool)
 
void setChecked (bool)
 
void setDown (bool)
 
void setIcon (const QIcon &icon)
 
void setIconSet (const QIcon &icon)
 
void setIconSize (const QSize &size)
 
void setOn (bool b)
 
void setPixmap (const QPixmap &p)
 
void setShortcut (const QKeySequence &key)
 
void setText (const QString &text)
 
void setToggleButton (bool b)
 
QKeySequence shortcut () const
 
QString text () const
 
void toggle ()
 
void toggled (bool checked)
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, QFlags< Qt::WindowType > f)
 
 QWidget (QWidget *parent, const char *name, QFlags< Qt::WindowType > f)
 
 ~QWidget ()
 
bool acceptDrops () const
 
QString accessibleDescription () const
 
QString accessibleName () const
 
QList< QAction * > actions () const
 
void activateWindow ()
 
void addAction (QAction *action)
 
void addActions (QList< QAction * > actions)
 
void adjustSize ()
 
bool autoFillBackground () const
 
Qt::BackgroundMode backgroundMode () const
 
QPoint backgroundOffset () const
 
BackgroundOrigin backgroundOrigin () const
 
QPalette::ColorRole backgroundRole () const
 
QSize baseSize () const
 
QString caption () const
 
QWidgetchildAt (int x, int y, bool includeThis) const
 
QWidgetchildAt (const QPoint &p, bool includeThis) const
 
QWidgetchildAt (int x, int y) const
 
QWidgetchildAt (const QPoint &p) const
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
void clearFocus ()
 
void clearMask ()
 
bool close (bool alsoDelete)
 
bool close ()
 
QColorGroup colorGroup () const
 
void constPolish () const
 
QMargins contentsMargins () const
 
QRect contentsRect () const
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
QCursor cursor () const
 
void customContextMenuRequested (const QPoint &pos)
 
void drawText (const QPoint &p, const QString &s)
 
void drawText (int x, int y, const QString &s)
 
WId effectiveWinId () const
 
void ensurePolished () const
 
void erase ()
 
void erase (const QRect &rect)
 
void erase (const QRegion &rgn)
 
void erase (int x, int y, int w, int h)
 
Qt::FocusPolicy focusPolicy () const
 
QWidgetfocusProxy () const
 
QWidgetfocusWidget () const
 
const QFontfont () const
 
QFontInfo fontInfo () const
 
QFontMetrics fontMetrics () const
 
QPalette::ColorRole foregroundRole () const
 
QRect frameGeometry () const
 
QSize frameSize () const
 
const QRectgeometry () const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const
 
virtual HDC getDC () const
 
void grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
 
QGraphicsEffectgraphicsEffect () const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const
 
bool hasEditFocus () const
 
bool hasFocus () const
 
bool hasMouse () const
 
bool hasMouseTracking () const
 
int height () const
 
virtual int heightForWidth (int w) const
 
void hide ()
 
const QPixmapicon () const
 
void iconify ()
 
QString iconText () const
 
QInputContextinputContext ()
 
Qt::InputMethodHints inputMethodHints () const
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const
 
void insertAction (QAction *before, QAction *action)
 
void insertActions (QAction *before, QList< QAction * > actions)
 
bool isActiveWindow () const
 
bool isAncestorOf (const QWidget *child) const
 
bool isDesktop () const
 
bool isDialog () const
 
bool isEnabled () const
 
bool isEnabledTo (QWidget *ancestor) const
 
bool isEnabledToTLW () const
 
bool isFullScreen () const
 
bool isHidden () const
 
bool isInputMethodEnabled () const
 
bool isMaximized () const
 
bool isMinimized () const
 
bool isModal () const
 
bool isPopup () const
 
bool isShown () const
 
bool isTopLevel () const
 
bool isUpdatesEnabled () const
 
bool isVisible () const
 
bool isVisibleTo (QWidget *ancestor) const
 
bool isVisibleToTLW () const
 
bool isWindow () const
 
bool isWindowModified () const
 
QLayoutlayout () const
 
Qt::LayoutDirection layoutDirection () const
 
QLocale locale () const
 
void lower ()
 
Qt::HANDLE macCGHandle () const
 
Qt::HANDLE macQDHandle () const
 
QPoint mapFrom (QWidget *parent, const QPoint &pos) const
 
QPoint mapFromGlobal (const QPoint &pos) const
 
QPoint mapFromParent (const QPoint &pos) const
 
QPoint mapTo (QWidget *parent, const QPoint &pos) const
 
QPoint mapToGlobal (const QPoint &pos) const
 
QPoint mapToParent (const QPoint &pos) const
 
QRegion mask () const
 
int maximumHeight () const
 
QSize maximumSize () const
 
int maximumWidth () const
 
int minimumHeight () const
 
QSize minimumSize () const
 
int minimumWidth () const
 
void move (int x, int y)
 
void move (const QPoint &)
 
QWidgetnativeParentWidget () const
 
QWidgetnextInFocusChain () const
 
QRect normalGeometry () const
 
void overrideWindowFlags (QFlags< Qt::WindowType > flags)
 
bool ownCursor () const
 
bool ownFont () const
 
bool ownPalette () const
 
virtual QPaintEnginepaintEngine () const
 
const QPalettepalette () const
 
QWidgetparentWidget (bool sameWindow) const
 
QWidgetparentWidget () const
 
QPlatformWindow * platformWindow () const
 
QPlatformWindowFormat platformWindowFormat () const
 
void polish ()
 
QPoint pos () const
 
QWidgetpreviousInFocusChain () const
 
void raise ()
 
void recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)
 
QRect rect () const
 
virtual void releaseDC (HDC hdc) const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)
 
void repaint (int x, int y, int w, int h, bool b)
 
void repaint (const QRegion &rgn, bool b)
 
void repaint ()
 
void repaint (int x, int y, int w, int h)
 
void repaint (const QRegion &rgn)
 
void repaint (bool b)
 
void repaint (const QRect &rect)
 
void repaint (const QRect &r, bool b)
 
void reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)
 
void reparent (QWidget *parent, const QPoint &p, bool showIt)
 
void resize (int w, int h)
 
void resize (const QSize &)
 
bool restoreGeometry (const QByteArray &geometry)
 
QByteArray saveGeometry () const
 
void scroll (int dx, int dy)
 
void scroll (int dx, int dy, const QRect &r)
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setActiveWindow ()
 
void setAttribute (Qt::WidgetAttribute attribute, bool on)
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundColor (const QColor &color)
 
void setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)
 
void setBackgroundOrigin (BackgroundOrigin background)
 
void setBackgroundPixmap (const QPixmap &pixmap)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 
void setCaption (const QString &c)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContentsMargins (const QMargins &margins)
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setDisabled (bool disable)
 
void setEditFocus (bool enable)
 
void setEnabled (bool)
 
void setEraseColor (const QColor &color)
 
void setErasePixmap (const QPixmap &pixmap)
 
void setFixedHeight (int h)
 
void setFixedSize (const QSize &s)
 
void setFixedSize (int w, int h)
 
void setFixedWidth (int w)
 
void setFocus (Qt::FocusReason reason)
 
void setFocus ()
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *w)
 
void setFont (const QFont &)
 
void setFont (const QFont &f, bool b)
 
void setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (int x, int y, int w, int h)
 
void setGeometry (const QRect &)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setHidden (bool hidden)
 
void setIcon (const QPixmap &i)
 
void setIconText (const QString &it)
 
void setInputContext (QInputContext *context)
 
void setInputMethodEnabled (bool enabled)
 
void setInputMethodHints (QFlags< Qt::InputMethodHint > hints)
 
void setKeyCompression (bool b)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &bitmap)
 
void setMask (const QRegion &region)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 
void setPalette (const QPalette &p, bool b)
 
void setPaletteBackgroundColor (const QColor &color)
 
void setPaletteBackgroundPixmap (const QPixmap &pixmap)
 
void setPaletteForegroundColor (const QColor &color)
 
void setParent (QWidget *parent)
 
void setParent (QWidget *parent, QFlags< Qt::WindowType > f)
 
void setPlatformWindow (QPlatformWindow *window)
 
void setPlatformWindowFormat (const QPlatformWindowFormat &format)
 
void setShortcutAutoRepeat (int id, bool enable)
 
void setShortcutEnabled (int id, bool enable)
 
void setShown (bool shown)
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setSizePolicy (QSizePolicy)
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *style)
 
QStylesetStyle (const QString &style)
 
void setStyleSheet (const QString &styleSheet)
 
void setToolTip (const QString &)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 
virtual void setVisible (bool visible)
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlags (QFlags< Qt::WindowType > type)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowIconText (const QString &)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowModified (bool)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &role)
 
void setWindowState (QFlags< Qt::WindowState > windowState)
 
void setWindowSurface (QWindowSurface *surface)
 
void setWindowTitle (const QString &)
 
void show ()
 
void showFullScreen ()
 
void showMaximized ()
 
void showMinimized ()
 
void showNormal ()
 
QSize size () const
 
QSize sizeIncrement () const
 
QSizePolicy sizePolicy () const
 
void stackUnder (QWidget *w)
 
QString statusTip () const
 
QStylestyle () const
 
QString styleSheet () const
 
bool testAttribute (Qt::WidgetAttribute attribute) const
 
QString toolTip () const
 
QWidgettopLevelWidget () const
 
bool underMouse () const
 
void ungrabGesture (Qt::GestureType gesture)
 
void unsetCursor ()
 
void unsetFont ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void unsetPalette ()
 
void update (const QRect &rect)
 
void update (const QRegion &rgn)
 
void update (int x, int y, int w, int h)
 
void update ()
 
void updateGeometry ()
 
bool updatesEnabled () const
 
QRect visibleRect () const
 
QRegion visibleRegion () const
 
QString whatsThis () const
 
int width () const
 
QWidgetwindow () const
 
QString windowFilePath () const
 
Qt::WindowFlags windowFlags () const
 
QIcon windowIcon () const
 
QString windowIconText () const
 
Qt::WindowModality windowModality () const
 
qreal windowOpacity () const
 
QString windowRole () const
 
Qt::WindowStates windowState () const
 
QWindowSurface * windowSurface () const
 
QString windowTitle () const
 
Qt::WindowType windowType () const
 
WId winId () const
 
int x () const
 
const QX11Infox11Info () const
 
Qt::HANDLE x11PictureHandle () const
 
int y () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 
- Public Member Functions inherited from QPaintDevice
virtual  ~QPaintDevice ()
 
int colorCount () const
 
int depth () const
 
int height () const
 
int heightMM () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
int numColors () const
 
virtual QPaintEnginepaintEngine () const =0
 
bool paintingActive () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
int width () const
 
int widthMM () const
 
int x11Cells () const
 
Qt::HANDLE x11Colormap () const
 
bool x11DefaultColormap () const
 
bool x11DefaultVisual () const
 
int x11Depth () const
 
Display * x11Display () const
 
int x11Screen () const
 
void * x11Visual () const
 

Static Public Member Functions

static QString anyStringDesc ()
 
static QString blendModesDesc ()
 
static QString boolDesc ()
 
static QString capStyleDesc ()
 
static QString charDesc ()
 
static QString colorAlphaDesc ()
 
static QString colorNoAlphaDesc ()
 
static QString customDashDesc ()
 
static QString double0to1Desc ()
 
static QString double180RotDesc ()
 
static QString doubleDesc ()
 
static QString doublePosDesc ()
 
static QString doubleXYDesc ()
 
static QString filePathDesc ()
 
static QString fillStyleDesc ()
 
static QString gradientCoordModeDesc ()
 
static QString gradientSpreadDesc ()
 
static QString gradientTypeDesc ()
 
static QString horizontalAnchorDesc ()
 
static QString intDesc ()
 
static QString intPosDesc ()
 
static QString intPosOneDesc ()
 
static QString intTranspDesc ()
 
static QString lineStyleDesc ()
 
static QString markerStyleDesc ()
 
static QString paperOrientationDesc ()
 
static QString paperSizeDesc ()
 
static QString penJoinStyleDesc ()
 
static QString svgPathDesc ()
 
static QString textHorzAlignDesc ()
 
static QString textVertAlignDesc ()
 
static QString trString ()
 Common descriptions for expected input values. More...
 
static QString unitsMmMuDesc ()
 
static QString unitsMmMuPercentDesc ()
 
static QString verticalAnchorDesc ()
 
- Static Public Member Functions inherited from QWidget
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
void setTabOrder (QWidget *first, QWidget *second)
 
QWidgetMapper * wmapper ()
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Public Member Functions inherited from QPaintDevice
int x11AppCells (int screen)
 
Qt::HANDLE x11AppColormap (int screen)
 
bool x11AppDefaultColormap (int screen)
 
bool x11AppDefaultVisual (int screen)
 
int x11AppDepth (int screen)
 
Display * x11AppDisplay ()
 
int x11AppDpiX (int screen)
 
int x11AppDpiY (int screen)
 
Qt::HANDLE x11AppRootWindow (int screen)
 
int x11AppScreen ()
 
void * x11AppVisual (int screen)
 
void x11SetAppDpiX (int dpi, int screen)
 
void x11SetAppDpiY (int dpi, int screen)
 

Protected Member Functions

void mouseReleaseEvent (QMouseEvent *event) override
 
void setExpression (QString exp)
 Set the current defined expression. More...
 
void setField (QString field)
 Set the current defined field. More...
 
void setUseExpression (bool use)
 Set whether the current expression is to be used instead of field mapping. More...
 
- Protected Member Functions inherited from QToolButton
virtual void actionEvent (QActionEvent *event)
 
virtual void changeEvent (QEvent *e)
 
virtual void enterEvent (QEvent *e)
 
virtual bool event (QEvent *event)
 
virtual bool hitButton (const QPoint &pos) const
 
void initStyleOption (QStyleOptionToolButton *option) const
 
virtual void leaveEvent (QEvent *e)
 
virtual void mousePressEvent (QMouseEvent *e)
 
virtual void nextCheckState ()
 
virtual void paintEvent (QPaintEvent *event)
 
virtual void timerEvent (QTimerEvent *e)
 
- Protected Member Functions inherited from QAbstractButton
virtual void checkStateSet ()
 
virtual void focusInEvent (QFocusEvent *e)
 
virtual void focusOutEvent (QFocusEvent *e)
 
virtual void keyPressEvent (QKeyEvent *e)
 
virtual void keyReleaseEvent (QKeyEvent *e)
 
virtual void mouseMoveEvent (QMouseEvent *e)
 
- Protected Member Functions inherited from QWidget
virtual void closeEvent (QCloseEvent *event)
 
virtual void contextMenuEvent (QContextMenuEvent *event)
 
void create (WId window, bool initializeWindow, bool destroyOldWindow)
 
void destroy (bool destroyWindow, bool destroySubWindows)
 
virtual void dragEnterEvent (QDragEnterEvent *event)
 
virtual void dragLeaveEvent (QDragLeaveEvent *event)
 
virtual void dragMoveEvent (QDragMoveEvent *event)
 
virtual void dropEvent (QDropEvent *event)
 
bool focusNextChild ()
 
virtual bool focusNextPrevChild (bool next)
 
bool focusPreviousChild ()
 
virtual void hideEvent (QHideEvent *event)
 
virtual void inputMethodEvent (QInputMethodEvent *event)
 
virtual void languageChange ()
 
virtual bool macEvent (EventHandlerCallRef caller, EventRef event)
 
virtual int metric (PaintDeviceMetric m) const
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 
virtual void moveEvent (QMoveEvent *event)
 
virtual bool qwsEvent (QWSEvent *event)
 
void resetInputContext ()
 
virtual void resizeEvent (QResizeEvent *event)
 
virtual void showEvent (QShowEvent *event)
 
virtual void tabletEvent (QTabletEvent *event)
 
void updateMicroFocus ()
 
virtual void wheelEvent (QWheelEvent *event)
 
virtual bool winEvent (MSG *message, long *result)
 
virtual bool x11Event (XEvent *event)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
- Protected Member Functions inherited from QPaintDevice
 QPaintDevice ()
 

Additional Inherited Members

- Public Attributes inherited from QWidget
typedef RenderFlags
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QToolButton
 arrowType
 
 autoRaise
 
 popupMode
 
 toolButtonStyle
 
- Properties inherited from QAbstractButton
 autoExclusive
 
 autoRepeat
 
 autoRepeatDelay
 
 autoRepeatInterval
 
 checkable
 
 checked
 
 down
 
 icon
 
 iconSize
 
 shortcut
 
 text
 
- Properties inherited from QWidget
 acceptDrops
 
 accessibleDescription
 
 accessibleName
 
 autoFillBackground
 
 baseSize
 
 childrenRect
 
 childrenRegion
 
 contextMenuPolicy
 
 cursor
 
 enabled
 
 focus
 
 focusPolicy
 
 font
 
 frameGeometry
 
 frameSize
 
 fullScreen
 
 geometry
 
 height
 
 inputMethodHints
 
 isActiveWindow
 
 layoutDirection
 
 locale
 
 maximized
 
 maximumHeight
 
 maximumSize
 
 maximumWidth
 
 minimized
 
 minimumHeight
 
 minimumSize
 
 minimumSizeHint
 
 minimumWidth
 
 modal
 
 mouseTracking
 
 normalGeometry
 
 palette
 
 pos
 
 rect
 
 size
 
 sizeHint
 
 sizeIncrement
 
 sizePolicy
 
 statusTip
 
 styleSheet
 
 toolTip
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 

Detailed Description

A button for defining data source field mappings or expressions.

Definition at line 47 of file qgsdatadefinedbutton.h.

Member Typedef Documentation

typedef QgsExpressionContext( * QgsDataDefinedButton::ExpressionContextCallback)(const void *context)

Callback function for retrieving the expression context for the button.

Definition at line 199 of file qgsdatadefinedbutton.h.

Member Enumeration Documentation

Enumerator
String 
Int 
Double 
AnyType 

Definition at line 53 of file qgsdatadefinedbutton.h.

Constructor & Destructor Documentation

QgsDataDefinedButton::QgsDataDefinedButton ( QWidget parent = 0,
const QgsVectorLayer vl = 0,
const QgsDataDefined datadefined = 0,
DataTypes  datatypes = AnyType,
QString  description = "" 
)

Construct a new data defined button.

Parameters
parentThe parent QWidget
vlPointer to the associated vector layer
datadefinedData defined property
datatypesThe expected data types to be compared against the variant type of the QgsField from data source and expression result
descriptionThe description of expected input data

Definition at line 39 of file qgsdatadefinedbutton.cpp.

QgsDataDefinedButton::~QgsDataDefinedButton ( )

Definition at line 106 of file qgsdatadefinedbutton.cpp.

Member Function Documentation

QString QgsDataDefinedButton::anyStringDesc ( )
static

Definition at line 740 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::blendModesDesc ( )
static

Definition at line 825 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::boolDesc ( )
static

Definition at line 735 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::capStyleDesc ( )
static

Definition at line 888 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::charDesc ( )
static

Definition at line 730 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::checkCheckedWidgets ( bool  check)
slot

Set siblings' checked property when data definition or expression is active.

Definition at line 701 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::clearCheckedWidgets ( )
inline

Clears list of checkable sibling widgets.

Definition at line 196 of file qgsdatadefinedbutton.h.

void QgsDataDefinedButton::clearEnabledWidgets ( )
inline

Clears list of sibling widgets.

Definition at line 174 of file qgsdatadefinedbutton.h.

QString QgsDataDefinedButton::colorAlphaDesc ( )
static

Definition at line 805 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::colorNoAlphaDesc ( )
static

Definition at line 800 of file qgsdatadefinedbutton.cpp.

QgsDataDefined QgsDataDefinedButton::currentDataDefined ( ) const

Returns a QgsDataDefined which reflects the current settings from the button.

Note
added in QGIS 2.9
See also
updateDataDefined

Definition at line 217 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::currentDefinition ( ) const
inline

The current definition.

Returns
empty QString if not active, otherwise currently defined expression or field name

Definition at line 131 of file qgsdatadefinedbutton.h.

QString QgsDataDefinedButton::customDashDesc ( )
static

Definition at line 905 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::dataDefinedActivated ( bool  active)
signal

Emitted when active state changed.

Parameters
activeWhether the definition is active
void QgsDataDefinedButton::dataDefinedChanged ( const QString definition)
signal

Emitted when data definition or expression is changed.

Parameters
definitionThe current definition or expression (empty string if inactive)
QMap< QString, QString > QgsDataDefinedButton::definedProperty ( ) const
inline

Definition at line 91 of file qgsdatadefinedbutton.h.

void QgsDataDefinedButton::disableEnabledWidgets ( bool  disable)
slot

Set siblings' enabled property when data definition or expression is set/unset.

Definition at line 653 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::double0to1Desc ( )
static

Definition at line 770 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::double180RotDesc ( )
static

Definition at line 780 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::doubleDesc ( )
static

Definition at line 760 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::doublePosDesc ( )
static

Definition at line 765 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::doubleXYDesc ( )
static

Definition at line 775 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::filePathDesc ( )
static

Definition at line 839 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::fillStyleDesc ( )
static

Definition at line 893 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::fullDescription ( ) const
inline

The full definition description and current definition (internally generated on a contextual basis)

Definition at line 142 of file qgsdatadefinedbutton.h.

QString QgsDataDefinedButton::getExpression ( ) const
inline

The current defined expression.

Definition at line 120 of file qgsdatadefinedbutton.h.

QString QgsDataDefinedButton::getField ( ) const
inline

The current defined field.

Definition at line 125 of file qgsdatadefinedbutton.h.

QString QgsDataDefinedButton::gradientCoordModeDesc ( )
static

Definition at line 873 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::gradientSpreadDesc ( )
static

Definition at line 878 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::gradientTypeDesc ( )
static

Definition at line 868 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::horizontalAnchorDesc ( )
static

Definition at line 858 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::init ( const QgsVectorLayer vl,
const QgsDataDefined datadefined = 0,
DataTypes  datatypes = AnyType,
QString  description = QString( "" ) 
)

Initialize a newly constructed data defined button (useful if button already included from form layout)

Parameters
vlPointer to the associated vector layer
datadefinedData defined property
datatypesThe expected data types to be compared against the variant type of the QgsField from data source and expression result
descriptionThe description of expected input data

Definition at line 112 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::intDesc ( )
static

Definition at line 745 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::intPosDesc ( )
static

Definition at line 750 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::intPosOneDesc ( )
static

Definition at line 755 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::intTranspDesc ( )
static

Definition at line 785 of file qgsdatadefinedbutton.cpp.

bool QgsDataDefinedButton::isActive ( ) const
inline

Whether the current data definition or expression is to be used.

Definition at line 110 of file qgsdatadefinedbutton.h.

QString QgsDataDefinedButton::lineStyleDesc ( )
static

Definition at line 883 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::markerStyleDesc ( )
static

Definition at line 900 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::mouseReleaseEvent ( QMouseEvent event)
overrideprotectedvirtual

Reimplemented from QToolButton.

Definition at line 224 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::paperOrientationDesc ( )
static

Definition at line 853 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::paperSizeDesc ( )
static

Definition at line 844 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::penJoinStyleDesc ( )
static

Definition at line 820 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::registerCheckedWidget ( QWidget wdgt)

Register a sibling widget that get checked when data definition or expression is active.

Definition at line 669 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::registerCheckedWidgets ( QList< QWidget * >  wdgts)

Register list of sibling widgets that get checked when data definition or expression is active.

Definition at line 661 of file qgsdatadefinedbutton.cpp.

QList< QWidget * > QgsDataDefinedButton::registeredCheckedWidgets ( )

Return widget siblings that get checked when data definition or expression is active.

Returns
unguarded pointers from guarded ones

Definition at line 678 of file qgsdatadefinedbutton.cpp.

QList< QWidget * > QgsDataDefinedButton::registeredEnabledWidgets ( )

Return widget siblings that get disabled/enabled when data definition or expression is set/unset.

Returns
unguarded pointers from guarded ones

Definition at line 643 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::registerEnabledWidget ( QWidget wdgt)

Register a sibling widget that gets disabled/enabled when data definition or expression is set/unset.

Definition at line 634 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::registerEnabledWidgets ( QList< QWidget * >  wdgts)

Register list of sibling widgets that get disabled/enabled when data definition or expression is set/unset.

Definition at line 626 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::registerGetExpressionContextCallback ( QgsDataDefinedButton::ExpressionContextCallback  fnGetExpressionContext,
const void *  context 
)

Register callback function for retrieving the expression context for the button.

Parameters
fnGetExpressionContextcall back function, will be called when the data defined button requires the current expression context
contextcontext for callback function
Note
added in QGIS 2.12
not available in Python bindings

Definition at line 688 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::setActive ( bool  active)
slot

Set whether the current data definition or expression is to be used.

Definition at line 617 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::setAssistant ( const QString title,
QgsDataDefinedAssistant assistant 
)

Sets an assistant used to define the data defined object properties.

Ownership of the assistant is transferred to the widget.

Parameters
titlemenu title for the assistant
assistantdata defined assistant. Set to null to remove the assistant option from the button.
Note
added in 2.10

Definition at line 694 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::setExpression ( QString  exp)
inlineprotected

Set the current defined expression.

Definition at line 299 of file qgsdatadefinedbutton.h.

void QgsDataDefinedButton::setField ( QString  field)
inlineprotected

Set the current defined field.

Definition at line 304 of file qgsdatadefinedbutton.h.

void QgsDataDefinedButton::setUsageInfo ( const QString info)
inline

Set the usage information about this data definition.

Definition at line 152 of file qgsdatadefinedbutton.h.

void QgsDataDefinedButton::setUseExpression ( bool  use)
inlineprotected

Set whether the current expression is to be used instead of field mapping.

Definition at line 294 of file qgsdatadefinedbutton.h.

QString QgsDataDefinedButton::svgPathDesc ( )
static

Definition at line 832 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::textHorzAlignDesc ( )
static

Definition at line 810 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::textVertAlignDesc ( )
static

Definition at line 815 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::trString ( )
static

Common descriptions for expected input values.

Definition at line 724 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::unitsMmMuDesc ( )
static

Definition at line 790 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::unitsMmMuPercentDesc ( )
static

Definition at line 795 of file qgsdatadefinedbutton.cpp.

void QgsDataDefinedButton::updateDataDefined ( QgsDataDefined dd) const

Updates a QgsDataDefined with the current settings from the button.

Parameters
ddQgsDataDefined to update
Note
added in QGIS 2.9
See also
currentDataDefined

Definition at line 206 of file qgsdatadefinedbutton.cpp.

QString QgsDataDefinedButton::usageInfo ( ) const
inline

The usage information about this data definition.

Definition at line 147 of file qgsdatadefinedbutton.h.

bool QgsDataDefinedButton::useExpression ( ) const
inline

Whether the current expression is to be used instead of field mapping.

Definition at line 115 of file qgsdatadefinedbutton.h.

const DataTypes& QgsDataDefinedButton::validDataTypes ( ) const
inline

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.

Definition at line 137 of file qgsdatadefinedbutton.h.

QString QgsDataDefinedButton::verticalAnchorDesc ( )
static

Definition at line 863 of file qgsdatadefinedbutton.cpp.


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