mirror of
https://github.com/jkriege2/JKQtPlotter.git
synced 2024-12-25 18:11:38 +08:00
103 lines
4.6 KiB
C++
103 lines
4.6 KiB
C++
/*
|
|
Copyright (c) 2008-2019 Jan W. Krieger (<jan@jkrieger.de>, <j.krieger@dkfz.de>)
|
|
|
|
|
|
|
|
This software is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Lesser General Public License as published by
|
|
the Free Software Foundation, either version 2.1 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef JKQTPSTYLE_H
|
|
#define JKQTPSTYLE_H
|
|
|
|
#include "jkqtcommon/jkqtptools.h"
|
|
#include "jkqtcommon/jkqtp_imexport.h"
|
|
#include <QColor>
|
|
#include <QString>
|
|
#include <QSettings>
|
|
|
|
class JKQTBasePlotterStyle; // forward
|
|
|
|
/** \brief Support Class for JKQTBasePlotter, which summarizes all proeprties that define the visual styling of the key in a JKQTBasePlotter
|
|
* \ingroup jkqtpplotter_styling
|
|
*
|
|
* \see JKQTBasePlotter, JKQTBasePlotterStyle, \ref jkqtpplotter_styling
|
|
*/
|
|
class JKQTP_LIB_EXPORT JKQTPKeyStyle {
|
|
Q_GADGET
|
|
public:
|
|
JKQTPKeyStyle();
|
|
JKQTPKeyStyle(const JKQTBasePlotterStyle& baseStyle);
|
|
|
|
|
|
/** \brief loads the plot properties from a <a href="http://doc.qt.io/qt-5/qsettings.html")">QSettings</a> object
|
|
*
|
|
* \param settings QSettings-object to read from
|
|
* \param group Group in the QSettings-object to read from
|
|
* \param defaultStyle If a setting cannot be found in \a settings, default values are taken from this object
|
|
* By default, this is a default-constructed object
|
|
*/
|
|
void loadSettings(const QSettings &settings, const QString& group=QString("plots/key/"), const JKQTPKeyStyle &defaultStyle=JKQTPKeyStyle());
|
|
|
|
/** \brief saves the plot properties into a <a href="http://doc.qt.io/qt-5/qsettings.html")">QSettings</a> object.
|
|
*
|
|
* \param settings QSettings-object to save to
|
|
* \param group Group in the QSettings-object to save to
|
|
*/
|
|
void saveSettings(QSettings& settings, const QString& group=QString("plots/key/")) const;
|
|
|
|
|
|
/** \brief indicates whether to plot a frame around the key */
|
|
bool frameVisible;
|
|
/** \brief color of the key frame line */
|
|
QColor frameColor;
|
|
/** \brief width of the key frame line [pt] */
|
|
double frameWidth;
|
|
/** \brief rounding radius of the key frame rectangle (<=0 -> no rounded rectangle) [pt] */
|
|
double frameRounding;
|
|
/** \brief color of the key background */
|
|
QBrush backgroundBrush;
|
|
/** \brief indicates whether to plot a key */
|
|
bool visible;
|
|
/** \brief font size for key labels [in points] */
|
|
double fontSize;
|
|
/** \brief color of the key entries' text */
|
|
QColor textColor;
|
|
/** \brief width of a key item in pt [in units of width of 'X' set in font, fontSize] */
|
|
double itemWidth;
|
|
/** \brief height of a key item in pt [in units of height of font, fontSize] */
|
|
double itemHeight;
|
|
/** \brief length of the line samples in the key in pt [in units of width of 'X' set in font, fontSize] */
|
|
double sampleLineLength;
|
|
/** \brief x-distance between key frame and key content [in units of width of 'X' set in font, fontSize] */
|
|
double xMargin;
|
|
/** \brief y-distance between key frame and key content [in units of width of 'x' set in font, fontSize] */
|
|
double yMargin;
|
|
/** \brief x-offset of the key from the border of the plot [in units of width of 'X' set in font, fontSize] */
|
|
double xOffset;
|
|
/** \brief y-offset of the key from the border of the plot [in units of width of 'x' set in font, fontSize] */
|
|
double yOffset;
|
|
/** \brief distance between key line example and key text [in units of width of 'X' set in font, fontSize] */
|
|
double xSeparation;
|
|
/** \brief distance between two key entries [in units of height of font, fontSize] */
|
|
double ySeparation;
|
|
/** \brief key position */
|
|
JKQTPKeyPosition position;
|
|
/** \brief the key layout */
|
|
JKQTPKeyLayout layout;
|
|
/** \brief determine width of the key automatically */
|
|
bool autosize;
|
|
};
|
|
|
|
#endif // JKQTPSTYLE_H
|