45#include <QStyleOptionToolButton>
46#include <QWidgetAction>
49#include "moc_qgscolorbutton.cpp"
51using namespace Qt::StringLiterals;
54 : QToolButton( parent )
55 , mColorDialogTitle( cdt.isEmpty() ? tr(
"Select Color" ) : cdt )
57 , mNoColorString( tr(
"No color" ) )
58 , mOpaqueColorString( tr(
"Opaque color" ) )
63 setAcceptDrops(
true );
64 setMinimumSize( QSize( 24, 16 ) );
65 connect(
this, &QAbstractButton::clicked,
this, &QgsColorButton::buttonClicked );
68 mMenu =
new QMenu(
this );
69 connect( mMenu, &QMenu::aboutToShow,
this, &QgsColorButton::prepareMenu );
71 setPopupMode( QToolButton::MenuButtonPopup );
74 mMinimumSize = QSize( 120, 22 );
76 mMinimumSize = QSize( 120, 28 );
79 mMinimumSize.setHeight( std::max(
static_cast<int>(
Qgis::UI_SCALE_FACTOR * fontMetrics().height() * 1.1 ), mMinimumSize.height() ) );
101 static QPixmap sTranspBkgrd;
103 if ( sTranspBkgrd.isNull() )
109void QgsColorButton::showColorDialog()
114 const QColor currentColor =
color();
119 if ( currentColor.isValid() )
130 const QgsSettings settings;
137 newColor = QColorDialog::getColor(
color(),
this, mColorDialogTitle, mAllowOpacity ? QColorDialog::ShowAlphaChannel : ( QColorDialog::ColorDialogOption ) 0 );
141 QgsColorDialog dialog(
this, Qt::WindowFlags(),
color() );
142 dialog.setTitle( mColorDialogTitle );
143 dialog.setAllowOpacity( mAllowOpacity );
147 newColor = dialog.color();
151 if ( newColor.isValid() )
153 setValidColor( newColor );
162 if ( !mDefaultColor.isValid() )
184 if ( e->type() == QEvent::ToolTip && isEnabled() )
186 QColor
c = linkedProjectColor();
187 const bool isProjectColor =
c.isValid();
188 if ( !isProjectColor )
191 QString info = ( isProjectColor ? u
"<p>%1: %2</p>"_s.arg( tr(
"Linked color" ), mLinkedColorName ) : QString() );
197 return QToolButton::event( e );
202 QColor noColor = QColor( mColor );
203 noColor.setAlpha( 0 );
209 QColor opaqueColor = QColor( mColor );
210 opaqueColor.setAlpha( 255 );
216 if ( e->button() == Qt::LeftButton )
218 mDragStartPosition = e->pos();
220 QToolButton::mousePressEvent( e );
225 QToolButton::showMenu();
229bool QgsColorButton::colorFromMimeData(
const QMimeData *mimeData, QColor &resultColor )
234 bool hasAlpha =
false;
237 if ( mimeColor.isValid() )
239 if ( !mAllowOpacity )
242 mimeColor.setAlpha( 255 );
244 else if ( !hasAlpha )
247 mimeColor.setAlpha( mColor.alpha() );
249 resultColor = mimeColor;
260 QColor
c = linkedProjectColor();
264 if ( !( e->buttons() & Qt::LeftButton ) || !
c.isValid() )
267 QToolButton::mouseMoveEvent( e );
271 if ( ( e->pos() - mDragStartPosition ).manhattanLength() < QApplication::startDragDistance() )
274 QToolButton::mouseMoveEvent( e );
279 QDrag *drag =
new QDrag(
this );
282 drag->exec( Qt::CopyAction );
286void QgsColorButton::onColorPicked(
const QColor &color )
288 if (
color.isValid() )
291 addRecentColor( mColor );
301void QgsColorButton::onColorHovered(
const QColor &color )
306void QgsColorButton::colorPickingCanceled()
311QColor QgsColorButton::linkedProjectColor()
const
313 QList<QgsProjectColorScheme *> projectSchemes;
315 if ( projectSchemes.length() > 0 )
317 QgsProjectColorScheme *scheme = projectSchemes.at( 0 );
319 for (
const auto &
color : colors )
321 if (
color.second.isEmpty() )
324 if (
color.second == mLinkedColorName )
335 const bool isProjectColor = linkedProjectColor().isValid();
336 if ( isProjectColor )
341 if ( colorFromMimeData( e->mimeData(), mimeColor ) )
346 e->acceptProposedAction();
360 const bool isProjectColor = linkedProjectColor().isValid();
361 if ( isProjectColor )
366 if ( colorFromMimeData( e->mimeData(), mimeColor ) )
369 e->acceptProposedAction();
371 addRecentColor( mimeColor );
377 if ( mAllowOpacity && isEnabled() && !
isNull() )
379 const double increment = ( (
event->modifiers() & Qt::ControlModifier ) ? 0.01 : 0.1 ) * (
event->angleDelta().y() > 0 ? 1 : -1 );
380 const double alpha = std::min( std::max( 0.0, mColor.alphaF() + increment ), 1.0 );
381 mColor.setAlphaF( alpha );
389 QToolButton::wheelEvent(
event );
393void QgsColorButton::setValidColor(
const QColor &newColor )
395 if ( newColor.isValid() )
398 addRecentColor( newColor );
402void QgsColorButton::setValidTemporaryColor(
const QColor &newColor )
404 if ( newColor.isValid() )
415 QPixmap pixmap( iconSize, iconSize );
416 pixmap.fill( Qt::transparent );
425 p.setPen( Qt::NoPen );
426 p.setBrush( checkBrush );
427 p.drawRect( 0, 0, iconSize - 1, iconSize - 1 );
431 p.setBrush( QBrush(
color ) );
434 p.setPen( QColor( 197, 197, 197 ) );
435 p.drawRect( 0, 0, iconSize - 1, iconSize - 1 );
440void QgsColorButton::buttonClicked()
442 if ( linkedProjectColor().isValid() )
444 QToolButton::showMenu();
460void QgsColorButton::prepareMenu()
468 const bool isProjectColor = linkedProjectColor().isValid();
470 if ( !isProjectColor )
474 QAction *nullAction =
new QAction( mNullColorString.isEmpty() ? tr(
"Clear Color" ) : mNullColorString,
this );
476 mMenu->addAction( nullAction );
481 if ( mDefaultColor.isValid() )
483 QAction *defaultColorAction =
new QAction( tr(
"Default Color" ),
this );
485 mMenu->addAction( defaultColorAction );
489 if ( mShowNoColorOption && mColor.alpha() > 0 )
491 QAction *noColorAction =
new QAction( mNoColorString,
this );
492 noColorAction->setIcon(
createMenuIcon( Qt::transparent,
false ) );
493 mMenu->addAction( noColorAction );
497 if ( ( mAllowOpacity || mShowNoColorOption ) && mColor.isValid() && mColor.alpha() < 255 )
499 QColor opaqueColor = QColor( mColor );
500 opaqueColor.setAlpha( 255 );
501 QAction *opaqueColorAction =
new QAction( mOpaqueColorString,
this );
503 mMenu->addAction( opaqueColorAction );
507 mMenu->addSeparator();
508 QgsColorWheel *colorWheel =
new QgsColorWheel( mMenu );
510 QgsColorWidgetAction *colorAction =
new QgsColorWidgetAction( colorWheel, mMenu, mMenu );
513 mMenu->addAction( colorAction );
518 QgsColorWidgetAction *alphaAction =
new QgsColorWidgetAction( alphaRamp, mMenu, mMenu );
523 mMenu->addAction( alphaAction );
526 if ( mColorSchemeRegistry )
530 QList<QgsColorScheme *>::iterator it = schemeList.begin();
531 for ( ; it != schemeList.end(); ++it )
533 QgsColorSwatchGridAction *colorAction =
new QgsColorSwatchGridAction( *it, mMenu, mContext,
this );
535 mMenu->addAction( colorAction );
541 mMenu->addSeparator();
544 if ( isProjectColor )
546 QAction *unlinkAction =
new QAction( tr(
"Unlink Color" ), mMenu );
547 mMenu->addAction( unlinkAction );
551 QAction *copyColorAction =
new QAction( tr(
"Copy Color" ),
this );
552 mMenu->addAction( copyColorAction );
555 if ( !isProjectColor )
557 QAction *pasteColorAction =
new QAction( tr(
"Paste Color" ),
this );
561 if ( colorFromMimeData( QApplication::clipboard()->mimeData(), clipColor ) )
567 pasteColorAction->setEnabled(
false );
569 mMenu->addAction( pasteColorAction );
572 QAction *pickColorAction =
new QAction( tr(
"Pick Color" ),
this );
573 mMenu->addAction( pickColorAction );
576 QAction *chooseColorAction =
new QAction( tr(
"Choose Color…" ),
this );
577 mMenu->addAction( chooseColorAction );
578 connect( chooseColorAction, &QAction::triggered,
this, &QgsColorButton::showColorDialog );
584 if ( e->type() == QEvent::EnabledChange )
588 QToolButton::changeEvent( e );
592void QgsColorButton::paintEvent( QPaintEvent *e )
594 QToolButton::paintEvent( e );
596 if ( !mBackgroundSet )
606 QToolButton::showEvent( e );
611 QToolButton::resizeEvent(
event );
619 const QColor oldColor = mColor;
623 if ( oldColor != mColor || ( mColor == QColor( Qt::black ) && !mColorSet ) )
636void QgsColorButton::addRecentColor(
const QColor &color )
643 QColor backgroundColor =
color;
644 bool isProjectColor =
false;
645 if ( !backgroundColor.isValid() && !mLinkedColorName.isEmpty() )
647 backgroundColor = linkedProjectColor();
648 isProjectColor = backgroundColor.isValid();
649 if ( !isProjectColor )
651 mLinkedColorName.clear();
655 if ( !backgroundColor.isValid() )
657 backgroundColor = mColor;
660 QSize currentIconSize;
664 if ( !mIconSize.isValid() )
667 QStyleOptionToolButton opt;
668 initStyleOption( &opt );
669 const QRect buttonSize = QApplication::style()->subControlRect( QStyle::CC_ToolButton, &opt, QStyle::SC_ToolButton,
this );
672 mIconSize = QSize( buttonSize.width() - 10, height() - 6 );
674 mIconSize = QSize( buttonSize.width() - 10, height() - 12 );
677 currentIconSize = mIconSize;
683 currentIconSize = QSize( width() - 10, height() - 6 );
685 currentIconSize = QSize( width() - 10, height() - 12 );
689 if ( !currentIconSize.isValid() || currentIconSize.width() <= 0 || currentIconSize.height() <= 0 )
695 const double pixelRatio = devicePixelRatioF();
696 QPixmap pixmap( currentIconSize * pixelRatio );
697 pixmap.setDevicePixelRatio( pixelRatio );
698 pixmap.fill( Qt::transparent );
700 if ( backgroundColor.isValid() )
702 const QRectF rect( 0, 0, currentIconSize.width(), currentIconSize.height() );
705 p.setRenderHint( QPainter::Antialiasing );
706 p.setPen( Qt::NoPen );
707 if ( mAllowOpacity && backgroundColor.alpha() < 255 )
711 p.setBrush( checkBrush );
712 p.drawRoundedRect( rect, 3, 3 );
715 p.setBrush( backgroundColor );
716 p.drawRoundedRect( rect, 3, 3 );
719 const QRectF clipRect( 0, 0,
static_cast<qreal
>( currentIconSize.width() ) / 2.0, currentIconSize.height() );
720 p.setClipRect( clipRect );
721 backgroundColor.setAlpha( 255 );
722 p.setBrush( backgroundColor );
723 p.drawRoundedRect( rect, 3, 3 );
727 p.setBrush( backgroundColor );
728 p.drawRoundedRect( rect, 3, 3 );
733 setIconSize( currentIconSize );
740 QColor
c = linkedProjectColor();
749 if ( colorFromMimeData( QApplication::clipboard()->mimeData(), clipColor ) )
753 addRecentColor( clipColor );
759 mPickerHelper->activate();
764 QColor
c = linkedProjectColor();
772 mAllowOpacity = allow;
777 mColorDialogTitle = title;
782 return mColorDialogTitle;
788 setMenu(
showMenu ? mMenu :
nullptr );
789 setPopupMode(
showMenu ? QToolButton::MenuButtonPopup : QToolButton::DelayedPopup );
802 mDefaultColor =
color;
808 mNullColorString = nullString;
818 return !mColor.isValid();
823 mLinkedColorName = name;
static const double UI_SCALE_FACTOR
UI scaling factor.
static QPixmap getThemePixmap(const QString &name, const QColor &foreColor=QColor(), const QColor &backColor=QColor(), int size=16)
Helper to get a theme icon as a pixmap.
static QgsColorSchemeRegistry * colorSchemeRegistry()
Returns the application's color scheme registry, used for managing color schemes.
A utility class for sampling colors from the screen.
void colorPicked(const QColor &color)
Emitted when the user has finished picking a color from the screen.
void colorHovered(const QColor &color)
Emitted when the user hovers over a color from the screen.
void canceled()
Emitted when the user cancels the picking operation.
Registry of color schemes.
QList< QgsColorScheme * > schemes() const
Returns all color schemes in the registry.
@ ShowInColorButtonMenu
Show scheme in color button drop-down menu.
void setBaseColor(const QColor &baseColor)
Sets the base color for the color grid.
void colorChanged(const QColor &color)
Emitted when a color has been selected from the widget.
void setColor(const QColor &color, bool emitSignals=false) override
QgsNamedColorList fetchColors(const QString &context=QString(), const QColor &baseColor=QColor()) override
Gets a list of colors from the scheme.
static QgsProject * instance()
Returns the QgsProject singleton instance.
void projectColorsChanged()
Emitted whenever the project's color scheme has been changed.
static void addRecentColor(const QColor &color)
Adds a color to the list of recent colors.
T value(const QString &dynamicKeyPart=QString()) const
Returns settings value.
static const QgsSettingsEntryBool * settingsNativeColorDialogs
Settings entry whether to use native color dialogs.
static QColor colorFromMimeData(const QMimeData *data, bool &hasAlpha)
Attempts to parse mime data as a color.
static std::unique_ptr< QMimeData > colorToMimeData(const QColor &color)
Creates mime data from a color.
QList< QPair< QColor, QString > > QgsNamedColorList
List of colors paired with a friendly display name identifying the color.
int scaleIconSize(int standardSize)
Scales an icon size to compensate for display pixel density, making the icon size hi-dpi friendly,...
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c