The BorderTitleBlock class This class represents the border and the titleblock which frame a particular electric diagram. More...

#include <bordertitleblock.h>

Inherits QObject.

Collaboration diagram for BorderTitleBlock:

Public Slots
void	titleBlockTemplateChanged (const QString &)
	BorderTitleBlock::titleBlockTemplateChanged This slot may be used to inform this class that the given title block template has changed. The title block-dedicated rendering cache will thus be flushed. More...

void	titleBlockTemplateRemoved (const QString &, const TitleBlockTemplate *=nullptr)
	BorderTitleBlock::titleBlockTemplateRemoved This slot has to be used to inform this class that the given title block template is about to be removed and is no longer accessible. This class will either use the provided optional TitleBlockTemplate or the default title block provided by QETApp::defaultTitleBlockTemplate() More...

void	displayTitleBlock (bool)
	BorderTitleBlock::displayTitleBlock. More...

void	displayColumns (bool)
	BorderTitleBlock::displayColumns. More...

void	displayRows (bool)
	BorderTitleBlock::displayRows. More...

void	displayBorder (bool)
	BorderTitleBlock::displayBorder. More...

void	slot_setAutoPageNum (QString)
	BorderTitleBlock::slot_setAutoPageNum. More...

Signals
void	borderChanged (QRectF old_border, QRectF new_border)
	borderChanged Signal emitted after the border has changed More...

void	displayChanged ()
	displayChanged Signal emitted after display options have changed More...

void	diagramTitleChanged (const QString &)
	diagramTitleChanged Signal emitted after the title has changed More...

void	titleBlockFolioChanged (const QString &)
	titleBlockFolioChanged Signal emitted after Folio has changed More...

void	needFolioData ()
	needFolioData Signal emitted when the title block requires its data to be updated in order to generate the folio field. More...

void	needTitleBlockTemplate (const QString &)
	needTitleBlockTemplate Signal emitted when this object needs to set a specific title block template. This object cannot handle the job since it does not know of its parent project. More...

Public Member Functions
	BorderTitleBlock (QObject *=nullptr)
	BorderTitleBlock::BorderTitleBlock Simple constructor: build a border by recovering the dimensions in the application configuration. More...

	~BorderTitleBlock () override
	BorderTitleBlock::~BorderTitleBlock. More...

void	draw (QPainter *painter)
	BorderTitleBlock::draw Draw the border and the titleblock. More...

void	drawDxf (int, int, bool, QString &, int)
	BorderTitleBlock::drawDxf. More...

int	columnsCount () const

qreal	columnsWidth () const

qreal	columnsTotalWidth () const

qreal	columnsHeaderHeight () const

int	rowsCount () const

qreal	rowsHeight () const

qreal	rowsTotalHeight () const

qreal	rowsHeaderWidth () const

qreal	diagramWidth () const
	diagramWidth More...

qreal	diagramHeight () const
	diagramHeight More...

QRectF	titleBlockRect () const
	BorderTitleBlock::titleBlockRect. More...

DiagramContext	titleblockInformation () const
	BorderTitleBlock::titleblockInformation. More...

QRectF	borderAndTitleBlockRect () const
	BorderTitleBlock::borderAndTitleBlockRect. More...

QRectF	columnsRect () const
	BorderTitleBlock::columnsRect. More...

QRectF	rowsRect () const
	BorderTitleBlock::rowsRect. More...

QRectF	outsideBorderRect () const
	BorderTitleBlock::outsideBorderRect. More...

QRectF	insideBorderRect () const
	BorderTitleBlock::insideBorderRect. More...

QString	author () const

QDate	date () const

QString	title () const

QString	folio () const

QString	finalfolio () const

QString	plant () const

QString	locmach () const

QString	indexrev () const

QString	fileName () const

QString	version () const

DiagramContext	additionalFields () const

QString	autoPageNum () const

int	folioTotal () const

bool	titleBlockIsDisplayed () const

bool	columnsAreDisplayed () const

bool	rowsAreDisplayed () const

bool	borderIsDisplayed () const

void	setColumnsCount (int)
	BorderTitleBlock::setColumnsCount Allows you to change the number of columns. If this number of columns is less than the minimum required, it is this minimum which is used. More...

void	setRowsCount (int)
	BorderTitleBlock::setRowsCount Allows you to change the number of lines. If this number of lines is lower than the minimum required, this function does nothing. More...

void	setColumnsWidth (const qreal &)
	BorderTitleBlock::setColumnsWidth Change the width of the columns. If the width indicated is less than the minimum required, it is this minimum which is used. More...

