DeviceTab Class Reference

The DeviceTab class. More...

#include <devicetab.h>

Inheritance diagram for DeviceTab:

Collaboration diagram for DeviceTab:

Public Types
enum class	Mode

Public Member Functions
	DeviceTab ()=delete
	DeviceTab (const DeviceTab &other)=delete
	DeviceTab (LibraryEditor &editor, std::unique_ptr< Device > dev, Mode mode, QObject *parent=nullptr) noexcept
	~DeviceTab () noexcept
FilePath	getDirectoryPath () const noexcept override
ui::TabData	getUiData () const noexcept override
ui::DeviceTabData	getDerivedUiData () const noexcept
void	setDerivedUiData (const ui::DeviceTabData &data) noexcept
void	trigger (ui::TabAction a) noexcept override
slint::Image	renderScene (float width, float height, int scene) noexcept override
bool	requestClose () noexcept override
	Request to close the tab.
DeviceTab &	operator= (const DeviceTab &rhs)=delete
template<>
bool	autoFix (const MsgNameNotTitleCase &msg)
template<>
bool	autoFix (const MsgMissingAuthor &msg)
template<>
bool	autoFix (const MsgMissingCategories &msg)
Public Member Functions inherited from LibraryEditorTab
	LibraryEditorTab ()=delete
	LibraryEditorTab (const LibraryEditorTab &other)=delete
	LibraryEditorTab (LibraryEditor &editor, QObject *parent=nullptr) noexcept
virtual	~LibraryEditorTab () noexcept
LibraryEditorTab &	operator= (const LibraryEditorTab &rhs)=delete
Public Member Functions inherited from WindowTab
	WindowTab ()=delete
	WindowTab (const WindowTab &other)=delete
	WindowTab (GuiApplication &app, QObject *parent=nullptr) noexcept
virtual	~WindowTab () noexcept
virtual void	setWindow (MainWindow *w) noexcept
virtual void	setUiData (const ui::TabData &data) noexcept
virtual void	activate () noexcept
virtual void	deactivate () noexcept
virtual bool	processScenePointerEvent (const QPointF &pos, slint::private_api::PointerEvent e) noexcept
virtual bool	processSceneScrolled (const QPointF &pos, slint::private_api::PointerScrollEvent e) noexcept
virtual bool	processSceneKeyEvent (const slint::private_api::KeyEvent &e) noexcept
WindowTab &	operator= (const WindowTab &rhs)=delete

Public Attributes
Signal< DeviceTab >	onDerivedUiDataChanged
Public Attributes inherited from WindowTab
Signal< WindowTab >	onUiDataChanged

Protected Member Functions
std::optional< std::pair< RuleCheckMessageList, QSet< SExpression > > >	runChecksImpl () override
bool	autoFixImpl (const std::shared_ptr< const RuleCheckMessage > &msg, bool checkOnly) override
template<typename MessageType >
bool	autoFixHelper (const std::shared_ptr< const RuleCheckMessage > &msg, bool checkOnly)
template<typename MessageType >
bool	autoFix (const MessageType &msg)
void	messageApprovalChanged (const SExpression &approval, bool approved) noexcept override
void	notifyDerivedUiDataChanged () noexcept override
Protected Member Functions inherited from LibraryEditorTab
bool	isPathOutsideLibDir () const noexcept
bool	hasUnsavedChanges () const noexcept
void	setWatchedFiles (const TransactionalDirectory &dir, const QSet< QString > &filenames) noexcept
virtual void	watchedFilesModifiedChanged () noexcept
virtual void	reloadFromDisk ()
void	scheduleChecks () noexcept
void	runChecks () noexcept
QString	getWorkspaceSettingsUserName () const noexcept
Protected Member Functions inherited from WindowTab
QWidget *	getWindow () const noexcept

Private Member Functions
bool	isWritable () const noexcept
void	refreshUiData () noexcept
void	refreshDependentElements () noexcept
void	commitUiData () noexcept
bool	save () noexcept
void	selectComponent () noexcept
void	selectPackage () noexcept

Private Attributes
std::unique_ptr< Device >	mDevice
const Mode	mMode
const bool	mIsNewElement
QCollator	mCollator
std::unique_ptr< DevicePinoutBuilder >	mPinoutBuilder
std::shared_ptr< ComponentSignalNameListModel >	mSignalNames
std::unique_ptr< GraphicsScene >	mComponentScene
std::unique_ptr< GraphicsScene >	mPackageScene
bool	mWizardMode
int	mCurrentPageIndex
bool	mComponentSelected
bool	mPackageSelected
bool	mChooseCategory
slint::SharedString	mName
slint::SharedString	mNameError
ElementName	mNameParsed
slint::SharedString	mDescription
slint::SharedString	mKeywords
slint::SharedString	mAuthor
slint::SharedString	mVersion
slint::SharedString	mVersionError
Version	mVersionParsed
bool	mDeprecated
std::shared_ptr< LibraryElementCategoriesModel >	mCategories
std::shared_ptr< CategoryTreeModel >	mCategoriesTree
slint::SharedString	mDatasheetUrl
slint::SharedString	mDatasheetUrlError
std::shared_ptr< AttributeListModel >	mAttributes
std::shared_ptr< DevicePinoutListModel >	mPinout
std::shared_ptr< slint::SortModel< ui::DevicePinoutData > >	mPinoutSorted
std::shared_ptr< PartListModel >	mParts
bool	mIsInterfaceBroken
	Broken interface detection.
