LibrePCB Developers Documentation
NewElementWizardContext Class Referencefinal

The NewElementWizardContext class. More...

#include <newelementwizardcontext.h>

Inherits QObject.

+ Collaboration diagram for NewElementWizardContext:

Public Types

enum  PageId
 
enum  ElementType
 

Public Member Functions

 NewElementWizardContext ()=delete
 
 NewElementWizardContext (const NewElementWizardContext &other)=delete
 
 NewElementWizardContext (const workspace::Workspace &ws, Library &lib, const IF_GraphicsLayerProvider &lp, QObject *parent=nullptr) noexcept
 
 ~NewElementWizardContext () noexcept
 
const FilePathgetOutputDirectory () const noexcept
 
const workspace::WorkspacegetWorkspace () const noexcept
 
const IF_GraphicsLayerProvidergetLayerProvider () const noexcept
 
const QStringList & getLibLocaleOrder () const noexcept
 
void reset (ElementType newType=ElementType::None) noexcept
 
void copyElement (ElementType type, const FilePath &fp)
 
void createLibraryElement ()
 
NewElementWizardContextoperator= (const NewElementWizardContext &rhs)=delete
 

Public Attributes

ElementType mElementType
 
tl::optional< ElementNamemElementName
 
QString mElementDescription
 
QString mElementKeywords
 
QString mElementAuthor
 
tl::optional< VersionmElementVersion
 
tl::optional< UuidmElementCategoryUuid
 
SymbolPinList mSymbolPins
 
PolygonList mSymbolPolygons
 
CircleList mSymbolCircles
 
TextList mSymbolTexts
 
PackagePadList mPackagePads
 
FootprintList mPackageFootprints
 
bool mComponentSchematicOnly
 
AttributeList mComponentAttributes
 
QString mComponentDefaultValue
 
NormDependentPrefixMap mComponentPrefixes
 
ComponentSignalList mComponentSignals
 
ComponentSymbolVariantList mComponentSymbolVariants
 
tl::optional< UuidmDeviceComponentUuid
 
tl::optional< UuidmDevicePackageUuid
 
DevicePadSignalMap mDevicePadSignalMap
 

Private Attributes

const workspace::WorkspacemWorkspace
 
library::LibrarymLibrary
 
const IF_GraphicsLayerProvidermLayerProvider
 
FilePath mOutputDirectory
 

Detailed Description

Member Enumeration Documentation

◆ PageId

enum PageId
Enumerator
ID_None 

last page

ID_ChooseType 
ID_CopyFrom 
ID_EnterMetadata 
ID_PackagePads 
ID_ComponentProperties 
ID_ComponentSymbols 
ID_ComponentSignals 
ID_ComponentPinSignalMap 
ID_DeviceProperties 

◆ ElementType

enum ElementType
strong
Enumerator
None 
ComponentCategory 
PackageCategory 
Symbol 
Package 
Component 
Device 

Constructor & Destructor Documentation

◆ NewElementWizardContext() [1/3]

◆ NewElementWizardContext() [2/3]

◆ NewElementWizardContext() [3/3]

NewElementWizardContext ( const workspace::Workspace ws,
Library lib,
const IF_GraphicsLayerProvider lp,
QObject *  parent = nullptr 
)
noexcept

◆ ~NewElementWizardContext()

~NewElementWizardContext ( )
noexcept

Member Function Documentation

◆ getOutputDirectory()

const FilePath& getOutputDirectory ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getWorkspace()

const workspace::Workspace& getWorkspace ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getLayerProvider()

const IF_GraphicsLayerProvider& getLayerProvider ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getLibLocaleOrder()

const QStringList & getLibLocaleOrder ( ) const
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ reset()

void reset ( ElementType  newType = ElementType::None)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ copyElement()

void copyElement ( ElementType  type,
const FilePath fp 
)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ createLibraryElement()

void createLibraryElement ( )
+ Here is the call graph for this function:

◆ operator=()

NewElementWizardContext& operator= ( const NewElementWizardContext rhs)
delete

Member Data Documentation

◆ mWorkspace

const workspace::Workspace& mWorkspace
private

◆ mLibrary

library::Library& mLibrary
private

◆ mLayerProvider

const IF_GraphicsLayerProvider& mLayerProvider
private

◆ mOutputDirectory

FilePath mOutputDirectory
private

◆ mElementType

ElementType mElementType

◆ mElementName

tl::optional<ElementName> mElementName

◆ mElementDescription

QString mElementDescription

◆ mElementKeywords

QString mElementKeywords

◆ mElementAuthor

QString mElementAuthor

◆ mElementVersion

tl::optional<Version> mElementVersion

◆ mElementCategoryUuid

tl::optional<Uuid> mElementCategoryUuid

◆ mSymbolPins

SymbolPinList mSymbolPins

◆ mSymbolPolygons

PolygonList mSymbolPolygons

◆ mSymbolCircles

CircleList mSymbolCircles

◆ mSymbolTexts

TextList mSymbolTexts

◆ mPackagePads

PackagePadList mPackagePads

◆ mPackageFootprints

FootprintList mPackageFootprints

◆ mComponentSchematicOnly

bool mComponentSchematicOnly

◆ mComponentAttributes

AttributeList mComponentAttributes

◆ mComponentDefaultValue

QString mComponentDefaultValue

◆ mComponentPrefixes

NormDependentPrefixMap mComponentPrefixes

◆ mComponentSignals

ComponentSignalList mComponentSignals

◆ mComponentSymbolVariants

ComponentSymbolVariantList mComponentSymbolVariants

◆ mDeviceComponentUuid

tl::optional<Uuid> mDeviceComponentUuid

◆ mDevicePackageUuid

tl::optional<Uuid> mDevicePackageUuid

◆ mDevicePadSignalMap

DevicePadSignalMap mDevicePadSignalMap

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