void	setRowsHeight (const qreal &)
	BorderTitleBlock::setRowsHeight Change the height of the lines. If the indicated height is lower than the minimum required, it is this minimum which is used. More...

void	setColumnsHeaderHeight (const qreal &)
	BorderTitleBlock::setColumnsHeaderHeight Change the height of the headers containing the column numbers. This must remain between 5 and 50 px. More...

void	setRowsHeaderWidth (const qreal &)
	BorderTitleBlock::setRowsHeaderWidth Change the width of the headers containing the line numbers. This must remain between 5 and 50 px. More...

void	setDiagramHeight (const qreal &)
	BorderTitleBlock::setDiagramHeight This method tries to get as close as possible to the given height as a parameter by modifying the number of rows in progress. More...

DiagramPosition	convertPosition (const QPointF &)
	BorderTitleBlock::convertPosition Convert a Point in cartesian coordinate (x : 12.5, 56.9) to a point in grid coordinate (ex : B2) More...

void	setAuthor (const QString &author)
	BorderTitleBlock::setAuthor. More...

void	setDate (const QDate &date)
	BorderTitleBlock::setDate. More...

void	setTitle (const QString &title)
	BorderTitleBlock::setTitle. More...

void	setFolio (const QString &folio)
	BorderTitleBlock::setFolio. More...

void	setFolioData (int, int, const QString &=nullptr, const DiagramContext &=DiagramContext())
	BorderTitleBlock::setFolioData. More...

void	setPlant (const QString &plant)
	BorderTitleBlock::setPlant. More...

void	setLocMach (const QString &locmach)
	BorderTitleBlock::setLocMach. More...

void	setIndicerev (const QString &indexrev)
	BorderTitleBlock::setIndicerev. More...

void	setFileName (const QString &filename)
	BorderTitleBlock::setFileName. More...

void	setVersion (const QString &version)
	BorderTitleBlock::setVersion. More...

void	setAutoPageNum (const QString &auto_page_num)
	BorderTitleBlock::setAutoPageNum. More...

void	setPreviousFolioNum (const QString &previous)
	BorderTitleBlock::setPreviousFolioNum. More...

void	setNextFolioNum (const QString &next)
	BorderTitleBlock::setNextFolioNum. More...

void	titleBlockToXml (QDomElement &)
	BorderTitleBlock::titleBlockToXml Exports the title block current values to XML. More...

void	titleBlockFromXml (const QDomElement &)
	BorderTitleBlock::titleBlockFromXml Reads the title block values from XML. More...

void	borderToXml (QDomElement &)
	BorderTitleBlock::borderToXml Exports the border current settings to XML. More...

void	borderFromXml (const QDomElement &)
	BorderTitleBlock::borderFromXml Reads the border settings from XML. More...

TitleBlockProperties	exportTitleBlock ()
	BorderTitleBlock::exportTitleBlock. More...

void	importTitleBlock (const TitleBlockProperties &)
	BorderTitleBlock::importTitleBlock. More...

BorderProperties	exportBorder ()
	BorderTitleBlock::exportBorder. More...

void	importBorder (const BorderProperties &)
	BorderTitleBlock::importBorder. More...

const TitleBlockTemplate *	titleBlockTemplate ()
	BorderTitleBlock::titleBlockTemplate. More...

void	setTitleBlockTemplate (const TitleBlockTemplate *)
	BorderTitleBlock::setTitleBlockTemplate. More...

QString	titleBlockTemplateName () const
	BorderTitleBlock::titleBlockTemplateName. More...

Private Member Functions
	BorderTitleBlock (const BorderTitleBlock &)

QRectF	titleBlockRectForQPainter () const
	BorderTitleBlock::titleBlockRectForQPainter. More...

void	updateRectangles ()
	BorderTitleBlock::updateRectangles This method update the diagram rect according to the value of rows and columns (number and size) More...

void	updateDiagramContextForTitleBlock (const DiagramContext &=DiagramContext())
	BorderTitleBlock::updateDiagramContextForTitleBlock Update the informations given to the titleblock template by regenerating a DiagramContext object. More...

QString	incrementLetters (const QString &)
	BorderTitleBlock::incrementLetters increments string with Letters A to Z. More...

Private Attributes
QString	btb_author_
	titleblock author More...

QDate	btb_date_
	titleblock date More...

QString	btb_title_
	titleblock title More...

QString	btb_folio_
	titleblock folio More...

QString	btb_plant_
	titleblock plant More...

