LibrePCB Developers Documentation
GraphicsExportSettings Class Referencefinal

Settings for librepcb::GraphicsExport. More...

#include <graphicsexportsettings.h>

+ Collaboration diagram for GraphicsExportSettings:

Public Types

enum class  Orientation
 

Public Member Functions

 GraphicsExportSettings () noexcept
 
 GraphicsExportSettings (const GraphicsExportSettings &other) noexcept
 
 ~GraphicsExportSettings () noexcept
 
const tl::optional< QPageSize > & getPageSize () const noexcept
 
Orientation getOrientation () const noexcept
 
const UnsignedLengthgetMarginLeft () const noexcept
 
const UnsignedLengthgetMarginTop () const noexcept
 
const UnsignedLengthgetMarginRight () const noexcept
 
const UnsignedLengthgetMarginBottom () const noexcept
 
bool getRotate () const noexcept
 
bool getMirror () const noexcept
 
const tl::optional< UnsignedRatio > & getScale () const noexcept
 
int getPixmapDpi () const noexcept
 
bool getBlackWhite () const noexcept
 
const QColor & getBackgroundColor () const noexcept
 
const UnsignedLengthgetMinLineWidth () const noexcept
 
const QList< std::pair< QString, QColor > > & getColors () const noexcept
 
QStringList getPaintOrder () const noexcept
 
QColor getColor (const QString &colorName) const noexcept
 
QColor getFillColor (const QString &colorName, bool isFilled, bool isGrabArea) const noexcept
 
void setPageSize (const tl::optional< QPageSize > &size) noexcept
 
void setOrientation (Orientation orientation) noexcept
 
void setMarginLeft (const librepcb::UnsignedLength &margin) noexcept
 
void setMarginTop (const librepcb::UnsignedLength &margin) noexcept
 
void setMarginRight (const librepcb::UnsignedLength &margin) noexcept
 
void setMarginBottom (const librepcb::UnsignedLength &margin) noexcept
 
void setRotate (bool rotate) noexcept
 
void setMirror (bool mirror) noexcept
 
void setScale (tl::optional< UnsignedRatio > scale) noexcept
 
void setPixmapDpi (int dpi) noexcept
 
void setBlackWhite (bool blackWhite) noexcept
 
void setBackgroundColor (const QColor &c) noexcept
 
void setMinLineWidth (const UnsignedLength &width) noexcept
 
void setColors (const QList< std::pair< QString, QColor > > &colors) noexcept
 
void loadColorsFromTheme (const Theme &theme, bool schematic=true, bool board=true, int innerLayerCount=-1) noexcept
 
GraphicsExportSettingsoperator= (const GraphicsExportSettings &rhs) noexcept
 
bool operator== (const GraphicsExportSettings &rhs) const noexcept
 
bool operator!= (const GraphicsExportSettings &rhs) const noexcept
 

Private Member Functions

QColor getColorImpl (const QString &name) const noexcept
 

Private Attributes

tl::optional< QPageSize > mPageSize
 
Orientation mOrientation
 
UnsignedLength mMarginLeft
 
UnsignedLength mMarginTop
 
UnsignedLength mMarginRight
 
UnsignedLength mMarginBottom
 
bool mRotate
 
bool mMirror
 
tl::optional< UnsignedRatiomScale
 
int mPixmapDpi
 
bool mBlackWhite
 
QColor mBackgroundColor
 
UnsignedLength mMinLineWidth
 
QList< std::pair< QString, QColor > > mColors
 

Detailed Description

Member Enumeration Documentation

◆ Orientation

enum class Orientation
strong
Enumerator
Landscape 
Portrait 
Auto 

Constructor & Destructor Documentation

◆ GraphicsExportSettings() [1/2]

GraphicsExportSettings ( )
noexcept
+ Here is the call graph for this function:

◆ GraphicsExportSettings() [2/2]

GraphicsExportSettings ( const GraphicsExportSettings other)
noexcept

◆ ~GraphicsExportSettings()

~GraphicsExportSettings ( )
noexcept

Member Function Documentation

◆ getPageSize()

const tl::optional< QPageSize > & getPageSize ( ) const
inlinenoexcept

◆ getOrientation()

Orientation getOrientation ( ) const
inlinenoexcept

◆ getMarginLeft()

const UnsignedLength & getMarginLeft ( ) const
inlinenoexcept

◆ getMarginTop()

