mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-17 00:09:36 -04:00
Add a bunch of useful interactive color widgets to GUI, including
color wheels, ramps, boxes, and text edits.
This commit is contained in:
Nyall Dawson
parent
c04127eccd
commit
b9fc2b51d9
@ -305,6 +305,7 @@
|
||||
<file>themes/default/mIconDbSchema.png</file>
|
||||
<file>themes/default/mIconDelete.png</file>
|
||||
<file>themes/default/mIconDeselected.svg</file>
|
||||
<file>themes/default/mIconDropDownMenu.svg</file>
|
||||
<file>themes/default/mIconEditable.png</file>
|
||||
<file>themes/default/mIconEditableEdits.png</file>
|
||||
<file>themes/default/mIconExpand.png</file>
|
||||
|
||||
68
images/themes/default/mIconDropDownMenu.svg
Normal file
68
images/themes/default/mIconDropDownMenu.svg
Normal file
@ -0,0 +1,68 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||
|
||||
<svg
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||
xmlns:cc="http://creativecommons.org/ns#"
|
||||
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
id="svg2"
|
||||
height="10"
|
||||
width="10"
|
||||
version="1.1"
|
||||
inkscape:version="0.48.4 r9939"
|
||||
sodipodi:docname="mIconDropDownMenu.svg">
|
||||
<defs
|
||||
id="defs10" />
|
||||
<sodipodi:namedview
|
||||
pagecolor="#ffffff"
|
||||
bordercolor="#666666"
|
||||
borderopacity="1"
|
||||
objecttolerance="10"
|
||||
gridtolerance="10"
|
||||
guidetolerance="10"
|
||||
inkscape:pageopacity="0"
|
||||
inkscape:pageshadow="2"
|
||||
inkscape:window-width="1422"
|
||||
inkscape:window-height="735"
|
||||
id="namedview8"
|
||||
showgrid="true"
|
||||
inkscape:zoom="33.37544"
|
||||
inkscape:cx="-1.5366077"
|
||||
inkscape:cy="5.821683"
|
||||
inkscape:window-x="299"
|
||||
inkscape:window-y="130"
|
||||
inkscape:window-maximized="0"
|
||||
inkscape:current-layer="svg2">
|
||||
<inkscape:grid
|
||||
type="xygrid"
|
||||
id="grid3009"
|
||||
empspacing="5"
|
||||
visible="true"
|
||||
enabled="true"
|
||||
snapvisiblegridlinesonly="true"
|
||||
spacingx="0.5px"
|
||||
spacingy="0.5px" />
|
||||
</sodipodi:namedview>
|
||||
<metadata
|
||||
id="metadata7">
|
||||
<rdf:RDF>
|
||||
<cc:Work
|
||||
rdf:about="">
|
||||
<dc:format>image/svg+xml</dc:format>
|
||||
<dc:type
|
||||
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||
<dc:title />
|
||||
</cc:Work>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
<path
|
||||
style="fill:#d7d7d7;fill-opacity:1;stroke:#bbbbbb;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
|
||||
inkscape:connector-curvature="0"
|
||||
d="m 2.5253352,3.5034931 0,1.0392947 2.504627,2.9759254 2.5276309,-2.9759254 0,-1.0392947 z"
|
||||
id="path2999"
|
||||
sodipodi:nodetypes="cccccc" />
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 2.1 KiB |
@ -37,6 +37,7 @@
|
||||
%Include qgscolordialog.sip
|
||||
%Include qgscolorswatchgrid.sip
|
||||
%Include qgscolorschemelist.sip
|
||||
%Include qgscolorwidgets.sip
|
||||
%Include qgscomposerview.sip
|
||||
%Include qgscredentialdialog.sip
|
||||
%Include qgsdatetimeedit.sip
|
||||
|
||||
407
python/gui/qgscolorwidgets.sip
Executable file
407
python/gui/qgscolorwidgets.sip
Executable file
@ -0,0 +1,407 @@
|
||||
/** \ingroup gui
|
||||
* \class QgsColorWidget
|
||||
* A base class for interactive color widgets. Widgets can either allow setting a single component of
|
||||
* a color (eg the red or green components), or an entire color. The QgsColorWidget also keeps track of
|
||||
* any explicitely set hue for the color, so that this information is not lost when the widget is
|
||||
* set to a color with an ambiguous hue (eg black or white shades).
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class QgsColorWidget : QWidget
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qgscolorwidgets.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
|
||||
/*! Specifies the color component which the widget alters
|
||||
*/
|
||||
enum ColorComponent
|
||||
{
|
||||
Multiple = 0, /*!< widget alters multiple color components */
|
||||
Red, /*!< red component of color */
|
||||
Green, /*!< green component of color */
|
||||
Blue, /*!< blue component of color */
|
||||
Hue, /*!< hue component of color (based on HSV model) */
|
||||
Saturation, /*!< saturation component of color (based on HSV model) */
|
||||
Value, /*!< value component of color (based on HSV model) */
|
||||
Alpha /*!< alpha component (opacity) of color */
|
||||
};
|
||||
|
||||
/**Construct a new color widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
* @param component color component the widget alters
|
||||
*/
|
||||
QgsColorWidget( QWidget* parent /TransferThis/ = 0, const ColorComponent component = Multiple );
|
||||
|
||||
virtual ~QgsColorWidget();
|
||||
|
||||
/**Returns the current color for the widget
|
||||
* @returns current widget color
|
||||
* @see setColor
|
||||
*/
|
||||
QColor color() const;
|
||||
|
||||
/**Returns the color component which the widget controls
|
||||
* @returns color component for widget
|
||||
* @see setComponent
|
||||
*/
|
||||
ColorComponent component() const;
|
||||
|
||||
/**Returns the current value of the widget's color component
|
||||
* @returns value of color component, or -1 if widget has multiple components or an invalid color
|
||||
* set
|
||||
* @see setComponentValue
|
||||
* @see component
|
||||
*/
|
||||
int componentValue() const;
|
||||
|
||||
public slots:
|
||||
|
||||
/**Sets the color for the widget
|
||||
* @param color widget color
|
||||
* @see color
|
||||
*/
|
||||
virtual void setColor( const QColor color );
|
||||
|
||||
/**Sets the color component which the widget controls
|
||||
* @param component color component for widget
|
||||
* @see component
|
||||
*/
|
||||
virtual void setComponent( const ColorComponent component );
|
||||
|
||||
/**Alters the widget's color by setting the value for the widget's color component
|
||||
* @param value value for widget's color component. This value is automatically
|
||||
* clipped to the range of valid values for the color component.
|
||||
* @see componentValue
|
||||
* @see setComponent
|
||||
* @note this method has no effect if the widget is set to the QgsColorWidget::Multiple
|
||||
* component
|
||||
*/
|
||||
virtual void setComponentValue( const int value );
|
||||
|
||||
signals:
|
||||
|
||||
/**Emitted when the widget's color changes
|
||||
* @param color new widget color
|
||||
*/
|
||||
void colorChanged( const QColor color );
|
||||
|
||||
protected:
|
||||
|
||||
/**Returns the range of valid values for the color widget's component
|
||||
* @returns maximum value allowed for color component, or -1 if widget has multiple components
|
||||
*/
|
||||
int componentRange() const;
|
||||
|
||||
/**Returns the range of valid values a color component
|
||||
* @returns maximum value allowed for color component
|
||||
*/
|
||||
int componentRange( const ColorComponent component ) const;
|
||||
|
||||
/**Returns the value of a component of the widget's current color. This method correctly
|
||||
* handles hue values when the color has an ambiguous hue (eg black or white shades)
|
||||
* @param component color component to return
|
||||
* @returns value of color component, or -1 if widget has an invalid color set
|
||||
* @see hue
|
||||
*/
|
||||
int componentValue( const ColorComponent component ) const;
|
||||
|
||||
/**Returns the hue for the widget. This may differ from the hue for the QColor returned by color(),
|
||||
* as QColor returns a hue of -1 if the color's hue is ambiguous (eg, if the saturation is zero).
|
||||
* @returns explicitly set hue for widget
|
||||
*/
|
||||
int hue() const;
|
||||
|
||||
/**Alters a color by modifiying the value of a specific color component
|
||||
* @param color color to alter
|
||||
* @param component color component to alter
|
||||
* @param newValue new value of color component. Values are automatically clipped to a
|
||||
* valid range for the color component.
|
||||
*/
|
||||
void alterColor( QColor& color, const QgsColorWidget::ColorComponent component, const int newValue ) const;
|
||||
|
||||
/**Generates a checkboard pattern pixmap for use as a background to transparent colors
|
||||
* @returns checkerboard pixmap
|
||||
*/
|
||||
static const QPixmap& transparentBackground();
|
||||
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorWheel
|
||||
* A color wheel widget. This widget consists of an outer ring which allows for hue selection, and an
|
||||
* inner rotating triangle which allows for saturation and value selection.
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class QgsColorWheel : QgsColorWidget
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qgscolorwidgets.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
|
||||
/**Constructs a new color wheel widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
*/
|
||||
QgsColorWheel( QWidget* parent /TransferThis/ = 0 );
|
||||
|
||||
virtual ~QgsColorWheel();
|
||||
|
||||
void paintEvent( QPaintEvent* event );
|
||||
|
||||
public slots:
|
||||
|
||||
virtual void setColor( const QColor color );
|
||||
|
||||
protected:
|
||||
|
||||
virtual void resizeEvent( QResizeEvent *event );
|
||||
virtual void mouseMoveEvent( QMouseEvent *event );
|
||||
virtual void mousePressEvent( QMouseEvent *event );
|
||||
virtual void mouseReleaseEvent( QMouseEvent *event );
|
||||
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorBox
|
||||
* A color box widget. This widget consists of a two dimensional rectangle filled with color
|
||||
* variations, where a different color component varies along both the horizontal and vertical
|
||||
* axis.
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class QgsColorBox : QgsColorWidget
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qgscolorwidgets.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
|
||||
/**Construct a new color box widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
* @param component constant color component for the widget. The color components
|
||||
* which vary along the horizontal and vertical axis are automatically assigned
|
||||
* based on this constant color component.
|
||||
*/
|
||||
QgsColorBox( QWidget* parent /TransferThis/ = 0, const ColorComponent component = Value );
|
||||
|
||||
virtual ~QgsColorBox();
|
||||
|
||||
virtual QSize sizeHint() const;
|
||||
void paintEvent( QPaintEvent* event );
|
||||
|
||||
virtual void setComponent( const ColorComponent component );
|
||||
|
||||
public slots:
|
||||
|
||||
virtual void setColor( const QColor color );
|
||||
|
||||
protected:
|
||||
|
||||
virtual void resizeEvent( QResizeEvent *event );
|
||||
virtual void mouseMoveEvent( QMouseEvent *event );
|
||||
virtual void mousePressEvent( QMouseEvent *event );
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorRampWidget
|
||||
* A color ramp widget. This widget consists of an interactive box filled with a color which varies along
|
||||
* its length by a single color component (eg, varying saturation from 0 to 100%).
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class QgsColorRampWidget : QgsColorWidget
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qgscolorwidgets.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
|
||||
/*! Specifies the orientation of a color ramp
|
||||
*/
|
||||
enum Orientation
|
||||
{
|
||||
Horizontal, /*!< horizontal ramp */
|
||||
Vertical /*!< vertical ramp */
|
||||
};
|
||||
|
||||
/**Construct a new color ramp widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
* @param component color component which varies along the ramp
|
||||
* @param orientation orientation for widget
|
||||
*/
|
||||
QgsColorRampWidget( QWidget* parent /TransferThis/ = 0,
|
||||
const ColorComponent component = QgsColorWidget::Red,
|
||||
const Orientation orientation = QgsColorRampWidget::Horizontal );
|
||||
|
||||
virtual ~QgsColorRampWidget();
|
||||
|
||||
virtual QSize sizeHint() const;
|
||||
void paintEvent( QPaintEvent* event );
|
||||
|
||||
/**Sets the orientation for the color ramp
|
||||
* @param orientation new orientation for the ramp
|
||||
* @see orientation
|
||||
*/
|
||||
void setOrientation( const Orientation orientation );
|
||||
|
||||
/**Fetches the orientation for the color ramp
|
||||
* @returns orientation for the ramp
|
||||
* @see setOrientation
|
||||
*/
|
||||
Orientation orientation() const;
|
||||
|
||||
/**Sets the margin between the edge of the widget and the ramp
|
||||
* @param margin margin around the ramp
|
||||
* @see interiorMargin
|
||||
*/
|
||||
void setInteriorMargin( const int margin );
|
||||
|
||||
/**Fetches the margin between the edge of the widget and the ramp
|
||||
* @returns margin around the ramp
|
||||
* @see setInteriorMargin
|
||||
*/
|
||||
int interiorMargin() const;
|
||||
|
||||
/**Sets whether the ramp should be drawn within a frame
|
||||
* @param showFrame set to true to draw a frame around the ramp
|
||||
* @see showFrame
|
||||
*/
|
||||
void setShowFrame( const bool showFrame );
|
||||
|
||||
/**Fetches whether the ramp is drawn within a frame
|
||||
* @returns true if a frame is drawn around the ramp
|
||||
* @see setShowFrame
|
||||
*/
|
||||
bool showFrame() const;
|
||||
|
||||
/**Sets the size for drawing the triangular markers on the ramp
|
||||
* @param markerSize marker size in pixels
|
||||
*/
|
||||
void setMarkerSize( const int markerSize );
|
||||
|
||||
signals:
|
||||
|
||||
/**Emitted when the widget's color component value changes
|
||||
* @param value new value of color component
|
||||
*/
|
||||
void valueChanged( const int value );
|
||||
|
||||
protected:
|
||||
|
||||
virtual void mouseMoveEvent( QMouseEvent *event );
|
||||
virtual void mousePressEvent( QMouseEvent *event );
|
||||
virtual void keyPressEvent( QKeyEvent * event );
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorSliderWidget
|
||||
* A composite horizontal color ramp widget and associated spinbox for manual value entry.
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class QgsColorSliderWidget : QgsColorWidget
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qgscolorwidgets.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
|
||||
/**Construct a new color slider widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
* @param component color component which is controlled by the slider
|
||||
*/
|
||||
QgsColorSliderWidget( QWidget* parent /TransferThis/ = 0, const ColorComponent component = QgsColorWidget::Red );
|
||||
|
||||
virtual ~QgsColorSliderWidget();
|
||||
|
||||
virtual void setComponent( const ColorComponent component );
|
||||
virtual void setComponentValue( const int value );
|
||||
virtual void setColor( const QColor color );
|
||||
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorTextWidget
|
||||
* A line edit widget which displays colors as text and accepts string representations
|
||||
* of colors.
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class QgsColorTextWidget : QgsColorWidget
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qgscolorwidgets.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
|
||||
/**Construct a new color line edit widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
*/
|
||||
QgsColorTextWidget( QWidget* parent /TransferThis/ = 0 );
|
||||
|
||||
virtual ~QgsColorTextWidget();
|
||||
|
||||
virtual void setColor( const QColor color );
|
||||
|
||||
protected:
|
||||
void resizeEvent( QResizeEvent * event );
|
||||
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorPreviewWidget
|
||||
* A preview box which displays one or two colors as swatches.
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class QgsColorPreviewWidget : QgsColorWidget
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qgscolorwidgets.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
|
||||
/**Construct a new color preview widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
*/
|
||||
QgsColorPreviewWidget( QWidget* parent /TransferThis/ = 0 );
|
||||
|
||||
virtual ~QgsColorPreviewWidget();
|
||||
|
||||
void paintEvent( QPaintEvent* event );
|
||||
|
||||
/**Returns the secondary color for the widget
|
||||
* @returns secondary widget color, or an invalid color if the widget
|
||||
* has no secondary color
|
||||
* @see color
|
||||
* @see setColor2
|
||||
*/
|
||||
QColor color2() const;
|
||||
|
||||
public slots:
|
||||
|
||||
/**Sets the second color for the widget
|
||||
* @param color secondary widget color. Set to an invalid color to prevent
|
||||
* drawing of a secondary color
|
||||
* @see setColor
|
||||
* @see color2
|
||||
*/
|
||||
virtual void setColor2( const QColor& color );
|
||||
|
||||
};
|
||||
@ -130,6 +130,7 @@ qgscolorbuttonv2.cpp
|
||||
qgscolordialog.cpp
|
||||
qgscolorswatchgrid.cpp
|
||||
qgscolorschemelist.cpp
|
||||
qgscolorwidgets.cpp
|
||||
qgscodeeditor.cpp
|
||||
qgscodeeditorpython.cpp
|
||||
qgscodeeditorsql.cpp
|
||||
@ -336,6 +337,7 @@ qgscodeeditorsql.h
|
||||
qgscodeeditorhtml.h
|
||||
qgscodeeditorcss.h
|
||||
qgscolordialog.h
|
||||
qgscolorwidgets.h
|
||||
qgsprevieweffect.h
|
||||
qgscomposerruler.h
|
||||
qgscomposerview.h
|
||||
@ -427,6 +429,7 @@ qgsbusyindicatordialog.h
|
||||
qgscharacterselectdialog.h
|
||||
qgscollapsiblegroupbox.h
|
||||
qgscolordialog.h
|
||||
qgscolorwidgets.h
|
||||
qgscredentialdialog.h
|
||||
qgscursors.h
|
||||
qgsdatadefinedbutton.h
|
||||
|
||||
1513
src/gui/qgscolorwidgets.cpp
Normal file
1513
src/gui/qgscolorwidgets.cpp
Normal file
File diff suppressed because it is too large
Load Diff
631
src/gui/qgscolorwidgets.h
Normal file
631
src/gui/qgscolorwidgets.h
Normal file
@ -0,0 +1,631 @@
|
||||
/***************************************************************************
|
||||
qgscolorwidgets.h - color selection widgets
|
||||
---------------------
|
||||
begin : September 2014
|
||||
copyright : (C) 2014 by Nyall Dawson
|
||||
email : nyall dot dawson at gmail dot com
|
||||
***************************************************************************
|
||||
* *
|
||||
* This program is free software; you can redistribute it and/or modify *
|
||||
* it under the terms of the GNU General Public License as published by *
|
||||
* the Free Software Foundation; either version 2 of the License, or *
|
||||
* (at your option) any later version. *
|
||||
* *
|
||||
***************************************************************************/
|
||||
|
||||
#ifndef QGSCOLORWIDGETS_H
|
||||
#define QGSCOLORWIDGETS_H
|
||||
|
||||
#include <QWidget>
|
||||
|
||||
class QColor;
|
||||
class QSpinBox;
|
||||
class QLineEdit;
|
||||
class QToolButton;
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorWidget
|
||||
* A base class for interactive color widgets. Widgets can either allow setting a single component of
|
||||
* a color (eg the red or green components), or an entire color. The QgsColorWidget also keeps track of
|
||||
* any explicitely set hue for the color, so that this information is not lost when the widget is
|
||||
* set to a color with an ambiguous hue (eg black or white shades).
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class GUI_EXPORT QgsColorWidget : public QWidget
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
|
||||
/*! Specifies the color component which the widget alters
|
||||
*/
|
||||
enum ColorComponent
|
||||
{
|
||||
Multiple = 0, /*!< widget alters multiple color components */
|
||||
Red, /*!< red component of color */
|
||||
Green, /*!< green component of color */
|
||||
Blue, /*!< blue component of color */
|
||||
Hue, /*!< hue component of color (based on HSV model) */
|
||||
Saturation, /*!< saturation component of color (based on HSV model) */
|
||||
Value, /*!< value component of color (based on HSV model) */
|
||||
Alpha /*!< alpha component (opacity) of color */
|
||||
};
|
||||
|
||||
/**Construct a new color widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
* @param component color component the widget alters
|
||||
*/
|
||||
QgsColorWidget( QWidget* parent = 0, const ColorComponent component = Multiple );
|
||||
|
||||
virtual ~QgsColorWidget();
|
||||
|
||||
/**Returns the current color for the widget
|
||||
* @returns current widget color
|
||||
* @see setColor
|
||||
*/
|
||||
QColor color() const;
|
||||
|
||||
/**Returns the color component which the widget controls
|
||||
* @returns color component for widget
|
||||
* @see setComponent
|
||||
*/
|
||||
ColorComponent component() const { return mComponent; }
|
||||
|
||||
/**Returns the current value of the widget's color component
|
||||
* @returns value of color component, or -1 if widget has multiple components or an invalid color
|
||||
* set
|
||||
* @see setComponentValue
|
||||
* @see component
|
||||
*/
|
||||
int componentValue() const;
|
||||
|
||||
public slots:
|
||||
|
||||
/**Sets the color for the widget
|
||||
* @param color widget color
|
||||
* @see color
|
||||
*/
|
||||
virtual void setColor( const QColor color );
|
||||
|
||||
/**Sets the color component which the widget controls
|
||||
* @param component color component for widget
|
||||
* @see component
|
||||
*/
|
||||
virtual void setComponent( const ColorComponent component );
|
||||
|
||||
/**Alters the widget's color by setting the value for the widget's color component
|
||||
* @param value value for widget's color component. This value is automatically
|
||||
* clipped to the range of valid values for the color component.
|
||||
* @see componentValue
|
||||
* @see setComponent
|
||||
* @note this method has no effect if the widget is set to the QgsColorWidget::Multiple
|
||||
* component
|
||||
*/
|
||||
virtual void setComponentValue( const int value );
|
||||
|
||||
signals:
|
||||
|
||||
/**Emitted when the widget's color changes
|
||||
* @param color new widget color
|
||||
*/
|
||||
void colorChanged( const QColor color );
|
||||
|
||||
protected:
|
||||
|
||||
QColor mCurrentColor;
|
||||
|
||||
ColorComponent mComponent;
|
||||
|
||||
/**QColor wipes the hue information when it is ambiguous (eg, for saturation = 0). So
|
||||
* the hue is stored in mExplicit hue to keep it around, as it is useful when modifying colors
|
||||
*/
|
||||
int mExplicitHue;
|
||||
|
||||
/**Returns the range of valid values for the color widget's component
|
||||
* @returns maximum value allowed for color component, or -1 if widget has multiple components
|
||||
*/
|
||||
int componentRange() const;
|
||||
|
||||
/**Returns the range of valid values a color component
|
||||
* @returns maximum value allowed for color component
|
||||
*/
|
||||
int componentRange( const ColorComponent component ) const;
|
||||
|
||||
/**Returns the value of a component of the widget's current color. This method correctly
|
||||
* handles hue values when the color has an ambiguous hue (eg black or white shades)
|
||||
* @param component color component to return
|
||||
* @returns value of color component, or -1 if widget has an invalid color set
|
||||
* @see hue
|
||||
*/
|
||||
int componentValue( const ColorComponent component ) const;
|
||||
|
||||
/**Returns the hue for the widget. This may differ from the hue for the QColor returned by color(),
|
||||
* as QColor returns a hue of -1 if the color's hue is ambiguous (eg, if the saturation is zero).
|
||||
* @returns explicitly set hue for widget
|
||||
*/
|
||||
int hue() const;
|
||||
|
||||
/**Alters a color by modifiying the value of a specific color component
|
||||
* @param color color to alter
|
||||
* @param component color component to alter
|
||||
* @param newValue new value of color component. Values are automatically clipped to a
|
||||
* valid range for the color component.
|
||||
*/
|
||||
void alterColor( QColor& color, const QgsColorWidget::ColorComponent component, const int newValue ) const;
|
||||
|
||||
/**Generates a checkboard pattern pixmap for use as a background to transparent colors
|
||||
* @returns checkerboard pixmap
|
||||
*/
|
||||
static const QPixmap& transparentBackground();
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorWheel
|
||||
* A color wheel widget. This widget consists of an outer ring which allows for hue selection, and an
|
||||
* inner rotating triangle which allows for saturation and value selection.
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class GUI_EXPORT QgsColorWheel : public QgsColorWidget
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
|
||||
/**Constructs a new color wheel widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
*/
|
||||
QgsColorWheel( QWidget* parent = 0 );
|
||||
|
||||
virtual ~QgsColorWheel();
|
||||
|
||||
void paintEvent( QPaintEvent* event );
|
||||
|
||||
public slots:
|
||||
|
||||
virtual void setColor( const QColor color );
|
||||
|
||||
protected:
|
||||
|
||||
virtual void resizeEvent( QResizeEvent *event );
|
||||
virtual void mouseMoveEvent( QMouseEvent *event );
|
||||
virtual void mousePressEvent( QMouseEvent *event );
|
||||
virtual void mouseReleaseEvent( QMouseEvent *event );
|
||||
|
||||
private:
|
||||
|
||||
enum ControlPart
|
||||
{
|
||||
None,
|
||||
Wheel,
|
||||
Triangle
|
||||
};
|
||||
|
||||
/*Margin between outer ring and edge of widget*/
|
||||
int mMargin;
|
||||
|
||||
/*Thickness of hue ring in pixels*/
|
||||
int mWheelThickness;
|
||||
|
||||
/*Part of the wheel where the mouse was originally depressed*/
|
||||
ControlPart mClickedPart;
|
||||
|
||||
/*Cached image of hue wheel*/
|
||||
QImage* mWheelImage;
|
||||
|
||||
/*Cached image of inner triangle*/
|
||||
QImage* mTriangleImage;
|
||||
|
||||
/*Resuable, temporary image for drawing widget*/
|
||||
QImage* mWidgetImage;
|
||||
|
||||
/*Whether the color wheel image requires redrawing*/
|
||||
bool mWheelDirty;
|
||||
|
||||
/*Whether the inner triangle image requires redrawing*/
|
||||
bool mTriangleDirty;
|
||||
|
||||
/*Conical gradient brush used for drawing hue wheel*/
|
||||
QBrush mWheelBrush;
|
||||
|
||||
/**Creates cache images for specified widget size
|
||||
* @param size widget size for images
|
||||
*/
|
||||
void createImages( const QSizeF size );
|
||||
|
||||
/**Creates the hue wheel image*/
|
||||
void createWheel();
|
||||
|
||||
/**Creates the inner triangle image*/
|
||||
void createTriangle();
|
||||
|
||||
/**Sets the widget color based on a point in the widget
|
||||
* @param pos position for color
|
||||
*/
|
||||
void setColorFromPos( const QPointF pos );
|
||||
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorBox
|
||||
* A color box widget. This widget consists of a two dimensional rectangle filled with color
|
||||
* variations, where a different color component varies along both the horizontal and vertical
|
||||
* axis.
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class GUI_EXPORT QgsColorBox : public QgsColorWidget
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
|
||||
/**Construct a new color box widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
* @param component constant color component for the widget. The color components
|
||||
* which vary along the horizontal and vertical axis are automatically assigned
|
||||
* based on this constant color component.
|
||||
*/
|
||||
QgsColorBox( QWidget* parent = 0, const ColorComponent component = Value );
|
||||
|
||||
virtual ~QgsColorBox();
|
||||
|
||||
virtual QSize sizeHint() const;
|
||||
void paintEvent( QPaintEvent* event );
|
||||
|
||||
virtual void setComponent( const ColorComponent component );
|
||||
|
||||
public slots:
|
||||
|
||||
virtual void setColor( const QColor color );
|
||||
|
||||
protected:
|
||||
|
||||
virtual void resizeEvent( QResizeEvent *event );
|
||||
virtual void mouseMoveEvent( QMouseEvent *event );
|
||||
virtual void mousePressEvent( QMouseEvent *event );
|
||||
|
||||
private:
|
||||
|
||||
/*Margin between outer ring and edge of widget*/
|
||||
int mMargin;
|
||||
|
||||
/*Cached image for color box*/
|
||||
QImage* mBoxImage;
|
||||
|
||||
/*Whether the cached image requires redrawing*/
|
||||
bool mDirty;
|
||||
|
||||
/**Creates the color box background cached image
|
||||
*/
|
||||
void createBox();
|
||||
|
||||
/**Returns the range of permissible values along the x axis
|
||||
* @returns maximum color component value for x axis
|
||||
*/
|
||||
int valueRangeX() const;
|
||||
|
||||
/**Returns the range of permissible values along the y axis
|
||||
* @returns maximum color component value for y axis
|
||||
*/
|
||||
int valueRangeY() const;
|
||||
|
||||
/**Returns the color component which varies along the y axis
|
||||
*/
|
||||
QgsColorWidget::ColorComponent yComponent() const;
|
||||
|
||||
/**Returns the value of the color component which varies along the y axis
|
||||
*/
|
||||
int yComponentValue() const;
|
||||
|
||||
/**Returns the color component which varies along the x axis
|
||||
*/
|
||||
QgsColorWidget::ColorComponent xComponent() const;
|
||||
|
||||
/**Returns the value of the color component which varies along the x axis
|
||||
*/
|
||||
int xComponentValue() const;
|
||||
|
||||
/**Updates the widget's color based on a point within the widget
|
||||
* @param point point within the widget
|
||||
*/
|
||||
void setColorFromPoint( const QPoint& point );
|
||||
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorRampWidget
|
||||
* A color ramp widget. This widget consists of an interactive box filled with a color which varies along
|
||||
* its length by a single color component (eg, varying saturation from 0 to 100%).
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class GUI_EXPORT QgsColorRampWidget : public QgsColorWidget
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
|
||||
/*! Specifies the orientation of a color ramp
|
||||
*/
|
||||
enum Orientation
|
||||
{
|
||||
Horizontal = 0, /*!< horizontal ramp */
|
||||
Vertical /*!< vertical ramp */
|
||||
};
|
||||
|
||||
/**Construct a new color ramp widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
* @param component color component which varies along the ramp
|
||||
* @param orientation orientation for widget
|
||||
*/
|
||||
QgsColorRampWidget( QWidget* parent = 0,
|
||||
const ColorComponent component = QgsColorWidget::Red,
|
||||
const Orientation orientation = QgsColorRampWidget::Horizontal );
|
||||
|
||||
virtual ~QgsColorRampWidget();
|
||||
|
||||
virtual QSize sizeHint() const;
|
||||
void paintEvent( QPaintEvent* event );
|
||||
|
||||
/**Sets the orientation for the color ramp
|
||||
* @param orientation new orientation for the ramp
|
||||
* @see orientation
|
||||
*/
|
||||
void setOrientation( const Orientation orientation );
|
||||
|
||||
/**Fetches the orientation for the color ramp
|
||||
* @returns orientation for the ramp
|
||||
* @see setOrientation
|
||||
*/
|
||||
Orientation orientation() const { return mOrientation; }
|
||||
|
||||
/**Sets the margin between the edge of the widget and the ramp
|
||||
* @param margin margin around the ramp
|
||||
* @see interiorMargin
|
||||
*/
|
||||
void setInteriorMargin( const int margin );
|
||||
|
||||
/**Fetches the margin between the edge of the widget and the ramp
|
||||
* @returns margin around the ramp
|
||||
* @see setInteriorMargin
|
||||
*/
|
||||
int interiorMargin() const { return mMargin; }
|
||||
|
||||
/**Sets whether the ramp should be drawn within a frame
|
||||
* @param showFrame set to true to draw a frame around the ramp
|
||||
* @see showFrame
|
||||
*/
|
||||
void setShowFrame( const bool showFrame );
|
||||
|
||||
/**Fetches whether the ramp is drawn within a frame
|
||||
* @returns true if a frame is drawn around the ramp
|
||||
* @see setShowFrame
|
||||
*/
|
||||
bool showFrame() const { return mShowFrame; }
|
||||
|
||||
/**Sets the size for drawing the triangular markers on the ramp
|
||||
* @param markerSize marker size in pixels
|
||||
*/
|
||||
void setMarkerSize( const int markerSize );
|
||||
|
||||
signals:
|
||||
|
||||
/**Emitted when the widget's color component value changes
|
||||
* @param value new value of color component
|
||||
*/
|
||||
void valueChanged( const int value );
|
||||
|
||||
protected:
|
||||
|
||||
virtual void mouseMoveEvent( QMouseEvent *event );
|
||||
virtual void mousePressEvent( QMouseEvent *event );
|
||||
virtual void keyPressEvent( QKeyEvent * event );
|
||||
|
||||
private:
|
||||
|
||||
/*Orientation for ramp*/
|
||||
Orientation mOrientation;
|
||||
|
||||
/*Margin around ramp*/
|
||||
int mMargin;
|
||||
|
||||
/*Whether to draw a frame around the ramp*/
|
||||
bool mShowFrame;
|
||||
|
||||
/*Polygon for upper triangle marker*/
|
||||
QPolygonF mTopTriangle;
|
||||
|
||||
/*Polygon for lower triangle marker*/
|
||||
QPolygonF mBottomTriangle;
|
||||
|
||||
/**Updates the widget's color based on a point within the widget
|
||||
* @param point point within the widget
|
||||
*/
|
||||
void setColorFromPoint( const QPointF &point );
|
||||
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorSliderWidget
|
||||
* A composite horizontal color ramp widget and associated spinbox for manual value entry.
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class GUI_EXPORT QgsColorSliderWidget : public QgsColorWidget
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
|
||||
/**Construct a new color slider widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
* @param component color component which is controlled by the slider
|
||||
*/
|
||||
QgsColorSliderWidget( QWidget* parent = 0, const ColorComponent component = QgsColorWidget::Red );
|
||||
|
||||
virtual ~QgsColorSliderWidget();
|
||||
|
||||
virtual void setComponent( const ColorComponent component );
|
||||
virtual void setComponentValue( const int value );
|
||||
virtual void setColor( const QColor color );
|
||||
|
||||
private:
|
||||
|
||||
/*Color ramp widget*/
|
||||
QgsColorRampWidget* mRampWidget;
|
||||
|
||||
/*Spin box widget*/
|
||||
QSpinBox* mSpinBox;
|
||||
|
||||
/**Converts the real value of a color component to a friendly display value. For instance,
|
||||
* alpha values from 0-255 have little meaning to users, so we translate them to 0-100%
|
||||
* @param realValue actual value of the color component
|
||||
* @returns display value of color component
|
||||
* @see convertDisplayToReal
|
||||
*/
|
||||
int convertRealToDisplay( const int realValue ) const;
|
||||
|
||||
/**Converts the display value of a color component to a real value.
|
||||
* @param displayValue friendly display value of the color component
|
||||
* @returns real value of color component
|
||||
* @see convertRealToDisplay
|
||||
*/
|
||||
int convertDisplayToReal( const int displayValue ) const;
|
||||
|
||||
private slots:
|
||||
|
||||
/**Called when the color for the ramp changes
|
||||
*/
|
||||
void rampColorChanged( const QColor color );
|
||||
|
||||
/**Called when the value of the spin box changes
|
||||
*/
|
||||
void spinChanged( int value );
|
||||
|
||||
/**Called when the value for the ramp changes
|
||||
*/
|
||||
void rampChanged( int value );
|
||||
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorTextWidget
|
||||
* A line edit widget which displays colors as text and accepts string representations
|
||||
* of colors.
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class GUI_EXPORT QgsColorTextWidget : public QgsColorWidget
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
|
||||
/**Construct a new color line edit widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
*/
|
||||
QgsColorTextWidget( QWidget* parent = 0 );
|
||||
|
||||
virtual ~QgsColorTextWidget();
|
||||
|
||||
virtual void setColor( const QColor color );
|
||||
|
||||
protected:
|
||||
void resizeEvent( QResizeEvent * event );
|
||||
|
||||
private:
|
||||
|
||||
/*! Specifies the display format for a color
|
||||
*/
|
||||
enum ColorTextFormat
|
||||
{
|
||||
HexRgb = 0, /*!< #RRGGBB in hexadecimal */
|
||||
HexRgbA, /*!< #RRGGBBAA in hexadecimal, with alpha */
|
||||
Rgb, /*!< rgb( r, g, b ) format */
|
||||
Rgba /*!< rgba( r, g, b, a ) format, with alpha */
|
||||
};
|
||||
|
||||
QLineEdit* mLineEdit;
|
||||
|
||||
/*Dropdown menu button*/
|
||||
QToolButton* mMenuButton;
|
||||
|
||||
/*Display format for colors*/
|
||||
ColorTextFormat mFormat;
|
||||
|
||||
/**Updates the text based on the current color
|
||||
*/
|
||||
void updateText();
|
||||
|
||||
private slots:
|
||||
|
||||
/**Called when the user enters text into the widget
|
||||
*/
|
||||
void textChanged();
|
||||
|
||||
/**Called when the dropdown arrow is clicked to show the format selection menu
|
||||
*/
|
||||
void showMenu();
|
||||
};
|
||||
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsColorPreviewWidget
|
||||
* A preview box which displays one or two colors as swatches.
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
class GUI_EXPORT QgsColorPreviewWidget : public QgsColorWidget
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
|
||||
/**Construct a new color preview widget.
|
||||
* @param parent parent QWidget for the widget
|
||||
*/
|
||||
QgsColorPreviewWidget( QWidget* parent = 0 );
|
||||
|
||||
virtual ~QgsColorPreviewWidget();
|
||||
|
||||
void paintEvent( QPaintEvent* event );
|
||||
|
||||
/**Returns the secondary color for the widget
|
||||
* @returns secondary widget color, or an invalid color if the widget
|
||||
* has no secondary color
|
||||
* @see color
|
||||
* @see setColor2
|
||||
*/
|
||||
QColor color2() const { return mColor2; }
|
||||
|
||||
public slots:
|
||||
|
||||
/**Sets the second color for the widget
|
||||
* @param color secondary widget color. Set to an invalid color to prevent
|
||||
* drawing of a secondary color
|
||||
* @see setColor
|
||||
* @see color2
|
||||
*/
|
||||
virtual void setColor2( const QColor& color );
|
||||
|
||||
private:
|
||||
|
||||
/*Secondary color for widget*/
|
||||
QColor mColor2;
|
||||
|
||||
/*Draws a color preview within the specified rect.
|
||||
* @param color color to draw
|
||||
* @param rect rect to draw color in
|
||||
* @param painter destination painter
|
||||
*/
|
||||
void drawColor( const QColor& color, const QRect& rect, QPainter &painter );
|
||||
};
|
||||
|
||||
#endif // #ifndef QGSCOLORWIDGETS_H
|
||||
Loading…
x
Reference in New Issue
Block a user