QString	btb_locmach_
	titleblock locmach More...

QString	btb_indexrev_
	titleblock index rev More...

QString	btb_final_folio_
	titleblock final folio More...

QString	btb_auto_page_num_
	titleblock auto page num More...

int	folio_index_
	titleblock index More...

int	folio_total_
	titleblock total More...

QString	btb_filename_
	titleblock filename More...

QString	btb_version_

DiagramContext	additional_fields_
	titleblock additional fields More...

Qt::Edge	m_edge
	titleblock edge More...

QString	m_next_folio_num
	titleblock next folio num More...

QString	m_previous_folio_num
	titleblock previous folio num More...

int	columns_count_
	columns count More...

qreal	columns_width_
	columns width More...

qreal	columns_header_height_
	columns header height More...

int	rows_count_
	rows count More...

qreal	rows_height_
	rows height More...

qreal	rows_header_width_
	rows header width More...

qreal	titleblock_height_

QRectF	diagram_rect_

bool	display_titleblock_

bool	display_columns_

bool	display_rows_

bool	display_border_

TitleBlockTemplateRenderer *	m_titleblock_template_renderer

Detailed Description

The BorderTitleBlock class This class represents the border and the titleblock which frame a particular electric diagram.

Constructor & Destructor Documentation

◆ BorderTitleBlock() [1/2]

BorderTitleBlock::BorderTitleBlock ( QObject * parent = nullptr )

BorderTitleBlock::BorderTitleBlock Simple constructor: build a border by recovering the dimensions in the application configuration.

Parameters

parent :

Here is the call graph for this function:

◆ ~BorderTitleBlock()

BorderTitleBlock::~BorderTitleBlock ( )

override

BorderTitleBlock::~BorderTitleBlock.

◆ BorderTitleBlock() [2/2]

BorderTitleBlock::BorderTitleBlock ( const BorderTitleBlock & )

private

Member Function Documentation

◆ additionalFields()

DiagramContext BorderTitleBlock::additionalFields ( ) const

inline

Returns: the value of the title block Additional Fields

Here is the caller graph for this function:

◆ author()

QString BorderTitleBlock::author ( ) const

inline

Returns: the value of the title block "Author" field

Here is the caller graph for this function:

◆ autoPageNum()

QString BorderTitleBlock::autoPageNum ( ) const

inline

Returns: the value of the title block

Here is the caller graph for this function:

◆ borderAndTitleBlockRect()

QRectF BorderTitleBlock::borderAndTitleBlockRect ( ) const

BorderTitleBlock::borderAndTitleBlockRect.

Returns: the bounding rectangle of diagram and titleblock. It's like unite outsideBorderRect and titleBlockRect. The rect is in scene coordinate

Here is the call graph for this function:

Here is the caller graph for this function:

◆ borderChanged

void BorderTitleBlock::borderChanged	(	QRectF	old_border,
		QRectF	new_border
	)

signal

borderChanged Signal emitted after the border has changed

Parameters

old_border	Former border
new_border	New border

Here is the caller graph for this function:

◆ borderFromXml()

void BorderTitleBlock::borderFromXml ( const QDomElement & xml_elmt )

BorderTitleBlock::borderFromXml Reads the border settings from XML.

Parameters

xml_elmt the XML element values will be read from

Here is the call graph for this function:

Here is the caller graph for this function:

◆ borderIsDisplayed()

bool BorderTitleBlock::borderIsDisplayed ( ) const

inline

Returns: true si la bordure est affichee, false sinon

Here is the caller graph for this function:

◆ borderToXml()

void BorderTitleBlock::borderToXml ( QDomElement & xml_elmt )

BorderTitleBlock::borderToXml Exports the border current settings to XML.

Parameters

xml_elmt the XML element attributes will be added to

Here is the call graph for this function:

Here is the caller graph for this function:

◆ columnsAreDisplayed()

bool BorderTitleBlock::columnsAreDisplayed ( ) const

inline

Returns: true si les entetes des colonnes sont affiches, false sinon

Here is the caller graph for this function:

◆ columnsCount()

int BorderTitleBlock::columnsCount ( ) const

inline

Returns: the number of columns

Here is the caller graph for this function:

◆ columnsHeaderHeight()

qreal BorderTitleBlock::columnsHeaderHeight ( ) const

inline

Returns: the column headers height, in pixels

Here is the caller graph for this function:

◆ columnsRect()

QRectF BorderTitleBlock::columnsRect ( ) const

BorderTitleBlock::columnsRect.

