Zip file reader. More...

#include <interactivehtmlbom.h>

Collaboration diagram for InteractiveHtmlBom:

Classes
struct	Pad

Public Types
enum class	ViewMode

enum class	HighlightPin1Mode

enum class	Layer

enum class	Sides

enum class	DrawingKind

enum class	DrawingLayer

Public Member Functions
	InteractiveHtmlBom ()=delete

	InteractiveHtmlBom (const InteractiveHtmlBom &other)=delete

InteractiveHtmlBom &	operator= (const InteractiveHtmlBom &rhs)=delete

	InteractiveHtmlBom (const QString &title, const QString &company, const QString &revision, const QString &date, const Point &topLeft, const Point &bottomRight)
	Constructor.

void	setViewConfig (ViewMode mode, HighlightPin1Mode highlightPin1, bool dark) noexcept
	Set view configuration.

void	setBoardRotation (const Angle &angle, bool offsetBack) noexcept
	Set board rotation.

void	setShowSilkscreen (bool show) noexcept
	Set silkscreen visibility.

void	setShowFabrication (bool show) noexcept
	Set fabrication visibility.

void	setShowPads (bool show) noexcept
	Set pads visibility.

void	setCheckBoxes (const QStringList &names) noexcept
	Set the BOM checkbox columns.

void	setFields (const QStringList &fields) noexcept
	Set the fields of BOM lines.

void	addDrawing (DrawingKind kind, DrawingLayer layer, const Path &path, const UnsignedLength &width, bool filled) noexcept
	Add a PCB drawing.

void	addTrack (Layer layer, const Point &start, const Point &end, const PositiveLength &width, const std::optional< QString > &netName) noexcept
	Add a track.

void	addVia (QSet< Layer > layers, const Point &pos, const PositiveLength &diameter, const PositiveLength &drillDiameter, const std::optional< QString > &netName) noexcept
	Add via.

void	addPlaneFragment (Layer layer, const Path &outline, const std::optional< QString > &netName) noexcept
	Add plane fragment.

std::size_t	addFootprint (Layer layer, const Point &pos, const Angle &rot, const Point &topLeft, const Point &bottomRight, bool mount, const QStringList &fields, const QList< Pad > &pads) noexcept
	Add footprint.

void	addBomRow (Sides sides, const QList< std::pair< QString, std::size_t > > &parts) noexcept
	Add a BOM row.

QString	generateHtml () const
	Generate the HTML.

Private Attributes
RustHandle< rs::InteractiveHtmlBom >	mHandle

Detailed Description

Zip file reader.

Note: This is just a wrapper around its Rust implementation.

Member Enumeration Documentation

◆ ViewMode

enum class ViewMode

strong

Enumerator
BomOnly
LeftRight
TopBottom

◆ HighlightPin1Mode

enum class HighlightPin1Mode

strong

Enumerator
None
Selected
All

◆ Layer

enum class Layer

strong

Enumerator
Top
Bottom

◆ Sides

enum class Sides

strong

Enumerator
Top
Bottom
Both

◆ DrawingKind

enum class DrawingKind

strong

Enumerator
Polygon
ReferenceText
ValueText

◆ DrawingLayer

enum class DrawingLayer

strong

Enumerator
Edge
SilkscreenFront
SilkscreenBack
FabricationFront
FabricationBack

Constructor & Destructor Documentation

◆ InteractiveHtmlBom() [1/3]

InteractiveHtmlBom ( )

delete

◆ InteractiveHtmlBom() [2/3]

InteractiveHtmlBom ( const InteractiveHtmlBom & other )

delete

◆ InteractiveHtmlBom() [3/3]

InteractiveHtmlBom	(	const QString &	title,
		const QString &	company,
		const QString &	revision,
		const QString &	date,
		const Point &	topLeft,
		const Point &	bottomRight
	)

Constructor.

Parameters

title	Project title
company	Company/author name
revision	Project revision
date	Export date/time
topLeft	Top left coordinate of PCB bounding box
bottomRight	Bottom right coordinate of PCB bounding box

Member Function Documentation

◆ operator=()

InteractiveHtmlBom & operator= ( const InteractiveHtmlBom & rhs )

delete

◆ setViewConfig()

void setViewConfig	(	ViewMode	mode,
		HighlightPin1Mode	highlightPin1,
		bool	dark
	)

noexcept

Set view configuration.

Parameters

mode	View mode
highlightPin1	Highlight pin-1 mode
dark	Dark or not

Here is the call graph for this function:

◆ setBoardRotation()

void setBoardRotation	(	const Angle &	angle,
		bool	offsetBack
	)