Uuid	mOriginalComponentUuid
Uuid	mOriginalPackageUuid
DevicePadSignalMap	mOriginalPadSignalMap
std::shared_ptr< const Component >	mComponent
QString	mComponentDescription
QList< std::shared_ptr< const Symbol > >	mSymbols
QList< std::shared_ptr< SymbolGraphicsItem > >	mSymbolGraphicsItems
std::shared_ptr< const Package >	mPackage
QString	mPackageDescription
std::unique_ptr< FootprintGraphicsItem >	mFootprintGraphicsItem

Additional Inherited Members
Signals inherited from WindowTab
void	panelPageRequested (ui::PanelPage p)
void	closeRequested ()
void	closeEnforced ()
void	statusBarMessageChanged (const QString &message, int timeoutMs)
void	cursorCoordinatesChanged (const Point &pos, const LengthUnit &unit)
Protected Attributes inherited from LibraryEditorTab
LibraryEditor &	mEditor
std::unique_ptr< UndoStack >	mUndoStack
bool	mManualModificationsMade
QSet< SExpression >	mSupportedApprovals
QSet< SExpression >	mDisappearedApprovals
std::shared_ptr< RuleCheckMessagesModel >	mCheckMessages
slint::SharedString	mCheckError
QTimer	mRuleCheckDelayTimer
QFileSystemWatcher	mFileSystemWatcher
QHash< FilePath, QByteArray >	mWatchedFileHashes
	To detect modifications.
QSet< FilePath >	mModifiedWatchedFiles
	Modified, but not reloaded yet.
bool	mAutoReloadOnFileModifications
	Set by derived classes.
QTimer	mWatchedFilesTimer
	To delay/aggregate the notification & reload.
Protected Attributes inherited from WindowTab
GuiApplication &	mApp
MainWindow *	mWindow

Detailed Description

The DeviceTab class.

Member Enumeration Documentation

Mode

enum class Mode

strong

Enumerator
Open
New
Duplicate

Constructor & Destructor Documentation

DeviceTab() [1/3]

DeviceTab ( )

delete

DeviceTab() [2/3]

DeviceTab ( const DeviceTab &  other )

delete

DeviceTab() [3/3]

DeviceTab ( LibraryEditor &  editor, std::unique_ptr< Device >  dev, Mode  mode, QObject *  parent = nullptr  )

explicitnoexcept

~DeviceTab()

~DeviceTab ( )

noexcept

Here is the call graph for this function:

Member Function Documentation

getDirectoryPath()

FilePath getDirectoryPath ( ) const

overridevirtualnoexcept

Implements LibraryEditorTab.

getUiData()

ui::TabData getUiData ( ) const

overridevirtualnoexcept

Implements WindowTab.

Here is the call graph for this function:

getDerivedUiData()

ui::DeviceTabData getDerivedUiData ( ) const

noexcept

Here is the call graph for this function:

setDerivedUiData()

void setDerivedUiData ( const ui::DeviceTabData &  data )

noexcept

Here is the call graph for this function:

trigger()

void trigger ( ui::TabAction  a )

overridevirtualnoexcept

Reimplemented from WindowTab.

Here is the call graph for this function:

renderScene()

slint::Image renderScene ( float  width, float  height, int  scene  )

overridevirtualnoexcept

Reimplemented from WindowTab.

Here is the call graph for this function:

requestClose()

bool requestClose ( )

overridevirtualnoexcept

Request to close the tab.

If there are unsaved changes to the tab, this method will ask the user whether the changes should be saved or not. If the user clicks on "cancel" or the changes could not be saved successfully, this method will return false. If there were no unsaved changes or they were successfully saved, the method returns true.

Return values

true	Tab is safe to be closed.
false	Tab still has unsaved changes.

Reimplemented from WindowTab.

Here is the call graph for this function:

operator=()

DeviceTab & operator= ( const DeviceTab &  rhs )

delete

runChecksImpl()

std::optional< std::pair< RuleCheckMessageList, QSet< SExpression > > > runChecksImpl ( )

overrideprotectedvirtual

Implements LibraryEditorTab.

autoFixImpl()

bool autoFixImpl ( const std::shared_ptr< const RuleCheckMessage > &  msg, bool  checkOnly  )

