QElectroTech  0.8-dev
Signals | Public Member Functions | Protected Attributes | Private Member Functions | List of all members
TitleBlockTemplatesCollection Class Referenceabstract

#include <templatescollection.h>

Inheritance diagram for TitleBlockTemplatesCollection:
Inheritance graph
Collaboration diagram for TitleBlockTemplatesCollection:
Collaboration graph

Signals

void changed (TitleBlockTemplatesCollection *, const QString &=QString())
 
void aboutToRemove (TitleBlockTemplatesCollection *, const QString &)
 

Public Member Functions

 TitleBlockTemplatesCollection (QObject *parent)
 
 ~TitleBlockTemplatesCollection () override
 
virtual QStringList templates ()=0
 
virtual TitleBlockTemplategetTemplate (const QString &)=0
 
virtual QDomElement getTemplateXmlDescription (const QString &)=0
 
virtual bool setTemplateXmlDescription (const QString &, const QDomElement &)=0
 
virtual void removeTemplate (const QString &)=0
 
virtual TitleBlockTemplateLocation location (const QString &=QString())=0
 
virtual bool hasFilePath ()=0
 
virtual QString filePath ()=0
 
virtual bool isReadOnly (const QString &=QString()) const =0
 
virtual QString title () const
 
virtual void setTitle (const QString &)
 TitleBlockTemplatesCollection::setTitle. More...
 
virtual QString protocol () const
 
virtual void setProtocol (const QString &)
 
virtual QET::QetCollection collection () const
 TitleBlockTemplatesCollection::collection. More...
 
virtual void setCollection (QET::QetCollection)
 TitleBlockTemplatesCollection::setCollection Set the storage of this collection. More...
 
virtual QETProjectparentProject ()
 
virtual QList< TitleBlockTemplateLocationtemplatesLocations ()
 

Protected Attributes

QString title_
 Human-readable title for this collection. More...
 
QString protocol_
 Protocol used to designate this collection. More...
 
QET::QetCollection m_collection
 
QHash< QString, TitleBlockTemplate * > titleblock_templates_
 Already parsed embedded titleblock templates. More...
 

Private Member Functions

 TitleBlockTemplatesCollection (const TitleBlockTemplatesCollection &)
 

Detailed Description

This abstract class represents a generic collection of title block templates. Unlike elements collections, title block templates collections do not provide a tree structure. Instead, they provide a simple, flat list of available templates.

Constructor & Destructor Documentation

◆ TitleBlockTemplatesCollection() [1/2]

TitleBlockTemplatesCollection::TitleBlockTemplatesCollection ( QObject *  parent)

Constructor

Parameters
parentParent QObject

◆ ~TitleBlockTemplatesCollection()

TitleBlockTemplatesCollection::~TitleBlockTemplatesCollection ( )
override

Destructor

◆ TitleBlockTemplatesCollection() [2/2]

TitleBlockTemplatesCollection::TitleBlockTemplatesCollection ( const TitleBlockTemplatesCollection )
private

Member Function Documentation

◆ aboutToRemove

void TitleBlockTemplatesCollection::aboutToRemove ( TitleBlockTemplatesCollection ,
const QString &   
)
signal
Here is the caller graph for this function:

◆ changed

void TitleBlockTemplatesCollection::changed ( TitleBlockTemplatesCollection ,
const QString &  = QString() 
)
signal
Here is the caller graph for this function:

◆ collection()

QET::QetCollection TitleBlockTemplatesCollection::collection ( ) const
virtual

TitleBlockTemplatesCollection::collection.

Returns
the collection where is stored this collection.

◆ filePath()

virtual QString TitleBlockTemplatesCollection::filePath ( )
pure virtual

◆ getTemplate()

virtual TitleBlockTemplate* TitleBlockTemplatesCollection::getTemplate ( const QString &  )
pure virtual

◆ getTemplateXmlDescription()

virtual QDomElement TitleBlockTemplatesCollection::getTemplateXmlDescription ( const QString &  )
pure virtual

◆ hasFilePath()

virtual bool TitleBlockTemplatesCollection::hasFilePath ( )
pure virtual

◆ isReadOnly()

virtual bool TitleBlockTemplatesCollection::isReadOnly ( const QString &  = QString()) const
pure virtual

◆ location()

virtual TitleBlockTemplateLocation TitleBlockTemplatesCollection::location ( const QString &  = QString())
pure virtual

Implemented in TitleBlockTemplatesFilesCollection, and TitleBlockTemplatesProjectCollection.

Here is the caller graph for this function:

◆ parentProject()

QETProject * TitleBlockTemplatesCollection::parentProject ( )
virtual
Returns
the project this collection is affiliated to, or 0 if this collection is not related to any project.

Reimplemented in TitleBlockTemplatesProjectCollection.

◆ protocol()

QString TitleBlockTemplatesCollection::protocol ( ) const
virtual
Returns
the protocol used by this collection ; examples: commontbt, customtbt, embedtbt, ...

Reimplemented in TitleBlockTemplatesProjectCollection.

Here is the caller graph for this function:

◆ removeTemplate()

virtual void TitleBlockTemplatesCollection::removeTemplate ( const QString &  )
pure virtual

◆ setCollection()

void TitleBlockTemplatesCollection::setCollection ( QET::QetCollection  c)
virtual

TitleBlockTemplatesCollection::setCollection Set the storage of this collection.

Parameters
c

◆ setProtocol()

void TitleBlockTemplatesCollection::setProtocol ( const QString &  protocol)
virtual

Define the protocol for this collection

Parameters
protocolNew protocol for this collection
Here is the call graph for this function:

◆ setTemplateXmlDescription()

virtual bool TitleBlockTemplatesCollection::setTemplateXmlDescription ( const QString &  ,
const QDomElement &   
)
pure virtual

◆ setTitle()

void TitleBlockTemplatesCollection::setTitle ( const QString &  title)
virtual

TitleBlockTemplatesCollection::setTitle.

Parameters
title: New title for this collection
Here is the call graph for this function:

◆ templates()

virtual QStringList TitleBlockTemplatesCollection::templates ( )
pure virtual

Implemented in TitleBlockTemplatesFilesCollection, and TitleBlockTemplatesProjectCollection.

Here is the caller graph for this function:

◆ templatesLocations()

QList< TitleBlockTemplateLocation > TitleBlockTemplatesCollection::templatesLocations ( )
virtual
Returns
the templates contained within this collection, as a list of location objects.
See also
templates()
Here is the call graph for this function:

◆ title()

QString TitleBlockTemplatesCollection::title ( ) const
virtual
Returns
the title of this collection

Reimplemented in TitleBlockTemplatesProjectCollection.

Here is the caller graph for this function:

Member Data Documentation

◆ m_collection

QET::QetCollection TitleBlockTemplatesCollection::m_collection
protected

◆ protocol_

QString TitleBlockTemplatesCollection::protocol_
protected

Protocol used to designate this collection.

◆ title_

QString TitleBlockTemplatesCollection::title_
protected

Human-readable title for this collection.

◆ titleblock_templates_

QHash<QString, TitleBlockTemplate *> TitleBlockTemplatesCollection::titleblock_templates_
protected

Already parsed embedded titleblock templates.


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