KiCad PCB EDA Suite
TEXT_EFFECTS Struct Reference

A container for text effects. More...

#include <eda_text.h>

Public Member Functions

 TEXT_EFFECTS (int aSetOfBits=0)
 
void Bit (int aBit, bool aValue)
 
bool Bit (int aBit) const
 

Public Attributes

int bits
 any set of booleans a client uses. More...
 
signed char hjustify
 horizontal justification More...
 
signed char vjustify
 vertical justification More...
 
wxSize size
 
int penwidth
 
double angle
 now: 0.1 degrees; future: degrees More...
 
wxPoint pos
 

Detailed Description

A container for text effects.

These fields are bundled so they can be easily copied together as a lot. The privacy policy is established by client (incorporating) code.

Definition at line 111 of file eda_text.h.

Constructor & Destructor Documentation

◆ TEXT_EFFECTS()

TEXT_EFFECTS::TEXT_EFFECTS ( int  aSetOfBits = 0)
inline

Definition at line 113 of file eda_text.h.

113  :
114  bits( aSetOfBits ),
117  penwidth( 0 ),
118  angle( 0.0 )
119  {}
signed char vjustify
vertical justification
Definition: eda_text.h:123
int bits
any set of booleans a client uses.
Definition: eda_text.h:121
double angle
now: 0.1 degrees; future: degrees
Definition: eda_text.h:126
signed char hjustify
horizontal justification
Definition: eda_text.h:122
int penwidth
Definition: eda_text.h:125

Member Function Documentation

◆ Bit() [1/2]

void TEXT_EFFECTS::Bit ( int  aBit,
bool  aValue 
)
inline

◆ Bit() [2/2]

bool TEXT_EFFECTS::Bit ( int  aBit) const
inline

Definition at line 130 of file eda_text.h.

130 { return bits & (1<<aBit); }
int bits
any set of booleans a client uses.
Definition: eda_text.h:121

References bits.

Member Data Documentation

◆ angle

double TEXT_EFFECTS::angle

now: 0.1 degrees; future: degrees

Definition at line 126 of file eda_text.h.

Referenced by EDA_TEXT::Compare(), EDA_TEXT::GetTextAngle(), and EDA_TEXT::SetTextAngle().

◆ bits

int TEXT_EFFECTS::bits

any set of booleans a client uses.

Definition at line 121 of file eda_text.h.

Referenced by Bit(), and EDA_TEXT::Compare().

◆ hjustify

signed char TEXT_EFFECTS::hjustify

horizontal justification

Definition at line 122 of file eda_text.h.

Referenced by EDA_TEXT::Compare(), EDA_TEXT::GetHorizJustify(), and EDA_TEXT::SetHorizJustify().

◆ penwidth

int TEXT_EFFECTS::penwidth

◆ pos

◆ size

◆ vjustify

signed char TEXT_EFFECTS::vjustify

vertical justification

Definition at line 123 of file eda_text.h.

Referenced by EDA_TEXT::Compare(), EDA_TEXT::GetVertJustify(), and EDA_TEXT::SetVertJustify().


The documentation for this struct was generated from the following file: