kchart
KDChartParams::KDChartFrameSettings Class Reference
#include <KDChartParams.h>
Detailed Description
Stores the frame settings for one of the chart areas:.
- frame (consisting of edges, corners, background, shadow)
- distance of frame to inner area
- distance of frame to surrounding parts of the chart
- See also:
- setSimpleFrame, setFrame, frameSettings
Definition at line 224 of file KDChartParams.h.
Public Member Functions | |
KDChartFrameSettings () | |
KDChartFrameSettings (uint dataRow, uint dataCol, uint data3rd, const KDFrame &frame, int outerGapX, int outerGapY, int innerGapX, int innerGapY, bool addFrameWidthToLayout=true, bool addFrameHeightToLayout=true) | |
uint | dataRow () const |
uint | dataCol () const |
uint | data3rd () const |
void | setDataRow (uint dataRow) |
void | setDataCol (uint dataCol) |
void | setData3rd (uint data3rd) |
void | resetFrame () |
const KDFrame * | framePtr () const |
const KDFrame & | frame () const |
int | innerGapX () const |
int | innerGapY () const |
int | outerGapX () const |
int | outerGapY () const |
bool | addFrameWidthToLayout () const |
bool | addFrameHeightToLayout () const |
virtual | ~KDChartFrameSettings () |
Static Public Member Functions | |
static void | createFrameSettingsNode (QDomDocument &document, QDomNode &parent, const QString &elementName, const KDChartFrameSettings *settings, uint areaId) |
static bool | readFrameSettingsNode (const QDomElement &element, KDChartFrameSettings &settings, uint &areaId) |
static void | deepCopy (KDChartFrameSettings &D, const KDChartFrameSettings &R) |
Constructor & Destructor Documentation
KDChartParams::KDChartFrameSettings::KDChartFrameSettings | ( | ) |
KDChartParams::KDChartFrameSettings::KDChartFrameSettings | ( | uint | dataRow, | |
uint | dataCol, | |||
uint | data3rd, | |||
const KDFrame & | frame, | |||
int | outerGapX, | |||
int | outerGapY, | |||
int | innerGapX, | |||
int | innerGapY, | |||
bool | addFrameWidthToLayout = true , |
|||
bool | addFrameHeightToLayout = true | |||
) |
Constructor.
- Parameters:
-
outerGap Distance between the frame and the surrounding parts of the chart. innerGap Distance between the frame and inner area. addFrameWidthToLayout If true, shrink inner area so the area AND its frame will occupy the same space of the chart as the area would occupy if no frame were drawn. If false, the frame is drawn around the area without taking care not to override other content of the chart. frame The frame settings to be used for this area. The values of this parameter will be copied into a KDFrame object stored internally in this KDChartFrameSettings so it is save to use the same KDFrame object for specifying the settings of more than one area.
Definition at line 77 of file KDChartParams_frame.cpp.
KDChartParams::KDChartFrameSettings::~KDChartFrameSettings | ( | ) | [virtual] |
Destructor.
Only defined to have it virtual.
Definition at line 108 of file KDChartParams_frame.cpp.
Member Function Documentation
bool KDChartParams::KDChartFrameSettings::addFrameHeightToLayout | ( | ) | const [inline] |
Return whether the inner area will shrink the area AND its frame will occupy the same space of the chart as the area would occupy if no frame were drawn.
If false, the frame is drawn around the area without taking care not to override other content of the chart.
- See also:
- addFrameWidthToLayout
Definition at line 318 of file KDChartParams.h.
bool KDChartParams::KDChartFrameSettings::addFrameWidthToLayout | ( | ) | const [inline] |
Return whether the inner area will shrink the area AND its frame will occupy the same space of the chart as the area would occupy if no frame were drawn.
If false, the frame is drawn around the area without taking care not to override other content of the chart.
- See also:
- addFrameHeightToLayout
Definition at line 312 of file KDChartParams.h.
void KDChartParams::KDChartFrameSettings::createFrameSettingsNode | ( | QDomDocument & | document, | |
QDomNode & | parent, | |||
const QString & | elementName, | |||
const KDChartFrameSettings * | settings, | |||
uint | areaId | |||
) | [static] |
Creates a DOM element node that represents a frame settings object for use in a DOM document.
- Parameters:
-
document the DOM document to which the node will belong parent the parent node to which the new node will be appended elementName the name of the new node settings the frame settings to be represented
Definition at line 254 of file KDChartParams_frame.cpp.
const KDFrame & KDChartParams::KDChartFrameSettings::frame | ( | ) | const [inline] |
Return the KDFrame object used for drawing this areas frame.
Definition at line 282 of file KDChartParams.h.
int KDChartParams::KDChartFrameSettings::innerGapX | ( | ) | const [inline] |
Return the X-distance between the frame and the inner area.
Definition at line 288 of file KDChartParams.h.
int KDChartParams::KDChartFrameSettings::innerGapY | ( | ) | const [inline] |
Return the Y-distance between the frame and the inner area.
Definition at line 294 of file KDChartParams.h.
int KDChartParams::KDChartFrameSettings::outerGapX | ( | ) | const [inline] |
Return the X-distance between the frame and the surrounding parts of the chart.
Definition at line 300 of file KDChartParams.h.
int KDChartParams::KDChartFrameSettings::outerGapY | ( | ) | const [inline] |
Return the Y-distance between the frame and the surrounding parts of the chart.
Definition at line 306 of file KDChartParams.h.
bool KDChartParams::KDChartFrameSettings::readFrameSettingsNode | ( | const QDomElement & | element, | |
KDChartFrameSettings & | settings, | |||
uint & | areaId | |||
) | [static] |
Reads data from a DOM element node that represents a frame settings object and fills a KDChartFrameSettings object with the data.
- Parameters:
-
element the DOM element to read from settings the frame settings object to read the data into
Definition at line 121 of file KDChartParams_frame.cpp.
The documentation for this class was generated from the following files: