ScaleBarItem Class Reference

Scale bar item class. More...

#include <scalebaritem.h>

Inheritance diagram for ScaleBarItem:

Public Types
enum	{ Type = UserType + ScaleBar }
	Specific QGraphicsItem type number for function type() More...
Public Types inherited from KplItem
enum	FillStyle {   NoBrush , SolidPattern , HorPattern , VerPattern ,   CrossPattern , BDiagPattern , FDiagPattern , DiagCrossPattern }
	Fill styles. More...
enum	ItemType {   Frame = 1 , Array , Function , ParFunction ,   Spline , Array3D , Function3D , Legend ,   Text , Line , Arrow , Arc ,   Rectangle , Ellipse , Image , ScaleBar }
	Item types. More...
enum	PenType { FramePen , GridPen , DataPen }
	Pen types. More...
enum	Symbol {   Invisible = -17 , FilledOctagon , FilledHourglass , FilledTriangle ,   FilledSquare , FilledDiamond , FilledCircle , Umbrella ,   Ypsilon , Plus , Cross , OpenOctagon ,   OpenHourglass , OpenTriangle , OpenSquare , OpenDiamond ,   Dot , OpenCircle , SolidLine , DashLine1 ,   DashLine2 , DotLine1 , DashLine3 , DashDotLine ,   DashLine4 , DashLine5 , DotLine2 }
	Symbol types. More...

Public Member Functions
	ScaleBarItem (double x0=0, double y0=0, unsigned color=0, QGraphicsItem *parent=nullptr, double length=1, const QString &text=QString(), bool visible=true, bool vertical=false, double relSize=1)
	Constructor.
	ScaleBarItem (const ScaleBarItem &a)
	Copy constructor.
	ScaleBarItem (const KConfigGroup *plo, unsigned color=0, QGraphicsItem *parent=nullptr)
	Constructor.
virtual	~ScaleBarItem ()
	Destructor.
virtual QRectF	boundingRect () const override
	Calculates bounding rectangle.
double	length () const
	Returns length in cm.
virtual void	paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget=nullptr) override
	Paints item.
QPixmap	pixmap () const
	Returns decoration pixmap for item list.
void	setLength (double length)
	Sets length.
void	setProperties (const QTransform &m)
	Sets properties according to transformation matrix.
void	setSize ()
	Sets size according to transformation matrix.
void	setText (const QString &text)
	Sets text.
void	setVertical (bool vertical)
	Sets orientation.
QString	text () const
	Returns text.
virtual int	type () const override
	Returns specific QGraphicsItem type number.
void	update ()
	Applies changes and forces redrawing.
bool	vertical () const
	Returns true for vertical, false for horizontal orientation.
void	writePlo (KConfigGroup *plo) const
	Writes into plot file.
Public Member Functions inherited from DecoItem
	DecoItem (unsigned color=0, double x0=0, double y0=0, double relSize=1)
	Constructor.
	DecoItem (const KConfigGroup *plo, unsigned color=0)
	Constructor.
virtual	~DecoItem ()
	Destructor.
unsigned	color () const
	Returns color.
void	setColor (unsigned color)
	Sets color.
void	setX0 (double x0)
	Sets x position.
void	setY0 (double y0)
	Sets y position.
void	updatePos (const QPointF &p, bool absolute=true)
	Updates position.
void	writePlo (KConfigGroup *plo, bool visible) const
	Writes into plot file.
double	x0 () const
	Returns x position in cm.
double	y0 () const
	Returns y position in cm.
Public Member Functions inherited from KplItem
	KplItem (double relSize=1)
	Constructor.
	KplItem (const KplItem &a)
	Copy constructor.
	KplItem (const KConfigGroup *plo)
	Constructor.
virtual	~KplItem ()
	Destructor.
void	readPlo (const KConfigGroup *plo)
	Initializes corresponding to plot file.
double	relSize () const
	Returns relative size of item.
void	setRelSize (double relSize)
	Sets relative size of item.
void	writePlo (KConfigGroup *plo, bool visible=true) const
	Writes into plot file.

Protected Member Functions
void	init ()
	Performs initialization.
virtual void	mouseReleaseEvent (QGraphicsSceneMouseEvent *event) override
	Updates position.
void	setProperties ()
	Sets properties according to transformation matrix.
QRectF	textRect () const
	Returns text rectangle in pixel units.
Protected Member Functions inherited from KplItem
QPen &	changePenWidth (QPen &pen, double width) const
	Changes pen width.
