TitleBlockTemplateLocation Class Reference

#include <templatelocation.h>

Collaboration diagram for TitleBlockTemplateLocation:

Public Member Functions
	TitleBlockTemplateLocation (const QString &=QString(), TitleBlockTemplatesCollection *=nullptr)
virtual	~TitleBlockTemplateLocation ()
TitleBlockTemplateLocation	locationFromString (const QString &)
TitleBlockTemplatesCollection *	parentCollection () const
void	setParentCollection (TitleBlockTemplatesCollection *)
	TitleBlockTemplateLocation::setParentCollection.
QString	name () const
void	setName (const QString &)
bool	isValid () const
void	fromString (const QString &)
QString	toString () const
QETProject *	parentProject () const
QString	protocol () const
QDomElement	getTemplateXmlDescription () const
TitleBlockTemplate *	getTemplate () const
bool	isReadOnly () const
bool	operator== (const TitleBlockTemplateLocation &) const

Static Public Attributes
static int	MetaTypeId = qRegisterMetaType<TitleBlockTemplateLocation>("TitleBlockTemplateLocation")
	Id of the corresponding Qt meta type.

Private Attributes
TitleBlockTemplatesCollection *	collection_
	Collection the template belongs to.
QString	name_
	Name of the template.

Detailed Description

This class represents the location of a title block template.

Constructor & Destructor Documentation

TitleBlockTemplateLocation()

TitleBlockTemplateLocation::TitleBlockTemplateLocation	(	const QString &	name = QString(),
		TitleBlockTemplatesCollection *	collection = nullptr
	)

Constructor

Parameters

collection	Parent collection of the title block template
name	Name of the title block template within its parent project or collection

~TitleBlockTemplateLocation()

TitleBlockTemplateLocation::~TitleBlockTemplateLocation ( )

virtual

Destructor

Member Function Documentation

fromString()

void TitleBlockTemplateLocation::fromString

(

const QString &

loc_str

)

Parameters

loc_str

String describing the location of a title block template.

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplate()

TitleBlockTemplate * TitleBlockTemplateLocation::getTemplate

(

)

const

This is a convenience method equivalent to parentCollection() -> getTemplate(...).

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplateXmlDescription()

QDomElement TitleBlockTemplateLocation::getTemplateXmlDescription

(

)

const

This is a convenience method equivalent to parentCollection() -> getTemplateXmlDescription

Here is the call graph for this function:

Here is the caller graph for this function:

isReadOnly()

bool TitleBlockTemplateLocation::isReadOnly

(

)

const

This is a convenience method equivalent to parentCollection() -> isReadOnly(name())

Here is the call graph for this function:

Here is the caller graph for this function:

isValid()

bool TitleBlockTemplateLocation::isValid

(

)

const

Returns

true if this location is null, false otherwise

Here is the caller graph for this function:

locationFromString()

TitleBlockTemplateLocation TitleBlockTemplateLocation::locationFromString

(

const QString &

loc_str

)

Parameters

loc_str

String describing the location of a title block template.

Here is the call graph for this function:

name()

QString TitleBlockTemplateLocation::name

(

)

const

Returns

the name of this template within its parent project or collection.

Here is the caller graph for this function:

operator==()

bool TitleBlockTemplateLocation::operator==

(

const TitleBlockTemplateLocation &

location

)

const

Parameters

location

other location that should be compared to this one

Returns

true if locations are equal, false otherwise

parentCollection()

TitleBlockTemplatesCollection * TitleBlockTemplateLocation::parentCollection

(

)

const

Returns

the parent collection of the template, or 0 if none was defined

Here is the caller graph for this function:

parentProject()

QETProject * TitleBlockTemplateLocation::parentProject

(

)

const

This is a convenience method equivalent to parentCollection() -> parentProject().

Here is the call graph for this function:

Here is the caller graph for this function:

protocol()

QString TitleBlockTemplateLocation::protocol

(

)

const

This is a convenience method equivalent to parentCollection() -> protocol().

Here is the call graph for this function:

Here is the caller graph for this function:

setName()

void TitleBlockTemplateLocation::setName

(

const QString &

name

)

Parameters

name	The new name of this template.

Here is the call graph for this function:

Here is the caller graph for this function:

setParentCollection()

void TitleBlockTemplateLocation::setParentCollection

(

TitleBlockTemplatesCollection *

collection

)

TitleBlockTemplateLocation::setParentCollection.

Parameters

collection

: TitleBlockTemplatesCollection

Here is the caller graph for this function:

toString()

QString TitleBlockTemplateLocation::toString

(

)

const

Returns

A string representation of the location

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

collection_

TitleBlockTemplatesCollection* TitleBlockTemplateLocation::collection_

private

Collection the template belongs to.

MetaTypeId

int TitleBlockTemplateLocation::MetaTypeId = qRegisterMetaType<TitleBlockTemplateLocation>("TitleBlockTemplateLocation")

static

Id of the corresponding Qt meta type.

name_

QString TitleBlockTemplateLocation::name_

private

Name of the template.

---

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

• sources/titleblock/templatelocation.h
• sources/titleblock/templatelocation.cpp