#include <titleblockproperties.h>

Public Types
enum	DateManagement { UseDateValue, CurrentDate }
	Lists the various ways to handle the date. More...

Public Member Functions
	TitleBlockProperties ()

virtual	~TitleBlockProperties ()

bool	operator== (const TitleBlockProperties &)

bool	operator!= (const TitleBlockProperties &)

void	toXml (QDomElement &) const

void	fromXml (const QDomElement &)

void	toSettings (QSettings &, const QString &=QString()) const
	TitleBlockProperties::toSettings Export the TitleBlockProperties into a QSettings. More...

void	fromSettings (QSettings &, const QString &=QString())

void	setAutoPageNum (QString autonum)

QDate	finalDate () const

Static Public Member Functions
static TitleBlockProperties	defaultProperties ()
	TitleBlockProperties::defaultProperties Return the default properties stored in the setting file. More...

Public Attributes
QString	title
	Folio title (displayed by the default template) More...

QString	author
	Author of the diagram/folio (displayed by the default template) More...

QDate	date
	Date (displayed by the default template) More...

QString	filename
	Filename (displayed by the default template) More...

QString	plant
	Plant (displayed by the default template) More...

QString	locmach
	Location(displayed by the default template) More...

QString	indexrev
	Revision Index (displayed by the default template) More...

QString	version
	Version (displayed by the default template) More...

QString	folio
	Folio information (displayed by the default template) More...

QString	auto_page_num

QString	location

DateManagement	useDate
	Wheter to use the date attribute. More...

QString	template_name
	Name of the template used to render the title block - an empty string means "the default template provided by the application". More...

DiagramContext	context
	Container for the additional, user-defined fields. More...

Qt::Edge	display_at
	Edge to display the titleblock. More...

QET::QetCollection	collection
	Specify the location of the title block. More...

Private Member Functions
QString	exportDate () const

void	setDateFromString (const QString &)

Detailed Description

This class provides a container for the properties of a particular title block, i.e. title, author, date, filename, folio, template, custom properties, ...

Definition at line 28 of file titleblockproperties.h.

Member Enumeration Documentation

◆ DateManagement

enum TitleBlockProperties::DateManagement

Lists the various ways to handle the date.

Enumerator
UseDateValue	use the date attribute
CurrentDate	use the current date

Definition at line 33 of file titleblockproperties.h.

Constructor & Destructor Documentation

◆ TitleBlockProperties()

TitleBlockProperties::TitleBlockProperties ( )

Constructeur. Initialise un objet TitleBlockProperties avec tous les champs vides (date vide + useDate a UseDateValue).

Definition at line 26 of file titleblockproperties.cpp.

◆ ~TitleBlockProperties()

TitleBlockProperties::~TitleBlockProperties ( )

virtual

Destructeur

Definition at line 37 of file titleblockproperties.cpp.

Member Function Documentation

◆ defaultProperties()

TitleBlockProperties TitleBlockProperties::defaultProperties ( )

static

TitleBlockProperties::defaultProperties Return the default properties stored in the setting file.

Definition at line 182 of file titleblockproperties.cpp.

References fromSettings().

Referenced by NewDiagramPage::NewDiagramPage(), QETDiagramEditor::newProject(), and QETProject::readDefaultPropertiesXml().

◆ exportDate()

QString TitleBlockProperties::exportDate ( ) const

private

Returns: une chaine de caracteres decrivant comment gerer la date dans le cartouche : la chaine peut valoir : null pour ne pas afficher de date now pour afficher la date courante (a la creation du schema) une date au format yyyyMMdd pour utiliser une date fixe

Definition at line 210 of file titleblockproperties.cpp.

References date, useDate, and UseDateValue.

Referenced by toSettings(), and toXml().

◆ finalDate()

QDate TitleBlockProperties::finalDate ( ) const

Returns: La date a utiliser

Definition at line 195 of file titleblockproperties.cpp.

References date, useDate, and UseDateValue.

◆ fromSettings()

void TitleBlockProperties::fromSettings	(	QSettings &	settings,
		const QString &	prefix = `QString()`
	)

Importe le cartouche depuis une configuration.

Parameters

settings	Parametres a lire
prefix	prefixe a ajouter devant les noms des parametres

Definition at line 161 of file titleblockproperties.cpp.

References author, auto_page_num, collection, context, display_at, filename, folio, DiagramContext::fromSettings(), indexrev, locmach, plant, QET::qetCollectionFromString(), setDateFromString(), template_name, title, and version.

Referenced by defaultProperties().

◆ fromXml()

void TitleBlockProperties::fromXml ( const QDomElement & e )

Importe le cartouche a partir des attributs XML de l'element e

Parameters

e	Element XML dont les attributs seront lus

Definition at line 105 of file titleblockproperties.cpp.

References author, auto_page_num, DiagramContext::clear(), collection, context, display_at, filename, QET::findInDomElement(), folio, DiagramContext::fromXml(), indexrev, locmach, plant, QET::qetCollectionFromString(), setDateFromString(), template_name, title, and version.

Referenced by QETProject::readDefaultPropertiesXml(), and BorderTitleBlock::titleBlockFromXml().