Returns: The columns rect in scene coordinate. If column is not displayed, return a null QRectF

Here is the caller graph for this function:

◆ columnsTotalWidth()

qreal BorderTitleBlock::columnsTotalWidth ( ) const

inline

Returns: the total width of all columns, headers excluded

Here is the caller graph for this function:

◆ columnsWidth()

qreal BorderTitleBlock::columnsWidth ( ) const

inline

Returns: the columns width, in pixels

Here is the caller graph for this function:

◆ convertPosition()

DiagramPosition BorderTitleBlock::convertPosition ( const QPointF & pos )

BorderTitleBlock::convertPosition Convert a Point in cartesian coordinate (x : 12.5, 56.9) to a point in grid coordinate (ex : B2)

Parameters

pos	: position to convert

Returns: the converted point in grid coordinate.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ date()

QDate BorderTitleBlock::date ( ) const

inline

Returns: the value of the title block "Date" field

Here is the caller graph for this function:

◆ diagramHeight()

qreal BorderTitleBlock::diagramHeight ( ) const

inline

diagramHeight

Returns: the diagram height, i.e. the height of the border without title block

Here is the call graph for this function:

Here is the caller graph for this function:

◆ diagramTitleChanged

void BorderTitleBlock::diagramTitleChanged ( const QString & )

signal

diagramTitleChanged Signal emitted after the title has changed

Here is the caller graph for this function:

◆ diagramWidth()

qreal BorderTitleBlock::diagramWidth ( ) const

inline

diagramWidth

Returns: the diagram width, i.e. the width of the border without title block

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayBorder

void BorderTitleBlock::displayBorder ( bool db )

slot

BorderTitleBlock::displayBorder.

Parameters

db	: true to display the border of the diagram, false otherwise

Note: : if the border display is deactivated, the rows and columns will not be drawn.

Here is the caller graph for this function:

◆ displayChanged

void BorderTitleBlock::displayChanged ( )

signal

displayChanged Signal emitted after display options have changed

Here is the caller graph for this function:

◆ displayColumns

void BorderTitleBlock::displayColumns ( bool dc )

slot

BorderTitleBlock::displayColumns.

Parameters

dc	: true to display the column headers, false otherwise

Here is the caller graph for this function:

◆ displayRows

void BorderTitleBlock::displayRows ( bool dr )

slot

BorderTitleBlock::displayRows.

Parameters

dr	: true to display line headers, false otherwise

Here is the caller graph for this function:

◆ displayTitleBlock

void BorderTitleBlock::displayTitleBlock ( bool di )

slot

BorderTitleBlock::displayTitleBlock.

Parameters

di	: true to display the title block, false otherwise

Here is the caller graph for this function:

◆ draw()

void BorderTitleBlock::draw ( QPainter * painter )

BorderTitleBlock::draw Draw the border and the titleblock.

Parameters

painter : QPainter to use for draw this.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ drawDxf()

void BorderTitleBlock::drawDxf	(	int	width,
		int	height,
		bool	keep_aspect_ratio,
		QString &	file_path,
		int	color
	)

BorderTitleBlock::drawDxf.

Parameters

width
height
keep_aspect_ratio
file_path
color

Here is the call graph for this function:

◆ exportBorder()

BorderProperties BorderTitleBlock::exportBorder ( )

BorderTitleBlock::exportBorder.

Returns: border properties

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportTitleBlock()

TitleBlockProperties BorderTitleBlock::exportTitleBlock ( )

BorderTitleBlock::exportTitleBlock.

Returns: the properties of the titleblock

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fileName()

QString BorderTitleBlock::fileName ( ) const

inline

Returns: the value of the title block "File" field

Here is the caller graph for this function:

◆ finalfolio()

QString BorderTitleBlock::finalfolio ( ) const

inline

Returns: the value of the title block "Folio" field as displayed

Here is the caller graph for this function:

◆ folio()

QString BorderTitleBlock::folio ( ) const

inline

Returns: the value of the title block "Folio" field

Here is the caller graph for this function:

◆ folioTotal()

int BorderTitleBlock::folioTotal ( ) const

inline

Returns: the value of the total number of folios

◆ importBorder()

void BorderTitleBlock::importBorder ( const BorderProperties & bp )

BorderTitleBlock::importBorder.

Parameters

bp	: the new properties of the border

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importTitleBlock()

void BorderTitleBlock::importTitleBlock ( const TitleBlockProperties & ip )

BorderTitleBlock::importTitleBlock.

Parameters

ip	the new properties of titleblock

