qelectrotech-source-mirror/sources/titleblockproperties.h
Laurent Trinques 77bfe84a4c One year
2025-01-04 13:37:40 +01:00

75 lines
2.9 KiB
C++

/*
Copyright 2006-2025 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 TITLEBLOCK_PROPERTIES_H
#define TITLEBLOCK_PROPERTIES_H
#include <QtXml>
#include "diagramcontext.h"
#include "qet.h"
/**
This class provides a container for the properties of a particular title
block, i.e. title, author, date, filename, folio, template, custom
properties, ...
*/
class TitleBlockProperties {
public:
TitleBlockProperties();
virtual ~TitleBlockProperties();
/// Lists the various ways to handle the date
enum DateManagement {
UseDateValue, ///< use the date attribute
CurrentDate ///< use the current date
};
bool operator==(const TitleBlockProperties &);
bool operator!=(const TitleBlockProperties &);
void toXml(QDomElement &) const;
void fromXml(const QDomElement &);
void toSettings(QSettings &, const QString & = QString()) const;
void fromSettings(QSettings &, const QString & = QString());
void setAutoPageNum(QString autonum) {auto_page_num = autonum;}
static TitleBlockProperties defaultProperties();
QDate finalDate() const ;
// attributes
QString title; ///< Folio title (displayed by the default template)
QString author; ///< Author of the diagram/folio (displayed by the default template)
QDate date; ///< Date (displayed by the default template)
QString filename; ///< Filename (displayed by the default template)
QString plant; ///< Plant (displayed by the default template)
QString locmach; ///< Location(displayed by the default template)
QString indexrev; ///< Revision Index (displayed by the default template)
QString version; ///< Version (displayed by the default template)
QString folio; ///< Folio information (displayed by the default template)
QString auto_page_num;
DateManagement useDate; ///< Wheter to use the date attribute
QString template_name; ///< Name of the template used to render the title block - an empty string means "the default template provided by the application"
DiagramContext context; ///< Container for the additional, user-defined fields
Qt::Edge display_at; ///< Edge to display the titleblock
QET::QetCollection collection; ///<Specify the location of the title block
private:
QString exportDate() const;
void setDateFromString(const QString &);
};
#endif