LibrePCB Developers Documentation
Loading...
Searching...
No Matches
componentcategorytab.h
Go to the documentation of this file.
1/*
2 * LibrePCB - Professional EDA for everyone!
3 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
4 * https://librepcb.org/
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef LIBREPCB_EDITOR_COMPONENTCATEGORYTAB_H
21#define LIBREPCB_EDITOR_COMPONENTCATEGORYTAB_H
22
23/*******************************************************************************
24 * Includes
25 ******************************************************************************/
26#include "../libraryeditortab.h"
27
31
32#include <QtCore>
33
34/*******************************************************************************
35 * Namespace / Forward Declarations
36 ******************************************************************************/
37namespace librepcb {
38
39class ComponentCategory;
40
41namespace editor {
42
43class CategoryTreeModel;
44
45/*******************************************************************************
46 * Class ComponentCategoryTab
47 ******************************************************************************/
48
53 Q_OBJECT
54
55public:
56 // Signals
58
59 // Types
60 enum class Mode { Open, New, Duplicate };
61
62 // Constructors / Destructor
65 explicit ComponentCategoryTab(LibraryEditor& editor,
66 std::unique_ptr<ComponentCategory> cat,
67 Mode mode, QObject* parent = nullptr) noexcept;
68 ~ComponentCategoryTab() noexcept;
69
70 // General Methods
71 FilePath getDirectoryPath() const noexcept override;
72 ui::TabData getUiData() const noexcept override;
73 ui::CategoryTabData getDerivedUiData() const noexcept;
74 void setDerivedUiData(const ui::CategoryTabData& data) noexcept;
75 void trigger(ui::TabAction a) noexcept override;
76 bool requestClose() noexcept override;
77
78 // Operator Overloadings
79 ComponentCategoryTab& operator=(const ComponentCategoryTab& rhs) = delete;
80
81protected:
82 std::optional<std::pair<RuleCheckMessageList, QSet<SExpression>>>
83 runChecksImpl() override;
84 bool autoFixImpl(const std::shared_ptr<const RuleCheckMessage>& msg,
85 bool checkOnly) override;
86 template <typename MessageType>
87 bool autoFixHelper(const std::shared_ptr<const RuleCheckMessage>& msg,
88 bool checkOnly);
89 template <typename MessageType>
90 void autoFix(const MessageType& msg);
91 void messageApprovalChanged(const SExpression& approval,
92 bool approved) noexcept override;
93 void notifyDerivedUiDataChanged() noexcept override;
94
95private:
96 bool isWritable() const noexcept;
97 void refreshUiData() noexcept;
98 void commitUiData() noexcept;
99 bool save() noexcept;
100
101private:
102 // References
104
105 // Library metadata to be applied
106 slint::SharedString mName;
107 slint::SharedString mNameError;
109 slint::SharedString mDescription;
110 slint::SharedString mKeywords;
111 slint::SharedString mAuthor;
112 slint::SharedString mVersion;
113 slint::SharedString mVersionError;
116 std::optional<Uuid> mParent;
117 std::shared_ptr<slint::VectorModel<slint::SharedString>> mParents;
119};
120
121/*******************************************************************************
122 * End of File
123 ******************************************************************************/
124
125} // namespace editor
126} // namespace librepcb
127
128#endif
The ComponentCategory class.
Definition componentcategory.h:44
This class represents absolute, well-formatted paths to files or directories.
Definition filepath.h:127
The RuleCheckMessage class.
Definition rulecheckmessage.h:45
The SExpression class.
Definition sexpression.h:69
The Signal class is used to emit signals on non-QObject derived classes.
Definition signalslot.h:65
The Uuid class is a replacement for QUuid to get UUID strings without {} braces.
Definition uuid.h:56
The Version class represents a version number in the format "1.42.7".
Definition version.h:58
The CategoryTreeModel class.
Definition categorytreemodel.h:50
The ComponentCategoryTab class.
Definition componentcategorytab.h:52
void autoFix(const MessageType &msg)
slint::SharedString mVersionError
Definition componentcategorytab.h:113
bool requestClose() noexcept override
Request to close the tab.
Definition componentcategorytab.cpp:229
std::optional< std::pair< RuleCheckMessageList, QSet< SExpression > > > runChecksImpl() override
Definition componentcategorytab.cpp:257
bool save() noexcept
Definition componentcategorytab.cpp:370
std::shared_ptr< slint::VectorModel< slint::SharedString > > mParents
Definition componentcategorytab.h:117
slint::SharedString mName
Definition componentcategorytab.h:106
std::shared_ptr< CategoryTreeModel > mParentsModel
Definition componentcategorytab.h:118
Signal< ComponentCategoryTab > onDerivedUiDataChanged
Definition componentcategorytab.h:57
void setDerivedUiData(const ui::CategoryTabData &data) noexcept
Definition componentcategorytab.cpp:160
slint::SharedString mDescription
Definition componentcategorytab.h:109
Mode
Definition componentcategorytab.h:60
std::unique_ptr< ComponentCategory > mCategory
Definition componentcategorytab.h:103
slint::SharedString mVersion
Definition componentcategorytab.h:112
bool mDeprecated
Definition componentcategorytab.h:115
void messageApprovalChanged(const SExpression &approval, bool approved) noexcept override
Definition componentcategorytab.cpp:281
bool autoFixImpl(const std::shared_ptr< const RuleCheckMessage > &msg, bool checkOnly) override
Definition componentcategorytab.cpp:262
FilePath getDirectoryPath() const noexcept override
Definition componentcategorytab.cpp:107
bool autoFixHelper(const std::shared_ptr< const RuleCheckMessage > &msg, bool checkOnly)
Definition componentcategorytab.cpp:270
Version mVersionParsed
Definition componentcategorytab.h:114
void commitUiData() noexcept
Definition componentcategorytab.cpp:350
slint::SharedString mNameError
Definition componentcategorytab.h:107
slint::SharedString mKeywords
Definition componentcategorytab.h:110
void trigger(ui::TabAction a) noexcept override
Definition componentcategorytab.cpp:186
void notifyDerivedUiDataChanged() noexcept override
Definition componentcategorytab.cpp:291
ElementName mNameParsed
Definition componentcategorytab.h:108
std::optional< Uuid > mParent
Definition componentcategorytab.h:116
slint::SharedString mAuthor
Definition componentcategorytab.h:111
bool isWritable() const noexcept
Definition componentcategorytab.cpp:316
ui::TabData getUiData() const noexcept override
Definition componentcategorytab.cpp:111
ui::CategoryTabData getDerivedUiData() const noexcept
Definition componentcategorytab.cpp:133
void refreshUiData() noexcept
Definition componentcategorytab.cpp:320
ComponentCategoryTab(const ComponentCategoryTab &other)=delete
The LibraryEditor class.
Definition libraryeditor.h:57
Specialized base class for all library editor tabs.
Definition libraryeditortab.h:54
Definition occmodel.cpp:77
QVector< std::shared_ptr< const RuleCheckMessage > > RuleCheckMessageList
Definition rulecheckmessage.h:104
type_safe::constrained_type< QString, ElementNameConstraint, ElementNameVerifier > ElementName
Definition elementname.h:84
Definition uuid.h:186