Here is the call graph for this function:

Here is the caller graph for this function:

◆ incrementLetters()

QString BorderTitleBlock::incrementLetters ( const QString & string )

private

BorderTitleBlock::incrementLetters increments string with Letters A to Z.

Parameters

string

Returns

string ++Letters eg:

A-> B
Z -> AA

Here is the caller graph for this function:

◆ indexrev()

QString BorderTitleBlock::indexrev ( ) const

inline

Returns: the value of the revision index block "Folio" field

Here is the caller graph for this function:

◆ insideBorderRect()

QRectF BorderTitleBlock::insideBorderRect ( ) const

BorderTitleBlock::insideBorderRect.

Returns: The rect of the inside border, in other word, the drawing area. This method take care about if rows or columns are displayed or not. The rect is in scene coordinate

Here is the caller graph for this function:

◆ locmach()

QString BorderTitleBlock::locmach ( ) const

inline

Returns: the value of the title block "Locmach" field

Here is the caller graph for this function:

◆ needFolioData

void BorderTitleBlock::needFolioData ( )

signal

needFolioData Signal emitted when the title block requires its data to be updated in order to generate the folio field.

Here is the caller graph for this function:

◆ needTitleBlockTemplate

void BorderTitleBlock::needTitleBlockTemplate ( const QString & )

signal

needTitleBlockTemplate Signal emitted when this object needs to set a specific title block template. This object cannot handle the job since it does not know of its parent project.

Here is the caller graph for this function:

◆ outsideBorderRect()

QRectF BorderTitleBlock::outsideBorderRect ( ) const

BorderTitleBlock::outsideBorderRect.

Returns: The rect of outside border (diagram with columns and rows) The rect is in scene coordinate

◆ plant()

QString BorderTitleBlock::plant ( ) const

inline

Returns: the value of the title block "Plant" field

Here is the caller graph for this function:

◆ rowsAreDisplayed()

bool BorderTitleBlock::rowsAreDisplayed ( ) const

inline

Returns: true si les entetes des lignes sont affiches, false sinon

Here is the caller graph for this function:

◆ rowsCount()

int BorderTitleBlock::rowsCount ( ) const

inline

Returns: the number of rows

Here is the caller graph for this function:

◆ rowsHeaderWidth()

qreal BorderTitleBlock::rowsHeaderWidth ( ) const

inline

Returns: la rows header width, in pixels

Here is the caller graph for this function:

◆ rowsHeight()

qreal BorderTitleBlock::rowsHeight ( ) const

inline

Returns: the rows height, in pixels

Here is the caller graph for this function:

◆ rowsRect()

QRectF BorderTitleBlock::rowsRect ( ) const

BorderTitleBlock::rowsRect.

Returns: The rows rect in scene coordinate. If row is not displayed, return a null QRectF

Here is the caller graph for this function:

◆ rowsTotalHeight()

qreal BorderTitleBlock::rowsTotalHeight ( ) const

inline

Returns: the total height of all rows, headers excluded

Here is the caller graph for this function:

◆ setAuthor()

void BorderTitleBlock::setAuthor ( const QString & author )

BorderTitleBlock::setAuthor.

Parameters

author the new value of the "Author" field

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAutoPageNum()

void BorderTitleBlock::setAutoPageNum ( const QString & auto_page_num )

BorderTitleBlock::setAutoPageNum.

Parameters

auto_page_num the new value of the "auto_page_num" field

Here is the caller graph for this function:

◆ setColumnsCount()

void BorderTitleBlock::setColumnsCount ( int nb_c )

BorderTitleBlock::setColumnsCount Allows you to change the number of columns. If this number of columns is less than the minimum required, it is this minimum which is used.

Parameters

nb_c	: new number of columns

See also: minNbColumns()

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColumnsHeaderHeight()

void BorderTitleBlock::setColumnsHeaderHeight ( const qreal & new_chh )

BorderTitleBlock::setColumnsHeaderHeight Change the height of the headers containing the column numbers. This must remain between 5 and 50 px.

Parameters

new_chh : new height of column headers

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColumnsWidth()

void BorderTitleBlock::setColumnsWidth ( const qreal & new_cw )

BorderTitleBlock::setColumnsWidth Change the width of the columns. If the width indicated is less than the minimum required, it is this minimum which is used.

Parameters

new_cw : new column width

See also: minColumnsWidth()

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDate()

void BorderTitleBlock::setDate ( const QDate & date )

BorderTitleBlock::setDate.

Parameters

