LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
BoardUserSettings Class Referencefinal

The BoardUserSettings class. More...

#include <boardusersettings.h>

+ Inheritance diagram for BoardUserSettings:
+ Collaboration diagram for BoardUserSettings:

Public Member Functions

 BoardUserSettings ()=delete
 
 BoardUserSettings (const BoardUserSettings &other)=delete
 
 BoardUserSettings (Board &board, const BoardUserSettings &other) noexcept
 
 BoardUserSettings (Board &board, bool restore, bool readOnly, bool create)
 
 ~BoardUserSettings () noexcept
 
bool save (bool toOriginal, QStringList &errors) noexcept
 
BoardUserSettingsoperator= (const BoardUserSettings &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...
 

Private Member Functions

void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 

Private Attributes

BoardmBoard
 
FilePath mFilepath
 
QScopedPointer< SmartSExprFilemFile
 
QScopedPointer
< GraphicsLayerStackAppearanceSettings
mLayerSettings
 

Additional Inherited Members

- 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)
 

Detailed Description

The BoardUserSettings class.

Constructor & Destructor Documentation

BoardUserSettings ( )
delete
BoardUserSettings ( const BoardUserSettings other)
delete
BoardUserSettings ( Board board,
const BoardUserSettings other 
)
noexcept
BoardUserSettings ( Board board,
bool  restore,
bool  readOnly,
bool  create 
)
explicit

+ Here is the call graph for this function:

~BoardUserSettings ( )
noexcept

Member Function Documentation

bool save ( bool  toOriginal,
QStringList &  errors 
)
noexcept

+ Here is the call graph for this function:

BoardUserSettings& operator= ( const BoardUserSettings rhs)
delete
void serialize ( SExpression root) const
overrideprivatevirtual

Serialize the object into an existing S-Expression node.

This method inserts/appends all attributes and childs of the object to an existing S-Expression node. The content which already exists in the given S-Expression node will not be removed.

Note
The generated S-Expression node has always the format of the application's major version (it's not possible to generate DOMs of older versions).
Parameters
rootThe target DOM root node
Exceptions
ExceptionThis method throws an exception if an error occurs.

Implements SerializableObject.

Member Data Documentation

Board& mBoard
private
FilePath mFilepath
private
QScopedPointer<SmartSExprFile> mFile
private
QScopedPointer<GraphicsLayerStackAppearanceSettings> mLayerSettings
private

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