#include <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 (TQDomDocument &document, TQDomNode &parent, const TQString &elementName, const KDChartFrameSettings *settings, uint areaId)

static bool	readFrameSettingsNode (const TQDomElement &element, KDChartFrameSettings &settings, uint &areaId)

static void	deepCopy (KDChartFrameSettings &D, const KDChartFrameSettings &R)

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 223 of file KDChartParams.h.

Constructor & Destructor Documentation

◆ KDChartFrameSettings() [1/2]

KDChartParams::KDChartFrameSettings::KDChartFrameSettings ( )

Constructor.

Setting default values.

Definition at line 49 of file KDChartParams_frame.cpp.

◆ KDChartFrameSettings() [2/2]

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 78 of file KDChartParams_frame.cpp.

◆ ~KDChartFrameSettings()

KDChartParams::KDChartFrameSettings::~KDChartFrameSettings ( )

virtual

Destructor.

Only defined to have it virtual.

Definition at line 109 of file KDChartParams_frame.cpp.

Member Function Documentation

◆ addFrameHeightToLayout()

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.

◆ addFrameWidthToLayout()

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.

◆ createFrameSettingsNode()

void KDChartParams::KDChartFrameSettings::createFrameSettingsNode	(	TQDomDocument &	document,
		TQDomNode &	parent,
		const TQString &	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 255 of file KDChartParams_frame.cpp.

◆ data3rd()

uint KDChartParams::KDChartFrameSettings::data3rd ( ) const

inline

Definition at line 249 of file KDChartParams.h.

◆ dataCol()

uint KDChartParams::KDChartFrameSettings::dataCol ( ) const

inline

Definition at line 245 of file KDChartParams.h.

◆ dataRow()

uint KDChartParams::KDChartFrameSettings::dataRow ( ) const

inline

Definition at line 241 of file KDChartParams.h.

◆ deepCopy()

static void KDChartParams::KDChartFrameSettings::deepCopy	(	KDChartFrameSettings &	D,
		const KDChartFrameSettings &	R
	)

inlinestatic

Definition at line 338 of file KDChartParams.h.

◆ frame()

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.

◆ framePtr()

const KDFrame * KDChartParams::KDChartFrameSettings::framePtr ( ) const

inline

Definition at line 276 of file KDChartParams.h.

◆ innerGapX()

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.

◆ innerGapY()

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.

◆ outerGapX()

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.

◆ outerGapY()

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.

◆ readFrameSettingsNode()

bool KDChartParams::KDChartFrameSettings::readFrameSettingsNode	(	const TQDomElement &	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 122 of file KDChartParams_frame.cpp.

◆ resetFrame()

void KDChartParams::KDChartFrameSettings::resetFrame ( )

inline

Definition at line 268 of file KDChartParams.h.

◆ setData3rd()

void KDChartParams::KDChartFrameSettings::setData3rd ( uint data3rd )

inline

Definition at line 262 of file KDChartParams.h.

◆ setDataCol()

void KDChartParams::KDChartFrameSettings::setDataCol ( uint dataCol )

inline

Definition at line 258 of file KDChartParams.h.

◆ setDataRow()

void KDChartParams::KDChartFrameSettings::setDataRow ( uint dataRow )

inline

Definition at line 254 of file KDChartParams.h.

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

kchart

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ KDChartFrameSettings() [1/2]

◆ KDChartFrameSettings() [2/2]

◆ ~KDChartFrameSettings()

Member Function Documentation

◆ addFrameHeightToLayout()

◆ addFrameWidthToLayout()

◆ createFrameSettingsNode()

◆ data3rd()

◆ dataCol()

◆ dataRow()

◆ deepCopy()

◆ frame()

◆ framePtr()

◆ innerGapX()

◆ innerGapY()

◆ outerGapX()

◆ outerGapY()

◆ readFrameSettingsNode()

◆ resetFrame()

◆ setData3rd()

◆ setDataCol()

◆ setDataRow()

kchart

kchart