KStarsPlotWidget Class Reference

A plotting widget for KStars tools, derived from the more generic class KPlotWidget. More...

#include <kstarsplotwidget.h>

Inheritance diagram for KStarsPlotWidget:

[legend]

List of all members.

Public Types
enum	AXIS_TYPE { DOUBLE = 0, TIME = 1, ANGLE = 2, UNKNOWN_TYPE }
Public Member Functions
void	checkLimits ()
double	dataHeight2 () const
double	dataWidth2 () const
	KStarsPlotWidget (double x1=0.0, double x2=1.0, double y1=0.0, double y2=1.0, QWidget *parent=0, const char *name=0)
int	rightPadding () const
void	setLimits (double xb1, double xb2, double yb1, double yb2)
void	setSecondaryLimits (double xb1, double xb2, double yb1, double yb2)
virtual void	setXAxisLabel2 (QString xlabel)
void	setXAxisType (AXIS_TYPE xtype)
void	setXAxisType0 (AXIS_TYPE xtype)
void	setXScale (double s)
virtual void	setYAxisLabel2 (QString ylabel)
void	setYAxisType (AXIS_TYPE ytype)
void	setYAxisType0 (AXIS_TYPE ytype)
void	setYScale (double s)
int	topPadding () const
void	updateTickmarks ()
AXIS_TYPE	xAxisType () const
AXIS_TYPE	xAxisType0 () const
double	xb () const
double	xb2 () const
double	xScale () const
AXIS_TYPE	yAxisType () const
AXIS_TYPE	yAxisType0 () const
double	yb () const
double	yb2 () const
double	yScale () const
	~KStarsPlotWidget ()
Protected Member Functions
void	drawBox (QPainter *p)
Protected Attributes
DRect	DataRect2
double	dXtick2
double	dYtick2
int	nmajX2
int	nmajY2
int	nminX2
int	nminY2
QString	XAxisLabel2
AXIS_TYPE	XAxisType
AXIS_TYPE	XAxisType_0
double	XScaleFactor
QString	YAxisLabel2
AXIS_TYPE	YAxisType
AXIS_TYPE	YAxisType_0
double	YScaleFactor

---

Detailed Description

A plotting widget for KStars tools, derived from the more generic class KPlotWidget.

Author:

Jason Harris

Version:

1.0 Widget for drawing plots. Features added to KPlotWidget: secondary Axis labels, data types

Definition at line 39 of file kstarsplotwidget.h.

---

Member Enumeration Documentation

enum KStarsPlotWidget::AXIS_TYPE

Specifies the data type of the axis.

Enumerator:

DOUBLE
TIME
ANGLE
UNKNOWN_TYPE

Definition at line 53 of file kstarsplotwidget.h.

---

Constructor & Destructor Documentation

KStarsPlotWidget::KStarsPlotWidget	(	double	x1 = 0.0,
		double	x2 = 1.0,
		double	y1 = 0.0,
		double	y2 = 1.0,
		QWidget *	parent = 0,
		const char *	name = 0
	)

Constructor.

Definition at line 31 of file kstarsplotwidget.cpp.

KStarsPlotWidget::~KStarsPlotWidget

(

)

[inline]

Destructor (empty).

Definition at line 48 of file kstarsplotwidget.h.

---

Member Function Documentation

void KStarsPlotWidget::checkLimits

(

)

Definition at line 67 of file kstarsplotwidget.cpp.

double KStarsPlotWidget::dataHeight2

(

)

const [inline]

Definition at line 67 of file kstarsplotwidget.h.

double KStarsPlotWidget::dataWidth2

(

)

const [inline]

Definition at line 66 of file kstarsplotwidget.h.

void KStarsPlotWidget::drawBox

(

QPainter *

p

)

[protected]

Definition at line 283 of file kstarsplotwidget.cpp.

int KStarsPlotWidget::rightPadding

(

)

const

Returns:

the number of pixels to the right of the plot area. Padding values are set to -1 by default; if unchanged, this function will try to guess a good value, based on whether ticklabels and/or axis labels are to be drawn.

Definition at line 650 of file kstarsplotwidget.cpp.

void KStarsPlotWidget::setLimits	(	double	xb1,
		double	xb2,
		double	yb1,
		double	yb2
	)

Definition at line 43 of file kstarsplotwidget.cpp.

void KStarsPlotWidget::setSecondaryLimits	(	double	xb1,
		double	xb2,
		double	yb1,
		double	yb2
	)

Definition at line 56 of file kstarsplotwidget.cpp.

virtual void KStarsPlotWidget::setXAxisLabel2

(

QString

xlabel

)

[inline, virtual]

set the secondary X-axis label

Parameters:

xlabel

a short string describing the data plotted on the x-axis. Set the label to an empty string to omit the axis label.

Definition at line 98 of file kstarsplotwidget.h.

void KStarsPlotWidget::setXAxisType

(

AXIS_TYPE

xtype

)

[inline]

set the data type of the x-axis

Parameters:

xtype

the new data type (DOUBLE, TIME, or ANGLE)

Definition at line 86 of file kstarsplotwidget.h.

