LibrePCB Developers Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
OrganizationTab Class Referencefinal

The OrganizationTab class. More...

#include <organizationtab.h>

+ Inheritance diagram for OrganizationTab:
+ Collaboration diagram for OrganizationTab:

Public Types

enum class  Mode
 

Public Member Functions

 OrganizationTab ()=delete
 
 OrganizationTab (const OrganizationTab &other)=delete
 
 OrganizationTab (LibraryEditor &editor, std::unique_ptr< Organization > cat, Mode mode, QObject *parent=nullptr) noexcept
 
 ~OrganizationTab () noexcept
 
FilePath getDirectoryPath () const noexcept override
 
ui::TabData getUiData () const noexcept override
 
ui::OrganizationTabData getDerivedUiData () const noexcept
 
void setDerivedUiData (const ui::OrganizationTabData &data) noexcept
 
void trigger (ui::TabAction a) noexcept override
 
bool requestClose () noexcept override
 Request to close the tab.
 
OrganizationTab & operator= (const OrganizationTab &rhs)=delete
 
template<>
bool autoFix (const MsgNameNotTitleCase &msg)
 
template<>
bool 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 setWindow (MainWindow *w) noexcept
 
virtual void setUiData (const ui::TabData &data) 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
 
WindowTab & operator= (const WindowTab &rhs)=delete
 

Public Attributes

Signal< OrganizationTab > 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 commitUiData () noexcept
 
bool save () noexcept
 
void execOutputJobsDialog (const OutputJobList &jobs, void(CmdOrganizationEdit::*setter)(const OutputJobList &jobs)) noexcept
 
Project & getTmpProject ()
 

Private Attributes

std::unique_ptr< Organization > mOrganization
 
QByteArray mLogo
 
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
 
int mPriority
 
std::shared_ptr< OrganizationPcbDesignRulesModel > mPcbDesignRules
 
std::unique_ptr< Project > mTmpProject
 

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 OrganizationTab class.

Member Enumeration Documentation

◆ Mode

enum class Mode
strong
Enumerator
Open 
New 
Duplicate 

Constructor & Destructor Documentation

◆ OrganizationTab() [1/3]

OrganizationTab ( )
delete

◆ OrganizationTab() [2/3]

OrganizationTab ( const OrganizationTab &  other)
delete

◆ OrganizationTab() [3/3]

OrganizationTab ( LibraryEditor &  editor,
std::unique_ptr< Organization >  cat,
Mode  mode,
QObject *  parent = nullptr 
)
explicitnoexcept
+ Here is the call graph for this function:

◆ ~OrganizationTab()

~OrganizationTab ( )
noexcept

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::OrganizationTabData getDerivedUiData ( ) const
noexcept
+ Here is the call graph for this function:

◆ setDerivedUiData()

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

◆ 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
trueTab is safe to be closed.
falseTab still has unsaved changes.

Reimplemented from WindowTab.

◆ operator=()

OrganizationTab & operator= ( const OrganizationTab &  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

◆ autoFix() [1/3]

template<typename MessageType >
bool autoFix ( const MessageType &  msg)
protected

◆ messageApprovalChanged()

void messageApprovalChanged ( const SExpression &  approval,
bool  approved 
)
overrideprotectedvirtualnoexcept

Implements LibraryEditorTab.

◆ notifyDerivedUiDataChanged()

void notifyDerivedUiDataChanged ( )
overrideprotectedvirtualnoexcept

Implements LibraryEditorTab.

◆ isWritable()

bool isWritable ( ) const
privatenoexcept

◆ refreshUiData()

void refreshUiData ( )
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:

◆ save()

bool save ( )
privatenoexcept
+ Here is the call graph for this function:

◆ execOutputJobsDialog()

void execOutputJobsDialog ( const OutputJobList &  jobs,
void(CmdOrganizationEdit::*)(const OutputJobList &jobs)  setter 
)
privatenoexcept

◆ getTmpProject()

Project & getTmpProject ( )
private

◆ autoFix() [2/3]

template<>
bool autoFix ( const MsgNameNotTitleCase &  msg)
+ Here is the call graph for this function:

◆ autoFix() [3/3]

template<>
bool autoFix ( const MsgMissingAuthor &  msg)
+ Here is the call graph for this function:

Member Data Documentation

◆ onDerivedUiDataChanged

Signal<OrganizationTab> onDerivedUiDataChanged

◆ mOrganization

std::unique_ptr<Organization> mOrganization
private

◆ mLogo

QByteArray mLogo
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

◆ mPriority

int mPriority
private

◆ mPcbDesignRules

std::shared_ptr<OrganizationPcbDesignRulesModel> mPcbDesignRules
private

◆ mTmpProject

std::unique_ptr<Project> mTmpProject
private
The documentation for this class was generated from the following files: