LibraryTab Class Reference

The LibraryTab class. More...

#include <librarytab.h>

Inheritance diagram for LibraryTab:

Collaboration diagram for LibraryTab:

Classes
struct	TreeItem

Signals
void	componentCategoryEditorRequested (LibraryEditor &editor, const FilePath &fp, bool copyFrom)
void	packageCategoryEditorRequested (LibraryEditor &editor, const FilePath &fp, bool copyFrom)
void	symbolEditorRequested (LibraryEditor &editor, const FilePath &fp, bool copyFrom)
void	packageEditorRequested (LibraryEditor &editor, const FilePath &fp)
void	componentEditorRequested (LibraryEditor &editor, const FilePath &fp)
void	deviceEditorRequested (LibraryEditor &editor, const FilePath &fp)
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)

Public Member Functions
	LibraryTab ()=delete
	LibraryTab (const LibraryTab &other)=delete
	LibraryTab (LibraryEditor &editor, bool wizardMode, QObject *parent=nullptr) noexcept
	~LibraryTab () noexcept
FilePath	getDirectoryPath () const noexcept override
ui::TabData	getUiData () const noexcept override
void	setUiData (const ui::TabData &data) noexcept override
ui::LibraryTabData	getDerivedUiData () const noexcept
void	setDerivedUiData (const ui::LibraryTabData &data) noexcept
void	trigger (ui::TabAction a) noexcept override
LibraryTab &	operator= (const LibraryTab &rhs)=delete
template<>
void	autoFix (const MsgNameNotTitleCase &msg)
template<>
void	autoFix (const MsgMissingAuthor &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	activate () noexcept
virtual void	deactivate () noexcept
virtual slint::Image	renderScene (float width, float height, int scene) 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
virtual bool	requestClose () noexcept
	Request to close the tab.
WindowTab &	operator= (const WindowTab &rhs)=delete

Public Attributes
Signal< LibraryTab >	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 >
void	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	scheduleChecks () noexcept
void	runChecks () noexcept
QString	getWorkspaceSettingsUserName () const noexcept

Private Member Functions
void	refreshUiData () noexcept
void	commitUiData () noexcept
void	refreshLibElements () noexcept
std::shared_ptr< TreeItem >	createRootItem (ui::LibraryTreeViewItemType type) noexcept
template<typename CategoryType >
void	loadCategories (ui::LibraryTreeViewItemType type, TreeItem &root)
template<typename CategoryType >
std::shared_ptr< TreeItem >	getOrCreateCategory (ui::LibraryTreeViewItemType type, const Uuid &uuid, TreeItem &root)
template<typename ElementType , typename CategoryType >
void	loadElements (ui::LibraryTreeViewItemType type, ui::LibraryTreeViewItemType catType, TreeItem &root, int &count)
void	sortItemsRecursive (QVector< std::shared_ptr< TreeItem > > &items) noexcept
void	addCategoriesToModel (ui::LibraryTreeViewItemType type, TreeItem &root, int count) noexcept
void	addCategoriesToModel (TreeItem &item, ui::LibraryTreeViewItemType type, slint::VectorModel< ui::LibraryTreeViewItemData > &model, int level) noexcept
void	setSelectedCategory (const std::optional< ui::LibraryTreeViewItemData > &data) noexcept
void	getChildsRecursive (TreeItem &item, QSet< std::shared_ptr< TreeItem > > &childs) noexcept
QList< std::shared_ptr< TreeItem > >	getSelectedCategories () const noexcept
QList< std::shared_ptr< TreeItem > >	getSelectedElements () const noexcept
void	duplicateElements (const QList< std::shared_ptr< TreeItem > > &items) noexcept
void	moveElementsTo (const QList< std::shared_ptr< TreeItem > > &items, const FilePath &dstLib) noexcept
void	deleteElements (const QList< std::shared_ptr< TreeItem > > &items) noexcept

Private Attributes
Library &	mLibrary
const WorkspaceLibraryDb &	mDb
const QStringList &	mLocaleOrder
bool	mWizardMode
int	mCurrentPageIndex
int	mCurrentCategoryIndex
int	mCurrentElementIndex
QString	mFilterTerm
QByteArray	mIcon
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
slint::SharedString	mUrl
slint::SharedString	mUrlError
std::shared_ptr< LibraryDependenciesModel >	mDependencies
slint::SharedString	mManufacturer
QHash< FilePath, Uuid >	mLibCategories
std::shared_ptr< TreeItem >	mUncategorizedRoot
std::shared_ptr< TreeItem >	mCmpCatRoot
int	mCmpCatElementCount
std::shared_ptr< TreeItem >	mPkgCatRoot
int	mPkgCatElementCount
QHash< QString, std::shared_ptr< TreeItem > >	mLibElementsMap
std::shared_ptr< slint::VectorModel< ui::LibraryTreeViewItemData > >	mCategories
std::shared_ptr< slint::VectorModel< ui::LibraryTreeViewItemData > >	mElements
std::shared_ptr< slint::FilterModel< ui::LibraryTreeViewItemData > >	mFilteredElements

Additional Inherited Members
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
Protected Attributes inherited from WindowTab
GuiApplication &	mApp

Detailed Description

The LibraryTab class.

Constructor & Destructor Documentation

LibraryTab() [1/3]

LibraryTab ( )

delete

LibraryTab() [2/3]

LibraryTab ( const LibraryTab &  other )

delete

LibraryTab() [3/3]

LibraryTab ( LibraryEditor &  editor, bool  wizardMode, QObject *  parent = nullptr  )

explicitnoexcept

Here is the call graph for this function:

~LibraryTab()

~LibraryTab ( )

noexcept

Here is the call graph for this function:

Member Function Documentation

getDirectoryPath()

FilePath getDirectoryPath ( ) const

overridevirtualnoexcept

Implements LibraryEditorTab.

Here is the call graph for this function:

getUiData()

ui::TabData getUiData ( ) const

overridevirtualnoexcept

Implements WindowTab.

Here is the call graph for this function:

setUiData()

void setUiData ( const ui::TabData &  data )

overridevirtualnoexcept

Reimplemented from WindowTab.

Here is the call graph for this function:

getDerivedUiData()

ui::LibraryTabData getDerivedUiData ( ) const

noexcept

Here is the call graph for this function:

setDerivedUiData()

void setDerivedUiData ( const ui::LibraryTabData &  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:

operator=()

LibraryTab & operator= ( const LibraryTab &  rhs )

delete

componentCategoryEditorRequested

void componentCategoryEditorRequested ( LibraryEditor &  editor, const FilePath &  fp, bool  copyFrom  )

signal

Here is the caller graph for this function:

packageCategoryEditorRequested

void packageCategoryEditorRequested ( LibraryEditor &  editor, const FilePath &  fp, bool  copyFrom  )

signal

Here is the caller graph for this function:

symbolEditorRequested

void symbolEditorRequested ( LibraryEditor &  editor, const FilePath &  fp, bool  copyFrom  )

signal

Here is the caller graph for this function:

packageEditorRequested

void packageEditorRequested ( LibraryEditor &  editor, const FilePath &  fp  )

signal

Here is the caller graph for this function:

componentEditorRequested

void componentEditorRequested ( LibraryEditor &  editor, const FilePath &  fp  )

signal

Here is the caller graph for this function:

deviceEditorRequested

void deviceEditorRequested ( LibraryEditor &  editor, const FilePath &  fp  )

signal

Here is the caller graph for this function:

runChecksImpl()

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

overrideprotectedvirtual

Implements LibraryEditorTab.

Here is the call graph for this function:

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/3]

template<typename MessageType >

void 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.

refreshUiData()

void refreshUiData ( )

privatenoexcept

Here is the call graph for this function:

commitUiData()

void commitUiData ( )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

refreshLibElements()

void refreshLibElements ( )

privatenoexcept

Here is the call graph for this function:

createRootItem()

std::shared_ptr< LibraryTab::TreeItem > createRootItem ( ui::LibraryTreeViewItemType  type )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

loadCategories()

template<typename CategoryType >

void loadCategories ( ui::LibraryTreeViewItemType  type, TreeItem &  root  )

private

Here is the call graph for this function:

getOrCreateCategory()

template<typename CategoryType >

std::shared_ptr< LibraryTab::TreeItem > getOrCreateCategory ( ui::LibraryTreeViewItemType  type, const Uuid &  uuid, TreeItem &  root  )

private

Here is the call graph for this function:

loadElements()

template<typename ElementType , typename CategoryType >

void loadElements ( ui::LibraryTreeViewItemType  type, ui::LibraryTreeViewItemType  catType, TreeItem &  root, int &  count  )

private

Here is the call graph for this function:

sortItemsRecursive()

void sortItemsRecursive ( QVector< std::shared_ptr< TreeItem > > &  items )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

addCategoriesToModel() [1/2]

void addCategoriesToModel ( ui::LibraryTreeViewItemType  type, TreeItem &  root, int  count  )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

addCategoriesToModel() [2/2]

void addCategoriesToModel ( TreeItem &  item, ui::LibraryTreeViewItemType  type, slint::VectorModel< ui::LibraryTreeViewItemData > &  model, int  level  )

privatenoexcept

Here is the call graph for this function:

setSelectedCategory()

void setSelectedCategory ( const std::optional< ui::LibraryTreeViewItemData > &  data )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getChildsRecursive()

void getChildsRecursive ( TreeItem &  item, QSet< std::shared_ptr< TreeItem > > &  childs  )

privatenoexcept

Here is the call graph for this function:

getSelectedCategories()

QList< std::shared_ptr< LibraryTab::TreeItem > > getSelectedCategories ( ) const

privatenoexcept

Here is the call graph for this function:

getSelectedElements()

QList< std::shared_ptr< LibraryTab::TreeItem > > getSelectedElements ( ) const

privatenoexcept

Here is the call graph for this function:

duplicateElements()

void duplicateElements ( const QList< std::shared_ptr< TreeItem > > &  items )

privatenoexcept

moveElementsTo()

void moveElementsTo ( const QList< std::shared_ptr< TreeItem > > &  items, const FilePath &  dstLib  )

privatenoexcept

Here is the call graph for this function:

deleteElements()

void deleteElements ( const QList< std::shared_ptr< TreeItem > > &  items )

privatenoexcept

Here is the call graph for this function:

autoFix() [2/3]

template<>

void autoFix

(

const MsgNameNotTitleCase &

msg

)

Here is the call graph for this function:

autoFix() [3/3]

template<>

void autoFix

(

const MsgMissingAuthor &

msg

)

Here is the call graph for this function:

Member Data Documentation

onDerivedUiDataChanged

Signal<LibraryTab> onDerivedUiDataChanged

mLibrary

Library& mLibrary

private

mDb

const WorkspaceLibraryDb& mDb

private

mLocaleOrder

const QStringList& mLocaleOrder

private

mWizardMode

bool mWizardMode

private

mCurrentPageIndex

int mCurrentPageIndex

private

mCurrentCategoryIndex

int mCurrentCategoryIndex

private

mCurrentElementIndex

int mCurrentElementIndex

private

mFilterTerm

QString mFilterTerm

private

mIcon

QByteArray mIcon

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

mUrl

slint::SharedString mUrl

private

mUrlError

slint::SharedString mUrlError

private

mDependencies

std::shared_ptr<LibraryDependenciesModel> mDependencies

private

mManufacturer

slint::SharedString mManufacturer

private

mLibCategories

QHash<FilePath, Uuid> mLibCategories

private

mUncategorizedRoot

std::shared_ptr<TreeItem> mUncategorizedRoot

private

mCmpCatRoot

std::shared_ptr<TreeItem> mCmpCatRoot

private

mCmpCatElementCount

int mCmpCatElementCount

private

mPkgCatRoot

std::shared_ptr<TreeItem> mPkgCatRoot

private

mPkgCatElementCount

int mPkgCatElementCount

private

mLibElementsMap

QHash<QString, std::shared_ptr<TreeItem> > mLibElementsMap

private

mCategories

std::shared_ptr<slint::VectorModel<ui::LibraryTreeViewItemData> > mCategories

private

mElements

std::shared_ptr<slint::VectorModel<ui::LibraryTreeViewItemData> > mElements

private

mFilteredElements

std::shared_ptr<slint::FilterModel<ui::LibraryTreeViewItemData> > mFilteredElements

private

---

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

• /__w/1/s/libs/librepcb/editor/library/lib/librarytab.h
• /__w/1/s/libs/librepcb/editor/library/lib/librarytab.cpp