KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DRC_RE_FIELD_POSITION Struct Reference

Specifies the position and size of a field overlaid on a constraint bitmap. More...

#include <drc_re_overlay_types.h>

Public Member Functions

 DRC_RE_FIELD_POSITION ()
 
 DRC_RE_FIELD_POSITION (int aXStart, int aXEnd, int aYCenter, const wxString &aLabelText=wxEmptyString, LABEL_POSITION aLabelPos=LABEL_POSITION::NONE, const wxString &aTooltipText=wxEmptyString, const wxString &aPrefixText=wxEmptyString)
 

Public Attributes

int xStart
 Left edge X coordinate where the field starts.
 
int xEnd
 Right edge X coordinate where the field ends.
 
int yCenter
 Vertical center Y coordinate of the field.
 
wxString labelText
 Optional label text (empty for no label)
 
LABEL_POSITION labelPosition
 Position of label relative to field.
 
wxString tooltipText
 Optional tooltip shown on the control.
 
wxString prefixText
 Optional text placed on the left.
 

Detailed Description

Specifies the position and size of a field overlaid on a constraint bitmap.

All coordinates are in 1x bitmap pixels. When the system selects a higher-resolution bitmap (1.5x or 2x), these values are automatically scaled at runtime.

yCenter is the vertical center of the field.

Definition at line 47 of file drc_re_overlay_types.h.

Constructor & Destructor Documentation

◆ DRC_RE_FIELD_POSITION() [1/2]

DRC_RE_FIELD_POSITION::DRC_RE_FIELD_POSITION ( )
inline

Definition at line 58 of file drc_re_overlay_types.h.

References labelPosition, labelText, NONE, prefixText, tooltipText, xEnd, xStart, and yCenter.

◆ DRC_RE_FIELD_POSITION() [2/2]

DRC_RE_FIELD_POSITION::DRC_RE_FIELD_POSITION ( int aXStart,
int aXEnd,
int aYCenter,
const wxString & aLabelText = wxEmptyString,
LABEL_POSITION aLabelPos = LABEL_POSITION::NONE,
const wxString & aTooltipText = wxEmptyString,
const wxString & aPrefixText = wxEmptyString )
inline

Definition at line 69 of file drc_re_overlay_types.h.

References labelPosition, labelText, NONE, prefixText, tooltipText, xEnd, xStart, and yCenter.

Member Data Documentation

◆ labelPosition

LABEL_POSITION DRC_RE_FIELD_POSITION::labelPosition

◆ labelText

wxString DRC_RE_FIELD_POSITION::labelText

Optional label text (empty for no label)

Definition at line 53 of file drc_re_overlay_types.h.

Referenced by DRC_RE_BITMAP_OVERLAY_PANEL::AddCheckbox(), DRC_RE_FIELD_POSITION(), and DRC_RE_FIELD_POSITION().

◆ prefixText

wxString DRC_RE_FIELD_POSITION::prefixText

Optional text placed on the left.

Definition at line 56 of file drc_re_overlay_types.h.

Referenced by DRC_RE_FIELD_POSITION(), and DRC_RE_FIELD_POSITION().

◆ tooltipText

wxString DRC_RE_FIELD_POSITION::tooltipText

Optional tooltip shown on the control.

Definition at line 55 of file drc_re_overlay_types.h.

Referenced by DRC_RE_BITMAP_OVERLAY_PANEL::AddControl(), DRC_RE_FIELD_POSITION(), and DRC_RE_FIELD_POSITION().

◆ xEnd

int DRC_RE_FIELD_POSITION::xEnd

◆ xStart

int DRC_RE_FIELD_POSITION::xStart

◆ yCenter

int DRC_RE_FIELD_POSITION::yCenter

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