◆ operator!=()

bool TitleBlockProperties::operator!= ( const TitleBlockProperties & ip )

Parameters

ip	autre conteneur TitleBlockProperties

Returns: false si ip et ce conteneur sont identiques, true sinon

Definition at line 67 of file titleblockproperties.cpp.

◆ operator==()

bool TitleBlockProperties::operator== ( const TitleBlockProperties & ip )

Parameters

ip	autre conteneur TitleBlockProperties

Returns: true si ip et ce conteneur sont identiques, false sinon

Definition at line 44 of file titleblockproperties.cpp.

References author, auto_page_num, collection, context, date, display_at, filename, folio, indexrev, locmach, plant, template_name, title, and version.

◆ setAutoPageNum()

void TitleBlockProperties::setAutoPageNum ( QString autonum )

inline

Definition at line 46 of file titleblockproperties.h.

References auto_page_num.

Referenced by AutoNumberingDockWidget::on_m_folio_cb_activated().

◆ setDateFromString()

void TitleBlockProperties::setDateFromString ( const QString & date_string )

private

Charge les attributs date et useDate a partir d'une chaine de caracteres.

Parameters

date_string Chaine de caracteres a analyser

See also: exportDate

Definition at line 226 of file titleblockproperties.cpp.

References CurrentDate, date, useDate, and UseDateValue.

Referenced by fromSettings(), and fromXml().

◆ toSettings()

void TitleBlockProperties::toSettings	(	QSettings &	settings,
		const QString &	prefix = `QString()`
	)		const

TitleBlockProperties::toSettings Export the TitleBlockProperties into a QSettings.

Parameters

settings	: setting to use
prefix	: name to use as prefix for this property

Definition at line 139 of file titleblockproperties.cpp.

References author, auto_page_num, collection, context, display_at, exportDate(), filename, folio, indexrev, locmach, plant, QET::qetCollectionToString(), template_name, title, DiagramContext::toSettings(), and version.

◆ toXml()

void TitleBlockProperties::toXml ( QDomElement & e ) const

Exporte le cartouche sous formes d'attributs XML ajoutes a l'element e.

Parameters

e	Element XML auquel seront ajoutes des attributs

Definition at line 76 of file titleblockproperties.cpp.

References author, auto_page_num, collection, context, display_at, exportDate(), filename, folio, indexrev, DiagramContext::keys(), locmach, plant, QET::qetCollectionToString(), template_name, title, DiagramContext::toXml(), and version.

Referenced by BorderTitleBlock::titleBlockToXml(), and QETProject::writeDefaultPropertiesXml().

Member Data Documentation

◆ author

QString TitleBlockProperties::author

Author of the diagram/folio (displayed by the default template)

Definition at line 54 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), BorderTitleBlock::importTitleBlock(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), SearchAndReplaceWorker::replaceAdvanced(), SearchAndReplaceWorker::replaceDiagram(), SearchAndReplaceWidget::searchTerms(), TitleBlockPropertiesWidget::setProperties(), ReplaceFolioWidget::setTitleBlockProperties(), ReplaceFolioWidget::titleBlockProperties(), toSettings(), and toXml().

◆ auto_page_num

QString TitleBlockProperties::auto_page_num

Definition at line 62 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), BorderTitleBlock::importTitleBlock(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), AutoNumberingDockWidget::setActive(), setAutoPageNum(), TitleBlockPropertiesWidget::setProperties(), toSettings(), and toXml().

◆ collection

QET::QetCollection TitleBlockProperties::collection

Specify the location of the title block.

Definition at line 68 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), QETProject::setDefaultTitleBlockProperties(), TitleBlockPropertiesWidget::setProperties(), toSettings(), and toXml().

◆ context

DiagramContext TitleBlockProperties::context

Container for the additional, user-defined fields.

Definition at line 66 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), BorderTitleBlock::importTitleBlock(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), SearchAndReplaceWorker::replaceDiagram(), SearchAndReplaceWidget::searchTerms(), TitleBlockPropertiesWidget::setProperties(), ReplaceFolioWidget::setTitleBlockProperties(), ReplaceFolioWidget::titleBlockProperties(), toSettings(), and toXml().

◆ date

QDate TitleBlockProperties::date

Date (displayed by the default template)

Definition at line 55 of file titleblockproperties.h.

Referenced by exportDate(), BorderTitleBlock::exportTitleBlock(), finalDate(), BorderTitleBlock::importTitleBlock(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), SearchAndReplaceWorker::replaceDiagram(), SearchAndReplaceWidget::searchTerms(), setDateFromString(), TitleBlockPropertiesWidget::setProperties(), ReplaceFolioWidget::setTitleBlockProperties(), and ReplaceFolioWidget::titleBlockProperties().

◆ display_at

Qt::Edge TitleBlockProperties::display_at

Edge to display the titleblock.

Definition at line 67 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), BorderTitleBlock::importTitleBlock(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), TitleBlockPropertiesWidget::setProperties(), toSettings(), and toXml().

◆ filename

QString TitleBlockProperties::filename

Filename (displayed by the default template)

