scorpio810 9c24163556 Add new description field
git-svn-id: svn+ssh://svn.tuxfamily.org/svnroot/qet/qet/trunk@5059 bfdf4180-ca20-0410-9c96-a3a8aa849046
2017-10-02 16:59:53 +00:00

85 lines
3.2 KiB
C++

/*
Copyright 2006-2017 The QElectroTech Team
This file is part of QElectroTech.
QElectroTech 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.
QElectroTech 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with QElectroTech. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef DIAGRAM_CONTEXT_H
#define DIAGRAM_CONTEXT_H
#include <QDomElement>
#include <QHash>
#include <QSettings>
#include <QString>
#include <QVariant>
#include <QStringList>
/**
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.
* 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
* auxiliary1 -> auxiliary 1 of element
* auxiliary2 -> auxiliary 2 of element
* machine-manufacturer-reference -> reference of the manufacturer machine
* function -> the function of element
* location -> the location of the element
* frozenLabel -> label locked at a given time
*
*/
class DiagramContext
{
public:
enum KeyOrder {
None,
Alphabetical,
DecreasingLength
};
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;
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 QString validKeyRegExp();
private:
static bool stringLongerThan(const QString &, const QString &);
bool keyIsAcceptable(const QString &) const;
/// Diagram context data (key/value pairs)
QHash<QString, QVariant> m_content;
QHash<QString, bool> m_content_show;
};
#endif