overrideprotectedvirtual

Implements LibraryEditorTab.

autoFixHelper()

template<typename MessageType >

bool autoFixHelper ( const std::shared_ptr< const RuleCheckMessage > &  msg, bool  checkOnly  )

protected

Here is the call graph for this function:

autoFix() [1/4]

template<typename MessageType >

bool autoFix ( const MessageType &  msg )

protected

Here is the caller graph for this function:

messageApprovalChanged()

void messageApprovalChanged ( const SExpression &  approval, bool  approved  )

overrideprotectedvirtualnoexcept

Implements LibraryEditorTab.

notifyDerivedUiDataChanged()

void notifyDerivedUiDataChanged ( )

overrideprotectedvirtualnoexcept

Implements LibraryEditorTab.

isWritable()

bool isWritable ( ) const

privatenoexcept

Here is the caller graph for this function:

refreshUiData()

void refreshUiData ( )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

refreshDependentElements()

void refreshDependentElements ( )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

commitUiData()

void commitUiData ( )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

save()

bool save ( )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

selectComponent()

void selectComponent ( )

privatenoexcept

Here is the call graph for this function:

selectPackage()

void selectPackage ( )

privatenoexcept

Here is the call graph for this function:

autoFix() [2/4]

template<>

bool autoFix

(

const MsgNameNotTitleCase &

msg

)

Here is the call graph for this function:

autoFix() [3/4]

template<>

bool autoFix

(

const MsgMissingAuthor &

msg

)

Here is the call graph for this function:

autoFix() [4/4]

template<>

bool autoFix

(

const MsgMissingCategories &

msg

)

Member Data Documentation

onDerivedUiDataChanged

Signal<DeviceTab> onDerivedUiDataChanged

mDevice

std::unique_ptr<Device> mDevice

private

mMode

const Mode mMode

private

mIsNewElement

const bool mIsNewElement

private

mCollator

QCollator mCollator

private

mPinoutBuilder

std::unique_ptr<DevicePinoutBuilder> mPinoutBuilder

private

mSignalNames

std::shared_ptr<ComponentSignalNameListModel> mSignalNames

private

mComponentScene

std::unique_ptr<GraphicsScene> mComponentScene

private

mPackageScene

std::unique_ptr<GraphicsScene> mPackageScene

private

mWizardMode

bool mWizardMode

private

mCurrentPageIndex

int mCurrentPageIndex

private

mComponentSelected

bool mComponentSelected

private

mPackageSelected

bool mPackageSelected

private

mChooseCategory

bool mChooseCategory

private

mName

slint::SharedString mName

private

mNameError

slint::SharedString mNameError

private

mNameParsed

ElementName mNameParsed

private

mDescription

slint::SharedString mDescription

private

mKeywords

slint::SharedString mKeywords

private

mAuthor

slint::SharedString mAuthor

private

mVersion

slint::SharedString mVersion

private

mVersionError

slint::SharedString mVersionError

private

mVersionParsed

Version mVersionParsed

private

mDeprecated

bool mDeprecated

private

mCategories

std::shared_ptr<LibraryElementCategoriesModel> mCategories

private

mCategoriesTree

std::shared_ptr<CategoryTreeModel> mCategoriesTree

private

mDatasheetUrl

slint::SharedString mDatasheetUrl

private

mDatasheetUrlError

slint::SharedString mDatasheetUrlError

private

mAttributes

std::shared_ptr<AttributeListModel> mAttributes

private

mPinout

std::shared_ptr<DevicePinoutListModel> mPinout

private

mPinoutSorted

std::shared_ptr<slint::SortModel<ui::DevicePinoutData> > mPinoutSorted

private

mParts

std::shared_ptr<PartListModel> mParts

private

mIsInterfaceBroken

bool mIsInterfaceBroken

private

Broken interface detection.

mOriginalComponentUuid

Uuid mOriginalComponentUuid

private

mOriginalPackageUuid

Uuid mOriginalPackageUuid

private

mOriginalPadSignalMap

DevicePadSignalMap mOriginalPadSignalMap

private

mComponent

std::shared_ptr<const Component> mComponent

private

mComponentDescription

QString mComponentDescription

private

mSymbols

QList<std::shared_ptr<const Symbol> > mSymbols

private

mSymbolGraphicsItems

QList<std::shared_ptr<SymbolGraphicsItem> > mSymbolGraphicsItems

private

mPackage

std::shared_ptr<const Package> mPackage

private

mPackageDescription

QString mPackageDescription

private

mFootprintGraphicsItem

std::unique_ptr<FootprintGraphicsItem> mFootprintGraphicsItem

private

---

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

• /__w/1/s/libs/librepcb/editor/library/dev/devicetab.h
• /__w/1/s/libs/librepcb/editor/library/dev/devicetab.cpp