README.md
1Color Widgets
2=============
3
4Here is a color dialog that is more user-friendly than the default QColorDialog
5and several other color-related widgets
6
7The provided widgets are:
8
9* ColorWheel, An analog widget used to select a color
10* ColorPreview, A simple widget that displays a color
11* GradientSlider, A slider that has a gradient background
12* HueSlider, A variant of GradientSlider that has a rainbow background
13* ColorSelector, A ColorPreview that shows a ColorDialog when clicked
14* ColorDialog, A dialog that uses the above widgets to provide a better user experience than QColorDialog
15* ColorListWidget, A widget to edit a list of colors
16* Swatch, A widget to display a color palette
17* ColorPaletteWidget, A widget to use and manage a list of palettes
18* Color2DSlider, An analog widget used to select 2 color components
19* ColorLineEdit, A widget to manipulate a string representing a color
20* HarmonyColorWheel, A ColorWheel which allows defining multiple colors, separated by hue
21* GradientListModel, A QAbstractListModel used to list gradients (useful for combo boxes, list views and the like)
22
23they are all in the color_widgets namespace.
24
25See [the gallery](gallery/README.md) for more information and screenshots.
26
27
28Using it in a project
29---------------------
30
31For QMake-based projects, include color_widgets.pri in the QMake project file.
32For CMake-based projects, add this as subdirectory, it will be compiled as a
33library and you can link the required targets to ColorWidgets.
34All the required files are in ./src and ./include.
35
36
37Installing as a Qt Designer/Creator Plugin
38------------------------------------------
39
40The sources for the designer plugin are in ./color_widgets_designer_plugin
41
42Compile the library and install in
43(Qt SDK)/Tools/QtCreator/bin/designer/
44(Qt SDK)/(Qt Version)/(Toolchain)/plugins/designer
45
46 mkdir build && cd build && cmake .. && make QtColorWidgetsPlugin && make install
47
48
49Latest Version
50--------------
51
52The latest version of the sources can be found at the following locations:
53
54* https://gitlab.com/mattia.basaglia/Qt-Color-Widgets
55* git://gitlab.com/mattia.basaglia/Qt-Color-Widgets.git
56
57
58License
59-------
60
61LGPLv3+, See COPYING.
62As a special exception, this library can be included in any project under the
63terms of any of the GNU liceses, distributing the whole project under a
64different GNU license, see LICENSE-EXCEPTION for details.
65
66Copyright (C) 2013-2020 Mattia Basaglia <dev@dragon.best>
67