LibrePCB Developers Documentation
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
ComponentCategory Class Referencefinal

The ComponentCategory class. More...

#include <componentcategory.h>

+ Inheritance diagram for ComponentCategory:
+ Collaboration diagram for ComponentCategory:

Public Member Functions

 ComponentCategory ()=delete
 
 ComponentCategory (const ComponentCategory &other)=delete
 
 ComponentCategory (const Uuid &uuid, const Version &version, const QString &author, const ElementName &name_en_US, const QString &description_en_US, const QString &keywords_en_US)
 
 ~ComponentCategory () noexcept
 
ComponentCategory & operator= (const ComponentCategory &rhs)=delete
 
- Public Member Functions inherited from LibraryCategory
 LibraryCategory ()=delete
 
 LibraryCategory (const LibraryCategory &other)=delete
 
 LibraryCategory (const QString &shortElementName, const QString &longElementName, const Uuid &uuid, const Version &version, const QString &author, const ElementName &name_en_US, const QString &description_en_US, const QString &keywords_en_US)
 
 LibraryCategory (const QString &shortElementName, const QString &longElementName, std::unique_ptr< TransactionalDirectory > directory, const SExpression &root)
 
virtual ~LibraryCategory () noexcept
 
const std::optional< Uuid > & getParentUuid () const noexcept
 
void setParentUuid (const std::optional< Uuid > &parentUuid) noexcept
 
LibraryCategory & operator= (const LibraryCategory &rhs)=delete
 
- Public Member Functions inherited from LibraryBaseElement
 LibraryBaseElement ()=delete
 
 LibraryBaseElement (const LibraryBaseElement &other)=delete
 
 LibraryBaseElement (const QString &shortElementName, const QString &longElementName, const Uuid &uuid, const Version &version, const QString &author, const ElementName &name_en_US, const QString &description_en_US, const QString &keywords_en_US)
 
 LibraryBaseElement (const QString &shortElementName, const QString &longElementName, bool dirnameMustBeUuid, std::unique_ptr< TransactionalDirectory > directory, const SExpression &root)
 
virtual ~LibraryBaseElement () noexcept
 
const TransactionalDirectory & getDirectory () const noexcept
 
TransactionalDirectory & getDirectory () noexcept
 
const Uuid & getUuid () const noexcept
 
const Version & getVersion () const noexcept
 
const QString & getAuthor () const noexcept
 
const QDateTime & getCreated () const noexcept
 
bool isDeprecated () const noexcept
 
const LocalizedNameMap & getNames () const noexcept
 
const LocalizedDescriptionMap & getDescriptions () const noexcept
 
const LocalizedKeywordsMap & getKeywords () const noexcept
 
QStringList getAllAvailableLocales () const noexcept
 
const QSet< SExpression > & getMessageApprovals () const noexcept
 
void setVersion (const Version &version) noexcept
 
void setAuthor (const QString &author) noexcept
 
void setDeprecated (bool deprecated) noexcept
 
void setNames (const LocalizedNameMap &names) noexcept
 
void setDescriptions (const LocalizedDescriptionMap &descriptions) noexcept
 
void setKeywords (const LocalizedKeywordsMap &keywords) noexcept
 
void setMessageApprovals (const QSet< SExpression > &approvals) noexcept
 
virtual RuleCheckMessageList runChecks () const
 
virtual void save ()
 
virtual void saveTo (TransactionalDirectory &dest)
 
virtual void moveTo (TransactionalDirectory &dest)
 
virtual void saveIntoParentDirectory (TransactionalDirectory &dest)
 
virtual void moveIntoParentDirectory (TransactionalDirectory &dest)
 
LibraryBaseElement & operator= (const LibraryBaseElement &rhs)=delete
 

Static Public Member Functions

static std::unique_ptr< ComponentCategory > open (std::unique_ptr< TransactionalDirectory > directory, bool abortBeforeMigration=false)
 
static QString getShortElementName () noexcept
 
static QString getLongElementName () noexcept
 
- Static Public Member Functions inherited from LibraryBaseElement
template<typename ElementType >
static bool isValidElementDirectory (const FilePath &dir) noexcept
 
template<typename ElementType >
static bool isValidElementDirectory (const TransactionalDirectory &dir, const QString &path) noexcept
 

Private Member Functions

 ComponentCategory (std::unique_ptr< TransactionalDirectory > directory, const SExpression &root)
 

Additional Inherited Members

- Protected Member Functions inherited from LibraryCategory
virtual void serialize (SExpression &root) const override
 Serialize into librepcb::SExpression node.
 
- Protected Member Functions inherited from LibraryBaseElement
void serializeMessageApprovals (SExpression &root) const
 
void removeObsoleteMessageApprovals ()
 
- Static Protected Member Functions inherited from LibraryBaseElement
static Version readFileFormat (const TransactionalDirectory &directory, const QString &fileName)
 
- Protected Attributes inherited from LibraryCategory
std::optional< Uuid > mParentUuid
 
- Protected Attributes inherited from LibraryBaseElement
const QString mShortElementName
 e.g. "lib", "cmpcat"
 
const QString mLongElementName
 e.g. "library", "component_category"
 
std::unique_ptr< TransactionalDirectory > mDirectory
 
Uuid mUuid
 
Version mVersion
 
QString mAuthor
 
QDateTime mCreated
 
bool mIsDeprecated
 
LocalizedNameMap mNames
 
LocalizedDescriptionMap mDescriptions
 
LocalizedKeywordsMap mKeywords
 
QSet< SExpression > mMessageApprovals
 

Detailed Description

The ComponentCategory class.

Constructor & Destructor Documentation

◆ ComponentCategory() [1/4]

ComponentCategory ( )
delete
+ Here is the caller graph for this function:

◆ ComponentCategory() [2/4]

ComponentCategory ( const ComponentCategory &  other)
delete

◆ ComponentCategory() [3/4]

ComponentCategory ( const Uuid &  uuid,
const Version &  version,
const QString &  author,
const ElementName &  name_en_US,
const QString &  description_en_US,
const QString &  keywords_en_US 
)

◆ ~ComponentCategory()

~ComponentCategory ( )
noexcept

◆ ComponentCategory() [4/4]

ComponentCategory ( std::unique_ptr< TransactionalDirectory >  directory,
const SExpression &  root 
)
private

Member Function Documentation

◆ operator=()

ComponentCategory & operator= ( const ComponentCategory &  rhs)
delete

◆ open()

std::unique_ptr< ComponentCategory > open ( std::unique_ptr< TransactionalDirectory >  directory,
bool  abortBeforeMigration = false 
)
static
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getShortElementName()

static QString getShortElementName ( )
inlinestaticnoexcept
+ Here is the caller graph for this function:

◆ getLongElementName()

static QString getLongElementName ( )
inlinestaticnoexcept
+ Here is the caller graph for this function:
The documentation for this class was generated from the following files: