summaryrefslogtreecommitdiffstats
path: root/libtdeedu/tdeeduplot/kplotaxis.h
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-16 16:06:06 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-16 16:06:06 -0600
commit34784ccef6ac9dd33b4460560c68e5422a73560a (patch)
treea206e2a4050c2861ce0706a8fd3542ff29e234e1 /libtdeedu/tdeeduplot/kplotaxis.h
parent89354dfc31a795bae9415f79bb07b32be643e4f4 (diff)
downloadtdeedu-34784ccef6ac9dd33b4460560c68e5422a73560a.tar.gz
tdeedu-34784ccef6ac9dd33b4460560c68e5422a73560a.zip
Finish rename from prior commit
Diffstat (limited to 'libtdeedu/tdeeduplot/kplotaxis.h')
-rw-r--r--libtdeedu/tdeeduplot/kplotaxis.h86
1 files changed, 86 insertions, 0 deletions
diff --git a/libtdeedu/tdeeduplot/kplotaxis.h b/libtdeedu/tdeeduplot/kplotaxis.h
new file mode 100644
index 00000000..3209b18c
--- /dev/null
+++ b/libtdeedu/tdeeduplot/kplotaxis.h
@@ -0,0 +1,86 @@
+/***************************************************************************
+ kplotaxis.h - An axis for the plot widget
+ -------------------
+ begin : 16 June 2005
+ copyright : (C) 2005 by Andreas Nicolai
+ email : Andreas.Nicolai@gmx.net
+ ***************************************************************************/
+
+/***************************************************************************
+ * *
+ * This program is free software; you can redistribute it and/or modify *
+ * it under the terms of the GNU General Public License as published by *
+ * the Free Software Foundation; either version 2 of the License, or *
+ * (at your option) any later version. *
+ * *
+ ***************************************************************************/
+
+#ifndef KPLOTAXIS_H
+#define KPLOTAXIS_H
+
+#include <tqstring.h>
+
+#include <kdemacros.h>
+
+/**class KPlotAxis
+ *@short Contains all data for drawing an axis including format specification axis labels.
+ *@author Andreas Nicolai
+ *@version 1.0
+ */
+class KDE_EXPORT KPlotAxis {
+public:
+
+ /**@short Default constructor, creates a default axis. */
+ KPlotAxis();
+
+ /**@short Constructor, constructs a labeled axis. */
+ KPlotAxis(const TQString& label);
+
+ /**@short Destructor. */
+ virtual ~KPlotAxis() {}
+
+ /**@short Returns whether the axis is visible or not. */
+ virtual bool isVisible() const { return m_visible; }
+
+ /**@short Sets the "visible" property of the axis. */
+ virtual void setVisible(bool visible) { m_visible = visible; }
+
+ /**@short Shows the axis (axis will be shown at next update of plot widget). */
+ virtual void show() { m_visible = true; }
+
+ /**@short Hides the axis (axis will be hidden at next update of plot widget). */
+ virtual void hide() { m_visible = false; }
+
+ /**@short Sets the axis label.
+ *@param label A short string describing the data plotted on the axis.
+ *Set the label to an empty string to omit the axis label.
+ */
+ virtual void setLabel( const TQString& label ) { m_label = label; }
+
+ /**@short Returns the axis label. */
+ virtual TQString label() const { return m_label; }
+
+ /**@short Set the number format for the tick labels, see TQString::arg() for
+ description of arguments.
+ */
+ virtual void setLabelFormat(int fieldWidth, char fmt = 'g', int prec=-1) {
+ m_labelFieldWidth = fieldWidth; m_labelFmt = fmt; m_labelPrec = prec; }
+
+ /**@short Returns the field width of the tick labels. */
+ virtual int labelFieldWidth() const { return m_labelFieldWidth; }
+
+ /**@short Returns the number format of the tick labels. */
+ virtual char labelFmt() const { return m_labelFmt; }
+
+ /**@short Returns the number precision of the tick labels. */
+ virtual int labelPrec() const { return m_labelPrec; }
+
+private:
+ bool m_visible; ///< Property "visible" defines if Axis is drawn or not.
+ TQString m_label; ///< The label of the axis.
+ int m_labelFieldWidth; ///< Field width for number labels, see TQString::arg().
+ char m_labelFmt; ///< Number format for number labels, see TQString::arg().
+ int m_labelPrec; ///< Number precision for number labels, see TQString::arg().
+};
+
+#endif // KPLOTAXIS_H