QElectroTech 0.100.0-dev
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | List of all members
TitleBlockProperties Class Reference

#include <titleblockproperties.h>

Collaboration diagram for TitleBlockProperties:
Collaboration graph

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.
 
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.
 

Public 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 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, ...

Member Enumeration Documentation

◆ DateManagement

Lists the various ways to handle the date.

Enumerator
UseDateValue 

use the date attribute

CurrentDate 

use the current date

Constructor & Destructor Documentation

◆ TitleBlockProperties()

TitleBlockProperties::TitleBlockProperties ( )

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

◆ ~TitleBlockProperties()

TitleBlockProperties::~TitleBlockProperties ( )
virtual

Destructeur

Member Function Documentation

◆ defaultProperties()

TitleBlockProperties TitleBlockProperties::defaultProperties ( )
static

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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
Here is the caller graph for this function:

◆ finalDate()

QDate TitleBlockProperties::finalDate ( ) const
Returns
La date a utiliser

◆ fromSettings()

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

Importe le cartouche depuis une configuration.

Parameters
settingsParametres a lire
prefixprefixe a ajouter devant les noms des parametres
Here is the call graph for this function:
Here is the caller graph for this function:

◆ fromXml()

void TitleBlockProperties::fromXml ( const QDomElement &  e)

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

Parameters
eElement XML dont les attributs seront lus
Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator!=()

bool TitleBlockProperties::operator!= ( const TitleBlockProperties ip)
Parameters
ipautre conteneur TitleBlockProperties
Returns
false si ip et ce conteneur sont identiques, true sinon

◆ operator==()

bool TitleBlockProperties::operator== ( const TitleBlockProperties ip)
Parameters
ipautre conteneur TitleBlockProperties
Returns
true si ip et ce conteneur sont identiques, false sinon

◆ setAutoPageNum()

void TitleBlockProperties::setAutoPageNum ( QString  autonum)
inline
Here is the caller graph for this function:

◆ setDateFromString()

void TitleBlockProperties::setDateFromString ( const QString &  date_string)
private

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

Parameters
date_stringChaine de caracteres a analyser
See also
exportDate
Here is the caller graph for this function:

◆ 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
Here is the call graph for this function:

◆ toXml()

void TitleBlockProperties::toXml ( QDomElement &  e) const

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

Parameters
eElement XML auquel seront ajoutes des attributs
Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ author

QString TitleBlockProperties::author

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

◆ auto_page_num

QString TitleBlockProperties::auto_page_num

◆ collection

QET::QetCollection TitleBlockProperties::collection

Specify the location of the title block.

◆ context

DiagramContext TitleBlockProperties::context

Container for the additional, user-defined fields.

◆ date

QDate TitleBlockProperties::date

Date (displayed by the default template)

◆ display_at

Qt::Edge TitleBlockProperties::display_at

Edge to display the titleblock.

◆ filename

QString TitleBlockProperties::filename

Filename (displayed by the default template)

◆ folio

QString TitleBlockProperties::folio

Folio information (displayed by the default template)

◆ indexrev

QString TitleBlockProperties::indexrev

Revision Index (displayed by the default template)

◆ locmach

QString TitleBlockProperties::locmach

Location(displayed by the default template)

◆ plant

QString TitleBlockProperties::plant

Plant (displayed by the default template)

◆ 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".

◆ title

QString TitleBlockProperties::title

Folio title (displayed by the default template)

◆ useDate

DateManagement TitleBlockProperties::useDate

Wheter to use the date attribute.

◆ version

QString TitleBlockProperties::version

Version (displayed by the default template)


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