File: color_names.hpp

package info (click to toggle)
qt-color-widgets 3.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,088 kB
  • sloc: cpp: 7,426; sh: 236; makefile: 14
file content (42 lines) | stat: -rw-r--r-- 1,051 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/*
 * SPDX-FileCopyrightText: 2013-2020 Mattia Basaglia
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later
 */

#ifndef COLOR_WIDGETS_COLOR_NAMES_HPP
#define COLOR_WIDGETS_COLOR_NAMES_HPP

#include <QColor>
#include <QString>

#include <QtColorWidgets/colorwidgets_global.hpp>

namespace color_widgets {

/**
 * \brief Convert a string into a color
 *
 * Supported string formats:
 *  * Short hex strings #f00
 *  * Long hex strings  #ff0000
 *  * Color names       red
 *  * Function-like     rgb(255,0,0)
 *
 * Additional string formats supported only when \p alpha is true:
 *  * Long hex strings  #ff0000ff
 *  * Function like     rgba(255,0,0,255)
 */
QCP_EXPORT QColor colorFromString(const QString& string, bool alpha = true);

/**
 * \brief Convert a color into a string
 *
 * Format:
 *  * If the color has full alpha: #ff0000
 *  * If alpha is true and the color has non-full alpha: #ff000088
 */
QCP_EXPORT QString stringFromColor(const QColor& color, bool alpha = true);

} // namespace color_widgets
#endif // COLOR_WIDGETS_COLOR_NAMES_HPP