/usr/include/KF5/KPlotting/kplotaxis.h is in libkf5plotting-dev 5.44.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 | /* -*- C++ -*-
This file is part of the KDE libraries
Copyright (C) 2005 Andreas Nicolai <Andreas.Nicolai@gmx.net>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KPLOTAXIS_H
#define KPLOTAXIS_H
#include <kplotting_export.h>
#include <QtCore/QString>
#include <QtCore/QList>
/**
* @short Axis for KPlotWidget
*
* Contains all data for drawing an axis including format specification axis labels.
*
* @author Andreas Nicolai
* @version 1.0
*/
class KPLOTTING_EXPORT KPlotAxis
{
public:
/**
* Constructor, constructs an axis with the label @p label.
*/
explicit KPlotAxis(const QString &label = QString());
/**
* Destructor.
*/
~KPlotAxis();
/**
* @return whether the axis is visible or not
*/
bool isVisible() const;
/**
* Sets the "visible" property of the axis.
* @param visible if true, this axis will be drawn on the KPlotWidget
*/
void setVisible(bool visible);
/**
* @return whether tick labels will be drawn for this axis
*/
bool areTickLabelsShown() const;
/**
* Determine whether tick labels will be drawn for this axis.
* @param b if true, tick labels will be drawn.
*/
void setTickLabelsShown(bool b);
/**
* Sets the axis label.
* Set the label to an empty string to omit the axis label.
* @param label a string describing the data plotted on the axis.
*/
void setLabel(const QString &label);
/**
* @return the label string for this axis
*/
QString label() const;
/**
* @return the ticklabel string for the given value, rendered according
* to the current format specification.
* @param the value to be rendered as a tick label.
* @sa setTickLabelFormat()
*/
QString tickLabel(double value) const;
/**
* Set the display format for converting the double value of the
* tick's position to the QString for the tick label.
*
* Normally, the format character is one of 'e', 'E', 'f', 'g', or 'G'
* (see the documentation for QString::arg(double) for details).
*
* In addition, it is possible to set the format character to 't';
* in this case the tickmark value is interpreted as a time in hours,
* and the ticklabel string will be in "hh:mm" clock format.
* Note that when the format character is 't', the fieldWidth and prec
* values are ignored.
*
* @param format the format specification character
* @param fieldWidth the number of characters in the output string.
* If set to 0, the string will be as wide as it needs to be to fully
* render the value.
* @param precision the number of characters following the decimal point.
*/
void setTickLabelFormat(char format = 'g', int fieldWidth = 0, int precision = -1);
/**
* @return the field width of the tick labels
*/
int tickLabelWidth() const;
/**
* @return the number format of the tick labels
*/
char tickLabelFormat() const;
/**
* @return the number precision of the tick labels
*/
int tickLabelPrecision() const;
/**
* Determine the positions of major and minor tickmarks for this axis.
* @note this function is called by KPlotWidget whenever the plot's
* limits are modified.
* @param x0 the minimum data coordinate of the axis.
* @param length the range covered by the axis, in data units.
* @sa majorTickMarks()
* @sa minorTickMarks()
*/
void setTickMarks(double x0, double length);
/**
* @return the list of coordinates of the major tickmarks for this axis
* @note the positions of tickmarks are automatically computed by setTickMarks().
* @sa setTickMarks()
* @sa minorTickMarks()
*/
QList< double > majorTickMarks() const;
/**
* @return the list with the minor tickmarks
* @note the positions of tickmarks are automatically computed by setTickMarks().
* @sa setTickMarks()
* @sa majorTickMarks()
*/
QList< double > minorTickMarks() const;
private:
class Private;
Private *const d;
Q_DISABLE_COPY(KPlotAxis)
};
#endif // KPLOTAXIS_H
|