noexcept

Set board rotation.

Parameters

angle	Rotation angle
offsetBack	Offset back side or not

Here is the call graph for this function:

◆ setShowSilkscreen()

void setShowSilkscreen ( bool show )

noexcept

Set silkscreen visibility.

Parameters

show	Show or not

Here is the call graph for this function:

◆ setShowFabrication()

void setShowFabrication ( bool show )

noexcept

Set fabrication visibility.

Parameters

show	Show or not

Here is the call graph for this function:

◆ setShowPads()

void setShowPads ( bool show )

noexcept

Set pads visibility.

Parameters

show	Show or not

Here is the call graph for this function:

◆ setCheckBoxes()

void setCheckBoxes ( const QStringList & names )

noexcept

Set the BOM checkbox columns.

Parameters

names Checkbox names

Here is the call graph for this function:

◆ setFields()

void setFields ( const QStringList & fields )

noexcept

Set the fields of BOM lines.

Parameters

fields Field names

Here is the call graph for this function:

◆ addDrawing()

void addDrawing	(	DrawingKind	kind,
		DrawingLayer	layer,
		const Path &	path,
		const UnsignedLength &	width,
		bool	filled
	)

noexcept

Add a PCB drawing.

Parameters

kind	Drawing kind
layer	Drawing layer
path	Drawing path
width	Line width
filled	Fill or not the shape

Here is the call graph for this function:

◆ addTrack()

void addTrack	(	Layer	layer,
		const Point &	start,
		const Point &	end,
		const PositiveLength &	width,
		const std::optional< QString > &	netName
	)

noexcept

Add a track.

Parameters

layer	Layer
start	Start position
end	End position
width	Width
netName	Net name (if any)

Here is the call graph for this function:

◆ addVia()

void addVia	(	QSet< Layer >	layers,
		const Point &	pos,
		const PositiveLength &	diameter,
		const PositiveLength &	drillDiameter,
		const std::optional< QString > &	netName
	)

noexcept

Add via.

Parameters

layers	Layers this via exists on
pos	Position
diameter	Outer diameter
drillDiameter	Drill diameter
netName	net name (if any)

Here is the call graph for this function:

◆ addPlaneFragment()

void addPlaneFragment	(	Layer	layer,
		const Path &	outline,
		const std::optional< QString > &	netName
	)

noexcept

Add plane fragment.

Parameters

layer	Layer
outline	Outline
netName	Net name (if any)

Here is the call graph for this function:

◆ addFootprint()

std::size_t addFootprint	(	Layer	layer,
		const Point &	pos,
		const Angle &	rot,
		const Point &	topLeft,
		const Point &	bottomRight,
		bool	mount,
		const QStringList &	fields,
		const QList< Pad > &	pads
	)

noexcept

Add footprint.

Parameters

layer	Mount layer
pos	Position
rot	Rotation
topLeft	Top left of bounding box
bottomRight	Bottom right of bounding box
mount	Whether it will be mounted or not
fields	Field values
pads	Pads

Returns: Footprint ID

Here is the call graph for this function:

◆ addBomRow()

void addBomRow	(	Sides	sides,
		const QList< std::pair< QString, std::size_t > > &	parts
	)

noexcept

Add a BOM row.

Parameters

sides	BOM sides
parts	Parts (designators & footprint IDs)

Here is the call graph for this function:

◆ generateHtml()

QString generateHtml ( ) const

Generate the HTML.

Returns: HTML file content

Exceptions

If	some of the data is invalid

Here is the call graph for this function:

Member Data Documentation

◆ mHandle

RustHandle<rs::InteractiveHtmlBom> mHandle

private

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

/__w/1/s/libs/librepcb/core/export/interactivehtmlbom.h
/__w/1/s/libs/librepcb/core/export/interactivehtmlbom.cpp

Classes

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ViewMode

◆ HighlightPin1Mode

◆ Layer

◆ Sides

◆ DrawingKind

◆ DrawingLayer

Constructor & Destructor Documentation

◆ InteractiveHtmlBom() [1/3]

◆ InteractiveHtmlBom() [2/3]

◆ InteractiveHtmlBom() [3/3]

Member Function Documentation

◆ operator=()

◆ setViewConfig()

◆ setBoardRotation()

◆ setShowSilkscreen()

◆ setShowFabrication()

◆ setShowPads()

◆ setCheckBoxes()

◆ setFields()

◆ addDrawing()

◆ addTrack()

◆ addVia()

◆ addPlaneFragment()

◆ addFootprint()

◆ addBomRow()

◆ generateHtml()

Member Data Documentation

◆ mHandle