void KStarsPlotWidget::setXAxisType0

(

AXIS_TYPE

xtype

)

[inline]

Definition at line 87 of file kstarsplotwidget.h.

void KStarsPlotWidget::setXScale

(

double

s

)

[inline]

Definition at line 70 of file kstarsplotwidget.h.

virtual void KStarsPlotWidget::setYAxisLabel2

(

QString

ylabel

)

[inline, virtual]

set the secondary Y-axis label

Parameters:

ylabel

a short string describing the data plotted on the y-axis. Set the label to an empty string to omit the axis label.

Definition at line 103 of file kstarsplotwidget.h.

void KStarsPlotWidget::setYAxisType

(

AXIS_TYPE

ytype

)

[inline]

set the data type of the y-axis

Parameters:

ytype

the new data type (DOUBLE, TIME, or ANGLE)

Definition at line 91 of file kstarsplotwidget.h.

void KStarsPlotWidget::setYAxisType0

(

AXIS_TYPE

ytype

)

[inline]

Definition at line 92 of file kstarsplotwidget.h.

void KStarsPlotWidget::setYScale

(

double

s

)

[inline]

Definition at line 72 of file kstarsplotwidget.h.

int KStarsPlotWidget::topPadding

(

)

const

Returns:

the number of pixels above the plot area. Padding values are set to -1 by default; if unchanged, this function will try to guess a good value, based on whether ticklabels and/or axis labels are to be drawn.

Definition at line 660 of file kstarsplotwidget.cpp.

void KStarsPlotWidget::updateTickmarks

(

)

Determine the placement of major and minor tickmarks, based on the current Limit settings.

Definition at line 118 of file kstarsplotwidget.cpp.

AXIS_TYPE KStarsPlotWidget::xAxisType

(

)

const [inline]

Returns:

the data type of the x-axis (DOUBLE, TIME or ANGLE)

Definition at line 76 of file kstarsplotwidget.h.

AXIS_TYPE KStarsPlotWidget::xAxisType0

(

)

const [inline]

Definition at line 77 of file kstarsplotwidget.h.

double KStarsPlotWidget::xb

(

)

const [inline]

Definition at line 62 of file kstarsplotwidget.h.

double KStarsPlotWidget::xb2

(

)

const [inline]

Definition at line 63 of file kstarsplotwidget.h.

double KStarsPlotWidget::xScale

(

)

const [inline]

Definition at line 69 of file kstarsplotwidget.h.

AXIS_TYPE KStarsPlotWidget::yAxisType

(

)

const [inline]

Returns:

the data type of the y-axis (DOUBLE, TIME or ANGLE)

Definition at line 80 of file kstarsplotwidget.h.

AXIS_TYPE KStarsPlotWidget::yAxisType0

(

)

const [inline]

Definition at line 81 of file kstarsplotwidget.h.

double KStarsPlotWidget::yb

(

)

const [inline]

Definition at line 64 of file kstarsplotwidget.h.

double KStarsPlotWidget::yb2

(

)

const [inline]

Definition at line 65 of file kstarsplotwidget.h.

double KStarsPlotWidget::yScale

(

)

const [inline]

Definition at line 71 of file kstarsplotwidget.h.

---

Member Data Documentation

DRect KStarsPlotWidget::DataRect2 [protected]

Definition at line 123 of file kstarsplotwidget.h.

double KStarsPlotWidget::dXtick2 [protected]

Definition at line 119 of file kstarsplotwidget.h.

double KStarsPlotWidget::dYtick2 [protected]

Definition at line 119 of file kstarsplotwidget.h.

int KStarsPlotWidget::nmajX2 [protected]

Definition at line 120 of file kstarsplotwidget.h.

int KStarsPlotWidget::nmajY2 [protected]

Definition at line 120 of file kstarsplotwidget.h.

int KStarsPlotWidget::nminX2 [protected]

Definition at line 120 of file kstarsplotwidget.h.

int KStarsPlotWidget::nminY2 [protected]

Definition at line 120 of file kstarsplotwidget.h.

QString KStarsPlotWidget::XAxisLabel2 [protected]

Definition at line 125 of file kstarsplotwidget.h.

AXIS_TYPE KStarsPlotWidget::XAxisType [protected]

Definition at line 121 of file kstarsplotwidget.h.

AXIS_TYPE KStarsPlotWidget::XAxisType_0 [protected]

Definition at line 121 of file kstarsplotwidget.h.

double KStarsPlotWidget::XScaleFactor [protected]

Definition at line 122 of file kstarsplotwidget.h.

QString KStarsPlotWidget::YAxisLabel2 [protected]

Definition at line 125 of file kstarsplotwidget.h.

AXIS_TYPE KStarsPlotWidget::YAxisType [protected]

Definition at line 121 of file kstarsplotwidget.h.

AXIS_TYPE KStarsPlotWidget::YAxisType_0 [protected]

Definition at line 121 of file kstarsplotwidget.h.

double KStarsPlotWidget::YScaleFactor [protected]

Definition at line 122 of file kstarsplotwidget.h.

---

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

• kstarsplotwidget.h
• kstarsplotwidget.cpp