external/Qt-Color-Widgets/README.md

0001 Color Widgets
0002 =============
0003
0004 Here is a color dialog that is more user-friendly than the default QColorDialog
0005 and several other color-related widgets
0006
0007 The provided widgets are:
0008
0009 * ColorWheel,         An analog widget used to select a color
0010 * ColorPreview,       A simple widget that displays a color
0011 * GradientSlider,     A slider that has a gradient background
0012 * HueSlider,          A variant of GradientSlider that has a rainbow background
0013 * ColorSelector,      A ColorPreview that shows a ColorDialog when clicked
0014 * ColorDialog,        A dialog that uses the above widgets to provide a better user experience than QColorDialog
0015 * ColorListWidget,    A widget to edit a list of colors
0016 * Swatch,             A widget to display a color palette
0017 * ColorPaletteWidget, A widget to use and manage a list of palettes
0018 * Color2DSlider,      An analog widget used to select 2 color components
0019 * ColorLineEdit,      A widget to manipulate a string representing a color
0020 * HarmonyColorWheel,  A ColorWheel which allows defining multiple colors, separated by hue
0021 * GradientListModel,  A QAbstractListModel used to list gradients (useful for combo boxes, list views and the like)
0022
0023 they are all in the color_widgets namespace.
0024
0025 See [the gallery](gallery/README.md) for more information and screenshots.
0026
0027
0028 Using it in a project
0029 ---------------------
0030
0031 For QMake-based projects, include color_widgets.pri in the QMake project file.
0032 For CMake-based projects, add this as subdirectory, it will be compiled as a
0033 library and you can link the required targets to ColorWidgets.
0034 All the required files are in ./src and ./include.
0035
0036
0037 Documentation
0038 -------------
0039
0040 See https://mattbas.gitlab.io/Qt-Color-Widgets/
0041
0042
0043 Installing as a Qt Designer/Creator Plugin
0044 ------------------------------------------
0045
0046 The sources for the designer plugin are in ./color_widgets_designer_plugin
0047
0048 Compile the library and install in
0049 (Qt SDK)/Tools/QtCreator/bin/designer/
0050 (Qt SDK)/(Qt Version)/(Toolchain)/plugins/designer
0051
0052     mkdir build && cd build && cmake .. && make QtColorWidgetsPlugin && make install
0053
0054
0055 Latest Version
0056 --------------
0057
0058 The latest version of the sources can be found at the following locations:
0059
0060 * https://gitlab.com/mattbas/Qt-Color-Widgets
0061 * git@gitlab.com:mattbas/Qt-Color-Widgets.git
0062
0063
0064 License
0065 -------
0066
0067 LGPLv3+, See COPYING.
0068 As a special exception, this library can be included in any project under the
0069 terms of any of the GNU liceses, distributing the whole project under a
0070 different GNU license, see LICENSE-EXCEPTION for details.
0071
0072 Copyright (C) 2013-2020 Mattia Basaglia <dev@dragon.best>