#include <kplotwidget.h>

Inheritance diagram for KPlotWidget:

Public Types
enum	Axis { LeftAxis = 0, BottomAxis, RightAxis, TopAxis }

Public Slots
void	setObjectToolTipShown (bool show)

void	setShowGrid (bool show)

Public Member Functions
	KPlotWidget (QWidget *parent=0)

virtual	~KPlotWidget ()

void	addPlotObject (KPlotObject *object)

void	addPlotObjects (const QList< KPlotObject * > &objects)

bool	antialiasing () const

KPlotAxis *	axis (Axis type)

const KPlotAxis *	axis (Axis type) const

QColor	backgroundColor () const

int	bottomPadding () const

void	clearSecondaryLimits ()

QRectF	dataRect () const

QColor	foregroundColor () const

QColor	gridColor () const

bool	isGridShown () const

bool	isObjectToolTipShown () const

int	leftPadding () const

QPointF	mapToWidget (const QPointF &p) const

void	maskAlongLine (const QPointF &p1, const QPointF &p2, float value=1.0)

void	maskRect (const QRectF &r, float value=1.0)

virtual QSize	minimumSizeHint () const

QRect	pixRect () const

void	placeLabel (QPainter painter, KPlotPoint pp)

QList< KPlotObject * >	plotObjects () const

void	removeAllPlotObjects ()

void	replacePlotObject (int i, KPlotObject *o)

void	resetPlot ()

void	resetPlotMask ()

int	rightPadding () const

QRectF	secondaryDataRect () const

void	setAntialiasing (bool b)

void	setBackgroundColor (const QColor &bg)

void	setBottomPadding (int padding)

void	setDefaultPaddings ()

void	setForegroundColor (const QColor &fg)

void	setGridColor (const QColor &gc)

void	setLeftPadding (int padding)

void	setLimits (double x1, double x2, double y1, double y2)

void	setRightPadding (int padding)

void	setSecondaryLimits (double x1, double x2, double y1, double y2)

void	setTopPadding (int padding)

virtual QSize	sizeHint () const

int	topPadding () const

Public Member Functions inherited from QFrame
	QFrame (QWidget *parent, QFlags< Qt::WindowType > f)

	QFrame (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QFrame ()

QRect	frameRect () const

Shadow	frameShadow () const

Shape	frameShape () const

int	frameStyle () const

int	frameWidth () const

int	lineWidth () const

int	midLineWidth () const

void	setFrameRect (const QRect &)

void	setFrameShadow (Shadow)

void	setFrameShape (Shape)

void	setFrameStyle (int style)

void	setLineWidth (int)

void	setMidLineWidth (int)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, QFlags< Qt::WindowType > f)

	QWidget (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

QString	caption () const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close (bool alsoDelete)

bool	close ()

QColorGroup	colorGroup () const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

void	erase (int x, int y, int w, int h)

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

QInputContext *	inputContext ()

Qt::InputMethodHints	inputMethodHints () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isDesktop () const

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget (bool sameWindow) const

QWidget *	parentWidget () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint (int x, int y, int w, int h, bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRegion &rgn)

void	repaint (bool b)

void	repaint (const QRect &rect)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setActiveWindow ()

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (int minw, int minh)

void	setMinimumSize (const QSize &)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	numColors () const

virtual QPaintEngine *	paintEngine () const =0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

int	x11Screen () const

void *	x11Visual () const

Protected Member Functions
virtual void	drawAxes (QPainter *p)

virtual bool	event (QEvent *)

virtual void	paintEvent (QPaintEvent *)

QList< KPlotPoint * >	pointsUnderPoint (const QPoint &p) const

virtual void	resizeEvent (QResizeEvent *)

void	setPixRect ()

Protected Member Functions inherited from QFrame
virtual void	changeEvent (QEvent *ev)

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

void	resetInputContext ()

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

Properties
QColor	backgroundColor

int	bottomPadding

QColor	foregroundColor

bool	grid

QColor	gridColor

int	leftPadding

bool	objectToolTip

int	rightPadding

int	topPadding

Properties inherited from QFrame
	frameRect

	frameShadow

	frameShape

	frameWidth

	lineWidth

	midLineWidth

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QWidgetMapper *	wmapper ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char 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)

Static Public Member Functions inherited from QPaintDevice
int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Public Attributes inherited from QWidget
typedef	RenderFlags

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Detailed Description

Generic data plotting widget.

Widget for drawing plots. The basic idea behind KPlotWidget is that you don't have to worry about any transformation from your data's natural units to screen pixel coordinates; this is handled internally by the widget.

