QGIS API Documentation  2.11.0-Master
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Properties | List of all members
QgsColorButtonV2 Class Reference

A cross platform button subclass for selecting colors. More...

#include <qgscolorbuttonv2.h>

Inheritance diagram for QgsColorButtonV2:
Inheritance graph
[legend]

Public Types

enum  Behaviour { ShowDialog = 0, SignalOnly }
 Specifies the behaviour when the button is clicked. More...
 

Public Slots

void activatePicker ()
 Activates the color picker tool, which allows for sampling a color from anywhere on the screen. More...
 
void copyColor ()
 Copies the current color to the clipboard. More...
 
void pasteColor ()
 Pastes a color from the clipboard to the color button. More...
 
void setButtonBackground (const QColor &color=QColor())
 Sets the background pixmap for the button based upon color and transparency. More...
 
void setColor (const QColor &color)
 Sets the current color for the button. More...
 
void setToDefaultColor ()
 Sets color to the button's default color, if set. More...
 
void setToNoColor ()
 Sets color to a totally transparent color. More...
 

Signals

void colorChanged (const QColor &color)
 Is emitted whenever a new color is set for the button. More...
 
void colorClicked (const QColor &color)
 Emitted when the button is clicked, if the button's behaviour is set to SignalOnly. More...
 

Public Member Functions

 QgsColorButtonV2 (QWidget *parent=0, QString cdt="", QgsColorSchemeRegistry *registry=0)
 Construct a new color button. More...
 
virtual ~QgsColorButtonV2 ()
 
bool acceptLiveUpdates () const
 Returns whether the button accepts live updates from QColorDialog. More...
 
bool allowAlpha () const
 Returns whether alpha modification (transparency) is permitted for the color. More...
 
Behaviour behaviour () const
 Returns the behaviour for when the button is clicked. More...
 
QColor color () const
 Return the currently selected color. More...
 
QString colorDialogTitle () const
 Returns the title for the color chooser dialog window. More...
 
QgsColorSchemeRegistrycolorSchemeRegistry ()
 Returns the color scheme registry for the button, which controls the color swatch grids that are shown in the button's drop down menu. More...
 
QString context () const
 Returns the context string for the color button. More...
 
QColor defaultColor () const
 Returns the default color for the button, which is shown in the button's drop down menu for the "default color" option. More...
 
QString noColorString () const
 Returns the string used for the "no color" option in the button's drop down menu. More...
 
void setAcceptLiveUpdates (const bool accept)
 Sets whether the button accepts live updates from QColorDialog. More...
 
void setAllowAlpha (const bool allowAlpha)
 Sets whether alpha modification (transparency) is permitted for the color. More...
 
void setBehaviour (const Behaviour behaviour)
 Sets the behaviour for when the button is clicked. More...
 
void setColorDialogTitle (const QString title)
 Set the title for the color chooser dialog window. More...
 
void setColorSchemeRegistry (QgsColorSchemeRegistry *registry)
 Sets the color scheme registry for the button, which controls the color swatch grids that are shown in the button's drop down menu. More...
 
void setContext (const QString context)
 Sets the context string for the color button. More...
 
void setDefaultColor (const QColor color)
 Sets the default color for the button, which is shown in the button's drop down menu for the "default color" option. More...
 
void setNoColorString (const QString noColorString)
 Sets the string to use for the "no color" option in the button's drop down menu. More...
 
void setShowMenu (const bool showMenu)
 Sets whether the drop down menu should be shown for the button. More...
 
void setShowNoColor (const bool showNoColorOption)
 Sets whether the "no color" option should be shown in the button's drop down menu. More...
 
bool showMenu () const
 Returns whether the drop down menu is shown for the button. More...
 
bool showNoColor () const
 Returns whether the "no color" option is shown in the button's drop down menu. More...
 
virtual QSize sizeHint () const override
 
- 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 ()
 
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
 

Protected Member Functions

void changeEvent (QEvent *e) override
 
void dragEnterEvent (QDragEnterEvent *e) override
 Reimplemented to accept dragged colors. More...
 
void dragLeaveEvent (QDragLeaveEvent *e) override
 Reimplemented to reset button appearance after drag leave. More...
 
void dropEvent (QDropEvent *e) override
 Reimplemented to accept dropped colors. More...
 
void keyPressEvent (QKeyEvent *e) override
 Reimplemented to allow cancelling color pick via keypress, and sample via space bar press. More...
 
void mouseMoveEvent (QMouseEvent *e) override
 Reimplemented to allow dragging colors from button. More...
 
