KChartEnums

#include <KChartEnums.h>

Inheritance diagram for KChartEnums:

Public Types

enum  GranularitySequence {
  GranularitySequence_10_20, GranularitySequence_10_50, GranularitySequence_25_50, GranularitySequence_125_25,
  GranularitySequenceIrregular
}
 
enum  MeasureCalculationMode {
  MeasureCalculationModeAbsolute, MeasureCalculationModeRelative, MeasureCalculationModeAuto, MeasureCalculationModeAutoArea,
  MeasureCalculationModeAutoOrientation
}
 
enum  MeasureOrientation {
  MeasureOrientationAuto, MeasureOrientationHorizontal, MeasureOrientationVertical, MeasureOrientationMinimum,
  MeasureOrientationMaximum
}
 
enum  PositionValue {
  PositionUnknown = 0, PositionCenter = 1, PositionNorthWest = 2, PositionNorth = 3,
  PositionNorthEast = 4, PositionEast = 5, PositionSouthEast = 6, PositionSouth = 7,
  PositionSouthWest = 8, PositionWest = 9, PositionFloating =10
}
 
enum  TextLayoutPolicy {
  LayoutJustOverwrite, LayoutPolicyRotate, LayoutPolicyShiftVertically, LayoutPolicyShiftHorizontally,
  LayoutPolicyShrinkFontSize
}
 

Static Public Member Functions

static QString granularitySequenceToString (GranularitySequence sequence)
 
static QString layoutPolicyToString (TextLayoutPolicy type)
 
static QString measureCalculationModeToString (MeasureCalculationMode mode)
 
static QString measureOrientationToString (MeasureOrientation mode)
 
static GranularitySequence stringToGranularitySequence (const QString &string)
 
static TextLayoutPolicy stringToLayoutPolicy (const QString &string)
 
static MeasureCalculationMode stringToMeasureCalculationMode (const QString &string)
 
static MeasureOrientation stringToMeasureOrientation (const QString &string)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Project global class providing some enums needed both by KChartParams and by KChartCustomBox.

Definition at line 37 of file KChartEnums.h.

Member Enumeration Documentation

GranularitySequence specifies the values, that may be applied, to determine a step width within a given data range.

Note
Granularity with can be set for Linear axis calculation mode only, there is no way to specify a step width for Logarithmic axes.

Value occurring in the GranularitySequence names only are showing their respective relation ship. For real data they will most times not be used directly, but be multiplied by positive (or negative, resp.) powers of ten.

A granularity sequence is a sequence of values from the following set: 1, 1.25, 2, 2.5, 5.

The reason for using one of the following three pre-defined granularity sequences (instead of just using the best matching step width) is to follow a simple rule: If scaling becomes finer (== smaller step width) no value, that has been on a grid line before, shall loose its line and be NOT on a grid line anymore!

This means: Smaller step width may not remove any grid lines, but it may add additional lines in between.

  • GranularitySequence_10_20 Step widths can be 1, or 2, but they never can be 2.5 nor 5, nor 1.25.
  • GranularitySequence_10_50 Step widths can be 1, or 5, but they never can be 2, nor 2.5, nor 1.25.
  • GranularitySequence_25_50 Step widths can be 2.5, or 5, but they never can be 1, nor 2, nor 1.25.
  • GranularitySequence_125_25 Step widths can be 1.25 or 2.5 but they never can be 1, nor 2, nor 5.
  • GranularitySequenceIrregular Step widths can be all of these values: 1, or 1.25, or 2, or 2.5, or 5.
Note
When ever possible, try to avoid using GranularitySequenceIrregular! Allowing all possible step values, using this granularity sequence involves a serious risk: Your users might be irritated due to 'jumping' grid lines, when step size is changed from 2.5 to 2 (or vice versa, resp.). In case you still want to use GranularitySequenceIrregular just make sure to NOT draw any sub-grid lines, because in most cases you will get not-matching step widths for the sub-grid. In short: GranularitySequenceIrregular can safely be used if your data range is not changing at all AND (b) you will not allow the coordinate plane to be zoomed AND (c) you are not displaying any sub-grid lines.

Since you probably like having the value 1 as an allowed step width, the granularity sequence decision boils down to a boolean question:

  • To get ten divided by five you use GranularitySequence_10_20, while
  • for having it divided by two GranularitySequence_10_50 is your choice.

Definition at line 92 of file KChartEnums.h.

Measure calculation mode: the way how the absolute value of a KChart::Measure is determined during KChart's internal geometry calculation time.

KChart::Measure values either are relative (calculated in relation to a given AbstractArea), or they are absolute (used as fixed values).

Values stored in relative measure always are interpreted as per-mille of a reference area's height (or width, resp.) depending on the orientation set for the KChart::Measure.

  • MeasureCalculationModeAbsolute Value set by setValue() is absolute, to be used unchanged.
  • MeasureCalculationModeRelative Value is relative, the reference area is specified by setReferenceArea(), and orientation specified by setOrientation().
  • MeasureCalculationModeAuto Value is relative, KChart will automatically determine which reference area to use, and it will determine the orientation too.
  • MeasureCalculationModeAutoArea Value is relative, Orientation is specified by setOrientation(), and KChart will automatically determine which reference area to use.
  • MeasureCalculationModeAutoOrientation Value is relative, Area is specified by setReferenceArea(), and KChart will automatically determine which orientation to use.
See also
KChart::Measure::setCalculationMode

Definition at line 219 of file KChartEnums.h.

Measure orientation mode: the way how the absolute value of a KChart::Measure is determined during KChart's internal geometry calculation time.

KChart::Measure values either are relative (calculated in relation to a given AbstractArea), or they are absolute (used as fixed values).

Values stored in relative measure take into account the width (and/or the height, resp.) of a so-called reference area, that is either specified by KChart::Measure::setReferenceArea, or determined by KChart automatically, respectively.

  • MeasureOrientationAuto Value is calculated, based upon the width (or on the height, resp.) of the reference area: KChart will automatically determie an appropriate way.
  • MeasureOrientationHorizontal Value is calculated, based upon the width of the reference area.
  • MeasureOrientationVertical Value is calculated, based upon the height of the reference area.
  • MeasureOrientationMinimum Value is calculated, based upon the width (or on the height, resp.) of the reference area - which ever is smaller.
  • MeasureOrientationMaximum Value is calculated, based upon the width (or on the height, resp.) of the reference area - which ever is smaller.
See also
KChart::Measure::setOrientationMode

Definition at line 287 of file KChartEnums.h.

Numerical values of the static KChart::Position instances, for using a Position::value() with a switch () statement.

See also
Position

Definition at line 189 of file KChartEnums.h.

Text layout policy: what to do if text that is to be drawn would cover neighboring text or neighboring areas.

  • LayoutJustOverwrite Just ignore the layout collision and write the text nevertheless.
  • LayoutPolicyRotate Try counter-clockwise rotation to make the text fit into the space.
  • LayoutPolicyShiftVertically Shift the text baseline upwards (or downwards, resp.) and draw a connector line between the text and its anchor.
  • LayoutPolicyShiftHorizontally Shift the text baseline to the left (or to the right, resp.) and draw a connector line between the text and its anchor.
  • LayoutPolicyShrinkFontSize Reduce the text font size.
See also
KChartParams::setPrintDataValues

Definition at line 158 of file KChartEnums.h.

Member Function Documentation

static QString KChartEnums::granularitySequenceToString ( GranularitySequence  sequence)
inlinestatic

Converts the specified granularity sequence enum to a string representation.

Parameters
sequencethe granularity sequence enum to convert
Returns
the string representation of the granularity sequence

Definition at line 106 of file KChartEnums.h.

static QString KChartEnums::layoutPolicyToString ( TextLayoutPolicy  type)
static

Converts the specified text layout policy enum to a string representation.

Parameters
typethe text layout policy to convert
Returns
the string representation of the text layout policy enum
static QString KChartEnums::measureCalculationModeToString ( MeasureCalculationMode  mode)
inlinestatic

Converts the specified measure calculation mode enum to a string representation.

Parameters
modethe measure calculation mode to convert
Returns
the string representation of the Measure calculation mode enum

Definition at line 232 of file KChartEnums.h.

static QString KChartEnums::measureOrientationToString ( MeasureOrientation  mode)
inlinestatic

Converts the specified measure orientation enum to a string representation.

Parameters
modethe measure orientation to convert
Returns
the string representation of the measure orientation enum

Definition at line 300 of file KChartEnums.h.

static GranularitySequence KChartEnums::stringToGranularitySequence ( const QString string)
inlinestatic

Converts the specified string to a granularity sequence enum value.

Parameters
stringthe string to convert
Returns
the granularity sequence enum value

Definition at line 130 of file KChartEnums.h.

static TextLayoutPolicy KChartEnums::stringToLayoutPolicy ( const QString string)
static

Converts the specified string to a text layout policy enum value.

Parameters
stringthe string to convert
Returns
the text layout policy enum value
static MeasureCalculationMode KChartEnums::stringToMeasureCalculationMode ( const QString string)
inlinestatic

Converts the specified string to a measure calculation mode enum value.

Parameters
stringthe string to convert
Returns
the measure calculation mode enum value

Definition at line 256 of file KChartEnums.h.

static MeasureOrientation KChartEnums::stringToMeasureOrientation ( const QString string)
inlinestatic

Converts the specified string to a measure orientation enum value.

Parameters
stringthe string to convert
Returns
the measure orientation enum value

Definition at line 324 of file KChartEnums.h.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Sep 29 2020 22:42:42 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.