Data to be plotted are represented by one or more instances of KPlotObject. KPlotObject contains a list of QPointFs to be plotted (again, in the data's natural units), as well as information about how the data are to be rendered in the plot (i.e., as separate points or connected by lines? With what color and point style? etc). See KPlotObject for more information.

KPlotWidget automatically adds axis labels with tickmarks and tick labels. These are encapsulated in the KPlotAxis class. All you have to do is set the limits of the plotting area in data units, and KPlotWidget wil figure out the optimal positions and labels for the tickmarks on the axes.

Example of usage:

KPlotWidget *kpw = new KPlotWidget( parent );
// setting our limits for the plot
kpw->setLimits( 1.0, 5.0, 1.0, 25.0 );
// creating a plot object whose points are connected by red lines ...
KPlotObject *kpo = new KPlotObject( Qt::red, KPlotObject::Lines );
// ... adding some points to it ...
for ( float x = 1.0; x <= 5.0; x += 0.1 )
    kpo->addPoint( x, x*x );
// ... and adding the object to the plot widget
kpw->addPlotObject( kpo );

Note: KPlotWidget will take care of the objects added to it, so when clearing the objects list (eg with removeAllPlotObjects()) any previous reference to a KPlotObject already added to a KPlotWidget will be invalid.

Author: Jason Harris

Version: 1.1

Definition at line 80 of file kplotwidget.h.

Member Enumeration Documentation

enum KPlotWidget::Axis

The four types of plot axes.

Enumerator
LeftAxis	the left axis
BottomAxis	the bottom axis
RightAxis	the right axis
TopAxis	the top axis

Definition at line 106 of file kplotwidget.h.

Constructor & Destructor Documentation

KPlotWidget::KPlotWidget ( QWidget * parent = 0 )

explicit

Constructor.

Parameters

parent the parent widget

Definition at line 104 of file kplotwidget.cpp.

KPlotWidget::~KPlotWidget ( )

virtual

Destructor.

Definition at line 120 of file kplotwidget.cpp.

Member Function Documentation

void KPlotWidget::addPlotObject ( KPlotObject * object )

Add an item to the list of KPlotObjects to be plotted.

Note: do not use this multiple time if many objects have to be added, addPlotObjects() is strongly suggested in this case

Parameters

object the KPlotObject to be added

Definition at line 210 of file kplotwidget.cpp.

void KPlotWidget::addPlotObjects ( const QList< KPlotObject * > & objects )

Add more than one KPlotObject at one time.

Parameters

objects the list of KPlotObjects to be added

Definition at line 219 of file kplotwidget.cpp.

bool KPlotWidget::antialiasing ( ) const

Returns: whether the antialiasing is active Antialiasing is not active by default.

Definition at line 323 of file kplotwidget.cpp.

KPlotAxis * KPlotWidget::axis ( Axis type )

Returns: the axis of the specified type, or 0 if no axis has been set.

See also: Axis

Definition at line 345 of file kplotwidget.cpp.

const KPlotAxis * KPlotWidget::axis ( Axis type ) const

Returns: the axis of the specified type, or 0 if no axis has been set.

See also: Axis

Definition at line 351 of file kplotwidget.cpp.

QColor KPlotWidget::backgroundColor ( ) const

Returns: the background color of the plot.

The default color is black.

int KPlotWidget::bottomPadding ( ) const

Returns: the number of pixels below 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.

void KPlotWidget::clearSecondaryLimits ( )

Unset the secondary limits, so the top and right axes show the same tickmarks as the bottom and left axes (no tickmark labels will be drawn for the top and right axes in this case)

Definition at line 192 of file kplotwidget.cpp.

QRectF KPlotWidget::dataRect ( ) const

Returns: the rectangle representing the boundaries of the current plot, in natural data units.

See also: setLimits()

Definition at line 200 of file kplotwidget.cpp.

void KPlotWidget::drawAxes ( QPainter * p )

protectedvirtual

Draws the plot axes and axis labels.

Internal use only; one should simply call update() to draw the widget with axes and all objects.

Parameters

p	pointer to the painter on which we are drawing

Definition at line 695 of file kplotwidget.cpp.

bool KPlotWidget::event ( QEvent * e )

protectedvirtual

Generic event handler.

Reimplemented from QFrame.

Definition at line 375 of file kplotwidget.cpp.

QColor KPlotWidget::foregroundColor ( ) const

Returns: the foreground color, used for axes, tickmarks and associated labels.

The default color is white.

QColor KPlotWidget::gridColor ( ) const

Returns: the grid color.

The default color is gray.

bool KPlotWidget::isGridShown ( ) const

Returns: whether the grid lines are shown Grid lines are not shown by default.

Definition at line 313 of file kplotwidget.cpp.

bool KPlotWidget::isObjectToolTipShown ( ) const

Returns: whether the tooltip for the point objects is shown. Tooltips are enabled by default.

Definition at line 318 of file kplotwidget.cpp.

int KPlotWidget::leftPadding ( ) const

Returns: the number of pixels to the left 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 need to be drawn.

QPointF KPlotWidget::mapToWidget ( const QPointF & p ) const

Map a coordinate.

Parameters

p	from the data rect to the physical pixel rect. Used mainly when drawing.
p	the point to be converted, in natural data units

Returns: the coordinate in the pixel coordinate system

Definition at line 405 of file kplotwidget.cpp.

void KPlotWidget::maskAlongLine	(	const QPointF &	p1,
		const QPointF &	p2,
		float	value = `1.0`
	)

Indicate that object labels should try to avoid the line joining the two given points (in pixel coordinates).

Note: You should not normally call this function directly. It is called by KPlotObject when lines are drawn in the plot.

Parameters

p1	the starting point for the line
p2	the ending point for the line
value	Allows you to determine how strongly the line should be avoided. Larger values are avoided more strongly.

Definition at line 427 of file kplotwidget.cpp.

void KPlotWidget::maskRect	(	const QRectF &	r,
		float	value = `1.0`
	)

Indicate that object labels should try to avoid the given rectangle in the plot.

The rectangle is in pixel coordinates.

Note: You should not normally call this function directly. It is called by KPlotObject when points, bars and labels are drawn.

Parameters

r	the rectangle defining the region in the plot that text labels should avoid (in pixel coordinates)
value	Allows you to determine how strongly the rectangle should be avoided. Larger values are avoided more strongly.

Definition at line 412 of file kplotwidget.cpp.

QSize KPlotWidget::minimumSizeHint ( ) const

virtual

Returns: suggested minimum size for the plot widget

Reimplemented from QWidget.

Definition at line 125 of file kplotwidget.cpp.

void KPlotWidget::paintEvent ( QPaintEvent * e )

protectedvirtual

The paint event handler, executed when update() or repaint() is called.

Reimplemented from QFrame.

Definition at line 667 of file kplotwidget.cpp.

QRect KPlotWidget::pixRect ( ) const

Returns: the rectangle representing the boundaries of the current plot, in screen pixel units.

Definition at line 357 of file kplotwidget.cpp.

void KPlotWidget::placeLabel	(	QPainter *	painter,
		KPlotPoint *	pp
	)

Place an object label optimally in the plot.

This function will attempt to place the label as close as it can to the point to which the label belongs, while avoiding overlap with regions of the plot that have been masked.

Note: You should not normally call this function directly. It is called internally in KPlotObject::draw().

Parameters

painter	Pointer to the painter on which to draw the label
pp	pointer to the KPlotPoint whose label is to be drawn.

Definition at line 489 of file kplotwidget.cpp.

QList< KPlotObject * > KPlotWidget::plotObjects ( ) const

Returns: the current list of plot objects

Definition at line 234 of file kplotwidget.cpp.

QList< KPlotPoint * > KPlotWidget::pointsUnderPoint ( const QPoint & p ) const

protected

Returns: a list of points in the plot which are within 4 pixels of the screen position given as an argument.

Parameters

p	The screen position from which to check for plot points.

Definition at line 362 of file kplotwidget.cpp.

void KPlotWidget::removeAllPlotObjects ( )

Remove and delete all items from the list of KPlotObjects.

Definition at line 239 of file kplotwidget.cpp.

void KPlotWidget::replacePlotObject	(	int	i,
		KPlotObject *	o
	)

Replace an item in the KPlotObject list.

Parameters

i	the index of the item to be replaced
o	pointer to the replacement KPlotObject

Definition at line 272 of file kplotwidget.cpp.

void KPlotWidget::resetPlot ( )

Clear the object list, reset the data limits, and remove axis labels.

Definition at line 256 of file kplotwidget.cpp.

void KPlotWidget::resetPlotMask ( )

Reset the mask used for non-overlapping labels so that all regions of the plot area are considered empty.

Definition at line 249 of file kplotwidget.cpp.

void KPlotWidget::resizeEvent ( QResizeEvent * e )

protectedvirtual

The resize event handler, called when the widget is resized.

Reimplemented from QWidget.

Definition at line 392 of file kplotwidget.cpp.

int KPlotWidget::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.

QRectF KPlotWidget::secondaryDataRect ( ) const

Returns: the rectangle representing the boundaries of the secondary data limits, if they have been set. Otherwise, this function behaves the same as dataRect().

See also: setSecondaryLimits()

Definition at line 205 of file kplotwidget.cpp.

void KPlotWidget::setAntialiasing ( bool b )

Toggle antialiased drawing.

Parameters

b	if true, the plot graphics will be antialiased.

Definition at line 328 of file kplotwidget.cpp.

void KPlotWidget::setBackgroundColor ( const QColor & bg )

Set the background color.

Parameters

bg	the new background color

Definition at line 296 of file kplotwidget.cpp.

void KPlotWidget::setBottomPadding ( int padding )

Set the number of pixels below the plot area.

Set this to -1 to revert to automatic determination of padding values.

Definition at line 959 of file kplotwidget.cpp.

void KPlotWidget::setDefaultPaddings ( )

Revert all four padding values to -1, so that they will be automatically determined.

Definition at line 964 of file kplotwidget.cpp.

void KPlotWidget::setForegroundColor ( const QColor & fg )

Set the foreground color.

Parameters

fg	the new foreground color

Definition at line 301 of file kplotwidget.cpp.

void KPlotWidget::setGridColor ( const QColor & gc )

Set the grid color.

Parameters

gc	the new grid color

Definition at line 307 of file kplotwidget.cpp.

void KPlotWidget::setLeftPadding ( int padding )

Set the number of pixels to the left of the plot area.

Set this to -1 to revert to automatic determination of padding values.

Definition at line 944 of file kplotwidget.cpp.

void KPlotWidget::setLimits	(	double	x1,
		double	x2,
		double	y1,
		double	y2
	)

Set new data limits for the plot.

Parameters

x1	the minimum X value in data units
x2	the maximum X value in data units
y1	the minimum Y value in data units
y2	the maximum Y value in data units

Definition at line 135 of file kplotwidget.cpp.

void KPlotWidget::setObjectToolTipShown ( bool show )

slot

Toggle the display of a tooltip for point objects.

Parameters

show	whether show the tooltip.

See also: isObjectToolTipShown()

Definition at line 339 of file kplotwidget.cpp.

void KPlotWidget::setPixRect ( )

protected

Synchronize the PixRect with the current widget size and padding settings.

Definition at line 398 of file kplotwidget.cpp.

void KPlotWidget::setRightPadding ( int padding )

Set the number of pixels to the right of the plot area.

Set this to -1 to revert to automatic determination of padding values.

Definition at line 949 of file kplotwidget.cpp.

void KPlotWidget::setSecondaryLimits	(	double	x1,
		double	x2,
		double	y1,
		double	y2
	)

Reset the secondary data limits, which control the values displayed along the top and right axes.

All data points are plotted using the coordinates defined by setLimits(), so this function is only useful for showing alternate tickmark labels along the top and right edges. For example, if you were plotting temperature on the X-axis, you could use Centigrade units for the primary (bottom) axis, using setLimits( 0.0, 100.0, 0.0, 1.0 ). If you also wanted to show Farenheit units along the secondary (top) axis, you would additionally use setSecondaryLimits( 32.0, 212.0, 0.0, 1.0 ). The data added to the plot would have x-coordinates in Centigrade degrees.

Parameters

x1	the minimum X value in secondary data units
x2	the maximum X value in secondary data units
y1	the minimum Y value in secondary data units
y2	the maximum Y value in secondary data units

See also: setLimits()

Definition at line 169 of file kplotwidget.cpp.

void KPlotWidget::setShowGrid ( bool show )

slot

Toggle whether grid lines are drawn at major tickmarks.

Parameters

show	if true, grid lines will be drawn.

See also: isGridShown()

Definition at line 334 of file kplotwidget.cpp.

void KPlotWidget::setTopPadding ( int padding )

Set the number of pixels above the plot area.

Set this to -1 to revert to automatic determination of padding values.

Definition at line 954 of file kplotwidget.cpp.

QSize KPlotWidget::sizeHint ( void ) const

virtual

Returns: suggested size for the plot widget

Reimplemented from QFrame.

Definition at line 130 of file kplotwidget.cpp.

int KPlotWidget::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.

Property Documentation

QColor KPlotWidget::backgroundColor

readwrite

Definition at line 86 of file kplotwidget.h.

int KPlotWidget::bottomPadding

read

Definition at line 85 of file kplotwidget.h.

QColor KPlotWidget::foregroundColor

readwrite

Definition at line 87 of file kplotwidget.h.

bool KPlotWidget::grid

readwrite

Definition at line 89 of file kplotwidget.h.

QColor KPlotWidget::gridColor

readwrite

Definition at line 88 of file kplotwidget.h.

int KPlotWidget::leftPadding

read

Definition at line 82 of file kplotwidget.h.

bool KPlotWidget::objectToolTip

readwrite

Definition at line 90 of file kplotwidget.h.

int KPlotWidget::rightPadding

read

Definition at line 83 of file kplotwidget.h.

int KPlotWidget::topPadding

read

Definition at line 84 of file kplotwidget.h.

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

KDEUI

Public Types

Public Slots

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation

KDEUI

kdelibs API Reference

Search