date	the new value of the "Date" field

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDiagramHeight()

void BorderTitleBlock::setDiagramHeight ( const qreal & height )

BorderTitleBlock::setDiagramHeight This method tries to get as close as possible to the given height as a parameter by modifying the number of rows in progress.

Parameters

height :

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFileName()

void BorderTitleBlock::setFileName ( const QString & filename )

BorderTitleBlock::setFileName.

Parameters

filename the new value of the "filename" field

Here is the caller graph for this function:

◆ setFolio()

void BorderTitleBlock::setFolio ( const QString & folio )

BorderTitleBlock::setFolio.

Parameters

folio the new value of the "Folio" field

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFolioData()

void BorderTitleBlock::setFolioData	(	int	index,
		int	total,
		const QString &	autonum = `nullptr`,
		const DiagramContext &	project_properties = `DiagramContext()`
	)

BorderTitleBlock::setFolioData.

Parameters

index	: schema number (from 1 to total)
total	: total number of diagrams in the project
autonum	:
project_properties	: Project-wide properties, to be merged with diagram-wide ones.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIndicerev()

void BorderTitleBlock::setIndicerev ( const QString & indexrev )

BorderTitleBlock::setIndicerev.

Parameters

indexrev the new value of the "indexrev" field

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLocMach()

void BorderTitleBlock::setLocMach ( const QString & locmach )

BorderTitleBlock::setLocMach.

Parameters

locmach the new value of the "locmach" field

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setNextFolioNum()

void BorderTitleBlock::setNextFolioNum ( const QString & next )

BorderTitleBlock::setNextFolioNum.

Parameters

next	the new value of the "next-folio-num" field

Here is the call graph for this function:

◆ setPlant()

void BorderTitleBlock::setPlant ( const QString & plant )

BorderTitleBlock::setPlant.

Parameters

plant the new value of the "plant" field

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPreviousFolioNum()

void BorderTitleBlock::setPreviousFolioNum ( const QString & previous )

BorderTitleBlock::setPreviousFolioNum.

Parameters

previous the new value of the "previous-folio-num" field

Here is the call graph for this function:

◆ setRowsCount()

void BorderTitleBlock::setRowsCount ( int nb_r )

BorderTitleBlock::setRowsCount Allows you to change the number of lines. If this number of lines is lower than the minimum required, this function does nothing.

Parameters

nb_r	: new number of lines

See also: minNbRows()

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRowsHeaderWidth()

void BorderTitleBlock::setRowsHeaderWidth ( const qreal & new_rhw )

BorderTitleBlock::setRowsHeaderWidth Change the width of the headers containing the line numbers. This must remain between 5 and 50 px.

Parameters

new_rhw : new width of line headers

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRowsHeight()

void BorderTitleBlock::setRowsHeight ( const qreal & new_rh )

BorderTitleBlock::setRowsHeight Change the height of the lines. If the indicated height is lower than the minimum required, it is this minimum which is used.

Parameters

new_rh : new row height

See also: minRowsHeight()

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTitle()

void BorderTitleBlock::setTitle ( const QString & title )

BorderTitleBlock::setTitle.

Parameters

title the new value of the "Title" field

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTitleBlockTemplate()

void BorderTitleBlock::setTitleBlockTemplate ( const TitleBlockTemplate * titleblock_template )

BorderTitleBlock::setTitleBlockTemplate.

Parameters

titleblock_template The new titleblock template to use to render the titleblock

See also: TitleBlockTemplateRenderer::setTitleBlockTemplate()

Here is the caller graph for this function:

◆ setVersion()

void BorderTitleBlock::setVersion ( const QString & version )

BorderTitleBlock::setVersion.

Parameters

version the new value of the "version" field

Here is the call graph for this function:

Here is the caller graph for this function:

◆ slot_setAutoPageNum

void BorderTitleBlock::slot_setAutoPageNum ( QString pageAutoNum )

slot

BorderTitleBlock::slot_setAutoPageNum.

Parameters

pageAutoNum : Set Page (Folio) Auto Num

◆ title()

QString BorderTitleBlock::title ( ) const

inline

Returns: the value of the title block "Title" field

Here is the caller graph for this function:

◆ titleBlockFolioChanged

void BorderTitleBlock::titleBlockFolioChanged ( const QString & )

signal

titleBlockFolioChanged Signal emitted after Folio has changed

Here is the caller graph for this function:

◆ titleBlockFromXml()

void BorderTitleBlock::titleBlockFromXml ( const QDomElement & xml_elmt )