QPen	createPen (QGraphicsItem *item, unsigned color=0, PenType penType=DataPen, Symbol symbol=SolidLine) const
	Creates pen for plot item.
double	penWidth (const QGraphicsItem *item, PenType penType=DataPen) const
	Calculates pen width for plot item.

Protected Attributes
bool	m_vertical
double	m_length
double	l2
double	wRel
QString	m_text
QTextDocument	m_doc
QPen	m_pen
Protected Attributes inherited from DecoItem
unsigned	m_color
double	m_x0
double	m_y0
QTransform	m_matrix
Protected Attributes inherited from KplItem
double	m_relSize

Additional Inherited Members
Static Public Member Functions inherited from KplItem
static QUrl	absoluteUrl (const QString &path, const QUrl &urlPlo)
	Constructs absolute file URL.
static QBrush	createBrush (unsigned color, FillStyle fillStyle=NoBrush)
	Creates brush.
static QPen	createPen (double width, unsigned color, PenType penType, Symbol symbol)
	Creates pen.
static void	paintSymbol (QPainter *painter, const QRectF &rect, Symbol symbol=OpenCircle)
	Paints symbol.
static QPixmap	pixmap (Symbol symbol)
	Returns black decoration pixmap of plot symbol for use in dialog GUI.
static QPixmap	pixmap (QPen pen, Symbol symbol=SolidLine)
	Returns decoration pixmap of plot symbol for use in item lists.
static QString	path (const QUrl &urlPlo, const QUrl &url, bool absolute=false)
	Constructs absolute or (if possible) relative file path.
static void	resetDashOffset ()
	Resets offset for dashed lines.
static unsigned	rgb (const QString &color)
	Converts rgb string to QRgb.
static unsigned	rgbQt1 (unsigned rgb)
	Converts QRgb to Qt1 QRgb.
Static Protected Member Functions inherited from KplItem
static double	parentWidth (const QGraphicsItem *item)
	Returns width of item's parent frame or width of scene if the item has no parent item.
static double	penWidthFactor (PenType penType)
	Returns factor to calculate pen width from frame width.
Static Protected Attributes inherited from KplItem
static double	m_dashOffset

Detailed Description

Scale bar item class.

Class for scale bar decoration items.

Author

Werner Stille

Member Enumeration Documentation

anonymous enum

anonymous enum

Specific QGraphicsItem type number for function type()

Enumerator
Type	Specific QGraphicsItem type number of ScaleBarItem for function type().

Constructor & Destructor Documentation

ScaleBarItem() [1/3]

ScaleBarItem::ScaleBarItem	(	double	x0 = 0,
		double	y0 = 0,
		unsigned	color = 0,
		QGraphicsItem *	parent = nullptr,
		double	length = 1,
		const QString &	text = QString(),
		bool	visible = true,
		bool	vertical = false,
		double	relSize = 1 )

Constructor.

Initializes corresponding to arguments.

Parameters

x0	x position of bar in cm.
y0	y position of bar in cm.
color	color for scale bar.
parent	pointer to parent item.
length	length in cm.
text	text.
visible	true for visible item.
vertical	false for horizontal, true for vertical orientation.
relSize	relative size of scale bar.

ScaleBarItem() [2/3]

ScaleBarItem::ScaleBarItem

(

const ScaleBarItem &

a

)

Copy constructor.

Parameters

a	source item.

ScaleBarItem() [3/3]

ScaleBarItem::ScaleBarItem	(	const KConfigGroup *	plo,
		unsigned	color = 0,
		QGraphicsItem *	parent = nullptr )

Constructor.

Initializes corresponding to plot file.

Parameters

plo	pointer to KSimpleConfig object containing item data.
color	default color for scale bar.
parent	pointer to parent item.

Member Function Documentation

setLength()

void ScaleBarItem::setLength ( double length )

inline

Sets length.

Parameters

length

length in cm.

setProperties()

void ScaleBarItem::setProperties

(

const QTransform &

m

)

Sets properties according to transformation matrix.

Parameters

m	transformation matrix.

setText()

void ScaleBarItem::setText ( const QString & text )

inline

Sets text.

Parameters

text

text.

setVertical()

void ScaleBarItem::setVertical ( bool vertical )

inline

Sets orientation.

Parameters

vertical

true for vertical, false for horizontal.

writePlo()

void ScaleBarItem::writePlo

(

KConfigGroup *

plo

)

const

Writes into plot file.

Parameters

plo	KConfigGroup object.

---

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

• scalebaritem.h