void mousePressEvent (QMouseEvent *e) override
 Reimplemented to detect right mouse button clicks on the color button and allow dragging colors. More...
 
void mouseReleaseEvent (QMouseEvent *e) override
 Reimplemented to allow color picking. More...
 
void resizeEvent (QResizeEvent *event) override
 
void showEvent (QShowEvent *e) override
 
- Protected Member Functions inherited from QToolButton
virtual void actionEvent (QActionEvent *event)
 
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 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 keyReleaseEvent (QKeyEvent *e)
 
virtual void paintEvent (QPaintEvent *e)=0
 
- 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 dragMoveEvent (QDragMoveEvent *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 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 ()
 

Static Protected Member Functions

static const QPixmaptransparentBackground ()
 Returns a checkboard pattern pixmap for use as a background to transparent colors. More...
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 

Properties

bool acceptLiveUpdates
 
bool allowAlpha
 
Behaviour behaviour
 
QColor color
 
QString colorDialogTitle
 
QString context
 
QColor defaultColor
 
QString noColorString
 
bool showMenu
 
bool showNoColor
 
- 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
 

Additional Inherited Members

- 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)
 
- Public Attributes inherited from QWidget
typedef RenderFlags
 

Detailed Description

A cross platform button subclass for selecting colors.

Will open a color chooser dialog when clicked. Offers live updates to button from color chooser dialog. An attached drop down menu allows for copying and pasting colors, picking colors from the screen, and selecting colors from color swatch grids.

Note
Added in version 2.5

Definition at line 34 of file qgscolorbuttonv2.h.

Member Enumeration Documentation

Specifies the behaviour when the button is clicked.

Enumerator
ShowDialog 

show a color picker dialog when clicked

SignalOnly 

emit colorClicked signal only, no dialog

Definition at line 53 of file qgscolorbuttonv2.h.

Constructor & Destructor Documentation

QgsColorButtonV2::QgsColorButtonV2 ( QWidget parent = 0,
QString  cdt = "",
QgsColorSchemeRegistry registry = 0 
)

Construct a new color button.

Parameters
parentThe parent QWidget for the dialog
cdtThe title to show in the color chooser dialog
registrya color scheme registry for color swatch grids to show in the drop down menu. If not specified, the button will use the global color scheme registry

Definition at line 41 of file qgscolorbuttonv2.cpp.

QgsColorButtonV2::~QgsColorButtonV2 ( )
virtual

Definition at line 70 of file qgscolorbuttonv2.cpp.

Member Function Documentation

bool QgsColorButtonV2::acceptLiveUpdates ( ) const
inline

Returns whether the button accepts live updates from QColorDialog.

Returns
true if the button will be accepted immediately when the dialog's color changes
See also
setAcceptLiveUpdates

Definition at line 107 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::activatePicker ( )
slot

Activates the color picker tool, which allows for sampling a color from anywhere on the screen.

Definition at line 640 of file qgscolorbuttonv2.cpp.

bool QgsColorButtonV2::allowAlpha ( ) const
inline

Returns whether alpha modification (transparency) is permitted for the color.

Returns
true if alpha modification is allowed
See also
setAllowAlpha

Definition at line 89 of file qgscolorbuttonv2.h.

Behaviour QgsColorButtonV2::behaviour ( ) const
inline

Returns the behaviour for when the button is clicked.

Returns
behaviour when button is clicked
See also
setBehaviour

Definition at line 140 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::changeEvent ( QEvent e)
overrideprotectedvirtual

Reimplemented from QToolButton.

Definition at line 460 of file qgscolorbuttonv2.cpp.

QColor QgsColorButtonV2::color ( ) const

Return the currently selected color.

Returns
currently selected color
See also
setColor
void QgsColorButtonV2::colorChanged ( const QColor color)
signal

Is emitted whenever a new color is set for the button.

The color is always valid. In case the new color is the same no signal is emitted, to avoid infinite loops.

Parameters
colorNew color
void QgsColorButtonV2::colorClicked ( const QColor color)
signal

Emitted when the button is clicked, if the button's behaviour is set to SignalOnly.

Parameters
colorbutton color
See also
setBehaviour
behaviour
QString QgsColorButtonV2::colorDialogTitle ( ) const

Returns the title for the color chooser dialog window.

Returns
title for the color chooser dialog
See also
setColorDialogTitle
QgsColorSchemeRegistry* QgsColorButtonV2::colorSchemeRegistry ( )
inline

