LibrePCB Developers Documentation
BI_StrokeText Class Referencefinal

The BI_StrokeText class. More...

#include <bi_stroketext.h>

+ Inheritance diagram for BI_StrokeText:
+ Collaboration diagram for BI_StrokeText:

Public Types

enum class  Event
 
typedef Slot< BI_StrokeText, EventOnEditedSlot
 

Public Member Functions

 BI_StrokeText ()=delete
 
 BI_StrokeText (const BI_StrokeText &other)=delete
 
 BI_StrokeText (Board &board, const BoardStrokeTextData &data)
 
 ~BI_StrokeText () noexcept
 
const BoardStrokeTextDatagetData () const noexcept
 
const StrokeFontgetFont () const noexcept
 
const QString & getSubstitutedText () const noexcept
 
const QVector< Path > & getPaths () const noexcept
 
bool setLayer (const Layer &layer) noexcept
 
bool setText (const QString &text) noexcept
 
bool setPosition (const Point &pos) noexcept
 
bool setRotation (const Angle &rotation) noexcept
 
bool setHeight (const PositiveLength &height) noexcept
 
bool setStrokeWidth (const UnsignedLength &strokeWidth) noexcept
 
bool setLetterSpacing (const StrokeTextSpacing &spacing) noexcept
 
bool setLineSpacing (const StrokeTextSpacing &spacing) noexcept
 
bool setAlign (const Alignment &align) noexcept
 
bool setMirrored (bool mirrored) noexcept
 
bool setAutoRotate (bool autoRotate) noexcept
 
bool setLocked (bool locked) noexcept
 
BI_DevicegetDevice () const noexcept
 
void setDevice (BI_Device *device) noexcept
 
void addToBoard () override
 
void removeFromBoard () override
 
BI_StrokeTextoperator= (const BI_StrokeText &rhs)=delete
 
- Public Member Functions inherited from BI_Base
 BI_Base ()=delete
 
 BI_Base (const BI_Base &other)=delete
 
 BI_Base (Board &board) noexcept
 
virtual ~BI_Base () noexcept
 
ProjectgetProject () const noexcept
 
CircuitgetCircuit () const noexcept
 
BoardgetBoard () const noexcept
 
virtual bool isAddedToBoard () const noexcept
 
virtual void addToBoard ()
 
virtual void removeFromBoard ()
 
BI_Baseoperator= (const BI_Base &rhs)=delete
 

Public Attributes

Signal< BI_StrokeText, EventonEdited
 

Private Member Functions

void updateText () noexcept
 
void updatePaths () noexcept
 
void invalidatePlanes (const Layer &layer) noexcept
 

Private Attributes

BoardStrokeTextData mData
 
const StrokeFontmFont
 
BI_DevicemDevice
 
QString mSubstitutedText
 
QVector< PathmPaths
 Without transformation (position/rotation/mirror) More...
 

Additional Inherited Members

- Protected Attributes inherited from BI_Base
BoardmBoard
 

Detailed Description

The BI_StrokeText class.

Member Typedef Documentation

◆ OnEditedSlot

Member Enumeration Documentation

◆ Event

enum class Event
strong
Enumerator
LayerChanged 
PositionChanged 
RotationChanged 
MirroredChanged 
StrokeWidthChanged 
PathsChanged 

Constructor & Destructor Documentation

◆ BI_StrokeText() [1/3]

BI_StrokeText ( )
delete

◆ BI_StrokeText() [2/3]

BI_StrokeText ( const BI_StrokeText other)
delete

◆ BI_StrokeText() [3/3]

BI_StrokeText ( Board board,
const BoardStrokeTextData data 
)
+ Here is the call graph for this function:

◆ ~BI_StrokeText()

~BI_StrokeText ( )
noexcept

Member Function Documentation

◆ getData()

const BoardStrokeTextData & getData ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getFont()

const StrokeFont & getFont ( ) const
inlinenoexcept

◆ getSubstitutedText()

const QString & getSubstitutedText ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getPaths()

const QVector< Path > & getPaths ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ setLayer()

bool setLayer ( const Layer layer)
noexcept
+ Here is the caller graph for this function:

◆ setText()

bool setText ( const QString &  text)
noexcept
+ Here is the caller graph for this function:

◆ setPosition()

bool setPosition ( const Point pos)
noexcept
+ Here is the caller graph for this function:

◆ setRotation()

bool setRotation ( const Angle rotation)
noexcept
+ Here is the caller graph for this function:

◆ setHeight()

bool setHeight ( const PositiveLength height)
noexcept
+ Here is the caller graph for this function:

◆ setStrokeWidth()

bool setStrokeWidth ( const UnsignedLength strokeWidth)
noexcept
+ Here is the caller graph for this function:

◆ setLetterSpacing()

bool setLetterSpacing ( const StrokeTextSpacing spacing)
noexcept
+ Here is the caller graph for this function:

◆ setLineSpacing()

bool setLineSpacing ( const StrokeTextSpacing spacing)
noexcept
+ Here is the caller graph for this function:

◆ setAlign()

bool setAlign ( const Alignment align)
noexcept
+ Here is the caller graph for this function:

◆ setMirrored()

bool setMirrored ( bool  mirrored)
noexcept
+ Here is the caller graph for this function:

◆ setAutoRotate()

bool setAutoRotate ( bool  autoRotate)
noexcept
+ Here is the caller graph for this function:

◆ setLocked()

bool setLocked ( bool  locked)
noexcept
+ Here is the caller graph for this function:

◆ getDevice()

BI_Device * getDevice ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ setDevice()

void setDevice ( BI_Device device)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ addToBoard()

void addToBoard ( )
overridevirtual

Reimplemented from BI_Base.

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

◆ removeFromBoard()

void removeFromBoard ( )
overridevirtual

Reimplemented from BI_Base.

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

◆ operator=()

BI_StrokeText & operator= ( const BI_StrokeText rhs)
delete

◆ updateText()

void updateText ( )
privatenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ updatePaths()

void updatePaths ( )
privatenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ invalidatePlanes()

void invalidatePlanes ( const Layer layer)
privatenoexcept
+ Here is the caller graph for this function:

Member Data Documentation

◆ onEdited

◆ mData

BoardStrokeTextData mData
private

◆ mFont

const StrokeFont& mFont
private

◆ mDevice

BI_Device* mDevice
private

◆ mSubstitutedText

QString mSubstitutedText
private

◆ mPaths

QVector<Path> mPaths
private

Without transformation (position/rotation/mirror)


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