BorderTitleBlock::titleBlockFromXml Reads the title block values from XML.

Parameters

xml_elmt the XML element values will be read from

Here is the call graph for this function:

Here is the caller graph for this function:

◆ titleblockInformation()

DiagramContext BorderTitleBlock::titleblockInformation ( ) const

BorderTitleBlock::titleblockInformation.

Returns

Here is the call graph for this function:

Here is the caller graph for this function:

◆ titleBlockIsDisplayed()

bool BorderTitleBlock::titleBlockIsDisplayed ( ) const

inline

Returns: true si le cartouche est affiche, false sinon

Here is the caller graph for this function:

◆ titleBlockRect()

QRectF BorderTitleBlock::titleBlockRect ( ) const

BorderTitleBlock::titleBlockRect.

Returns: the rectangle of the titleblock in scene coordinate.

Here is the caller graph for this function:

◆ titleBlockRectForQPainter()

QRectF BorderTitleBlock::titleBlockRectForQPainter ( ) const

private

BorderTitleBlock::titleBlockRectForQPainter.

Returns: The title block rect to use with the QPainter in the method draw. The returned rect is alway horizontal (like displayed at the bottom of rect) only the top left change of pos according to the edge where the title block need to be displayed. Rect according to edge: Bottom : top left is at the bottom left edge of the diagram rect. Right : top left is at the bottom right of diagram rect. Befor use this rect you need to rotate the QPainter by -90° for snap the rect at the right edge of diagram.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ titleBlockTemplate()

const TitleBlockTemplate * BorderTitleBlock::titleBlockTemplate ( )

BorderTitleBlock::titleBlockTemplate.

Returns: the titleblock template used to render the titleblock

See also: TitleBlockTemplateRenderer::titleBlockTemplate()

Here is the caller graph for this function:

◆ titleBlockTemplateChanged

void BorderTitleBlock::titleBlockTemplateChanged ( const QString & template_name )

slot

BorderTitleBlock::titleBlockTemplateChanged This slot may be used to inform this class that the given title block template has changed. The title block-dedicated rendering cache will thus be flushed.

Parameters

template_name : Name of the title block template that has changed

Here is the call graph for this function:

Here is the caller graph for this function:

◆ titleBlockTemplateName()

QString BorderTitleBlock::titleBlockTemplateName ( ) const

BorderTitleBlock::titleBlockTemplateName.

Returns: The name of the template used to render the titleblock.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ titleBlockTemplateRemoved

void BorderTitleBlock::titleBlockTemplateRemoved	(	const QString &	removed_template_name,
		const TitleBlockTemplate *	new_template = `nullptr`
	)

slot

BorderTitleBlock::titleBlockTemplateRemoved This slot has to be used to inform this class that the given title block template is about to be removed and is no longer accessible. This class will either use the provided optional TitleBlockTemplate or the default title block provided by QETApp::defaultTitleBlockTemplate()

Parameters

removed_template_name	: Name of the title block template that has changed
new_template	(Optional) title block template to use instead

Here is the call graph for this function:

Here is the caller graph for this function:

◆ titleBlockToXml()

void BorderTitleBlock::titleBlockToXml ( QDomElement & xml_elmt )

BorderTitleBlock::titleBlockToXml Exports the title block current values to XML.

Parameters

xml_elmt the XML element attributes will be added to

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateDiagramContextForTitleBlock()

void BorderTitleBlock::updateDiagramContextForTitleBlock ( const DiagramContext & initial_context = DiagramContext() )

private

BorderTitleBlock::updateDiagramContextForTitleBlock Update the informations given to the titleblock template by regenerating a DiagramContext object.

Parameters

initial_context : Base diagram context that will be overridden by diagram-wide values

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateRectangles()

void BorderTitleBlock::updateRectangles ( )

private

BorderTitleBlock::updateRectangles This method update the diagram rect according to the value of rows and columns (number and size)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ version()

QString BorderTitleBlock::version ( ) const

inline

Returns: the value of the title block Additional Fields

Here is the caller graph for this function:

Member Data Documentation

◆ additional_fields_

DiagramContext BorderTitleBlock::additional_fields_

private

titleblock additional fields

◆ btb_author_

QString BorderTitleBlock::btb_author_

private

titleblock author

◆ btb_auto_page_num_

QString BorderTitleBlock::btb_auto_page_num_

private

titleblock auto page num

◆ btb_date_

QDate BorderTitleBlock::btb_date_

private

titleblock date

◆ btb_filename_

QString BorderTitleBlock::btb_filename_

