LibrePCB Developers Documentation
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) noexcept
 
 BoardUserSettings (Board &board, const BoardUserSettings &other) noexcept
 
 BoardUserSettings (Board &board, const SExpression &node, const Version &fileFormat)
 
 ~BoardUserSettings () noexcept
 
bool getPlaneVisibility (const Uuid &uuid) const noexcept
 
void setPlaneVisibility (const Uuid &uuid, bool visible) noexcept
 
void resetPlanesVisibility () noexcept
 
void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 
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 Attributes

BoardmBoard
 
QScopedPointer< GraphicsLayerStackAppearanceSettingsmLayerSettings
 
QMap< Uuid, bool > mPlanesVisibility
 

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() [1/5]

BoardUserSettings ( )
delete

◆ BoardUserSettings() [2/5]

BoardUserSettings ( const BoardUserSettings other)
delete

◆ BoardUserSettings() [3/5]

BoardUserSettings ( Board board)
explicitnoexcept

◆ BoardUserSettings() [4/5]

BoardUserSettings ( Board board,
const BoardUserSettings other 
)
noexcept

◆ BoardUserSettings() [5/5]

BoardUserSettings ( Board board,
const SExpression node,
const Version fileFormat 
)
+ Here is the call graph for this function:

◆ ~BoardUserSettings()

~BoardUserSettings ( )
noexcept

Member Function Documentation

◆ getPlaneVisibility()

bool getPlaneVisibility ( const Uuid uuid) const
inlinenoexcept

◆ setPlaneVisibility()

void setPlaneVisibility ( const Uuid uuid,
bool  visible 
)
inlinenoexcept

◆ resetPlanesVisibility()

void resetPlanesVisibility ( )
inlinenoexcept
+ Here is the call graph for this function:

◆ serialize()

void serialize ( SExpression root) const
overridevirtual

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.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator=()

BoardUserSettings& operator= ( const BoardUserSettings rhs)
delete
+ Here is the caller graph for this function:

Member Data Documentation

◆ mBoard

Board& mBoard
private

◆ mLayerSettings

QScopedPointer<GraphicsLayerStackAppearanceSettings> mLayerSettings
private

◆ mPlanesVisibility

QMap<Uuid, bool> mPlanesVisibility
private

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