JKQTPlotter
an extensive Qt4/Qt5 Plotter framework (including a fast variant and a LaTeX equation renderer!), written fully in C/C++ and without external dependencies

Support Class for JKQTBasePlotter, which summarizes all proeprties that define the visual styling of the key in a JKQTBasePlotter. More...

#include <jkqtpkeystyle.h>

Public Member Functions

 JKQTPKeyStyle ()
 
 JKQTPKeyStyle (const JKQTBasePlotterStyle &baseStyle)
 
void loadSettings (const QSettings &settings, const QString &group=QString("plots/key/"), const JKQTPKeyStyle &defaultStyle=JKQTPKeyStyle())
 loads the plot properties from a <a href="http://doc.qt.io/qt-5/qsettings.html")">QSettings object More...
 
void saveSettings (QSettings &settings, const QString &group=QString("plots/key/")) const
 saves the plot properties into a <a href="http://doc.qt.io/qt-5/qsettings.html")">QSettings object. More...
 

Public Attributes

bool autosize
 determine width of the key automatically More...
 
QBrush backgroundBrush
 color of the key background More...
 
double fontSize
 font size for key labels [in points] More...
 
QColor frameColor
 color of the key frame line More...
 
double frameRounding
 rounding radius of the key frame rectangle (<=0 -> no rounded rectangle) [pt] More...
 
bool frameVisible
 indicates whether to plot a frame around the key More...
 
double frameWidth
 width of the key frame line [pt] More...
 
double itemHeight
 height of a key item in pt [in units of height of font, fontSize] More...
 
double itemWidth
 width of a key item in pt [in units of width of 'X' set in font, fontSize] More...
 
JKQTPKeyLayout layout
 the key layout More...
 
JKQTPKeyPosition position
 key position More...
 
double sampleLineLength
 length of the line samples in the key in pt [in units of width of 'X' set in font, fontSize] More...
 
QColor textColor
 color of the key entries' text More...
 
bool visible
 indicates whether to plot a key More...
 
double xMargin
 x-distance between key frame and key content [in units of width of 'X' set in font, fontSize] More...
 
double xOffset
 x-offset of the key from the border of the plot [in units of width of 'X' set in font, fontSize] More...
 
double xSeparation
 distance between key line example and key text [in units of width of 'X' set in font, fontSize] More...
 
double yMargin
 y-distance between key frame and key content [in units of width of 'x' set in font, fontSize] More...
 
double yOffset
 y-offset of the key from the border of the plot [in units of width of 'x' set in font, fontSize] More...
 
double ySeparation
 distance between two key entries [in units of height of font, fontSize] More...
 

Detailed Description

Support Class for JKQTBasePlotter, which summarizes all proeprties that define the visual styling of the key in a JKQTBasePlotter.

See also
JKQTBasePlotter, JKQTBasePlotterStyle, JKQTPlotter Styling System

Constructor & Destructor Documentation

◆ JKQTPKeyStyle() [1/2]

JKQTPKeyStyle::JKQTPKeyStyle ( )

◆ JKQTPKeyStyle() [2/2]

JKQTPKeyStyle::JKQTPKeyStyle ( const JKQTBasePlotterStyle baseStyle)

Member Function Documentation

◆ loadSettings()

void JKQTPKeyStyle::loadSettings ( const QSettings &  settings,
const QString &  group = QString("plots/key/"),
const JKQTPKeyStyle defaultStyle = JKQTPKeyStyle() 
)

loads the plot properties from a <a href="http://doc.qt.io/qt-5/qsettings.html")">QSettings object

Parameters
settingsQSettings-object to read from
groupGroup in the QSettings-object to read from
defaultStyleIf a setting cannot be found in settings, default values are taken from this object By default, this is a default-constructed object

◆ saveSettings()

void JKQTPKeyStyle::saveSettings ( QSettings &  settings,
const QString &  group = QString("plots/key/") 
) const

saves the plot properties into a <a href="http://doc.qt.io/qt-5/qsettings.html")">QSettings object.

Parameters
settingsQSettings-object to save to
groupGroup in the QSettings-object to save to

Member Data Documentation

◆ autosize

bool JKQTPKeyStyle::autosize

determine width of the key automatically

◆ backgroundBrush

QBrush JKQTPKeyStyle::backgroundBrush

color of the key background

◆ fontSize

double JKQTPKeyStyle::fontSize

font size for key labels [in points]

◆ frameColor

QColor JKQTPKeyStyle::frameColor

color of the key frame line

◆ frameRounding

double JKQTPKeyStyle::frameRounding

rounding radius of the key frame rectangle (<=0 -> no rounded rectangle) [pt]

◆ frameVisible

bool JKQTPKeyStyle::frameVisible

indicates whether to plot a frame around the key

◆ frameWidth

double JKQTPKeyStyle::frameWidth

width of the key frame line [pt]

◆ itemHeight

double JKQTPKeyStyle::itemHeight

height of a key item in pt [in units of height of font, fontSize]

◆ itemWidth

double JKQTPKeyStyle::itemWidth

width of a key item in pt [in units of width of 'X' set in font, fontSize]

◆ layout

JKQTPKeyLayout JKQTPKeyStyle::layout

the key layout

◆ position

JKQTPKeyPosition JKQTPKeyStyle::position

key position

◆ sampleLineLength

double JKQTPKeyStyle::sampleLineLength

length of the line samples in the key in pt [in units of width of 'X' set in font, fontSize]

◆ textColor

QColor JKQTPKeyStyle::textColor

color of the key entries' text

◆ visible

bool JKQTPKeyStyle::visible

indicates whether to plot a key

◆ xMargin

double JKQTPKeyStyle::xMargin

x-distance between key frame and key content [in units of width of 'X' set in font, fontSize]

◆ xOffset

double JKQTPKeyStyle::xOffset

x-offset of the key from the border of the plot [in units of width of 'X' set in font, fontSize]

◆ xSeparation

double JKQTPKeyStyle::xSeparation

distance between key line example and key text [in units of width of 'X' set in font, fontSize]

◆ yMargin

double JKQTPKeyStyle::yMargin

y-distance between key frame and key content [in units of width of 'x' set in font, fontSize]

◆ yOffset

double JKQTPKeyStyle::yOffset

y-offset of the key from the border of the plot [in units of width of 'x' set in font, fontSize]

◆ ySeparation

double JKQTPKeyStyle::ySeparation

distance between two key entries [in units of height of font, fontSize]


The documentation for this class was generated from the following file: