kchart
KDChartEnums Class Reference#include <KDChartEnums.h>
List of all members.
Detailed Description
Project global class providing some enums needed both by KDChartParams and by KDChartCustomBox.
Definition at line 46 of file KDChartEnums.h.
|
Public Types |
enum | TextLayoutPolicy {
LayoutJustOverwrite,
LayoutPolicyRotate,
LayoutPolicyShiftVertically,
LayoutPolicyShiftHorizontally,
LayoutPolicyShrinkFontSize
} |
enum | AreaName {
AreaUNKNOWN = 0x0000,
AreaData = 0x0001,
AreaAxes = 0x0002,
AreaDataAxes = 0x0003,
AreaLegend = 0x0004,
AreaDataAxesLegend = 0x0005,
AreaHeaders = 0x0006,
AreaFooters = 0x0007,
AreaDataAxesLegendHeadersFooters = 0x0008,
AreaInnermost = 0x0009,
AreaOutermost = 0x000a,
AreaChartDataRegion = 0x000b,
AreasCustomBoxes = 0x000d,
AreaAxisBASE = 0x1000,
AreaHdFtBASE = 0x2000,
AreaCustomBoxesBASE = 0x4000,
AreaBASEMask = 0xF000
} |
enum | PositionFlag {
PosTopLeft = 0,
PosTopCenter = 1,
PosTopRight = 2,
PosCenterLeft = 3,
PosCenter = 4,
PosCenterRight = 5,
PosBottomLeft = 6,
PosBottomCenter = 7,
PosBottomRight = 8
} |
Static Public Member Functions |
static QString | layoutPolicyToString (TextLayoutPolicy type) |
static TextLayoutPolicy | stringToLayoutPolicy (const QString &string) |
static QPoint | positionFlagToPoint (const QRect &rect, PositionFlag pos) |
static QPoint | positionFlagToPoint (const QPointArray &points, PositionFlag pos) |
static QString | positionFlagToString (PositionFlag type) |
static PositionFlag | stringToPositionFlag (const QString &string) |
Member Enumeration Documentation
|
Areas of the chart that may have their own backgrounds and/or may be surrounded by a simple or complex border.
AreaData surrounding the data area
AreaAxes surrounding the axes but leaving out the data area
AreaDataAxes surrounding the data+axes area
AreaLegend surrounding the legend area
AreaDataAxesLegend surrounding the data+axes+legend area
AreaHeaders surrounding the headers area
AreaFooters surrounding the footers area
AreaDataAxesLegendHeadersFooters surrounding the data+axes+legend+headers+footers area
AreaInnermost covering the complete drawing area but not covering the global left/top/right/bottom leading
AreaOutermost covering the complete drawing area including the global left/top/right/bottom leading
AreaChartDataRegion covering the area used to display one data entry (i.e. one point, bar, line, pie slice,...). The respective data coordinates are specified by additional parameters, this is used by KDChartCustomBox where you have the parameters dataRow , dataCol , data3rd .
In addition there is a special value specifying a list of regions:
AreasCustomBoxes specifies many small areas surrounding all the custom boxes that you might have added to the chart, this is useful in case you want to specify some default frame settings to be used for all custom boxes not having frame settings of their own.
Finally there are three special values that you may use to specify a single axis area (or a header/footer area, or a custom box area resp.). Just add the number of the axis (or header/footer, or custom box resp.) to the respective base value:
AreaAxisBASE value to be added to the axis number in case you want to specify a single axis area, e.g. for specifying the area of the left ordinate axis just type AreaAxisBASE + AxisPosLeft.
AreaHdFtBASE value to be added to the header/footer number in case you want to specify a single header (or footer, resp.) area, e.g. for specifying the area of the main header just type AreaHdFtBASE + HdFtPosHeader.
AreaCustomBoxBASE value to be added to the number of a custom box that you might have added to your chart, e.g. for specifying the area a custom box you have added to the chart (let us assume the index of that box is in boxIdx1 ) just type AreaCustBoxBASE + boxIdx1.
- See also:
- KDChartParams::setSimpleFrame, KDChartParams::setFrame
KDChartParams::insertCustomBox, KDChartCustomBox
Definition at line 161 of file KDChartEnums.h. |
|
The general position flag to specify a point of an area, for example this could be the anchor point which an annotation box should be aligned to.
The following picture shows the different positions:
- Note:
- The position and alignment of content to be printed at (or inside of, resp.) an area or a point -- like for printing data value texts next to their graphical representations (which might be a bar, line, pie slice,...) -- is specified by two parameters: a
PositionFlag and a uint holding a combination of Qt::AlignmentFlags . Remember that Qt::AlignmentFlags are used to specify with which edge something is to be aligned to its anchor, e.g. AlignLeft means align with the left edge.
The position of content and the way it is aligned to this position is shown in the following drawing, note that annotation #2 and annotation #3 share the same PositionFlag but have different alignment flags set:
- See also:
- KDChartParams::setPrintDataValues
Definition at line 206 of file KDChartEnums.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:
- KDChartParams::setPrintDataValues
Definition at line 66 of file KDChartEnums.h. |
Member Function Documentation
static QString KDChartEnums::layoutPolicyToString |
( |
TextLayoutPolicy |
type |
) |
[inline, static] |
|
|
Converts the specified text layout policy enum to a string representation.
- Parameters:
-
| type | the text layout policy to convert |
- Returns:
- the string representation of the text layout policy enum
Definition at line 79 of file KDChartEnums.h. |
static QPoint KDChartEnums::positionFlagToPoint |
( |
const QPointArray & |
points, |
|
|
PositionFlag |
pos |
|
) |
[inline, static] |
|
|
Returns the point representing a position of a corresponding QPointArray.
- Note:
- The array
points must have at least nine elements.
Definition at line 223 of file KDChartEnums.h. |
QPoint KDChartEnums::positionFlagToPoint |
( |
const QRect & |
rect, |
|
|
PositionFlag |
pos |
|
) |
[static] |
|
|
Returns the point representing a position of a rectangle.
Definition at line 54 of file KDChartEnums.cpp. |
QString KDChartEnums::positionFlagToString |
( |
PositionFlag |
type |
) |
[static] |
|
|
Converts the specified content position enum to a string representation.
- Parameters:
-
| type | the content position to convert |
- Returns:
- the string representation of the type enum
Definition at line 3 of file KDChartEnums.cpp. |
static TextLayoutPolicy KDChartEnums::stringToLayoutPolicy |
( |
const QString & |
string |
) |
[inline, static] |
|
|
Converts the specified string to a text layout policy enum value.
- Parameters:
-
| string | the string to convert |
- Returns:
- the text layout policy enum value
Definition at line 104 of file KDChartEnums.h. |
|
Converts the specified string to a content position enum value.
- Parameters:
-
| string | the string to convert |
- Returns:
- the content position enum value
Definition at line 30 of file KDChartEnums.cpp. |
The documentation for this class was generated from the following files:
|