#include <diagramcontext.h>

Public Types
enum	KeyOrder { None, Alphabetical, DecreasingLength }

Public Member Functions
void	add (DiagramContext other)
	DiagramContext::add Add all value of to this. If a key already exist, the value is replaced. If a key doesn't exist, she will be added. All other keys of this context, which are not present in , stay unchanged. More...

QList< QString >	keys (KeyOrder=None) const

bool	contains (const QString &) const

const QVariant	operator[] (const QString &) const

bool	addValue (const QString &, const QVariant &, bool show=true)

QVariant	value (const QString &key) const

void	clear ()

int	count ()

bool	keyMustShow (const QString &) const
	DiagramContext::keyMustShow. More...

bool	operator== (const DiagramContext &) const

bool	operator!= (const DiagramContext &) const

void	toXml (QDomElement &, const QString &="property") const

void	fromXml (const QDomElement &, const QString &="property")

void	toSettings (QSettings &, const QString &) const

void	fromSettings (QSettings &, const QString &)

Static Public Member Functions
static QString	validKeyRegExp ()

Private Member Functions
bool	keyIsAcceptable (const QString &) const

Static Private Member Functions
static bool	stringLongerThan (const QString &, const QString &)

Private Attributes
QHash< QString, QVariant >	m_content
	Diagram context data (key/value pairs) More...

QHash< QString, bool >	m_content_show

Detailed Description

This class represents a diagram context, i.e. the data (a list of key/value pairs) of a diagram at a given time. It is notably used by titleblock templates to fetch the informations they need to do their rendering, or element for retrieve information about itself Key for element : label -> label or identification of element formula -> formula used to create the label (formula is make with variable) designation -> exhaustive comment used to explain what the element does. description -> exhaustive description used to explain what the element does. plant -> the plant assigned to the element comment -> a little comment wich can be displayed in the folio manufacturer -> the manufacturer of the element manufacturer-reference -> the manufacturer reference of the element quantity -> quantity of the element unity -> unity of the element auxiliary1 -> auxiliary 1 of element auxiliary2 -> auxiliary 2 of element machine-manufacturer-reference -> reference of the machine manufacturer supplier -> the supplier of the element function -> the function of element location -> the location assigned to the element frozenLabel -> label locked at a given time

Definition at line 53 of file diagramcontext.h.

Member Enumeration Documentation

◆ KeyOrder

enum DiagramContext::KeyOrder

Enumerator
None
Alphabetical
DecreasingLength

Definition at line 56 of file diagramcontext.h.

Member Function Documentation

◆ add()

void DiagramContext::add ( DiagramContext other )

DiagramContext::add Add all value of to this. If a key already exist, the value is replaced. If a key doesn't exist, she will be added. All other keys of this context, which are not present in , stay unchanged.

Parameters

other

Definition at line 31 of file diagramcontext.cpp.

References addValue(), keys(), and value().

Referenced by SearchAndReplaceWorker::replaceDiagram().

◆ addValue()

bool DiagramContext::addValue	(	const QString &	key,
		const QVariant &	value,
		bool	show = `true`
	)

Parameters

key	key to insert in the context - the key may only contain lowercase letters and dashes. If embedded key is set, key must be find it else value is not added.