Returns the color scheme registry for the button, which controls the color swatch grids that are shown in the button's drop down menu.

Returns
color scheme registry for the button. If returned value is 0 then all color swatch grids are hidden from the button's drop down menu.
See also
setColorSchemeRegistry

Definition at line 226 of file qgscolorbuttonv2.h.

QString QgsColorButtonV2::context ( ) const
inline

Returns the context string for the color button.

The context string is passed to all color swatch grids shown in the button's drop down menu, to allow them to customise their display colors based on the context.

Returns
context string for the color button's color swatch grids
See also
setContext

Definition at line 210 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::copyColor ( )
slot

Copies the current color to the clipboard.

See also
pasteColor

Definition at line 623 of file qgscolorbuttonv2.cpp.

QColor QgsColorButtonV2::defaultColor ( ) const
inline

Returns the default color for the button, which is shown in the button's drop down menu for the "default color" option.

Returns
default color for the button. Returns an invalid QColor if the default color option is disabled.
See also
setDefaultColor

Definition at line 156 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::dragEnterEvent ( QDragEnterEvent e)
overrideprotectedvirtual

Reimplemented to accept dragged colors.

Reimplemented from QWidget.

Definition at line 302 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::dragLeaveEvent ( QDragLeaveEvent e)
overrideprotectedvirtual

Reimplemented to reset button appearance after drag leave.

Reimplemented from QWidget.

Definition at line 316 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::dropEvent ( QDropEvent e)
overrideprotectedvirtual

Reimplemented to accept dropped colors.

Reimplemented from QWidget.

Definition at line 323 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::keyPressEvent ( QKeyEvent e)
overrideprotectedvirtual

Reimplemented to allow cancelling color pick via keypress, and sample via space bar press.

Reimplemented from QAbstractButton.

Definition at line 289 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::mouseMoveEvent ( QMouseEvent e)
overrideprotectedvirtual

Reimplemented to allow dragging colors from button.

Reimplemented from QAbstractButton.

Definition at line 212 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::mousePressEvent ( QMouseEvent e)
overrideprotectedvirtual

Reimplemented to detect right mouse button clicks on the color button and allow dragging colors.

Reimplemented from QToolButton.

Definition at line 166 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::mouseReleaseEvent ( QMouseEvent e)
overrideprotectedvirtual

Reimplemented to allow color picking.

Reimplemented from QToolButton.

Definition at line 254 of file qgscolorbuttonv2.cpp.

QString QgsColorButtonV2::noColorString ( ) const
inline

Returns the string used for the "no color" option in the button's drop down menu.

Returns
string used for the "no color" menu option
See also
setNoColorString
showNoColor
Note
The "no color" option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

Definition at line 194 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::pasteColor ( )
slot

Pastes a color from the clipboard to the color button.

If clipboard does not contain a valid color or string representation of a color, then no change is applied.

See also
copyColor

Definition at line 629 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::resizeEvent ( QResizeEvent event)
overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 487 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setAcceptLiveUpdates ( const bool  accept)
inline

Sets whether the button accepts live updates from QColorDialog.

Live updates may cause changes that are not undoable on QColorDialog cancel.

Parameters
acceptset to true to enable live updates
See also
acceptLiveUpdates

Definition at line 114 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::setAllowAlpha ( const bool  allowAlpha)

Sets whether alpha modification (transparency) is permitted for the color.

Defaults to false.

Parameters
allowAlphaset to true to allow alpha modification
See also
allowAlpha

Definition at line 655 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setBehaviour ( const Behaviour  behaviour)

Sets the behaviour for when the button is clicked.

The default behaviour is to show a color picker dialog.

Parameters
behaviourbehaviour when button is clicked
See also
behaviour

Definition at line 679 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setButtonBackground ( const QColor color = QColor())
slot

Sets the background pixmap for the button based upon color and transparency.

Call directly to update background after adding/removing QColorDialog::ShowAlphaChannel option but the color has not changed, i.e. setColor() wouldn't update button and you want the button to retain the set color's alpha component regardless

Parameters
colorColor for button background. If no color is specified, the button's current color will be used

Definition at line 550 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setColor ( const QColor color)
slot

Sets the current color for the button.

Will emit a colorChanged signal if the color is different to the previous color.

Parameters
colornew color for the button
See also
color

Definition at line 495 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setColorDialogTitle ( const QString  title)

Set the title for the color chooser dialog window.

Parameters
titleTitle for the color chooser dialog
See also
colorDialogTitle