private

titleblock filename

◆ btb_final_folio_

QString BorderTitleBlock::btb_final_folio_

private

titleblock final folio

◆ btb_folio_

QString BorderTitleBlock::btb_folio_

private

titleblock folio

◆ btb_indexrev_

QString BorderTitleBlock::btb_indexrev_

private

titleblock index rev

◆ btb_locmach_

QString BorderTitleBlock::btb_locmach_

private

titleblock locmach

◆ btb_plant_

QString BorderTitleBlock::btb_plant_

private

titleblock plant

◆ btb_title_

QString BorderTitleBlock::btb_title_

private

titleblock title

◆ btb_version_

QString BorderTitleBlock::btb_version_

private

titleblock version

◆ columns_count_

int BorderTitleBlock::columns_count_

private

columns count

◆ columns_header_height_

qreal BorderTitleBlock::columns_header_height_

private

columns header height

◆ columns_width_

qreal BorderTitleBlock::columns_width_

private

columns width

◆ diagram_rect_

QRectF BorderTitleBlock::diagram_rect_

private

◆ display_border_

bool BorderTitleBlock::display_border_

private

◆ display_columns_

bool BorderTitleBlock::display_columns_

private

◆ display_rows_

bool BorderTitleBlock::display_rows_

private

◆ display_titleblock_

bool BorderTitleBlock::display_titleblock_

private

◆ folio_index_

int BorderTitleBlock::folio_index_

private

titleblock index

◆ folio_total_

int BorderTitleBlock::folio_total_

private

titleblock total

◆ m_edge

Qt::Edge BorderTitleBlock::m_edge

private

titleblock edge

◆ m_next_folio_num

QString BorderTitleBlock::m_next_folio_num

private

titleblock next folio num

◆ m_previous_folio_num

QString BorderTitleBlock::m_previous_folio_num

private

titleblock previous folio num

◆ m_titleblock_template_renderer

TitleBlockTemplateRenderer* BorderTitleBlock::m_titleblock_template_renderer

private

◆ rows_count_

int BorderTitleBlock::rows_count_

private

rows count

◆ rows_header_width_

qreal BorderTitleBlock::rows_header_width_

private

rows header width

◆ rows_height_

qreal BorderTitleBlock::rows_height_

private

rows height

◆ titleblock_height_

qreal BorderTitleBlock::titleblock_height_

private

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

sources/bordertitleblock.h
sources/bordertitleblock.cpp

Public Slots

Signals

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BorderTitleBlock() [1/2]

◆ ~BorderTitleBlock()

◆ BorderTitleBlock() [2/2]

Member Function Documentation

◆ additionalFields()

◆ author()

◆ autoPageNum()

◆ borderAndTitleBlockRect()

◆ borderChanged

◆ borderFromXml()

◆ borderIsDisplayed()

◆ borderToXml()

◆ columnsAreDisplayed()

◆ columnsCount()

◆ columnsHeaderHeight()

◆ columnsRect()

◆ columnsTotalWidth()

◆ columnsWidth()

◆ convertPosition()

◆ date()

◆ diagramHeight()

◆ diagramTitleChanged

◆ diagramWidth()

◆ displayBorder

◆ displayChanged

◆ displayColumns

◆ displayRows

◆ displayTitleBlock

◆ draw()

◆ drawDxf()

◆ exportBorder()

◆ exportTitleBlock()

◆ fileName()

◆ finalfolio()

◆ folio()

◆ folioTotal()

◆ importBorder()

◆ importTitleBlock()

◆ incrementLetters()

◆ indexrev()

◆ insideBorderRect()

◆ locmach()

◆ needFolioData

◆ needTitleBlockTemplate

◆ outsideBorderRect()

◆ plant()

◆ rowsAreDisplayed()

◆ rowsCount()

◆ rowsHeaderWidth()

◆ rowsHeight()

◆ rowsRect()

◆ rowsTotalHeight()

◆ setAuthor()

◆ setAutoPageNum()

◆ setColumnsCount()

◆ setColumnsHeaderHeight()

◆ setColumnsWidth()

◆ setDate()

◆ setDiagramHeight()

◆ setFileName()

◆ setFolio()

◆ setFolioData()

◆ setIndicerev()

◆ setLocMach()

◆ setNextFolioNum()

◆ setPlant()

◆ setPreviousFolioNum()

◆ setRowsCount()

◆ setRowsHeaderWidth()

◆ setRowsHeight()

◆ setTitle()

◆ setTitleBlockTemplate()

◆ setVersion()