const UnsignedLength & getMarginTop ( ) const
inlinenoexcept

◆ getMarginRight()

const UnsignedLength & getMarginRight ( ) const
inlinenoexcept

◆ getMarginBottom()

const UnsignedLength & getMarginBottom ( ) const
inlinenoexcept

◆ getRotate()

bool getRotate ( ) const
inlinenoexcept

◆ getMirror()

bool getMirror ( ) const
inlinenoexcept

◆ getScale()

const tl::optional< UnsignedRatio > & getScale ( ) const
inlinenoexcept

◆ getPixmapDpi()

int getPixmapDpi ( ) const
inlinenoexcept

◆ getBlackWhite()

bool getBlackWhite ( ) const
inlinenoexcept

◆ getBackgroundColor()

const QColor & getBackgroundColor ( ) const
inlinenoexcept

◆ getMinLineWidth()

const UnsignedLength & getMinLineWidth ( ) const
inlinenoexcept

◆ getColors()

const QList< std::pair< QString, QColor > > & getColors ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getPaintOrder()

QStringList getPaintOrder ( ) const
noexcept

◆ getColor()

QColor getColor ( const QString &  colorName) const
noexcept

◆ getFillColor()

QColor getFillColor ( const QString &  colorName,
bool  isFilled,
bool  isGrabArea 
) const
noexcept
+ Here is the call graph for this function:

◆ setPageSize()

void setPageSize ( const tl::optional< QPageSize > &  size)
inlinenoexcept

◆ setOrientation()

void setOrientation ( Orientation  orientation)
inlinenoexcept

◆ setMarginLeft()

void setMarginLeft ( const librepcb::UnsignedLength margin)
inlinenoexcept

◆ setMarginTop()

void setMarginTop ( const librepcb::UnsignedLength margin)
inlinenoexcept

◆ setMarginRight()

void setMarginRight ( const librepcb::UnsignedLength margin)
inlinenoexcept

◆ setMarginBottom()

void setMarginBottom ( const librepcb::UnsignedLength margin)
inlinenoexcept

◆ setRotate()

void setRotate ( bool  rotate)
inlinenoexcept

◆ setMirror()

void setMirror ( bool  mirror)
inlinenoexcept

◆ setScale()

void setScale ( tl::optional< UnsignedRatio scale)
inlinenoexcept

◆ setPixmapDpi()

void setPixmapDpi ( int  dpi)
inlinenoexcept

◆ setBlackWhite()

void setBlackWhite ( bool  blackWhite)
inlinenoexcept

◆ setBackgroundColor()

void setBackgroundColor ( const QColor &  c)
inlinenoexcept

◆ setMinLineWidth()

void setMinLineWidth ( const UnsignedLength width)
inlinenoexcept

◆ setColors()

void setColors ( const QList< std::pair< QString, QColor > > &  colors)
inlinenoexcept

◆ loadColorsFromTheme()

void loadColorsFromTheme ( const Theme theme,
bool  schematic = true,
bool  board = true,
int  innerLayerCount = -1 
)
noexcept
+ Here is the caller graph for this function:

◆ operator=()

GraphicsExportSettings & operator= ( const GraphicsExportSettings rhs)
noexcept

◆ operator==()

bool operator== ( const GraphicsExportSettings rhs) const
noexcept

◆ operator!=()

bool operator!= ( const GraphicsExportSettings rhs) const
noexcept

◆ getColorImpl()

QColor getColorImpl ( const QString &  name) const
privatenoexcept

Member Data Documentation

◆ mPageSize

tl::optional<QPageSize> mPageSize
private

◆ mOrientation

Orientation mOrientation
private

◆ mMarginLeft

UnsignedLength mMarginLeft
private

◆ mMarginTop

UnsignedLength mMarginTop
private

◆ mMarginRight

UnsignedLength mMarginRight
private

◆ mMarginBottom

UnsignedLength mMarginBottom
private

◆ mRotate

bool mRotate
private

◆ mMirror

bool mMirror
private

◆ mScale

tl::optional<UnsignedRatio> mScale
private

◆ mPixmapDpi

int mPixmapDpi
private

◆ mBlackWhite

bool mBlackWhite
private

◆ mBackgroundColor

QColor mBackgroundColor
private

◆ mMinLineWidth

UnsignedLength mMinLineWidth
private

◆ mColors

QList<std::pair<QString, QColor> > mColors
private

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