LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 (const FilePath &elementDirectory, bool readOnly)
 
 ~ComponentCategory () noexcept
 
ComponentCategoryoperator= (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 FilePath &elementDirectory, const QString &shortElementName, const QString &longElementName, bool readOnly)
 
virtual ~LibraryCategory () noexcept
 
const tl::optional< Uuid > & getParentUuid () const noexcept
 
void setParentUuid (const tl::optional< Uuid > &parentUuid) noexcept
 
LibraryCategoryoperator= (const LibraryCategory &rhs)=delete
 
- Public Member Functions inherited from LibraryBaseElement
 LibraryBaseElement ()=delete
 
 LibraryBaseElement (const LibraryBaseElement &other)=delete
 
 LibraryBaseElement (bool dirnameMustBeUuid, 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 FilePath &elementDirectory, bool dirnameMustBeUuid, const QString &shortElementName, const QString &longElementName, bool readOnly)
 
virtual ~LibraryBaseElement () noexcept
 
const FilePathgetFilePath () const noexcept
 
const QString & getShortElementName () const noexcept
 
const QString & getLongElementName () const noexcept
 
bool isOpenedReadOnly () const noexcept
 
const UuidgetUuid () const noexcept
 
const VersiongetVersion () const noexcept
 
const QString & getAuthor () const noexcept
 
const QDateTime & getCreated () const noexcept
 
bool isDeprecated () const noexcept
 
const LocalizedNameMapgetNames () const noexcept
 
const LocalizedDescriptionMapgetDescriptions () const noexcept
 
const LocalizedKeywordsMapgetKeywords () const noexcept
 
QStringList getAllAvailableLocales () 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
 
virtual
LibraryElementCheckMessageList 
runChecks () const
 
virtual void save ()
 
virtual void saveTo (const FilePath &destination)
 
virtual void saveIntoParentDirectory (const FilePath &parentDir)
 
virtual void moveTo (const FilePath &destination)
 
virtual void moveIntoParentDirectory (const FilePath &parentDir)
 
LibraryBaseElementoperator= (const LibraryBaseElement &rhs)=delete
 
- Public Member Functions inherited from SerializableObject
 SerializableObject () noexcept
 
virtual ~SerializableObject () noexcept
 
SExpression serializeToDomElement (const QString &name) const
 Serialize the object to a new S-Expression node. More...
 

Static Public Member Functions

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
 
- Static Public Member Functions inherited from SerializableObject
template<typename T >
static void serializeObjectContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainerUuidSorted (SExpression &root, const T &container, const QString &itemName)
 

Additional Inherited Members

- Protected Member Functions inherited from LibraryCategory
virtual void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 
- Protected Member Functions inherited from LibraryBaseElement
virtual void cleanupAfterLoadingElementFromFile () noexcept
 
virtual void copyTo (const FilePath &destination, bool removeSource)
 
- Protected Attributes inherited from LibraryCategory
tl::optional< UuidmParentUuid
 
- Protected Attributes inherited from LibraryBaseElement
FilePath mDirectory
 
bool mDirectoryIsTemporary
 
bool mOpenedReadOnly
 
bool mDirectoryNameMustBeUuid
 
QString mShortElementName
 e.g. "lib", "cmpcat", "sym" More...
 
QString mLongElementName
 e.g. "library", "component_category", "symbol" More...
 
SExpression mLoadingFileDocument
 
Uuid mUuid
 
Version mVersion
 
QString mAuthor
 
QDateTime mCreated
 
bool mIsDeprecated
 
LocalizedNameMap mNames
 
LocalizedDescriptionMap mDescriptions
 
LocalizedKeywordsMap mKeywords
 

Detailed Description

The ComponentCategory class.

Constructor & Destructor Documentation

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 ( const FilePath elementDirectory,
bool  readOnly 
)

+ Here is the call graph for this function:

~ComponentCategory ( )
noexcept

Member Function Documentation

ComponentCategory& operator= ( const ComponentCategory rhs)
delete
static QString getShortElementName ( )
inlinestaticnoexcept
static QString getLongElementName ( )
inlinestaticnoexcept

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