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
21they are all in the color_widgets namespace.
22
23See [the gallery](gallery/README.md) for more information and screenshots.
24
25
26Using it in a project
27---------------------
28
29For QMake-based projects, include color_widgets.pri in the QMake project file.
30For CMake-based projects, add this as subdirectory, it will be compiled as a
31library and you can link the required targets to ColorWidgets-qt5.
32All the required files are in ./src and ./include.
33
34
35Installing as a Qt Designer/Creator Plugin
36------------------------------------------
37
38The sources for the designer plugin are in ./color_widgets_designer_plugin
39
40Compile the library and install in
41(Qt SDK)/Tools/QtCreator/bin/designer/
42(Qt SDK)/(Qt Version)/(Toolchain)/plugins/designer
43
44cd build && cmake .. && make ColorWidgetsPlugin && make install
45
46
47Latest Version
48--------------
49
50The latest version of the sources can be found at the following locations:
51
52* https://github.com/mbasaglia/Qt-Color-Widgets
53* git://github.com/mbasaglia/Qt-Color-Widgets.git
54
55
56License
57-------
58
59LGPLv3+, See COPYING.
60As a special exception, this library can be included in any project under the
61terms of any of the GNU liceses, distributing the whole project under a
62different GNU license, see LICENSE-EXCEPTION for details.
63
64Copyright (C) 2013-2017 Mattia Basaglia <mattia.basaglia@gmail.com>
65