Definition at line 660 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setColorSchemeRegistry ( QgsColorSchemeRegistry registry)
inline

Sets the color scheme registry for the button, which controls the color swatch grids that are shown in the button's drop down menu.

Parameters
registrycolor scheme registry for the button. Set to 0 to hide all color swatch grids from the button's drop down menu.
See also
colorSchemeRegistry

Definition at line 218 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::setContext ( const QString  context)
inline

Sets the context string for the color button.

The context string is passed to all color swatch grids shown in the button's drop down menu, to allow them to customise their display colors based on the context.

Parameters
contextcontext string for the color button's color swatch grids
See also
context

Definition at line 202 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::setDefaultColor ( const QColor  color)

Sets the default color for the button, which is shown in the button's drop down menu for the "default color" option.

Parameters
colordefault color for the button. Set to an invalid QColor to disable the default color option.
See also
defaultColor

Definition at line 684 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setNoColorString ( const QString  noColorString)
inline

Sets the string to use for the "no color" option in the button's drop down menu.

Parameters
noColorStringstring to use for the "no color" menu option
See also
noColorString
setShowNoColor
Note
The "no color" option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

Definition at line 185 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::setShowMenu ( const bool  showMenu)

Sets whether the drop down menu should be shown for the button.

The default behaviour is to show the menu.

Parameters
showMenuset to false to hide the drop down menu
See also
showMenu

Definition at line 670 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setShowNoColor ( const bool  showNoColorOption)
inline

Sets whether the "no color" option should be shown in the button's drop down menu.

If selected, the "no color" option sets the color button's color to a totally transparent color.

Parameters
showNoColorOptionset to true to show the no color option. This is disabled by default.
See also
showNoColor
setNoColorString
Note
The "no color" option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

Definition at line 166 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::setToDefaultColor ( )
slot

Sets color to the button's default color, if set.

See also
setDefaultColor
defaultColor

Definition at line 148 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setToNoColor ( )
slot

Sets color to a totally transparent color.

Note
If the color button is not set to show an alpha channel in the color dialog (see setColorDialogOptions) then the color will not be changed.

Definition at line 158 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::showEvent ( QShowEvent e)
overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 481 of file qgscolorbuttonv2.cpp.

bool QgsColorButtonV2::showMenu ( ) const
inline

Returns whether the drop down menu is shown for the button.

Returns
true if drop down menu is shown
See also
setShowMenu

Definition at line 127 of file qgscolorbuttonv2.h.

bool QgsColorButtonV2::showNoColor ( ) const
inline

Returns whether the "no color" option is shown in the button's drop down menu.

If selected, the "no color" option sets the color button's color to a totally transparent color.

Returns
true if the no color option is shown.
See also
setShowNoColor
noColorString
Note
The "no color" option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

Definition at line 176 of file qgscolorbuttonv2.h.

QSize QgsColorButtonV2::sizeHint ( ) const
overridevirtual

Reimplemented from QToolButton.

Definition at line 74 of file qgscolorbuttonv2.cpp.

const QPixmap & QgsColorButtonV2::transparentBackground ( )
staticprotected

Returns a checkboard pattern pixmap for use as a background to transparent colors.

Definition at line 84 of file qgscolorbuttonv2.cpp.

Property Documentation

bool QgsColorButtonV2::acceptLiveUpdates
readwrite

Definition at line 39 of file qgscolorbuttonv2.h.

bool QgsColorButtonV2::allowAlpha
readwrite

Definition at line 41 of file qgscolorbuttonv2.h.

Behaviour QgsColorButtonV2::behaviour
readwrite

Definition at line 43 of file qgscolorbuttonv2.h.

QColor QgsColorButtonV2::color
readwrite

Definition at line 40 of file qgscolorbuttonv2.h.

QString QgsColorButtonV2::colorDialogTitle
readwrite

Definition at line 38 of file qgscolorbuttonv2.h.

QString QgsColorButtonV2::context
readwrite

Definition at line 47 of file qgscolorbuttonv2.h.

QColor QgsColorButtonV2::defaultColor
readwrite

Definition at line 44 of file qgscolorbuttonv2.h.

QString QgsColorButtonV2::noColorString
readwrite

Definition at line 46 of file qgscolorbuttonv2.h.

bool QgsColorButtonV2::showMenu
readwrite

Definition at line 42 of file qgscolorbuttonv2.h.

bool QgsColorButtonV2::showNoColor
readwrite

Definition at line 45 of file qgscolorbuttonv2.h.


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