Definition at line 56 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), BorderTitleBlock::importTitleBlock(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), SearchAndReplaceWorker::replaceAdvanced(), SearchAndReplaceWorker::replaceDiagram(), SearchAndReplaceWidget::searchTerms(), TitleBlockPropertiesWidget::setProperties(), ReplaceFolioWidget::setTitleBlockProperties(), ReplaceFolioWidget::titleBlockProperties(), toSettings(), and toXml().

◆ folio

QString TitleBlockProperties::folio

Folio information (displayed by the default template)

Definition at line 61 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), BorderTitleBlock::importTitleBlock(), AutoNumberingDockWidget::on_m_folio_cb_activated(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), SearchAndReplaceWorker::replaceAdvanced(), SearchAndReplaceWorker::replaceDiagram(), SearchAndReplaceWidget::searchTerms(), AutoNumberingDockWidget::setActive(), TitleBlockPropertiesWidget::setProperties(), ReplaceFolioWidget::setTitleBlockProperties(), ReplaceFolioWidget::titleBlockProperties(), toSettings(), and toXml().

◆ indexrev

QString TitleBlockProperties::indexrev

Revision Index (displayed by the default template)

Definition at line 59 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), BorderTitleBlock::importTitleBlock(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), SearchAndReplaceWorker::replaceAdvanced(), SearchAndReplaceWorker::replaceDiagram(), SearchAndReplaceWidget::searchTerms(), TitleBlockPropertiesWidget::setProperties(), ReplaceFolioWidget::setTitleBlockProperties(), ReplaceFolioWidget::titleBlockProperties(), toSettings(), and toXml().

◆ location

QString TitleBlockProperties::location

Definition at line 63 of file titleblockproperties.h.

◆ locmach

QString TitleBlockProperties::locmach

Location(displayed by the default template)

Definition at line 58 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), BorderTitleBlock::importTitleBlock(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), SearchAndReplaceWorker::replaceAdvanced(), SearchAndReplaceWorker::replaceDiagram(), SearchAndReplaceWidget::searchTerms(), TitleBlockPropertiesWidget::setProperties(), ReplaceFolioWidget::setTitleBlockProperties(), ReplaceFolioWidget::titleBlockProperties(), toSettings(), and toXml().

◆ plant

QString TitleBlockProperties::plant

Plant (displayed by the default template)

Definition at line 57 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), BorderTitleBlock::importTitleBlock(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), SearchAndReplaceWorker::replaceAdvanced(), SearchAndReplaceWorker::replaceDiagram(), SearchAndReplaceWidget::searchTerms(), TitleBlockPropertiesWidget::setProperties(), ReplaceFolioWidget::setTitleBlockProperties(), ReplaceFolioWidget::titleBlockProperties(), toSettings(), and toXml().

◆ template_name

QString TitleBlockProperties::template_name

Name of the template used to render the title block - an empty string means "the default template provided by the application".

Definition at line 65 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), DiagramView::handleTitleBlockDrop(), BorderTitleBlock::importTitleBlock(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), QETProject::setDefaultTitleBlockProperties(), TitleBlockPropertiesWidget::setProperties(), toSettings(), and toXml().

◆ title

QString TitleBlockProperties::title

Folio title (displayed by the default template)

Definition at line 53 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), BorderTitleBlock::importTitleBlock(), operator==(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), SearchAndReplaceWorker::replaceAdvanced(), SearchAndReplaceWorker::replaceDiagram(), SearchAndReplaceWidget::searchTerms(), TitleBlockPropertiesWidget::setProperties(), ReplaceFolioWidget::setTitleBlockProperties(), ReplaceFolioWidget::titleBlockProperties(), toSettings(), and toXml().

◆ useDate

DateManagement TitleBlockProperties::useDate

Wheter to use the date attribute.

Definition at line 64 of file titleblockproperties.h.

Referenced by exportDate(), finalDate(), TitleBlockPropertiesWidget::properties(), TitleBlockPropertiesWidget::propertiesAutoNum(), setDateFromString(), TitleBlockPropertiesWidget::setProperties(), ReplaceFolioWidget::setTitleBlockProperties(), and ReplaceFolioWidget::titleBlockProperties().

◆ version

QString TitleBlockProperties::version

Version (displayed by the default template)

Definition at line 60 of file titleblockproperties.h.

Referenced by BorderTitleBlock::exportTitleBlock(), fromSettings(), fromXml(), operator==(), toSettings(), and toXml().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ DateManagement

Constructor & Destructor Documentation

◆ TitleBlockProperties()

◆ ~TitleBlockProperties()

Member Function Documentation

◆ defaultProperties()

◆ exportDate()

◆ finalDate()

◆ fromSettings()

◆ fromXml()

◆ operator!=()

◆ operator==()

◆ setAutoPageNum()

◆ setDateFromString()

◆ toSettings()

◆ toXml()

Member Data Documentation

◆ author

◆ auto_page_num

◆ collection

◆ context

◆ date

◆ display_at

◆ filename

◆ folio

◆ indexrev

◆ location

◆ locmach

◆ plant

◆ template_name

◆ title

◆ useDate

◆ version