KiCad PCB EDA Suite: SCH_TEXT Class Reference

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), LIB_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), LIB_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_TOOLS::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_TOOLS::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), LIB_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::RepeatDrawItem(), LIB_PIN_TOOL::RepeatPin(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References EDA_ITEM::m_flags.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 199 of file eda_item.h.

199 { ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Definition: eda_item.h:113

EDA_ITEM::ClearFlags

void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:221

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_PART::LIB_PART(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), PL_SELECTION_TOOL::unhighlight(), EE_SELECTION_TOOL::unhighlight(), SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 233 of file eda_item.h.

     {
         ClearFlags( STARTPOINT | ENDPOINT | CANDIDATE | TEMP_SELECTED | IS_LINKED | SKIP_STRUCT |
                     DO_NOT_DRAW );
     }

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, ENDPOINT, IS_LINKED, SKIP_STRUCT, STARTPOINT, and TEMP_SELECTED.

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 154 of file view_item.h.

     {
         m_viewPrivData = NULL;
     }

References KIGFX::VIEW_ITEM::m_viewPrivData, and NULL.

Referenced by KIGFX::VIEW::OnDestroy().

◆ Clone()

EDA_ITEM * SCH_TEXT::Clone ( ) const

overridevirtual

Function Clone creates a duplicate of this item with linked list members set to NULL.

The default version will return NULL in release builds and likely crash the program. In debug builds, a warning message indicating the derived class has not implemented cloning. This really should be a pure virtual function. Due to the fact that there are so many objects derived from EDA_ITEM, the decision was made to return NULL until all the objects derived from EDA_ITEM implement cloning. Once that happens, this function should be made pure.

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Reimplemented in SCH_HIERLABEL, SCH_GLOBALLABEL, and SCH_LABEL.

Definition at line 146 of file sch_text.cpp.

 {
     return new SCH_TEXT( *this );
 }

References SCH_TEXT().

◆ ConnectedItems()

SCH_ITEM_SET & SCH_ITEM::ConnectedItems ( const SCH_SHEET_PATH & aPath )

inherited

Retrieves the set of items connected to this item on the given sheet.

Definition at line 164 of file sch_item.cpp.

 {
     return m_connected_items[ aSheet ];
 }

References SCH_ITEM::m_connected_items.

Referenced by addConnections(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), CONNECTION_GRAPH::buildConnectionGraph(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ Connection()

SCH_CONNECTION * SCH_ITEM::Connection ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

Retrieve the connection associated with this object in the given sheet.

Note: The returned value can be nullptr.

Definition at line 131 of file sch_item.cpp.

 {
     if( !aSheet )
         aSheet = &Schematic()->CurrentSheet();
 
     auto it = m_connection_map.find( *aSheet );
 
     if( it == m_connection_map.end() )
         return nullptr;
     else
         return it->second;
 }

References SCHEMATIC::CurrentSheet(), SCH_ITEM::m_connection_map, and SCH_ITEM::Schematic().

Referenced by CONNECTION_SUBGRAPH::Absorb(), CONNECTION_SUBGRAPH::AddItem(), BACK_ANNOTATE::applyChangelist(), CONNECTION_GRAPH::buildConnectionGraph(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckNoConnects(), SCH_PIN::GetMsgPanelInfo(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), GetMsgPanelInfo(), CONNECTION_SUBGRAPH::GetNetName(), highlightNet(), SCH_ITEM::InitializeConnection(), SCH_ITEM::NetClass(), SCH_EDIT_FRAME::OnModify(), SCH_HIERLABEL::Print(), CONNECTION_SUBGRAPH::ResolveDrivers(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), BUS_UNFOLD_MENU::update(), SCH_EDITOR_CONTROL::UpdateNetHighlighting(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ ConnectionPropagatesTo()

virtual bool SCH_ITEM::ConnectionPropagatesTo ( const EDA_ITEM * aItem ) const

inlinevirtualinherited

Returns true if this item should propagate connection info to aItem.

Reimplemented in SCH_BUS_WIRE_ENTRY, and SCH_PIN.

Definition at line 442 of file sch_item.h.

442 { return true; }

Referenced by CONNECTION_GRAPH::updateItemConnectivity().

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT & aSrc )

inherited

Definition at line 129 of file eda_text.cpp.

 {
     m_text = aSrc.m_text;
     m_shown_text = aSrc.m_shown_text;
     m_shown_text_has_text_var_refs = aSrc.m_shown_text_has_text_var_refs;
 }

References EDA_TEXT::m_shown_text, EDA_TEXT::m_shown_text_has_text_var_refs, and EDA_TEXT::m_text.

Referenced by LIB_FIELD::Copy(), and CLIPBOARD_IO::SaveSelection().

◆ CreateGraphicShape()

virtual void SCH_TEXT::CreateGraphicShape	(	RENDER_SETTINGS *	aSettings,
		std::vector< wxPoint > &	aPoints,
		const wxPoint &	Pos
	)

inlinevirtual

Calculate the graphic shape (a polygon) associated to the text.

Parameters

aPoints	A buffer to fill with polygon corners coordinates
Pos	Position of the shape, for texts and labels: do nothing Mainly for derived classes (SCH_SHEET_PIN and Hierarchical labels)

Reimplemented in SCH_HIERLABEL, SCH_GLOBALLABEL, and SCH_SHEET_PIN.

Definition at line 256 of file sch_text.h.

     {
         aPoints.clear();
     }

Referenced by Plot().

◆ DoHypertextMenu()

virtual void SCH_ITEM::DoHypertextMenu ( EDA_DRAW_FRAME * aFrame )

inlinevirtualinherited

Reimplemented in SCH_FIELD.

Definition at line 280 of file sch_item.h.

280 { }

◆ Duplicate()

SCH_ITEM * SCH_ITEM::Duplicate ( bool doClone = false ) const

inherited

Routine to create a new copy of given item.

The new object is not put in draw list (not linked).

Parameters

doClone (default = false) indicates unique values (such as timestamp and sheet name) should be duplicated. Use only for undo/redo operations.

Definition at line 78 of file sch_item.cpp.

 {
     SCH_ITEM* newItem = (SCH_ITEM*) Clone();
 
     if( !doClone )
         const_cast<KIID&>( newItem->m_Uuid ) = KIID();
 
     newItem->ClearFlags( SELECTED | BRIGHTENED );
 
     newItem->RunOnChildren(
             []( SCH_ITEM* aChild )
             {
                 aChild->ClearFlags( SELECTED | BRIGHTENED );
             } );
 
     return newItem;
 }

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), EDA_ITEM::m_Uuid, SCH_ITEM::RunOnChildren(), and SELECTED.

Referenced by SCH_EDIT_TOOL::Duplicate(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_DRAWING_TOOLS::PlaceComponent(), SCH_EDIT_TOOL::RepeatDrawItem(), and SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ Empty()

void EDA_TEXT::Empty ( )

inlineinherited

Definition at line 261 of file eda_text.h.

261 { m_text.Empty(); }

EDA_TEXT::m_text

wxString m_text

Definition: eda_text.h:377

References EDA_TEXT::m_text.

Referenced by SCH_LEGACY_PLUGIN_CACHE::LoadPart().

◆ Format()

void EDA_TEXT::Format	(	OUTPUTFORMATTER *	aFormatter,
		int	aNestLevel,
		int	aControlBits
	)		const

virtualinherited

Output the object to aFormatter in s-expression form.

Parameters

aFormatter	The OUTPUTFORMATTER object to write to.
aNestLevel	The indentation next level.
aControlBits	The control bit definition for object specific formatting.

Exceptions

IO_ERROR on write error.

Definition at line 520 of file eda_text.cpp.

 {
 #ifndef GERBVIEW        // Gerbview does not use EDA_TEXT::Format
                         // and does not define FormatInternalUnits, used here
                         // however this function should exist
 
     aFormatter->Print( aNestLevel + 1, "(effects" );
 
     // Text size
     aFormatter->Print( 0, " (font" );
 
     aFormatter->Print( 0, " (size %s %s)",
                        FormatInternalUnits( GetTextHeight() ).c_str(),
                        FormatInternalUnits( GetTextWidth() ).c_str() );
 
     if( GetTextThickness() )
         aFormatter->Print( 0, " (thickness %s)", FormatInternalUnits( GetTextThickness() ).c_str() );
 
     if( IsBold() )
         aFormatter->Print( 0, " bold" );
 
     if( IsItalic() )
         aFormatter->Print( 0, " italic" );
 
     aFormatter->Print( 0, ")"); // (font
 
     if( IsMirrored() ||
         GetHorizJustify() != GR_TEXT_HJUSTIFY_CENTER ||
         GetVertJustify() != GR_TEXT_VJUSTIFY_CENTER )
     {
         aFormatter->Print( 0, " (justify");
 
         if( GetHorizJustify() != GR_TEXT_HJUSTIFY_CENTER )
             aFormatter->Print( 0, (GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT) ? " left" : " right" );
 
         if( GetVertJustify() != GR_TEXT_VJUSTIFY_CENTER )
             aFormatter->Print( 0, (GetVertJustify() == GR_TEXT_VJUSTIFY_TOP) ? " top" : " bottom" );
 
         if( IsMirrored() )
             aFormatter->Print( 0, " mirror" );
         aFormatter->Print( 0, ")" ); // (justify
     }
 
     if( !(aControlBits & CTL_OMIT_HIDE) && !IsVisible() )
         aFormatter->Print( 0, " hide" );
 
     aFormatter->Print( 0, ")\n" ); // (justify
 
 #endif
 }

References CTL_OMIT_HIDE, FormatInternalUnits(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetVertJustify(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsVisible(), and OUTPUTFORMATTER::Print().

Referenced by SCH_SEXPR_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN::saveText(), and SCH_SEXPR_PLUGIN_CACHE::saveText().

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 84 of file inspectable.h.

     {
         PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
         TYPE_ID thisType = TYPE_HASH( *this );
         void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
         return object ? aProperty->getter( object ) : wxAny();
     }

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [2/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty )

inlineinherited

Definition at line 93 of file inspectable.h.

     {
         PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
         TYPE_ID thisType = TYPE_HASH( *this );
         void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
         return object ? aProperty->get<T>( object ) : T();
     }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Get() [3/3]

template<typename T >

boost::optional<T> INSPECTABLE::Get ( const wxString & aProperty )

inlineinherited

Definition at line 102 of file inspectable.h.

     {
         PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
         TYPE_ID thisType = TYPE_HASH( *this );
         PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
         boost::optional<T> ret;
 
         if( prop )
         {
             void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
             if( object )
                 ret = prop->get<T>( object );
         }
 
         return ret;
     }

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ GetBoundingBox()

const EDA_RECT SCH_TEXT::GetBoundingBox ( ) const

overridevirtual

Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Reimplemented from EDA_ITEM.

Reimplemented in SCH_HIERLABEL, SCH_GLOBALLABEL, and SCH_LABEL.

Definition at line 447 of file sch_text.cpp.

 {
     EDA_RECT rect = GetTextBox();
 
     if( GetTextAngle() != 0 )      // Rotate rect
     {
         wxPoint pos = rect.GetOrigin();
         wxPoint end = rect.GetEnd();
 
         RotatePoint( &pos, GetTextPos(), GetTextAngle() );
         RotatePoint( &end, GetTextPos(), GetTextAngle() );
 
         rect.SetOrigin( pos );
         rect.SetEnd( end );
     }
 
     rect.Normalize();
     return rect;
 }

References EDA_RECT::GetEnd(), EDA_RECT::GetOrigin(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextPos(), EDA_RECT::Normalize(), RotatePoint(), EDA_RECT::SetEnd(), and EDA_RECT::SetOrigin().

Referenced by KIGFX::SCH_PAINTER::draw(), and HitTest().

◆ GetClass()

virtual wxString SCH_TEXT::GetClass ( ) const

inlineoverridevirtual

Function GetClass returns the class name.

Returns: wxString

Reimplemented from SCH_ITEM.

Reimplemented in SCH_HIERLABEL, SCH_GLOBALLABEL, SCH_LABEL, and SCH_SHEET_PIN.

Definition at line 206 of file sch_text.h.

     {
         return wxT( "SCH_TEXT" );
     }

◆ GetConnectionPoints()

std::vector< wxPoint > SCH_TEXT::GetConnectionPoints ( ) const

overridevirtual

Add all the connection points for this item to aPoints.

Not all schematic items have connection points so the default method does nothing.

Parameters

aPoints List of connection points to add to.

Reimplemented from SCH_ITEM.

Definition at line 437 of file sch_text.cpp.

 {
     // Normal text labels do not have connection points.  All others do.
     if( Type() == SCH_TEXT_T )
         return {};
 
     return { GetTextPos() };
 }

References EDA_TEXT::GetTextPos(), SCH_TEXT_T, and EDA_ITEM::Type().

◆ GetContextualTextVars()

void SCH_TEXT::GetContextualTextVars ( wxArrayString * aVars ) const

Returns the set of contextual text variable tokens for this text item.

Parameters

aVars [out]

Definition at line 482 of file sch_text.cpp.

 {
     if( Type() == SCH_GLOBAL_LABEL_T || Type() == SCH_HIER_LABEL_T || Type() == SCH_SHEET_PIN_T )
         aVars->push_back( wxT( "CONNECTION_TYPE" ) );
 
     if( Type() == SCH_SHEET_PIN_T && m_parent )
         static_cast<SCH_SHEET*>( m_parent )->GetContextualTextVars( aVars );
 }

References EDA_ITEM::m_parent, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_SHEET_PIN_T, and EDA_ITEM::Type().

Referenced by DIALOG_LABEL_EDITOR::onScintillaCharAdded().

◆ GetDrawRotation()

double EDA_TEXT::GetDrawRotation ( ) const

virtualinherited

Reimplemented in FP_TEXT.

Definition at line 637 of file eda_text.cpp.

 {
     return GetTextAngle();
 }

References EDA_TEXT::GetTextAngle().

Referenced by EDA_TEXT::TransformToSegmentList().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 225 of file eda_item.h.

     {
         constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
                                IS_WIRE_IMAGE | STRUCT_DELETED );
 
         return m_flags & mask;
     }

References IS_DRAGGED, IS_MOVED, IS_NEW, IS_PASTED, IS_RESIZED, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), LIB_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithLibEdit(), SCH_COMPONENT::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), LIB_MOVE_TOOL::Main(), POINT_EDITOR::OnSelectionChange(), LIB_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::recombinePad(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_FRAME::TrimWire().

◆ GetEffectiveTextPenWidth()

int EDA_TEXT::GetEffectiveTextPenWidth ( int aDefaultWidth = 0 ) const

inherited

The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultWidth.

Definition at line 157 of file eda_text.cpp.

 {
     int width = GetTextThickness();
 
     if( width <= 1 )
     {
         width = aDefaultWidth;
 
         if( IsBold() )
             width = GetPenSizeForBold( GetTextWidth() );
         else if( width <= 1 )
             width = GetPenSizeForNormal( GetTextWidth() );
     }
 
     // Clip pen size for small texts:
     width = Clamp_Text_PenSize( width, GetTextSize(), ALLOW_BOLD_THICKNESS );
 
     return width;
 }

References ALLOW_BOLD_THICKNESS, Clamp_Text_PenSize(), GetPenSizeForBold(), GetPenSizeForNormal(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), and EDA_TEXT::IsBold().

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), KIGFX::WS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), export_vrml_fp_text(), export_vrml_pcbtext(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), EDA_TEXT::GetEffectiveTextShape(), LIB_TEXT::GetPenWidth(), LIB_FIELD::GetPenWidth(), SCH_FIELD::GetPenWidth(), GetPenWidth(), EDA_TEXT::GetTextBox(), KIGFX::SCH_PAINTER::getTextThickness(), LIB_TEXT::Plot(), SCH_FIELD::Plot(), Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), LIB_TEXT::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), PNS_KICAD_IFACE_BASE::syncTextItem(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), ALIGNED_DIMENSION::updateGeometry(), ORTHOGONAL_DIMENSION::updateGeometry(), LEADER::updateGeometry(), ALIGNED_DIMENSION::updateText(), and ORTHOGONAL_DIMENSION::updateText().

◆ GetEffectiveTextShape()

std::shared_ptr< SHAPE_COMPOUND > EDA_TEXT::GetEffectiveTextShape ( ) const

inherited

Definition at line 624 of file eda_text.cpp.

 {
     std::shared_ptr<SHAPE_COMPOUND> shape = std::make_shared<SHAPE_COMPOUND>();
     int penWidth = GetEffectiveTextPenWidth();
     std::vector<wxPoint> pts = TransformToSegmentList();
 
     for( unsigned jj = 0; jj < pts.size(); jj += 2 )
         shape->AddShape( new SHAPE_SEGMENT( pts[jj], pts[jj+1], penWidth ) );
 
     return shape;
 }

References EDA_TEXT::GetEffectiveTextPenWidth(), and EDA_TEXT::TransformToSegmentList().

Referenced by PCB_TEXT::GetEffectiveShape(), and FP_TEXT::GetEffectiveShape().

◆ GetEndPoints()

void SCH_TEXT::GetEndPoints ( std::vector< DANGLING_END_ITEM > & aItemList )

overridevirtual

Add the schematic item end points to aItemList if the item has end points.

The default version doesn't do anything since many of the schematic object cannot be tested for dangling ends. If you add a new schematic item that can have a dangling end ( no connect ), override this method to provide the correct end points.

Parameters

aItemList - List of DANGLING_END_ITEMS to add to.

Reimplemented from SCH_ITEM.

Definition at line 340 of file sch_text.cpp.

 {
     // Normal text labels cannot be tested for dangling ends.
     if( Type() == SCH_TEXT_T )
         return;
 
     DANGLING_END_ITEM item( LABEL_END, this, GetTextPos() );
     aItemList.push_back( item );
 }

References EDA_TEXT::GetTextPos(), LABEL_END, SCH_TEXT_T, and EDA_ITEM::Type().

◆ GetFieldsAutoplaced()

FIELDS_AUTOPLACED SCH_ITEM::GetFieldsAutoplaced ( ) const

inlineinherited

Return whether the fields have been automatically placed.

Definition at line 453 of file sch_item.h.

453 { return m_fieldsAutoplaced; }

SCH_ITEM::m_fieldsAutoplaced

FIELDS_AUTOPLACED m_fieldsAutoplaced

Definition: sch_item.h:201

References SCH_ITEM::m_fieldsAutoplaced.

Referenced by SCH_ITEM::AutoAutoplaceFields(), and EE_POINT_EDITOR::updateParentItem().

◆ GetFlags()

STATUS_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and TRACK.

Definition at line 333 of file eda_item.h.

333 { return GetPosition(); }

EDA_ITEM::GetPosition

virtual wxPoint GetPosition() const

Definition: eda_item.h:325

References EDA_ITEM::GetPosition().

Referenced by PCB_BASE_FRAME::FocusOnItem(), and SCH_EDIT_FRAME::FocusOnItem().

◆ GetHorizJustify()

EDA_TEXT_HJUSTIFY_T EDA_TEXT::GetHorizJustify ( ) const

inlineinherited

Definition at line 205 of file eda_text.h.

205 { return EDA_TEXT_HJUSTIFY_T( m_e.hjustify ); };

EDA_TEXT_HJUSTIFY_T

Definition: eda_text.h:61

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), export_vrml_fp_text(), export_vrml_pcbtext(), AUTOPLACER::field_horiz_placement(), PCB_TEXT::Flip(), FP_TEXT::Flip(), EDA_TEXT::Format(), EDA_TEXT::GetTextBox(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::IsHorizJustifyFlipped(), FP_TEXT::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), positioningChanged(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), LIB_TEXT::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), KIGFX::GAL::SetTextAttributes(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

TEXT_EFFECTS m_e

Definition: eda_text.h:381

TEXT_EFFECTS::hjustify

signed char hjustify

horizontal justification

Definition: eda_text.h:101

References TEXT_EFFECTS::hjustify, and EDA_TEXT::m_e.

◆ GetInterline()

int EDA_TEXT::GetInterline ( ) const

inherited

Return the distance between two lines of text.

Calculates the distance (pitch) between two lines of text. This distance includes the interline distance plus room for characters like j, {, and [. It also used for single line text, to calculate the text bounding box.

Definition at line 217 of file eda_text.cpp.

 {
     return KiROUND( KIGFX::STROKE_FONT::GetInterline( GetTextHeight() ) );
 }

References KIGFX::STROKE_FONT::GetInterline(), EDA_TEXT::GetTextHeight(), and KiROUND().

Referenced by EDA_TEXT::GetLinePositions(), and EDA_TEXT::GetTextBox().

◆ GetLabelSpinStyle()

LABEL_SPIN_STYLE SCH_TEXT::GetLabelSpinStyle ( ) const

inline

Definition at line 233 of file sch_text.h.

233 { return m_spin_style; }

SCH_TEXT::m_spin_style

LABEL_SPIN_STYLE m_spin_style

The orientation of text and any associated drawing elements of derived objects.

Definition: sch_text.h:185

References m_spin_style.

Referenced by SCH_GLOBALLABEL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_DRAWING_TOOLS::createNewText(), KIGFX::SCH_PAINTER::draw(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), GetMsgPanelInfo(), GetSchematicTextOffset(), SCH_GLOBALLABEL::GetSchematicTextOffset(), SCH_HIERLABEL::GetSchematicTextOffset(), MirrorSpinStyle(), MirrorX(), MirrorY(), Rotate90(), SCH_SEXPR_PLUGIN::saveText(), SCH_LEGACY_PLUGIN::saveText(), and DIALOG_LABEL_EDITOR::TransferDataToWindow().

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const

inlineinherited

Return the layer this item is on.

Definition at line 285 of file sch_item.h.

285 { return m_layer; }

SCH_ITEM::m_layer

SCH_LAYER_ID m_layer

Definition: sch_item.h:199

References SCH_ITEM::m_layer.

Referenced by SCH_EAGLE_PLUGIN::addBusEntries(), SCH_JUNCTION::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_LINE::CanConnect(), SCH_LABEL::CanConnect(), SCH_ITEM::CanConnect(), SCH_GLOBALLABEL::CanConnect(), SCH_HIERLABEL::CanConnect(), SCH_SHEET::CanConnect(), SCH_COMPONENT::CanConnect(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckFloatingWires(), SCH_LINE::GetEndPoints(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_EDIT_TOOL::Init(), SCH_LINE::IsGraphicLine(), SCH_LINE::IsWire(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_JUNCTION::operator<(), SCH_BUS_ENTRY_BASE::operator<(), SCH_LINE::operator<(), operator<(), SCH_JUNCTION::Plot(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_LINE::Plot(), SCH_SCREEN::Plot(), Plot(), SCH_JUNCTION::Print(), SCH_LINE::Print(), SCH_SCREEN::Print(), SCH_LEGACY_PLUGIN::saveBusEntry(), SCH_SEXPR_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveLine(), SCH_LEGACY_PLUGIN::saveText(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::TrimWire(), and SCH_LINE::UpdateDanglingState().

◆ GetLinePositions()

void EDA_TEXT::GetLinePositions	(	std::vector< wxPoint > &	aPositions,
		int	aLineCount
	)		const

inherited

Populate aPositions with the position of each line of a multiline text, according to the vertical justification and the rotation of the whole text.

Parameters

aPositions	is the list to populate by the wxPoint positions
aLineCount	is the number of lines (not recalculated here for efficiency reasons

Definition at line 424 of file eda_text.cpp.

 {
     wxPoint        pos  = GetTextPos();     // Position of first line of the
                                             // multiline text according to
                                             // the center of the multiline text block
 
     wxPoint        offset;                  // Offset to next line.
 
     offset.y = GetInterline();
 
     if( aLineCount > 1 )
     {
         switch( GetVertJustify() )
         {
         case GR_TEXT_VJUSTIFY_TOP:
             break;
 
         case GR_TEXT_VJUSTIFY_CENTER:
             pos.y -= ( aLineCount - 1 ) * offset.y / 2;
             break;
 
         case GR_TEXT_VJUSTIFY_BOTTOM:
             pos.y -= ( aLineCount - 1 ) * offset.y;
             break;
         }
     }
 
     // Rotate the position of the first line
     // around the center of the multiline text block
     RotatePoint( &pos, GetTextPos(), GetTextAngle() );
 
     // Rotate the offset lines to increase happened in the right direction
     RotatePoint( &offset, GetTextAngle() );
 
     for( int ii = 0; ii < aLineCount; ii++ )
     {
         aPositions.push_back( pos );
         pos += offset;
     }
 }

References EDA_TEXT::GetInterline(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetVertJustify(), GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, and RotatePoint().

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), export_vrml_pcbtext(), Plot(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::Print(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), and EDA_TEXT::TransformToSegmentList().

◆ GetMenuImage()

BITMAP_DEF SCH_TEXT::GetMenuImage ( ) const

overridevirtual

Function GetMenuImage returns a pointer to an image to be used in menus.

The default version returns the right arrow image. Override this function to provide object specific menu images.

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Reimplemented in SCH_HIERLABEL, SCH_GLOBALLABEL, and SCH_LABEL.

Definition at line 561 of file sch_text.cpp.

 {
     return text_xpm;
 }

References text_xpm.

◆ GetMsgPanelInfo()

void SCH_TEXT::GetMsgPanelInfo	(	EDA_DRAW_FRAME *	aFrame,
		std::vector< MSG_PANEL_ITEM > &	aList
	)

overridevirtual

Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 629 of file sch_text.cpp.

 {
     wxString msg;
 
     switch( Type() )
     {
     case SCH_TEXT_T:          msg = _( "Graphic Text" );           break;
     case SCH_LABEL_T:         msg = _( "Label" );                  break;
     case SCH_GLOBAL_LABEL_T:  msg = _( "Global Label" );           break;
     case SCH_HIER_LABEL_T:    msg = _( "Hierarchical Label" );     break;
     case SCH_SHEET_PIN_T:     msg = _( "Hierarchical Sheet Pin" ); break;
     default: return;
     }
 
     aList.push_back( MSG_PANEL_ITEM( msg, GetShownText() ) );
 
     switch( GetLabelSpinStyle() )
     {
     case LABEL_SPIN_STYLE::LEFT:   msg = _( "Horizontal left" );  break;
     case LABEL_SPIN_STYLE::UP:     msg = _( "Vertical up" );      break;
     case LABEL_SPIN_STYLE::RIGHT:  msg = _( "Horizontal right" ); break;
     case LABEL_SPIN_STYLE::BOTTOM: msg = _( "Vertical down" );    break;
     default:                       msg = wxT( "???" );            break;
     }
 
     aList.push_back( MSG_PANEL_ITEM( _( "Orientation" ), msg, BROWN ) );
 
     wxString textStyle[] = { _( "Normal" ), _( "Italic" ), _( "Bold" ), _( "Bold Italic" ) };
     int style = 0;
 
     if( IsItalic() )
         style = 1;
 
     if( IsBold() )
         style += 2;
 
     aList.push_back( MSG_PANEL_ITEM( _( "Style" ), textStyle[style] ) );
 
     // Display electrical type if it is relevant
     if( Type() == SCH_GLOBAL_LABEL_T || Type() == SCH_HIER_LABEL_T || Type() == SCH_SHEET_PIN_T )
     {
         msg = getElectricalTypeLabel( GetShape() );
         aList.push_back( MSG_PANEL_ITEM( _( "Type" ), msg ) );
     }
 
     // Display text size (X or Y value, with are the same value in Eeschema)
     msg = MessageTextFromValue( aFrame->GetUserUnits(), GetTextWidth() );
     aList.push_back( MSG_PANEL_ITEM( _( "Size" ), msg ) );
 
     SCH_EDIT_FRAME* frame = dynamic_cast<SCH_EDIT_FRAME*>( aFrame );
 
     if( frame )
     {
         if( SCH_CONNECTION* conn = Connection() )
         {
             conn->AppendInfoToMsgPanel( aList );
 
             NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
             const wxString& netname = conn->Name( true );
 
             if( netSettings.m_NetClassAssignments.count( netname ) )
             {
                 const wxString& netclassName = netSettings.m_NetClassAssignments[ netname ];
                 aList.push_back( MSG_PANEL_ITEM( _( "Assigned Netclass" ), netclassName ) );
             }
         }
     }
 }

References _, LABEL_SPIN_STYLE::BOTTOM, BROWN, SCH_ITEM::Connection(), getElectricalTypeLabel(), GetLabelSpinStyle(), PROJECT::GetProjectFile(), GetShape(), GetShownText(), EDA_TEXT::GetTextWidth(), EDA_BASE_FRAME::GetUserUnits(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), LABEL_SPIN_STYLE::LEFT, NET_SETTINGS::m_NetClassAssignments, MessageTextFromValue(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), LABEL_SPIN_STYLE::RIGHT, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_SHEET_PIN_T, SCH_TEXT_T, SCH_ITEM::Schematic(), EDA_ITEM::Type(), and LABEL_SPIN_STYLE::UP.

◆ GetParent()

EDA_ITEM* EDA_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 183 of file eda_item.h.

183 { return m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:162

References EDA_ITEM::m_parent.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::editFieldText(), FormatProbeItem(), SCH_PIN::GetParentSymbol(), EE_SELECTION_TOOL::highlight(), highlightNet(), EE_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDITOR_CONTROL::nextMatch(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), BOARD_COMMIT::parentObject(), SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshSelection(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_SEXPR_PLUGIN::saveField(), SCH_SCREEN::Schematic(), SCH_ITEM::Schematic(), SCH_SHEET::SearchHierarchy(), BOARD_COMMIT::Stage(), DIALOG_FIELDS_EDITOR_GLOBAL::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), and SCH_BASE_FRAME::UpdateItem().

◆ GetPenWidth()

int SCH_TEXT::GetPenWidth ( ) const

overridevirtual

Returns: the size of the "pen" that be used to draw or plot this item

Reimplemented from SCH_ITEM.

Definition at line 325 of file sch_text.cpp.

 {
     return GetEffectiveTextPenWidth();
 }

References EDA_TEXT::GetEffectiveTextPenWidth().

Referenced by SCH_GLOBALLABEL::AutoplaceFields(), SCH_GLOBALLABEL::CreateGraphicShape(), GetSchematicTextOffset(), SCH_GLOBALLABEL::Print(), and SCH_HIERLABEL::Print().

◆ GetPosition()

wxPoint SCH_TEXT::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 312 of file sch_text.h.

312 { return EDA_TEXT::GetTextPos(); }

EDA_TEXT::GetTextPos

const wxPoint & GetTextPos() const

Definition: eda_text.h:254

References EDA_TEXT::GetTextPos().

Referenced by SCH_EAGLE_PLUGIN::adjustNetLabels(), SCH_GLOBALLABEL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), CONNECTION_GRAPH::ercCheckLabels(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_SHEET_PIN::IsPointClickableAnchor(), SCH_LABEL::IsPointClickableAnchor(), SCH_GLOBALLABEL::IsPointClickableAnchor(), SCH_HIERLABEL::IsPointClickableAnchor(), SCH_EAGLE_PLUGIN::SEG_DESC_STRUCT::LabelAttached(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_GLOBALLABEL::MirrorSpinStyle(), operator<(), SCH_GLOBALLABEL::Rotate90(), SCH_SEXPR_PLUGIN::saveText(), SCH_LEGACY_PLUGIN::saveText(), and ERC_TESTER::TestSimilarLabels().

◆ GetSchematicTextOffset()

wxPoint SCH_TEXT::GetSchematicTextOffset ( RENDER_SETTINGS * aSettings ) const

virtual

Returns: the offset between the SCH_TEXT position and the text itself position

This offset depends on the orientation, the type of text, and the area required to draw the associated graphic symbol or to put the text above a wire.

Reimplemented in SCH_HIERLABEL, and SCH_GLOBALLABEL.

Definition at line 160 of file sch_text.cpp.

 {
     wxPoint text_offset;
 
     // add an offset to x (or y) position to aid readability of text on a wire or line
     int dist = GetTextOffset( aSettings ) + GetPenWidth();
 
     switch( GetLabelSpinStyle() )
     {
     case LABEL_SPIN_STYLE::UP:
     case LABEL_SPIN_STYLE::BOTTOM:
         text_offset.x = -dist;
         break; // Vert Orientation
     default:
     case LABEL_SPIN_STYLE::LEFT:
     case LABEL_SPIN_STYLE::RIGHT:
         text_offset.y = -dist;
         break; // Horiz Orientation
     }
 
     return text_offset;
 }

References LABEL_SPIN_STYLE::BOTTOM, GetLabelSpinStyle(), GetPenWidth(), GetTextOffset(), LABEL_SPIN_STYLE::LEFT, LABEL_SPIN_STYLE::RIGHT, and LABEL_SPIN_STYLE::UP.

Referenced by KIGFX::SCH_PAINTER::draw(), Plot(), and Print().

◆ GetSelectMenuText()

wxString SCH_TEXT::GetSelectMenuText ( EDA_UNITS aUnits ) const

overridevirtual

Function GetSelectMenuText returns the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position.

The default version of this function raises an assertion in the debug mode and returns a string to indicate that it was not overridden to provide the object specific text.

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Reimplemented in SCH_HIERLABEL, SCH_GLOBALLABEL, and SCH_LABEL.

Definition at line 555 of file sch_text.cpp.

 {
     return wxString::Format( _( "Graphic Text '%s'" ), ShortenedShownText() );
 }

References _, Format(), and EDA_TEXT::ShortenedShownText().

◆ GetShape()

PINSHEETLABEL_SHAPE SCH_TEXT::GetShape ( ) const

inline

Definition at line 235 of file sch_text.h.

235 { return m_shape; }

SCH_TEXT::m_shape

PINSHEETLABEL_SHAPE m_shape

Definition: sch_text.h:168

References m_shape.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), GetMsgPanelInfo(), GetShownText(), CONNECTION_SUBGRAPH::ResolveDrivers(), SCH_SEXPR_PLUGIN::saveText(), SCH_LEGACY_PLUGIN::saveText(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), and DIALOG_LABEL_EDITOR::TransferDataToWindow().

◆ GetShownText() [1/2]

wxString EDA_TEXT::GetShownText ( bool * processTextVars ) const

inlineinherited

A version of GetShownText() which also indicates whether or not the text needs to be processed for text variables.

Parameters

processTextVars [out]

Definition at line 147 of file eda_text.h.

     {
         *processTextVars = m_shown_text_has_text_var_refs;
         return m_shown_text;
     }

References EDA_TEXT::m_shown_text, and EDA_TEXT::m_shown_text_has_text_var_refs.

◆ GetShownText() [2/2]

wxString SCH_TEXT::GetShownText ( int aDepth = 0 ) const

overridevirtual

Return the string actually shown after processing of the base text.

@aParam aDepth is used to prevent infinite recusions and loops when expanding text variables.

Reimplemented from EDA_TEXT.

Definition at line 492 of file sch_text.cpp.

 {
     std::function<bool( wxString* )> textResolver =
             [&]( wxString* token ) -> bool
             {
                 if( ( Type() == SCH_GLOBAL_LABEL_T
                         || Type() == SCH_HIER_LABEL_T
                         || Type() == SCH_SHEET_PIN_T )
                      && token->IsSameAs( wxT( "CONNECTION_TYPE" ) ) )
                 {
                     *token = getElectricalTypeLabel( GetShape() );
                     return true;
                 }
 
                 if( Type() == SCH_SHEET_PIN_T && m_parent )
                 {
                     SCH_SHEET* sheet = static_cast<SCH_SHEET*>( m_parent );
 
                     if( sheet->ResolveTextVar( token, aDepth ) )
                         return true;
                 }
 
                 if( Type() == SCH_TEXT_T )
                 {
                     if( token->Contains( ':' ) )
                     {
                         if( Schematic()->ResolveCrossReference( token, aDepth ) )
                             return true;
                     }
                     else
                     {
                         SCHEMATIC* schematic = Schematic();
                         SCH_SHEET* sheet = schematic ? schematic->CurrentSheet().Last() : nullptr;
 
                         if( sheet && sheet->ResolveTextVar( token, aDepth + 1 ) )
                             return true;
                     }
                 }
 
                 return false;
             };
 
     bool     processTextVars = false;
     wxString text = EDA_TEXT::GetShownText( &processTextVars );
 
     if( processTextVars )
     {
         wxCHECK_MSG( Schematic(), wxEmptyString,
                      "No parent SCHEMATIC set for SCH_TEXT!" );
 
         PROJECT* project = nullptr;
 
         if( Schematic() )
             project = &Schematic()->Prj();
 
         if( aDepth < 10 )
             text = ExpandTextVars( text, &textResolver, project );
     }
 
     return text;
 }

References SCHEMATIC::CurrentSheet(), ExpandTextVars(), getElectricalTypeLabel(), GetShape(), EDA_TEXT::GetShownText(), SCH_SHEET_PATH::Last(), EDA_ITEM::m_parent, SCHEMATIC::Prj(), SCHEMATIC::ResolveCrossReference(), SCH_SHEET::ResolveTextVar(), SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_SHEET_PIN_T, SCH_TEXT_T, SCH_ITEM::Schematic(), and EDA_ITEM::Type().

Referenced by SCH_GLOBALLABEL::CreateGraphicShape(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckLabels(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), GetMsgPanelInfo(), Plot(), and ERC_TESTER::TestSimilarLabels().

◆ GetState()

int EDA_ITEM::GetState ( int type ) const

inlineinherited

Definition at line 204 of file eda_item.h.

     {
         return m_status & type;
     }

References EDA_ITEM::m_status.

Referenced by TRACK::GetMsgPanelInfoBase_Common(), and TRACK::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 217 of file eda_item.h.

217 { return m_status; }

EDA_ITEM::m_status

STATUS_FLAGS m_status

Definition: eda_item.h:161

References EDA_ITEM::m_status.

◆ GetStoredPos()

wxPoint& SCH_ITEM::GetStoredPos ( )

inlineinherited

Definition at line 249 of file sch_item.h.

249 { return m_storedPos; }

SCH_ITEM::m_storedPos

wxPoint m_storedPos

Definition: sch_item.h:202

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::moveItem().

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const

inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 486 of file sch_item.h.

486 { wxCHECK( false, STROKE_PARAMS() ); }

STROKE_PARAMS

Simple container to manage line stroke parameters.

Definition: sch_item.h:153

◆ GetText()

virtual const wxString& EDA_TEXT::GetText ( ) const

inlinevirtualinherited

Return the string associated with the text object.

Returns: a const wxString reference containing the string of the item.

Definition at line 133 of file eda_text.h.

133 { return m_text; }

EDA_TEXT::m_text

wxString m_text

Definition: eda_text.h:377

References EDA_TEXT::m_text.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), NETLIST_EXPORTER_XML::addSymbolFields(), SIM_PLOT_FRAME::AddTuner(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXT::Clone(), LIB_TEXT::compare(), LIB_FIELD::compare(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), KIGFX::SCH_VIEW::DisplayComponent(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), SCH_FIELD::DoHypertextMenu(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::Duplicate(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CONNECTION_GRAPH::ercCheckHierSheets(), LIB_PART::Flatten(), PCB_IO::format(), FormatProbeItem(), SCH_COMPONENT::GetFootprint(), LIB_FIELD::GetFullText(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), FP_TEXT::GetLength(), getMatchingTextItem(), SCH_COMPONENT::GetRef(), LIB_PART::GetSearchText(), DIMENSION_BASE::GetText(), TEXT_MOD_GRID_TABLE::GetValue(), SCH_COMPONENT::GetValue(), hash_fp_item(), LIB_FIELD::HitTest(), SCH_EDIT_FRAME::importFile(), SCH_DRAWING_TOOLS::importHierLabel(), IncrementLabel(), GENERAL_COLLECTOR::Inspect(), SCH_SCREEN::IsTerminalPoint(), SCH_FIELD::IsVoid(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_EAGLE_PLUGIN::loadSegments(), SCH_SHEET_PIN::Matches(), Matches(), SCH_FIELD::operator<(), operator<(), LIB_FIELD::operator=(), SCH_COMPONENT::operator==(), PCB_PARSER::parseDIMENSION(), SCH_SEXPR_PARSER::parseSchematicSymbol(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceText(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), DIALOG_RESCUE_EACH::PopulateInstanceList(), LIB_FIELD::print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), processTextItem(), SCH_EDIT_FRAME::RecomputeIntersheetsRefs(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_LEGACY_PLUGIN::saveComponent(), SCH_SEXPR_PLUGIN::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_LEGACY_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_COMPONENT::SetRef(), LIB_VIEW_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_SHEET::SymbolCount(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), TUNER_SLIDER::TUNER_SLIDER(), DIALOG_FOOTPRINT_FP_EDITOR::Validate(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and FP_TEXT::ViewGetLOD().

◆ GetTextAngle()

double EDA_TEXT::GetTextAngle ( ) const

inlineinherited

Definition at line 180 of file eda_text.h.

180 { return m_e.angle; }

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), BOARD_ADAPTER::AddShapeWithClearanceToContainer(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::WS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), export_vrml_pcbtext(), PCB_TEXT::Flip(), FP_TEXT::Flip(), PCB_IO::format(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), GetBoundingBox(), SCH_LABEL::GetBoundingBox(), FP_TEXT::GetDrawRotation(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetLinePositions(), PCB_TEXT::GetMsgPanelInfo(), EDA_TEXT::GetTextAngleDegrees(), EDA_TEXT::GetTextAngleRadians(), TEXT_MOD_GRID_TABLE::GetValue(), hash_fp_item(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), FP_TEXT::KeepUpright(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), DIMENSION_BASE::Mirror(), LIB_TEXT::MirrorHorizontal(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), EAGLE_PLUGIN::orientFPText(), PCB_PARSER::parseFOOTPRINT_unchecked(), ALTIUM_PCB::ParseTexts6Data(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), Plot(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), positioningChanged(), LIB_TEXT::print(), LIB_FIELD::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), SCH_EDIT_TOOL::Rotate(), LIB_TEXT::Rotate(), PCB_TEXT::Rotate(), FP_TEXT::Rotate(), LIB_FIELD::Rotate(), DIMENSION_BASE::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), EDA_TEXT::TextHitTest(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

TEXT_EFFECTS m_e

Definition: eda_text.h:381

TEXT_EFFECTS::angle

double angle

now: 0.1 degrees; future: degrees

Definition: eda_text.h:105

References TEXT_EFFECTS::angle, and EDA_TEXT::m_e.

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const

inlineinherited

Definition at line 182 of file eda_text.h.

182 { return GetTextAngle() / 10.0; }

EDA_TEXT::GetTextAngle

double GetTextAngle() const

Definition: eda_text.h:180

References EDA_TEXT::GetTextAngle().

Referenced by FP_TEXT::GetMsgPanelInfo(), SCH_SEXPR_PLUGIN::saveField(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetTextAngleRadians()

double EDA_TEXT::GetTextAngleRadians ( ) const

inlineinherited

Definition at line 183 of file eda_text.h.

183 { return GetTextAngle() * M_PI/1800; }

EDA_TEXT::GetTextAngle

double GetTextAngle() const

Definition: eda_text.h:180

References EDA_TEXT::GetTextAngle().

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), ALIGNED_DIMENSION::updateGeometry(), ORTHOGONAL_DIMENSION::updateGeometry(), and LEADER::updateGeometry().

◆ GetTextBox()

EDA_RECT EDA_TEXT::GetTextBox	(	int	aLine = `-1`,
		bool	aInvertY = `false`
	)		const

inherited

Useful in multiline texts to calculate the full text or a line area (for zones filling, locate functions....)

Parameters

aLine	The line of text to consider. Pass -1 for all lines.
aInvertY	Invert the Y axis when calculating bounding box.

Returns: the rect containing the line of text (i.e. the position and the size of one line) this rectangle is calculated for 0 orient text. If orientation is not 0 the rect must be rotated to match the physical area

Definition at line 223 of file eda_text.cpp.

 {
     EDA_RECT       rect;
     wxArrayString  strings;
     wxString       text = GetShownText();
     int            thickness = GetEffectiveTextPenWidth();
     int            linecount = 1;
     bool           hasOverBar = false;     // true if the first line of text as an overbar
 
     if( IsMultilineAllowed() )
     {
         wxStringSplit( text, strings, '\n' );
 
         if( strings.GetCount() )     // GetCount() == 0 for void strings
         {
             if( aLine >= 0 && ( aLine < (int)strings.GetCount() ) )
                 text = strings.Item( aLine );
             else
                 text = strings.Item( 0 );
 
             linecount = strings.GetCount();
         }
     }
 
     // Search for overbar symbol. Only text is scanned,
     // because only this line can change the bounding box
     for( unsigned ii = 1; ii < text.size(); ii++ )
     {
         if( text[ii-1] == '~' && text[ii] != '~' )
         {
             hasOverBar = true;
             break;
         }
     }
 
     // calculate the H and V size
     const auto& font = basic_gal.GetStrokeFont();
     VECTOR2D    fontSize( GetTextSize() );
     double      penWidth( thickness );
     int         dx = KiROUND( font.ComputeStringBoundaryLimits( text, fontSize, penWidth ).x );
     int         dy = GetInterline();
 
     // Creates bounding box (rectangle) for horizontal, left and top justified text. The
     // bounding box will be moved later according to the actual text options
     wxSize textsize = wxSize( dx, dy );
     wxPoint pos = GetTextPos();
 
     if( aInvertY )
         pos.y = -pos.y;
 
     rect.SetOrigin( pos );
 
     // The bbox vertical size returned by GetInterline( aThickness )
     // includes letters like j and y and ] + interval between lines.
     // The interval below the last line is not usefull, and we can use its half value
     // as vertical margin above the text
     // the full interval is roughly GetTextHeight() * 0.4 - aThickness/2
     rect.Move( wxPoint( 0, thickness/4 - KiROUND( GetTextHeight() * 0.22 ) ) );
 
     if( hasOverBar )
     {   // A overbar adds an extra size to the text
         // Height from the base line text of chars like [ or {
         double curr_height = GetTextHeight() * 1.15;
         double overbarPosition = font.ComputeOverbarVerticalPosition( fontSize.y );
         int    extra_height = KiROUND( overbarPosition - curr_height );
 
         extra_height += thickness / 2;
         textsize.y += extra_height;
         rect.Move( wxPoint( 0, -extra_height ) );
     }
 
     // for multiline texts and aLine < 0, merge all rectangles
     // ( if aLine < 0, we want the full text bounding box )
     if( IsMultilineAllowed() && aLine < 0 )
     {
         for( unsigned ii = 1; ii < strings.GetCount(); ii++ )
         {
             text = strings.Item( ii );
             dx = KiROUND( font.ComputeStringBoundaryLimits( text, fontSize, penWidth ).x );
             textsize.x = std::max( textsize.x, dx );
             textsize.y += dy;
         }
     }
 
     rect.SetSize( textsize );
 
     /* Now, calculate the rect origin, according to text justification
      * At this point the rectangle origin is the text origin (m_Pos).
      * This is true only for left and top text justified texts (using top to bottom Y axis
      * orientation). and must be recalculated for others justifications
      * also, note the V justification is relative to the first line
      */
     switch( GetHorizJustify() )
     {
     case GR_TEXT_HJUSTIFY_LEFT:
         if( IsMirrored() )
             rect.SetX( rect.GetX() - rect.GetWidth() );
         break;
 
     case GR_TEXT_HJUSTIFY_CENTER:
         rect.SetX( rect.GetX() - (rect.GetWidth() / 2) );
         break;
 
     case GR_TEXT_HJUSTIFY_RIGHT:
         if( !IsMirrored() )
             rect.SetX( rect.GetX() - rect.GetWidth() );
         break;
     }
 
     dy = GetTextHeight() + thickness;
 
     switch( GetVertJustify() )
     {
     case GR_TEXT_VJUSTIFY_TOP:
         break;
 
     case GR_TEXT_VJUSTIFY_CENTER:
         rect.SetY( rect.GetY() - ( dy / 2) );
         break;
 
     case GR_TEXT_VJUSTIFY_BOTTOM:
         rect.SetY( rect.GetY() - dy );
         break;
     }
 
     if( linecount > 1 )
     {
         int yoffset;
         linecount -= 1;
 
         switch( GetVertJustify() )
         {
         case GR_TEXT_VJUSTIFY_TOP:
             break;
 
         case GR_TEXT_VJUSTIFY_CENTER:
             yoffset = linecount * GetInterline() / 2;
             rect.SetY( rect.GetY() - yoffset );
             break;
 
         case GR_TEXT_VJUSTIFY_BOTTOM:
             yoffset = linecount * GetInterline();
             rect.SetY( rect.GetY() - yoffset );
             break;
         }
     }
 
     rect.Normalize();       // Make h and v sizes always >= 0
 
     return rect;
 }

References basic_gal, EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetInterline(), EDA_TEXT::GetShownText(), KIGFX::GAL::GetStrokeFont(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), EDA_RECT::GetWidth(), EDA_RECT::GetX(), EDA_RECT::GetY(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_TOP, EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), KiROUND(), EDA_RECT::Move(), EDA_RECT::Normalize(), EDA_RECT::SetOrigin(), EDA_RECT::SetSize(), EDA_RECT::SetX(), EDA_RECT::SetY(), wxStringSplit(), and VECTOR2< T >::y.

Referenced by PCB_TEXT::Flip(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), FP_TEXT::GetBoundingBox(), DIMENSION_BASE::GetBoundingBox(), GetBoundingBox(), WS_DRAW_ITEM_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), LIB_TEXT::NormalizeJustification(), FP_TEXT::TextHitTest(), EDA_TEXT::TextHitTest(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), ALIGNED_DIMENSION::updateGeometry(), ORTHOGONAL_DIMENSION::updateGeometry(), LEADER::updateGeometry(), and FP_TEXT::ViewBBox().

◆ GetTextHeight()

int EDA_TEXT::GetTextHeight ( ) const

inlineinherited

Definition at line 251 of file eda_text.h.

251 { return m_e.size.y; }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by LIB_TEXT::compare(), LIB_FIELD::compare(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_HIERLABEL::CreateGraphicShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), EDA_TEXT::GetInterline(), PCB_TEXT::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_GLOBALLABEL::GetSchematicTextOffset(), EDA_TEXT::GetTextBox(), TEXT_MOD_GRID_TABLE::GetValue(), hash_fp_item(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_SEXPR_PARSER::parsePin(), SCH_SEXPR_PLUGIN::saveField(), ALIGNED_DIMENSION::updateText(), and ORTHOGONAL_DIMENSION::updateText().

wxSize size

Definition: eda_text.h:103

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

◆ GetTextOffset()

int SCH_TEXT::GetTextOffset ( RENDER_SETTINGS * aSettings = nullptr ) const

Definition at line 308 of file sch_text.cpp.

 {
     double ratio;
 
     if( aSettings )
         ratio = static_cast<SCH_RENDER_SETTINGS*>( aSettings )->m_TextOffsetRatio;
     else if( Schematic() )
         ratio = Schematic()->Settings().m_TextOffsetRatio;
     else
         ratio = DEFAULT_TEXT_OFFSET_RATIO;   // For previews (such as in Preferences), etc.
 
     return KiROUND( ratio * GetTextSize().y );
 
     return 0;
 }

References DEFAULT_TEXT_OFFSET_RATIO, EDA_TEXT::GetTextSize(), KiROUND(), SCHEMATIC_SETTINGS::m_TextOffsetRatio, SCH_ITEM::Schematic(), and SCHEMATIC::Settings().

Referenced by SCH_GLOBALLABEL::AutoplaceFields(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_LABEL::GetBoundingBox(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), GetSchematicTextOffset(), SCH_GLOBALLABEL::GetSchematicTextOffset(), and SCH_HIERLABEL::GetSchematicTextOffset().

◆ GetTextPos()

const wxPoint& EDA_TEXT::GetTextPos ( ) const

inlineinherited

Definition at line 254 of file eda_text.h.

254 { return m_e.pos; }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), LIB_TEXT::compare(), LIB_FIELD::compare(), SCH_SHEET_PIN::ConstrainOnEdge(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), SCH_LABEL::doIsConnected(), SCH_GLOBALLABEL::doIsConnected(), SCH_HIERLABEL::doIsConnected(), KIGFX::WS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), export_vrml_fp_text(), export_vrml_pcbtext(), FP_TEXT::Flip(), PCB_IO::format(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), FP_TEXT::GetBoundingBox(), GetBoundingBox(), SCH_LABEL::GetBoundingBox(), SCH_GLOBALLABEL::GetBoundingBox(), SCH_HIERLABEL::GetBoundingBox(), GetConnectionPoints(), SCH_SHEET_PIN::GetEndPoints(), GetEndPoints(), SCH_FIELD::GetLibPosition(), EDA_TEXT::GetLinePositions(), PCB_TEXT::GetPosition(), LIB_TEXT::GetPosition(), FP_TEXT::GetPosition(), LIB_FIELD::GetPosition(), SCH_FIELD::GetPosition(), WS_DRAW_ITEM_TEXT::GetPosition(), GetPosition(), EDA_TEXT::GetTextBox(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), FP_TEXT::Mirror(), DIMENSION_BASE::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_FIELD::MirrorHorizontal(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), LIB_FIELD::MirrorVertical(), SCH_SHEET_PIN::MirrorX(), MirrorX(), SCH_SHEET_PIN::MirrorY(), MirrorY(), LIB_TEXT::NormalizeJustification(), PCB_PARSER::parseDIMENSION(), DRAWING_TOOL::PlaceText(), Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), LIB_FIELD::print(), EDA_TEXT::Print(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), LIB_TEXT::Rotate(), PCB_TEXT::Rotate(), FP_TEXT::Rotate(), SCH_FIELD::Rotate(), SCH_SHEET_PIN::Rotate(), LIB_FIELD::Rotate(), DIMENSION_BASE::Rotate(), Rotate(), SCH_GLOBALLABEL::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), FP_TEXT::SetDrawCoord(), FP_TEXT::SetLocalCoord(), SCH_COMPONENT::SetRef(), FP_TEXT::TextHitTest(), EDA_TEXT::TextHitTest(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), UpdateDanglingState(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and FP_TEXT::ViewBBox().

wxPoint pos

Definition: eda_text.h:106

References EDA_TEXT::m_e, and TEXT_EFFECTS::pos.

◆ GetTextSize()

const wxSize& EDA_TEXT::GetTextSize ( ) const

inlineinherited

Definition at line 245 of file eda_text.h.

245 { return m_e.size; }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), SCH_EDIT_TOOL::ChangeTextType(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::SCH_PAINTER::draw(), export_vrml_fp_text(), export_vrml_pcbtext(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetTextBox(), GetTextOffset(), EDA_TEXT::LenSize(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), EAGLE_PLUGIN::orientFPText(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), LIB_TEXT::print(), LIB_FIELD::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN::saveSheet(), KIGFX::GAL::SetTextAttributes(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

wxSize size

Definition: eda_text.h:103

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

◆ GetTextStyleName()

wxString EDA_TEXT::GetTextStyleName ( ) const

inherited

Returns: a wxString with the style name( Normal, Italic, Bold, Bold+Italic)

Definition at line 485 of file eda_text.cpp.

 {
     int style = 0;
 
     if( IsItalic() )
         style = 1;
 
     if( IsBold() )
         style += 2;
 
     wxString stylemsg[4] = {
         _("Normal"),
         _("Italic"),
         _("Bold"),
         _("Bold+Italic")
     };
 
     return stylemsg[style];
 }

References _, EDA_TEXT::IsBold(), and EDA_TEXT::IsItalic().

Referenced by LIB_FIELD::GetMsgPanelInfo().

◆ GetTextThickness()

int EDA_TEXT::GetTextThickness ( ) const

inlineinherited

Definition at line 165 of file eda_text.h.

165 { return m_e.penwidth; };

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), LIB_TEXT::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), TEXT_MOD_GRID_TABLE::GetValue(), LIB_TEXT::GetWidth(), LIB_FIELD::GetWidth(), EDA_TEXT::IsDefaultFormatting(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_LEGACY_PLUGIN::saveText(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

TEXT_EFFECTS m_e

Definition: eda_text.h:381

TEXT_EFFECTS::penwidth

int penwidth

Definition: eda_text.h:104

References EDA_TEXT::m_e, and TEXT_EFFECTS::penwidth.

◆ GetTextWidth()

int EDA_TEXT::GetTextWidth ( ) const

inlineinherited

Definition at line 248 of file eda_text.h.

248 { return m_e.size.x; }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by LIB_TEXT::compare(), LIB_FIELD::compare(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), PCB_TEXT::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_HIERLABEL::GetSchematicTextOffset(), TEXT_MOD_GRID_TABLE::GetValue(), hash_fp_item(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_EAGLE_PLUGIN::loadTextAttributes(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), ALIGNED_DIMENSION::updateGeometry(), ORTHOGONAL_DIMENSION::updateGeometry(), and LEADER::updateGeometry().

wxSize size

Definition: eda_text.h:103

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

◆ GetVertJustify()

EDA_TEXT_VJUSTIFY_T EDA_TEXT::GetVertJustify ( ) const

inlineinherited

Definition at line 206 of file eda_text.h.

206 { return EDA_TEXT_VJUSTIFY_T( m_e.vjustify ); };

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), export_vrml_fp_text(), export_vrml_pcbtext(), PCB_TEXT::Flip(), EDA_TEXT::Format(), EDA_TEXT::GetLinePositions(), EDA_TEXT::GetTextBox(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), positioningChanged(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), LIB_TEXT::Rotate(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), KIGFX::GAL::SetTextAttributes(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

TEXT_EFFECTS m_e

Definition: eda_text.h:381

TEXT_EFFECTS::vjustify

signed char vjustify

vertical justification

Definition: eda_text.h:102

EDA_TEXT_VJUSTIFY_T

Definition: eda_text.h:68

References EDA_TEXT::m_e, and TEXT_EFFECTS::vjustify.

◆ HasFlag()

bool EDA_ITEM::HasFlag ( STATUS_FLAGS aFlag )

inlineinherited

Definition at line 223 of file eda_item.h.

223 { return ( m_flags & aFlag ) == aFlag; }

Referenced by TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::moveItem(), LIB_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_HOLE_CLEARANCE::Run(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), and EE_POINT_EDITOR::updateParentItem().

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References EDA_ITEM::m_flags.

◆ HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this schematic item has line stoke properties.

See also: STROKE_PARAMS

Returns: true if this schematic item support line stroke properties. Otherwise, false.

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 484 of file sch_item.h.

484 { return false; }

Referenced by EE_SELECTION::AllItemsHaveLineStroke(), and SCH_EDIT_TOOL::Properties().

◆ HitTest() [1/2]

bool SCH_TEXT::HitTest	(	const wxPoint &	aPosition,
		int	aAccuracy = `0`
	)		const

overridevirtual

Function HitTest tests if aPosition is contained within or on the bounding box of an item.

Parameters

aPosition	A reference to a wxPoint object containing the coordinates to test.
aAccuracy	Increase the item bounding box by this amount.

Returns: True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 567 of file sch_text.cpp.

 {
     EDA_RECT bBox = GetBoundingBox();
     bBox.Inflate( aAccuracy );
     return bBox.Contains( aPosition );
 }

References EDA_RECT::Contains(), GetBoundingBox(), and EDA_RECT::Inflate().

◆ HitTest() [2/2]

bool SCH_TEXT::HitTest	(	const EDA_RECT &	aRect,
		bool	aContained,
		int	aAccuracy = `0`
	)		const

overridevirtual

Function HitTest tests if aRect intersects or is contained within the bounding box of an item.

Parameters

aRect	A reference to a EDA_RECT object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns: True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 575 of file sch_text.cpp.

 {
     EDA_RECT bBox = GetBoundingBox();
     bBox.Inflate( aAccuracy );
 
     if( aContained )
         return aRect.Contains( bBox );
 
     return aRect.Intersects( bBox );
 }

References EDA_RECT::Contains(), GetBoundingBox(), EDA_RECT::Inflate(), and EDA_RECT::Intersects().

◆ IncrementLabel()

void SCH_TEXT::IncrementLabel ( int aIncrement )

Increment the label text, if it ends with a number.

Parameters

aIncrement = the increment value to add to the number ending the text.

Definition at line 152 of file sch_text.cpp.

 {
     wxString text = GetText();
     IncrementLabelMember( text, aIncrement );
     SetText(text );
 }

References EDA_TEXT::GetText(), IncrementLabelMember(), and EDA_TEXT::SetText().

Referenced by SCH_EDIT_TOOL::RepeatDrawItem().

◆ InitializeConnection()

SCH_CONNECTION * SCH_ITEM::InitializeConnection	(	const SCH_SHEET_PATH &	aPath,
		CONNECTION_GRAPH *	aGraph
	)

inherited

Creates a new connection object associated with this object.

Parameters

aPath is the sheet path to initialize

Definition at line 176 of file sch_item.cpp.

 {
     SCH_CONNECTION* connection = Connection( &aSheet );
 
     if( connection )
     {
         connection->Reset();
     }
     else
     {
         connection = new SCH_CONNECTION( this );
         m_connection_map.insert( std::make_pair( aSheet, connection ) );
         connection->SetGraph( aGraph );
     }
 
     connection->SetSheet( aSheet );
     return connection;
 }

References SCH_ITEM::Connection(), SCH_ITEM::m_connection_map, SCH_CONNECTION::Reset(), SCH_CONNECTION::SetGraph(), and SCH_CONNECTION::SetSheet().

Referenced by CONNECTION_GRAPH::buildConnectionGraph().

◆ IsBold()

bool EDA_TEXT::IsBold ( ) const

inlineinherited

Definition at line 189 of file eda_text.h.

189 { return m_e.Bit( TE_BOLD ); }

EDA_TEXT::TE_BOLD

Definition: eda_text.h:386

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), GetMsgPanelInfo(), EDA_TEXT::GetTextStyleName(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), EDA_TEXT::LenSize(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), Plot(), PlotWorkSheet(), LIB_TEXT::print(), LIB_FIELD::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), KIGFX::GAL::SetTextAttributes(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_BOLD.

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 193 of file eda_item.h.

193 { return m_flags & BRIGHTENED; }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item.h:129

SCH_ITEM::m_connectivity_dirty

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::WS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_EDITOR_CONTROL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ IsConnectable()

virtual bool SCH_ITEM::IsConnectable ( ) const

inlinevirtualinherited

Returns: true if the schematic item can connect to another schematic item.

Reimplemented in SCH_COMPONENT, SCH_SHEET, SCH_HIERLABEL, SCH_GLOBALLABEL, SCH_LABEL, SCH_LINE, SCH_SHEET_PIN, SCH_BUS_ENTRY_BASE, SCH_NO_CONNECT, and SCH_JUNCTION.

Definition at line 383 of file sch_item.h.

383 { return false; }

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), SCH_EDIT_TOOL::DoDelete(), SCH_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::RepeatDrawItem(), and SCH_EDIT_TOOL::Rotate().

◆ IsConnected()

bool SCH_ITEM::IsConnected ( const wxPoint & aPoint ) const

inherited

Test the item to see if it is connected to aPoint.

Parameters

aPoint A reference to a wxPoint object containing the coordinates to test.

Returns: True if connection to aPoint exists.

Definition at line 122 of file sch_item.cpp.

 {
     if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
         return false;
 
     return doIsConnected( aPosition );
 }

References SCH_ITEM::doIsConnected(), EDA_ITEM::m_flags, SKIP_STRUCT, and STRUCT_DELETED.

Referenced by SCH_SCREEN::IsTerminalPoint().

◆ IsConnectivityDirty()

bool SCH_ITEM::IsConnectivityDirty ( )

inlineinherited

Definition at line 444 of file sch_item.h.

444 { return m_connectivity_dirty; }

bool m_connectivity_dirty

Definition: sch_item.h:211

References SCH_ITEM::m_connectivity_dirty.

◆ IsDangling()

bool SCH_TEXT::IsDangling ( ) const

inlineoverridevirtual

Reimplemented from SCH_ITEM.

Definition at line 303 of file sch_text.h.

303 { return m_isDangling; }

SCH_TEXT::m_isDangling

bool m_isDangling

True if not connected to another object if the object derive from SCH_TEXT supports connections.

Definition: sch_text.h:172

References m_isDangling.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), KIGFX::SCH_PAINTER::draw(), and CONNECTION_GRAPH::ercCheckLabels().

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const

inherited

Definition at line 506 of file eda_text.cpp.

 {
     return ( IsVisible()
              && !IsMirrored()
              && GetHorizJustify() == GR_TEXT_HJUSTIFY_CENTER
              && GetVertJustify() == GR_TEXT_VJUSTIFY_CENTER
              && GetTextThickness() == 0
            && !IsItalic()
            && !IsBold()
            && !IsMultilineAllowed()
            );
 }

References EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetVertJustify(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_VJUSTIFY_CENTER, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), and EDA_TEXT::IsVisible().

Referenced by SCH_SEXPR_PLUGIN::saveField().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 189 of file eda_item.h.

189 { return m_flags & IS_DRAGGED; }

IS_DRAGGED

#define IS_DRAGGED

Item being dragged.

Definition: eda_item.h:108

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References IS_DRAGGED, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), and KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 274 of file eda_item.h.

274 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:163

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), and SCH_FIELD::Print().

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const

inlinevirtualinherited

Allows items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD.

Definition at line 278 of file sch_item.h.

278 { return false; }

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const

inlineinherited

Definition at line 186 of file eda_text.h.

186 { return m_e.Bit( TE_ITALIC ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), export_vrml_fp_text(), export_vrml_pcbtext(), EDA_TEXT::Format(), GetMsgPanelInfo(), EDA_TEXT::GetTextStyleName(), TEXT_MOD_GRID_TABLE::GetValueAsBool(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), EDA_TEXT::LenSize(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), LIB_TEXT::print(), LIB_FIELD::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), KIGFX::GAL::SetTextAttributes(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_ITALIC

Definition: eda_text.h:385

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_ITALIC.

◆ IsLocked()

virtual bool SCH_ITEM::IsLocked ( ) const

inlinevirtualinherited

Returns: bool - true if the object is locked, else false

Definition at line 268 of file sch_item.h.

268 { return false; }

Referenced by SCH_EDIT_TOOL::DeleteItemCursor().

◆ IsMirrored()

bool EDA_TEXT::IsMirrored ( ) const

inlineinherited

Definition at line 195 of file eda_text.h.

195 { return m_e.Bit( TE_MIRROR ); }

EDA_TEXT::TE_MIRROR

Definition: eda_text.h:384

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), export_vrml_fp_text(), export_vrml_pcbtext(), PCB_TEXT::Flip(), EDA_TEXT::Format(), PCB_TEXT::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), DIMENSION_BASE::Mirror(), EAGLE_PLUGIN::orientFPText(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::printOneLineOfText(), KIGFX::GAL::SetTextAttributes(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), and EDA_TEXT::TransformToSegmentList().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_MIRROR.

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 186 of file eda_item.h.

186 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

std::function passed to nested users by ref, avoids copying std::function

Definition: eda_item.h:102

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

virtual bool SCH_ITEM::IsMovableFromAnchorPoint ( )

inlinevirtualinherited

Returns: true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor Usually return true for small items (labels, junctions) and false for items which can be large (hierarchical sheets, symbols)

Reimplemented in SCH_SHEET, SCH_COMPONENT, SCH_BITMAP, SCH_SHEET_PIN, and SCH_BUS_ENTRY_BASE.

Definition at line 247 of file sch_item.h.

247 { return true; }

Referenced by SCH_MOVE_TOOL::Main().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 188 of file eda_item.h.

188 { return m_flags & IS_MOVED; }

IS_MOVED

#define IS_MOVED

Item being moved.

Definition: eda_item.h:105

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References IS_MOVED, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), LIB_PIN::CalcEdit(), LIB_ARC::CalcRadiusAngles(), KIGFX::SCH_PAINTER::draw(), LIB_EDIT_TOOL::Duplicate(), LIB_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), LIB_EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), and KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsMultilineAllowed()

bool EDA_TEXT::IsMultilineAllowed ( ) const

inlineinherited

Definition at line 203 of file eda_text.h.

203 { return m_e.Bit( TE_MULTILINE ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_MULTILINE

Definition: eda_text.h:387

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_MULTILINE.

Referenced by BOARD_ADAPTER::AddShapeWithClearanceToContainer(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), export_vrml_pcbtext(), EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), Plot(), BRDITEMS_PLOTTER::PlotPcbText(), PlotWorkSheet(), EDA_TEXT::Print(), PCB_TEXT::TransformShapeWithClearanceToPolygon(), and EDA_TEXT::TransformToSegmentList().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 187 of file eda_item.h.

187 { return m_flags & IS_NEW; }

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), LIB_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Duplicate(), LIB_PIN_TOOL::EditPinProperties(), LIB_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PL_EDIT_TOOL::Main(), EE_POINT_EDITOR::Main(), LIB_MOVE_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), LIB_PIN_TOOL::PlacePin(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), and SCH_EDIT_FRAME::UpdateSymbolFromEditor().

STATUS_FLAGS m_flags

Definition: eda_item.h:164

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item.h:106

References IS_NEW, and EDA_ITEM::m_flags.

◆ IsPointClickableAnchor()

virtual bool SCH_ITEM::IsPointClickableAnchor ( const wxPoint & aPos ) const

inlinevirtualinherited

Returns: true if the given point can start drawing (usually means the anchor is unused/free/dangling)

Reimplemented in SCH_HIERLABEL, SCH_GLOBALLABEL, SCH_LABEL, SCH_LINE, SCH_SHEET_PIN, SCH_JUNCTION, and SCH_PIN.

Definition at line 388 of file sch_item.h.

388 { return false; }

Referenced by EE_SELECTION_TOOL::GuessSelectionCandidates().

◆ IsReplaceable()

virtual bool SCH_TEXT::IsReplaceable ( ) const

inlineoverridevirtual

Function IsReplaceable.

Override this method in any derived object that supports test find and replace.

Returns: True if the item has replaceable text that can be modified using the find and replace dialog.

Reimplemented from EDA_ITEM.

Reimplemented in SCH_LABEL, and SCH_SHEET_PIN.

Definition at line 296 of file sch_text.h.

296 { return true; }

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 192 of file eda_item.h.

192 { return m_flags & IS_RESIZED; }

IS_RESIZED

#define IS_RESIZED

Item being resized.

Definition: eda_item.h:107

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References IS_RESIZED, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::setDeviceColors().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 191 of file eda_item.h.

191 { return m_flags & SELECTED; }

SELECTED

#define SELECTED

Definition: eda_item.h:113

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::WS_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), KIGFX::SCH_PAINTER::getTextThickness(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), BOARD_COMMIT::Push(), SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), C3D_RENDER_OGL_LEGACY::render_3D_footprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SELECTION_TOOL::select(), GERBVIEW_SELECTION_TOOL::select(), EE_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), GERBVIEW_SELECTION_TOOL::unselect(), and WS_PROXY_UNDO_ITEM::WS_PROXY_UNDO_ITEM().

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References EDA_ITEM::m_flags, and SELECTED.

◆ IsType()

virtual bool EDA_ITEM::IsType ( const KICAD_T aScanTypes[] ) const

inlinevirtualinherited

Function IsType Checks whether the item is one of the listed types.

Parameters

aScanTypes List of item types

Returns: true if the item type is contained in the list aScanTypes

Reimplemented in VIA, SCH_LABEL, DIMENSION_BASE, PAD, PCB_SHAPE, SCH_FIELD, SCH_LINE, FP_TEXT, FP_SHAPE, and PCB_TEXT.

Definition at line 250 of file eda_item.h.

     {
         if( aScanTypes[0] == SCH_LOCATE_ANY_T )
             return true;
 
         for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
         {
             if( m_structType == *p )
                 return true;
         }
 
         return false;
     }

References EOT, EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), FP_TEXT::IsType(), SCH_LINE::IsType(), SCH_FIELD::IsType(), PCB_SHAPE::IsType(), PAD::IsType(), DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), EE_SELECTION_TOOL::RequestSelection(), SCH_BASE_FRAME::UpdateItem(), EDA_ITEM::Visit(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsVisible()

bool EDA_TEXT::IsVisible ( ) const

inlineinherited

Definition at line 192 of file eda_text.h.

192 { return m_e.Bit( TE_VISIBLE ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by BOARD_ADAPTER::AddFPShapesWithClearanceToContainer(), ZONE_FILLER::addKnockout(), SCH_EDITOR_CONTROL::AssignFootprints(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), export_vrml_footprint(), export_vrml_fp_text(), PCB_IO::format(), EDA_TEXT::Format(), FOOTPRINT::GetBoundingBox(), FP_TEXT::GetMsgPanelInfo(), TEXT_MOD_GRID_TABLE::GetValueAsBool(), SCH_FIELD::HitTest(), GENERAL_COLLECTOR::Inspect(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::Matches(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), LIB_FIELD::print(), SCH_FIELD::Print(), LIB_PART::Print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), processTextItem(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), FOOTPRINT::TransformFPShapesWithClearanceToPolygon(), and FP_TEXT::ViewGetLayers().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_VISIBLE

Definition: eda_text.h:388

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_VISIBLE.

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 190 of file eda_item.h.

190 { return m_flags & IS_WIRE_IMAGE; }

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item.h:110

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

template<class T >

static SEARCH_RESULT EDA_ITEM::IterateForward	(	std::deque< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const KICAD_T	scanTypes[]
	)

inlinestaticinherited

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use the main queue instead

Definition at line 372 of file eda_item.h.

     {
         for( auto it : aList )
         {
             if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
                     == SEARCH_RESULT::QUIT )
                 return SEARCH_RESULT::QUIT;
         }
 
         return SEARCH_RESULT::CONTINUE;
     }

References CONTINUE, QUIT, and EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

static SEARCH_RESULT EDA_ITEM::IterateForward	(	std::vector< T > &	aList,
		INSPECTOR	inspector,
		void *	testData,
		const KICAD_T	scanTypes[]
	)

inlinestaticinherited

IterateForward( EDA_ITEM*, INSPECTOR, void*, const KICAD_T )

This changes first parameter to avoid the DList and use std::vector instead

Definition at line 393 of file eda_item.h.

     {
         for( auto it : aList )
         {
             if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
                     == SEARCH_RESULT::QUIT )
                 return SEARCH_RESULT::QUIT;
         }
 
         return SEARCH_RESULT::CONTINUE;
     }

References CONTINUE, QUIT, and EDA_ITEM::Visit().

◆ LenSize()

int EDA_TEXT::LenSize	(	const wxString &	aLine,
		int	aThickness
	)		const

inherited

Returns: the text length in internal units

Parameters

aLine	: the line of text to consider. For single line text, this parameter is always m_Text
aThickness	: the stroke width of the text

Definition at line 188 of file eda_text.cpp.

 {
     basic_gal.SetFontItalic( IsItalic() );
     basic_gal.SetFontBold( IsBold() );
     basic_gal.SetFontUnderlined( false );
     basic_gal.SetLineWidth( (float) aThickness );
     basic_gal.SetGlyphSize( VECTOR2D( GetTextSize() ) );
 
     VECTOR2D tsize = basic_gal.GetTextLineSize( aLine );
 
     return KiROUND( tsize.x );
 }

References basic_gal, KIGFX::GAL::GetTextLineSize(), EDA_TEXT::GetTextSize(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), KiROUND(), KIGFX::GAL::SetFontBold(), KIGFX::GAL::SetFontItalic(), KIGFX::GAL::SetFontUnderlined(), KIGFX::GAL::SetGlyphSize(), KIGFX::GAL::SetLineWidth(), and VECTOR2< T >::x.

Referenced by SCH_GLOBALLABEL::CreateGraphicShape(), SCH_GLOBALLABEL::GetBoundingBox(), and SCH_HIERLABEL::GetBoundingBox().

◆ MapHorizJustify()

EDA_TEXT_HJUSTIFY_T EDA_TEXT::MapHorizJustify ( int aHorizJustify )

staticinherited

Definition at line 63 of file eda_text.cpp.

 {
     wxASSERT( aHorizJustify >= GR_TEXT_HJUSTIFY_LEFT && aHorizJustify <= GR_TEXT_HJUSTIFY_RIGHT );
 
     if( aHorizJustify > GR_TEXT_HJUSTIFY_RIGHT )
         return GR_TEXT_HJUSTIFY_RIGHT;
 
     if( aHorizJustify < GR_TEXT_HJUSTIFY_LEFT )
         return GR_TEXT_HJUSTIFY_LEFT;
 
     return (EDA_TEXT_HJUSTIFY_T) aHorizJustify;
 }

References GR_TEXT_HJUSTIFY_LEFT, and GR_TEXT_HJUSTIFY_RIGHT.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and DIALOG_EDIT_ONE_FIELD::updateText().

◆ MapVertJustify()

EDA_TEXT_VJUSTIFY_T EDA_TEXT::MapVertJustify ( int aVertJustify )

staticinherited

Definition at line 77 of file eda_text.cpp.

 {
     wxASSERT( aVertJustify >= GR_TEXT_VJUSTIFY_TOP && aVertJustify <= GR_TEXT_VJUSTIFY_BOTTOM );
 
     if( aVertJustify > GR_TEXT_VJUSTIFY_BOTTOM )
         return GR_TEXT_VJUSTIFY_BOTTOM;
 
     if( aVertJustify < GR_TEXT_VJUSTIFY_TOP )
         return GR_TEXT_VJUSTIFY_TOP;
 
     return (EDA_TEXT_VJUSTIFY_T) aVertJustify;
 }

References GR_TEXT_VJUSTIFY_BOTTOM, and GR_TEXT_VJUSTIFY_TOP.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and DIALOG_EDIT_ONE_FIELD::updateText().

◆ Matches() [1/2]

bool SCH_TEXT::Matches	(	wxFindReplaceData &	aSearchData,
		void *	aAuxData
	)

inlineoverridevirtual

Function Matches compares the item against the search criteria in aSearchData.

The base class returns false since many of the objects derived from EDA_ITEM do not have any text to search.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns: True if the item's text matches the search criteria in aSearchData.

Reimplemented from EDA_ITEM.

Definition at line 286 of file sch_text.h.

     {
         return SCH_ITEM::Matches( GetText(), aSearchData );
     }

References EDA_TEXT::GetText(), and EDA_ITEM::Matches().

◆ Matches() [2/2]

bool EDA_ITEM::Matches	(	const wxString &	aText,
		wxFindReplaceData &	aSearchData
	)

protectedinherited

Function Matches compares aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

aText	A reference to a wxString object containing the string to test.
aSearchData	The criteria to search against.

Returns: True if aText matches the search criteria in aSearchData.

Definition at line 132 of file eda_item.cpp.

 {
     wxString text = aText;
     wxString searchText = aSearchData.GetFindString();
 
     // Don't match if searching for replaceable item and the item doesn't support text replace.
     if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
         return false;
 
     if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
         return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
 
     if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
     {
         if( aSearchData.GetFlags() & wxFR_MATCHCASE )
             return text.Matches( searchText );
 
         return text.MakeUpper().Matches( searchText.MakeUpper() );
     }
 
     if( aSearchData.GetFlags() & wxFR_MATCHCASE )
         return aText.Find( searchText ) != wxNOT_FOUND;
 
     return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
 }

References FR_MATCH_WILDCARD, FR_SEARCH_REPLACE, and EDA_ITEM::IsReplaceable().

◆ MirrorSpinStyle()

void SCH_TEXT::MirrorSpinStyle ( bool aLeftRight )

virtual

Reimplemented in SCH_GLOBALLABEL.

Definition at line 223 of file sch_text.cpp.

 {
     if( aLeftRight )
         SetLabelSpinStyle( GetLabelSpinStyle().MirrorY() );
     else
         SetLabelSpinStyle( GetLabelSpinStyle().MirrorX() );
 }

References GetLabelSpinStyle(), MirrorX(), MirrorY(), and SetLabelSpinStyle().

Referenced by SCH_EDIT_TOOL::Mirror(), and SCH_GLOBALLABEL::MirrorSpinStyle().

◆ MirrorX()

void SCH_TEXT::MirrorX ( int aXaxis_position )

overridevirtual

Mirror item relative to the X axis about aXaxis_position.

Parameters

aXaxis_position The X axis position to mirror around.

Implements SCH_ITEM.

Definition at line 193 of file sch_text.cpp.

 {
     // Text is NOT really mirrored; it is moved to a suitable vertical position
     SetLabelSpinStyle( GetLabelSpinStyle().MirrorX() );
 
     SetTextY( MIRRORVAL( GetTextPos().y, aXaxis_position ) );
 }

References GetLabelSpinStyle(), EDA_TEXT::GetTextPos(), MIRRORVAL(), SetLabelSpinStyle(), and EDA_TEXT::SetTextY().

Referenced by MirrorSpinStyle().

◆ MirrorY()

void SCH_TEXT::MirrorY ( int aYaxis_position )

overridevirtual

Mirror item relative to the Y axis about aYaxis_position.

Parameters

aYaxis_position The Y axis position to mirror around.

Implements SCH_ITEM.

Definition at line 184 of file sch_text.cpp.

 {
     // Text is NOT really mirrored; it is moved to a suitable horizontal position
     SetLabelSpinStyle( GetLabelSpinStyle().MirrorY() );
 
     SetTextX( MIRRORVAL( GetTextPos().x, aYaxis_position ) );
 }

References GetLabelSpinStyle(), EDA_TEXT::GetTextPos(), MIRRORVAL(), SetLabelSpinStyle(), and EDA_TEXT::SetTextX().

Referenced by MirrorSpinStyle().

◆ Move()

void SCH_TEXT::Move ( const wxPoint & aMoveVector )

inlineoverridevirtual

Move the item by aMoveVector to a new position.

Parameters

aMoveVector = the displacement vector

Implements SCH_ITEM.

Reimplemented in SCH_GLOBALLABEL.

Definition at line 274 of file sch_text.h.

     {
         EDA_TEXT::Offset( aMoveVector );
     }

References EDA_TEXT::Offset().

Referenced by SCH_GLOBALLABEL::Move(), and SCH_MOVE_TOOL::moveItem().

◆ NetClass()

NETCLASSPTR SCH_ITEM::NetClass ( const SCH_SHEET_PATH * aSheet = nullptr ) const

inherited

Definition at line 145 of file sch_item.cpp.

 {
     if( m_connection_map.size() )
     {
         SCH_CONNECTION* connection = Connection( aSheet );
 
         if( connection )
         {
             NET_SETTINGS&   netSettings = Schematic()->Prj().GetProjectFile().NetSettings();
             const wxString& netclassName = netSettings.GetNetclassName( connection->Name() );
 
             return netSettings.m_NetClasses.Find( netclassName );
         }
     }
 
     return nullptr;
 }

References SCH_ITEM::Connection(), NETCLASSES::Find(), NET_SETTINGS::GetNetclassName(), PROJECT::GetProjectFile(), SCH_ITEM::m_connection_map, NET_SETTINGS::m_NetClasses, SCH_CONNECTION::Name(), PROJECT_FILE::NetSettings(), SCHEMATIC::Prj(), and SCH_ITEM::Schematic().

Referenced by SCH_LINE::GetEffectiveLineStyle(), SCH_JUNCTION::getEffectiveShape(), SCH_JUNCTION::GetJunctionColor(), SCH_LINE::GetLineColor(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), and SCH_BUS_ENTRY_BASE::GetStrokeStyle().

◆ Offset()

void EDA_TEXT::Offset ( const wxPoint & aOffset )

inlineinherited

Definition at line 259 of file eda_text.h.

259 { m_e.pos += aOffset; }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

References color, CreateGraphicShape(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetHorizJustify(), SCH_ITEM::GetLayer(), KIGFX::RENDER_SETTINGS::GetLayerColor(), EDA_TEXT::GetLinePositions(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), GetSchematicTextOffset(), GetShownText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMultilineAllowed(), NO_FILL, PLOTTER::PlotPoly(), PLOTTER::RenderSettings(), PLOTTER::SetCurrentLineWidth(), PLOTTER::Text(), and wxStringSplit().

wxPoint pos

Definition: eda_text.h:106

References EDA_TEXT::m_e, and TEXT_EFFECTS::pos.

Referenced by PCB_TEXT::Move(), FP_TEXT::Move(), SCH_FIELD::Move(), SCH_SHEET_PIN::Move(), DIMENSION_BASE::Move(), Move(), LIB_TEXT::Offset(), LIB_FIELD::Offset(), FP_TEXT::SetDrawCoord(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ operator<() [1/2]

bool SCH_TEXT::operator< ( const SCH_ITEM & aItem ) const

overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 288 of file sch_text.cpp.

 {
     if( Type() != aItem.Type() )
         return Type() < aItem.Type();
 
     auto other = static_cast<const SCH_TEXT*>( &aItem );
 
     if( GetLayer() != other->GetLayer() )
             return GetLayer() < other->GetLayer();
 
     if( GetPosition().x != other->GetPosition().x )
         return GetPosition().x < other->GetPosition().x;
 
     if( GetPosition().y != other->GetPosition().y )
         return GetPosition().y < other->GetPosition().y;
 
     return GetText() < other->GetText();
 }

References SCH_ITEM::GetLayer(), GetPosition(), EDA_TEXT::GetText(), and EDA_ITEM::Type().

◆ operator<() [2/2]

bool EDA_ITEM::operator< ( const EDA_ITEM & aItem ) const

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

Returns: - True if aItem is less than the item.

Definition at line 185 of file eda_item.cpp.

 {
     wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
                                  GetClass() ) );
 
     return false;
 }

References Format(), and EDA_ITEM::GetClass().

◆ Plot()

void SCH_TEXT::Plot ( PLOTTER * aPlotter )

overridevirtual

Plot the schematic item to aPlotter.

Parameters

aPlotter A pointer to a PLOTTER object.

Reimplemented from SCH_ITEM.

Definition at line 587 of file sch_text.cpp.

 {
     static std::vector<wxPoint> Poly;
     COLOR4D color = aPlotter->RenderSettings()->GetLayerColor( GetLayer() );
     int penWidth = GetEffectiveTextPenWidth( aPlotter->RenderSettings()->GetDefaultPenWidth() );
 
     penWidth = std::max( penWidth, aPlotter->RenderSettings()->GetMinPenWidth() );
     aPlotter->SetCurrentLineWidth( penWidth );
 
     if( IsMultilineAllowed() )
     {
         std::vector<wxPoint> positions;
         wxArrayString strings_list;
         wxStringSplit( GetShownText(), strings_list, '\n' );
         positions.reserve( strings_list.Count() );
 
         GetLinePositions( positions, (int) strings_list.Count() );
 
         for( unsigned ii = 0; ii < strings_list.Count(); ii++ )
         {
             wxPoint textpos = positions[ii] + GetSchematicTextOffset( aPlotter->RenderSettings() );
             wxString& txt = strings_list.Item( ii );
             aPlotter->Text( textpos, color, txt, GetTextAngle(), GetTextSize(), GetHorizJustify(),
                             GetVertJustify(), penWidth, IsItalic(), IsBold() );
         }
     }
     else
     {
         wxPoint textpos = GetTextPos() + GetSchematicTextOffset( aPlotter->RenderSettings() );
 
         aPlotter->Text( textpos, color, GetShownText(), GetTextAngle(), GetTextSize(),
                         GetHorizJustify(), GetVertJustify(), penWidth, IsItalic(), IsBold() );
     }
 
     // Draw graphic symbol for global or hierarchical labels
     CreateGraphicShape( aPlotter->RenderSettings(), Poly, GetTextPos() );
 
     if( Poly.size() )
         aPlotter->PlotPoly( Poly, FILL_TYPE::NO_FILL, penWidth );
 }

◆ Print() [1/2]

void SCH_TEXT::Print	(	RENDER_SETTINGS *	aSettings,
		const wxPoint &	aOffset
	)

overridevirtual

Print a schematic item.

Each schematic item should have its own method

Parameters

aOffset drawing offset (usually {0,0} but can be different when moving an object)

Implements SCH_ITEM.

Reimplemented in SCH_HIERLABEL, and SCH_GLOBALLABEL.

Definition at line 331 of file sch_text.cpp.

 {
     COLOR4D color = aSettings->GetLayerColor( m_layer );
     wxPoint text_offset = aOffset + GetSchematicTextOffset( aSettings );
 
     EDA_TEXT::Print( aSettings, text_offset, color );
 }

References color, KIGFX::RENDER_SETTINGS::GetLayerColor(), GetSchematicTextOffset(), SCH_ITEM::m_layer, and EDA_TEXT::Print().

◆ Print() [2/2]

void EDA_TEXT::Print	(	RENDER_SETTINGS *	aSettings,
		const wxPoint &	aOffset,
		COLOR4D	aColor,
		OUTLINE_MODE	aDisplay_mode = `FILLED`
	)

inherited

Print this text object to the device context aDC.

Parameters

aDC	= the current Device Context
aOffset	= draw offset (usually (0,0))
aColor	= text color
aDisplay_mode	= FILLED or SKETCH

Definition at line 401 of file eda_text.cpp.

 {
     if( IsMultilineAllowed() )
     {
         std::vector<wxPoint> positions;
         wxArrayString  strings;
         wxStringSplit( GetShownText(), strings, '\n' );
 
         positions.reserve( strings.Count() );
 
         GetLinePositions( positions, strings.Count() );
 
         for( unsigned ii = 0; ii < strings.Count(); ii++ )
             printOneLineOfText( aSettings, aOffset, aColor, aFillMode, strings[ii], positions[ii] );
     }
     else
     {
         printOneLineOfText( aSettings, aOffset, aColor, aFillMode, GetShownText(), GetTextPos() );
     }
 }

References EDA_TEXT::GetLinePositions(), EDA_TEXT::GetShownText(), EDA_TEXT::GetTextPos(), EDA_TEXT::IsMultilineAllowed(), EDA_TEXT::printOneLineOfText(), and wxStringSplit().

Referenced by Print(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), and WS_DRAW_ITEM_TEXT::PrintWsItem().

◆ Replace() [1/3]

bool EDA_TEXT::Replace ( wxFindReplaceData & aSearchData )

inherited

Helper function used in search and replace dialog.

Perform a text replace using the find and replace criteria in aSearchData.

Parameters

aSearchData A reference to a wxFindReplaceData object containing the search and replace criteria.

Returns: True if the text item was modified, otherwise false.

Definition at line 178 of file eda_text.cpp.

 {
     bool retval = EDA_ITEM::Replace( aSearchData, m_text );
     m_shown_text = UnescapeString( m_text );
     m_shown_text_has_text_var_refs = m_shown_text.Contains( wxT( "${" ) );
 
     return retval;
 }

References EDA_TEXT::m_shown_text, EDA_TEXT::m_shown_text_has_text_var_refs, EDA_TEXT::m_text, EDA_ITEM::Replace(), and UnescapeString().

Referenced by SCH_FIELD::Replace(), SCH_SHEET_PIN::Replace(), and Replace().

◆ Replace() [2/3]

bool SCH_TEXT::Replace	(	wxFindReplaceData &	aSearchData,
		void *	aAuxData
	)

inlineoverridevirtual

Function Replace performs a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

This function must be overridden for items that support text replace.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxData	A pointer to optional data required for the search or NULL if not used.

Returns: True if the item text was modified, otherwise false.

Reimplemented from EDA_ITEM.

Definition at line 291 of file sch_text.h.

     {
         return EDA_TEXT::Replace( aSearchData );
     }

References EDA_TEXT::Replace().

◆ Replace() [3/3]

bool EDA_ITEM::Replace	(	wxFindReplaceData &	aSearchData,
		wxString &	aText
	)

staticinherited

Helper function used in search and replace dialog Function Replace performs a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aText	A reference to a wxString object containing the text to be replaced.

Returns: True if aText was modified, otherwise false.

Definition at line 159 of file eda_item.cpp.

 {
     wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
 
     int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
                                     aSearchData.GetFindString() :
                                     aSearchData.GetFindString().Upper() );
 
     if( result == wxNOT_FOUND )
         return false;
 
     wxString prefix = aText.Left( result );
     wxString suffix;
 
     if( aSearchData.GetFindString().length() + result < aText.length() )
         suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
 
     wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
                 aText, prefix, aSearchData.GetReplaceString(), suffix );
 
     aText = prefix + aSearchData.GetReplaceString() + suffix;
 
     return true;
 }

References traceFindReplace.

Referenced by SCH_FIELD::Replace(), EDA_TEXT::Replace(), and SCH_EDITOR_CONTROL::ReplaceAndFindNext().

◆ Rotate()

void SCH_TEXT::Rotate ( wxPoint aPosition )

overridevirtual

Rotate the item around aPosition 90 degrees in the clockwise direction.

Parameters

aPosition A reference to a wxPoint object containing the coordinates to rotate around.

Implements SCH_ITEM.

Reimplemented in SCH_GLOBALLABEL.

Definition at line 202 of file sch_text.cpp.

 {
     wxPoint pt = GetTextPos();
     RotatePoint( &pt, aPosition, 900 );
     wxPoint offset = pt - GetTextPos();
 
     Rotate90( false );
 
     SetTextPos( GetTextPos() + offset );
 }

References EDA_TEXT::GetTextPos(), Rotate90(), RotatePoint(), and EDA_TEXT::SetTextPos().

◆ Rotate90()

void SCH_TEXT::Rotate90 ( bool aClockwise )

virtual

Reimplemented in SCH_GLOBALLABEL.

Definition at line 214 of file sch_text.cpp.

 {
     if( aClockwise )
         SetLabelSpinStyle( GetLabelSpinStyle().RotateCW() );
     else
         SetLabelSpinStyle( GetLabelSpinStyle().RotateCCW() );
 }

References GetLabelSpinStyle(), and SetLabelSpinStyle().

Referenced by SCH_EDIT_TOOL::Rotate(), Rotate(), and SCH_GLOBALLABEL::Rotate90().

◆ RunOnChildren()

virtual void SCH_ITEM::RunOnChildren ( const std::function< void(SCH_ITEM *)> & aFunction )

inlinevirtualinherited

Reimplemented in SCH_SHEET, SCH_COMPONENT, and SCH_GLOBALLABEL.

Definition at line 475 of file sch_item.h.

475 { }

Referenced by SCH_ITEM::Duplicate(), and SCH_SHEET_LIST::GetItem().

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const

inherited

Searches the item hierarchy to find a SCHEMATIC.

Every SCH_ITEM that lives on a SCH_SCREEN should be parented to either that screen or another SCH_ITEM on the same screen (for example, pins to their symbols).

Every SCH_SCREEN should be parented to the SCHEMATIC. Note that this hierarchy is not the same as the sheet hierarchy!

Returns: the parent schematic this item lives on, or nullptr

Definition at line 97 of file sch_item.cpp.

 {
     EDA_ITEM* parent = GetParent();
 
     while( parent )
     {
         if( parent->Type() == SCHEMATIC_T )
             return static_cast<SCHEMATIC*>( parent );
         else
             parent = parent->GetParent();
     }
 
     return nullptr;
 }

References EDA_ITEM::GetParent(), SCHEMATIC_T, and EDA_ITEM::Type().

Referenced by SCH_ITEM::Connection(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), SCH_FIELD::DoHypertextMenu(), SCH_MARKER::GetColorLayer(), SCH_JUNCTION::getEffectiveShape(), SCH_LINE::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_NO_CONNECT::GetPenWidth(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_COMPONENT::GetPins(), SCH_FIELD::GetShownText(), GetShownText(), GetTextOffset(), inheritNetclass(), SCH_SHEET::IsRootSheet(), SCH_LABEL::IsType(), SCH_ITEM::NetClass(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), SCH_HIERLABEL::Print(), SCH_COMPONENT::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_GLOBALLABEL::ResolveTextVar(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), and SCH_MARKER::ViewGetLayers().

◆ Set() [1/3]

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		wxAny &	aValue
	)

inlineinherited

Definition at line 40 of file inspectable.h.

     {
         PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
         TYPE_ID thisType = TYPE_HASH( *this );
         void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 
         if( object )
             aProperty->setter( object, aValue );
 
         return object != nullptr;
     }

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::setter(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [2/3]

template<typename T >

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		T	aValue
	)

inlineinherited

Definition at line 53 of file inspectable.h.

     {
         PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
         TYPE_ID thisType = TYPE_HASH( *this );
         void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
 
         if( object )
             aProperty->set<T>( object, aValue );
 
         return object != nullptr;
     }

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [3/3]

template<typename T >

bool INSPECTABLE::Set	(	const wxString &	aProperty,
		T	aValue
	)

inlineinherited

Definition at line 66 of file inspectable.h.

     {
         PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
         TYPE_ID thisType = TYPE_HASH( *this );
         PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
         void* object = nullptr;
 
         if( prop )
         {
             object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
             if( object )
                 prop->set<T>( object, aValue );
         }
 
         return object != nullptr;
     }

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ SetBold()

void EDA_TEXT::SetBold ( bool aBold )

inlineinherited

Definition at line 188 of file eda_text.h.

188 { m_e.Bit( TE_BOLD, aBold); }

EDA_TEXT::TE_BOLD

Definition: eda_text.h:386

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewText(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibraryFieldAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute(), SCH_LEGACY_PLUGIN_CACHE::loadText(), SCH_EAGLE_PLUGIN::loadTextAttributes(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseLabel(), ALTIUM_PCB::ParseTexts6Data(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), SCH_GLOBALLABEL::UpdateIntersheetRefProps(), DIALOG_EDIT_ONE_FIELD::updateText(), and WS_DRAW_ITEM_TEXT::WS_DRAW_ITEM_TEXT().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_BOLD.

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 197 of file eda_item.h.

197 { SetFlags( BRIGHTENED ); }

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item.h:129

EDA_ITEM::SetFlags

void SetFlags(STATUS_FLAGS aMask)

Definition: eda_item.h:220

References BRIGHTENED, and EDA_ITEM::SetFlags().

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), KIGFX::SCH_PAINTER::draw(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ SetConnectivityDirty()

void SCH_ITEM::SetConnectivityDirty ( bool aDirty = true )

inlineinherited

Definition at line 446 of file sch_item.h.

446 { m_connectivity_dirty = aDirty; }

SCH_ITEM::m_connectivity_dirty

bool m_connectivity_dirty

Definition: sch_item.h:211

References SCH_ITEM::m_connectivity_dirty.

Referenced by SCH_EDIT_FRAME::SaveCopyInUndoList().

◆ SetEffects()

void EDA_TEXT::SetEffects ( const EDA_TEXT & aSrc )

inherited

Set the text effects from another instance.

TEXT_EFFECTS is not exposed in the public API, but includes everything except the actual text string itself.

Definition at line 137 of file eda_text.cpp.

 {
     m_e = aSrc.m_e;
 }

References EDA_TEXT::m_e.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::ImportValues(), LIB_FIELD::operator=(), DIALOG_CHANGE_SYMBOLS::processSymbol(), CLIPBOARD_IO::SaveSelection(), and FP_TEXT::SetEffects().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS aMask )

inlineinherited

Definition at line 220 of file eda_item.h.

220 { m_flags |= aMask; }

STATUS_FLAGS m_flags

Definition: eda_item.h:164

References EDA_ITEM::m_flags.

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

Function SetForceVisible is used to set and cleag force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

Parameters

aEnable True forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 272 of file eda_item.h.

272 { m_forceVisible = aEnable; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:163

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetHorizJustify()

void EDA_TEXT::SetHorizJustify ( EDA_TEXT_HJUSTIFY_T aType )

inlineinherited

Definition at line 208 of file eda_text.h.

208 { m_e.hjustify = aType; };

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_GLOBALLABEL::AutoplaceFields(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::Flip(), ALTIUM_PCB::HelperParseDimensions6Leader(), AUTOPLACER::justify_field(), FP_TEXT::KeepUpright(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN_CACHE::loadText(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseSheetName(), ALTIUM_PCB::ParseTexts6Data(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), LIB_TEXT::Rotate(), SCH_GLOBALLABEL::Rotate90(), SetEdaTextJustification(), SetLabelSpinStyle(), SCH_GLOBALLABEL::SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), PCAD2KICAD::SetTextJustify(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_EDIT_ONE_FIELD::updateText().

TEXT_EFFECTS m_e

Definition: eda_text.h:381

TEXT_EFFECTS::hjustify

signed char hjustify

horizontal justification

Definition: eda_text.h:101

References TEXT_EFFECTS::hjustify, and EDA_TEXT::m_e.

◆ SetIsDangling()

void SCH_TEXT::SetIsDangling ( bool aIsDangling )

inline

Definition at line 304 of file sch_text.h.

304 { m_isDangling = aIsDangling; }

SCH_TEXT::m_isDangling

bool m_isDangling

True if not connected to another object if the object derive from SCH_TEXT supports connections.

Definition: sch_text.h:172

References m_isDangling.

Referenced by SCH_EDIT_TOOL::ChangeTextType().

◆ SetItalic()

void EDA_TEXT::SetItalic ( bool isItalic )

inlineinherited

Definition at line 185 of file eda_text.h.

185 { m_e.Bit( TE_ITALIC, isItalic ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), SCH_EDIT_TOOL::ChangeTextType(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), DRAWING_TOOL::DrawDimension(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), SCH_LEGACY_PLUGIN_CACHE::loadField(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN_CACHE::loadText(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseLabel(), ALTIUM_PCB::ParseTexts6Data(), DRAWING_TOOL::PlaceText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), TEXT_MOD_GRID_TABLE::SetValueAsBool(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), SCH_GLOBALLABEL::UpdateIntersheetRefProps(), DIALOG_EDIT_ONE_FIELD::updateText(), and WS_DRAW_ITEM_TEXT::WS_DRAW_ITEM_TEXT().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_ITALIC

Definition: eda_text.h:385

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_ITALIC.

◆ SetLabelSpinStyle()

void SCH_TEXT::SetLabelSpinStyle ( LABEL_SPIN_STYLE aSpinStyle )

virtual

Set a spin or rotation angle, along with specific horizontal and vertical justification styles with each angle.

Parameters

aSpinStyle Spin style as per LABEL_SPIN_STYLE storage class, may be the enum values or int value

Reimplemented in SCH_HIERLABEL, and SCH_GLOBALLABEL.

Definition at line 232 of file sch_text.cpp.

 {
     m_spin_style = aSpinStyle;
 
     // Assume "Right" and Left" mean which side of the anchor the text will be on
     // Thus we want to left justify text up agaisnt the anchor if we are on the right
     switch( aSpinStyle )
     {
     default:
         wxASSERT_MSG( 1, "Bad spin style" );
         break;
 
     case LABEL_SPIN_STYLE::RIGHT: // Horiz Normal Orientation
         //
         m_spin_style = LABEL_SPIN_STYLE::RIGHT; // Handle the error spin style by resetting
         SetTextAngle( TEXT_ANGLE_HORIZ );
         SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
         SetVertJustify( GR_TEXT_VJUSTIFY_BOTTOM );
         break;
 
     case LABEL_SPIN_STYLE::UP: // Vert Orientation UP
         SetTextAngle( TEXT_ANGLE_VERT );
         SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
         SetVertJustify( GR_TEXT_VJUSTIFY_BOTTOM );
         break;
 
     case LABEL_SPIN_STYLE::LEFT: // Horiz Orientation - Right justified
         SetTextAngle( TEXT_ANGLE_HORIZ );
         SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT );
         SetVertJustify( GR_TEXT_VJUSTIFY_BOTTOM );
         break;
 
     case LABEL_SPIN_STYLE::BOTTOM: //  Vert Orientation BOTTOM
         SetTextAngle( TEXT_ANGLE_VERT );
         SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT );
         SetVertJustify( GR_TEXT_VJUSTIFY_BOTTOM );
         break;
     }
 }

References LABEL_SPIN_STYLE::BOTTOM, GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, LABEL_SPIN_STYLE::LEFT, m_spin_style, LABEL_SPIN_STYLE::RIGHT, EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetVertJustify(), TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, and LABEL_SPIN_STYLE::UP.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewText(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), MirrorSpinStyle(), MirrorX(), MirrorY(), SCH_ALTIUM_PLUGIN::ParseNetLabel(), SCH_ALTIUM_PLUGIN::ParsePort(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BACK_ANNOTATE::processNetNameChange(), Rotate90(), and DIALOG_LABEL_EDITOR::TransferDataFromWindow().

◆ SetLayer()

void SCH_ITEM::SetLayer ( SCH_LAYER_ID aLayer )

inlineinherited

Set the layer this item is on.

Parameters

aLayer The layer number.

Definition at line 292 of file sch_item.h.

292 { m_layer = aLayer; }

SCH_ITEM::m_layer

SCH_LAYER_ID m_layer

Definition: sch_item.h:199

References SCH_ITEM::m_layer.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), SCH_NO_CONNECT::SCH_NO_CONNECT(), SCH_FIELD::SetId(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ SetLocked()

virtual void SCH_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

Set the 'lock' status to aLocked for of this item.

Definition at line 273 of file sch_item.h.

273 {}

◆ SetMirrored()

void EDA_TEXT::SetMirrored ( bool isMirrored )

inlineinherited

Definition at line 194 of file eda_text.h.

194 { m_e.Bit( TE_MIRROR, isMirrored ); }

EDA_TEXT::TE_MIRROR

Definition: eda_text.h:384

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_TEXT::Flip(), FP_TEXT::Flip(), FP_TEXT::FP_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), DIMENSION_BASE::Mirror(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseParameter(), ALTIUM_PCB::ParseTexts6Data(), DRAWING_TOOL::PlaceText(), TEXT_MOD_GRID_TABLE::SetValueAsLong(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_MIRROR.

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 79 of file eda_item.cpp.

 {
     SetFlags( IS_CHANGED );
 
     // If this a child object, then the parent modification state also needs to be set.
     if( m_parent )
         m_parent->SetModified();
 }

References IS_CHANGED, EDA_ITEM::m_parent, EDA_ITEM::SetFlags(), and EDA_ITEM::SetModified().

Referenced by LIB_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_COMPONENT::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_ALTIUM_PLUGIN::Parse(), ALTIUM_PCB::Parse(), LIB_PART::RemoveDrawItem(), SCH_COMPONENT::SetConvert(), SCH_COMPONENT::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_COMPONENT::SetTransform(), and SCH_COMPONENT::SetUnit().

◆ SetMultilineAllowed()

void EDA_TEXT::SetMultilineAllowed ( bool aAllow )

inlineinherited

Parameters

aAllow true if ok to use multiline option, false if ok to use only single line text. (Single line is faster in calculations than multiline.)

Definition at line 202 of file eda_text.h.

202 { m_e.Bit( TE_MULTILINE, aAllow ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_SHEET::AddPin(), LIB_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_PART::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), LIB_PART::LIB_PART(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), FOOTPRINT::operator=(), LIB_PART::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), LIB_EDIT_TOOL::Paste(), PCBNEW_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), SCH_DRAWING_TOOLS::PlaceComponent(), PCB_EDITOR_CONTROL::PlaceModule(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_GLOBALLABEL::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_MULTILINE

Definition: eda_text.h:387

References TEXT_EFFECTS::Bit(), EDA_TEXT::m_e, and EDA_TEXT::TE_MULTILINE.

Referenced by PCB_TEXT::PCB_TEXT(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_LABEL::SCH_LABEL(), SCH_TEXT(), and WS_DATA_ITEM_TEXT::SyncDrawItems().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in DIMENSION_BASE.

Definition at line 184 of file eda_item.h.

184 { m_parent = aParent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:162

References EDA_ITEM::m_parent.

◆ SetPosition()

void SCH_TEXT::SetPosition ( const wxPoint & aPosition )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 313 of file sch_text.h.

313 { EDA_TEXT::SetTextPos( aPosition ); }

EDA_TEXT::SetTextPos

void SetTextPos(const wxPoint &aPoint)

Definition: eda_text.h:253

References EDA_TEXT::SetTextPos().

Referenced by SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_EAGLE_PLUGIN::adjustNetLabels(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), and SCH_MOVE_TOOL::moveItem().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 196 of file eda_item.h.

196 { SetFlags( SELECTED ); }

EDA_ITEM::SetFlags

void SetFlags(STATUS_FLAGS aMask)

Definition: eda_item.h:220

SELECTED

#define SELECTED

Definition: eda_item.h:113

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by KIGFX::SCH_PAINTER::draw(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), SELECTION_TOOL::highlightInternal(), WS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::selectVisually(), and GROUP_TOOL::Ungroup().

◆ SetShape()

void SCH_TEXT::SetShape ( PINSHEETLABEL_SHAPE aShape )

inline

Definition at line 237 of file sch_text.h.

237 { m_shape = aShape; }

SCH_TEXT::m_shape

PINSHEETLABEL_SHAPE m_shape

Definition: sch_text.h:168

References m_shape.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParseSheetEntry(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), and DIALOG_LABEL_EDITOR::TransferDataFromWindow().

◆ SetState()

void EDA_ITEM::SetState	(	int	type,
		int	state
	)

inlineinherited

Definition at line 209 of file eda_item.h.

     {
         if( state )
             m_status |= type; // state = ON or OFF
         else
             m_status &= ~type;
     }

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), SELECTION_TOOL::selectConnectedTracks(), and TRACK::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS aStatus )

inlineinherited

Definition at line 218 of file eda_item.h.

218 { m_status = aStatus; }

EDA_ITEM::m_status

STATUS_FLAGS m_status

Definition: eda_item.h:161

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( wxPoint aPos )

inlineinherited

Definition at line 250 of file sch_item.h.

250 { m_storedPos = aPos; }

SCH_ITEM::m_storedPos

wxPoint m_storedPos

Definition: sch_item.h:202

References SCH_ITEM::m_storedPos.

Referenced by SCH_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::moveItem().

◆ SetStroke()

virtual void SCH_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

inlinevirtualinherited

Reimplemented in SCH_LINE, and SCH_BUS_ENTRY_BASE.

Definition at line 488 of file sch_item.h.

488 { wxCHECK( false, /* void */ ); }

◆ SetText()

void EDA_TEXT::SetText ( const wxString & aText )

virtualinherited

Definition at line 121 of file eda_text.cpp.

 {
     m_text = aText;
     m_shown_text = UnescapeString( aText );
     m_shown_text_has_text_var_refs = m_shown_text.Contains( wxT( "${" ) );
 }

References EDA_TEXT::m_shown_text, EDA_TEXT::m_shown_text_has_text_var_refs, EDA_TEXT::m_text, and UnescapeString().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LIB_TEXT::Clone(), createBoard(), PCB_BASE_FRAME::CreateNewFootprint(), SYMBOL_EDIT_FRAME::CreateNewPart(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), dummy(), KIGFX::dummy(), SCH_EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), ALTIUM_PCB::HelperParseDimensions6Leader(), LIB_FIELD::HitTest(), SCH_EDIT_FRAME::importFile(), IncrementLabel(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), SCH_LEGACY_PLUGIN_CACHE::loadField(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), SCH_EAGLE_PLUGIN::loadLibrary(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EAGLE_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN::loadSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_LEGACY_PLUGIN_CACHE::loadText(), TUNER_SLIDER::onSave(), DIALOG_SHEET_PROPERTIES::OnUpdateUI(), LIB_FIELD::operator=(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseSheetEntry(), SCH_ALTIUM_PLUGIN::ParseSheetName(), ALTIUM_PCB::ParseTexts6Data(), LIB_EDIT_TOOL::Paste(), SCH_EDITOR_CONTROL::Paste(), LIB_PART::PlotLibFields(), DIALOG_CHANGE_SYMBOLS::processSymbol(), processTextItem(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), CLIPBOARD_IO::SaveSelection(), LIB_PART::SetName(), SCH_COMPONENT::SetRef(), TEXT_MOD_GRID_TABLE::SetValue(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_SPICE_MODEL::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_LIB_EDIT_ONE_FIELD::UpdateField(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), SCH_COMPONENT::UpdateFields(), SCH_SHEET_LIST::UpdateSymbolInstances(), and DIMENSION_BASE::updateText().

◆ SetTextAngle()

virtual void EDA_TEXT::SetTextAngle ( double aAngle )

inlinevirtualinherited

Reimplemented in WS_DRAW_ITEM_TEXT, FP_TEXT, and PCB_TEXT.

Definition at line 173 of file eda_text.h.

     {
         // Higher level classes may be more restrictive than this by overloading
         // SetTextAngle() or merely calling EDA_TEXT::SetTextAngle() after clamping
         // aAngle before calling this lowest inline accessor.
         m_e.angle = aAngle;
     }

References TEXT_EFFECTS::angle, and EDA_TEXT::m_e.

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), SCH_GLOBALLABEL::AutoplaceFields(), eagleToKicadAlignment(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), LIB_FIELD::Init(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibraryFieldAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute(), SCH_LEGACY_PLUGIN_CACHE::loadText(), DIALOG_SHEET_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), SCH_ALTIUM_PLUGIN::ParseParameter(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), ALTIUM_PCB::ParseTexts6Data(), SCH_EDIT_TOOL::Rotate(), LIB_TEXT::Rotate(), LIB_FIELD::Rotate(), SCH_GLOBALLABEL::Rotate90(), SetFieldOrientation(), SetLabelSpinStyle(), SCH_GLOBALLABEL::SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), PCB_TEXT::SetTextAngle(), FP_TEXT::SetTextAngle(), WS_DRAW_ITEM_TEXT::SetTextAngle(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), and DIALOG_EDIT_ONE_FIELD::updateText().

◆ SetTextHeight()

void EDA_TEXT::SetTextHeight ( int aHeight )

inlineinherited

Definition at line 250 of file eda_text.h.

250 { m_e.size.y = aHeight; }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

wxSize size

Definition: eda_text.h:103

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), TEXT_MOD_GRID_TABLE::SetValue(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextPos()

void EDA_TEXT::SetTextPos ( const wxPoint & aPoint )

inlineinherited

Definition at line 253 of file eda_text.h.

253 { m_e.pos = aPoint; }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), SCH_GLOBALLABEL::AutoplaceFields(), LIB_TEXT::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_TEXT::CalcEdit(), LIB_FIELD::CalcEdit(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), FP_TEXT::FP_TEXT(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibraryFieldAttribute(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), DIMENSION_BASE::Mirror(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MoveTo(), LIB_FIELD::MoveTo(), LIB_TEXT::NormalizeJustification(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseSchText(), DRAWING_TOOL::PlaceText(), DIALOG_CHANGE_SYMBOLS::processSymbol(), LIB_TEXT::Rotate(), PCB_TEXT::Rotate(), FP_TEXT::Rotate(), SCH_FIELD::Rotate(), LIB_FIELD::Rotate(), DIMENSION_BASE::Rotate(), Rotate(), SCH_GLOBALLABEL::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_FIELD::SCH_FIELD(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT(), FP_TEXT::SetDrawCoord(), PCB_TEXT::SetPosition(), FP_TEXT::SetPosition(), SCH_FIELD::SetPosition(), WS_DRAW_ITEM_TEXT::SetPosition(), SetPosition(), SCH_COMPONENT::SetRef(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), SCH_COMPONENT::UpdateFields(), DIALOG_EDIT_ONE_FIELD::updateText(), ALIGNED_DIMENSION::updateText(), ORTHOGONAL_DIMENSION::updateText(), and WS_DRAW_ITEM_TEXT::WS_DRAW_ITEM_TEXT().

wxPoint pos

Definition: eda_text.h:106

References EDA_TEXT::m_e, and TEXT_EFFECTS::pos.

◆ SetTextSize()

void EDA_TEXT::SetTextSize ( const wxSize & aNewSize )

inlineinherited

Definition at line 244 of file eda_text.h.

244 { m_e.size = aNewSize; }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_EDIT_TOOL::ChangeTextType(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), dummy(), KIGFX::dummy(), EDA_TEXT::EDA_TEXT(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParseDimensions6Linear(), LIB_TEXT::LIB_TEXT(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_LEGACY_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN_CACHE::loadText(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseLabel(), ALTIUM_PCB::ParseTexts6Data(), DRAWING_TOOL::PlaceText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BACK_ANNOTATE::processNetNameChange(), DIMENSION_BASE::SetTextSize(), PCAD2KICAD::SetTextSizeFromStrokeFontHeight(), PCAD2KICAD::SetTextSizeFromTrueTypeFontHeight(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), LIB_DRAWING_TOOLS::TwoClickPlace(), SCH_GLOBALLABEL::UpdateIntersheetRefProps(), DIALOG_EDIT_ONE_FIELD::updateText(), and WS_DRAW_ITEM_TEXT::WS_DRAW_ITEM_TEXT().

wxSize size

Definition: eda_text.h:103

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

◆ SetTextThickness()

void EDA_TEXT::SetTextThickness ( int aWidth )

inlineinherited

The TextThickness is that set by the user.

The EffectiveTextPenWidth also factors in bold text and thickness clamping.

Definition at line 164 of file eda_text.h.

164 { m_e.penwidth = aWidth; };

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParseDimensions6Linear(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), ALTIUM_PCB::ParseTexts6Data(), DRAWING_TOOL::PlaceText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), TEXT_MOD_GRID_TABLE::SetValue(), LIB_TEXT::SetWidth(), LIB_FIELD::SetWidth(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), SCH_GLOBALLABEL::UpdateIntersheetRefProps(), and WS_DRAW_ITEM_TEXT::WS_DRAW_ITEM_TEXT().

TEXT_EFFECTS m_e

Definition: eda_text.h:381

TEXT_EFFECTS::penwidth

int penwidth

Definition: eda_text.h:104

References EDA_TEXT::m_e, and TEXT_EFFECTS::penwidth.

◆ SetTextWidth()

void EDA_TEXT::SetTextWidth ( int aWidth )

inlineinherited

Definition at line 247 of file eda_text.h.

247 { m_e.size.x = aWidth; }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

wxSize size

Definition: eda_text.h:103

References EDA_TEXT::m_e, and TEXT_EFFECTS::size.

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), TEXT_MOD_GRID_TABLE::SetValue(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextX()

void EDA_TEXT::SetTextX ( int aX )

inlineinherited

Definition at line 256 of file eda_text.h.

256 { m_e.pos.x = aX; }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

wxPoint pos

Definition: eda_text.h:106

References EDA_TEXT::m_e, and TEXT_EFFECTS::pos.

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), PCB_TEXT::Flip(), FP_TEXT::Flip(), FP_TEXT::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_FIELD::MirrorHorizontal(), SCH_SHEET_PIN::MirrorY(), MirrorY(), and SCH_SHEET_PIN::SetEdge().

◆ SetTextY()

void EDA_TEXT::SetTextY ( int aY )

inlineinherited

Definition at line 257 of file eda_text.h.

257 { m_e.pos.y = aY; }

TEXT_EFFECTS m_e

Definition: eda_text.h:381

wxPoint pos

Definition: eda_text.h:106

References EDA_TEXT::m_e, and TEXT_EFFECTS::pos.

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), PCB_TEXT::Flip(), FP_TEXT::Flip(), FP_TEXT::Mirror(), LIB_TEXT::MirrorVertical(), LIB_FIELD::MirrorVertical(), SCH_SHEET_PIN::MirrorX(), MirrorX(), and SCH_SHEET_PIN::SetEdge().

◆ SetVertJustify()

void EDA_TEXT::SetVertJustify ( EDA_TEXT_VJUSTIFY_T aType )

inlineinherited

Definition at line 209 of file eda_text.h.

209 { m_e.vjustify = aType; };

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Leader(), AUTOPLACER::justify_field(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN_CACHE::loadText(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParseSheetName(), ALTIUM_PCB::ParseTexts6Data(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), LIB_TEXT::Rotate(), SetEdaTextJustification(), SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), PCAD2KICAD::SetTextJustify(), WS_DATA_ITEM_TEXT::SyncDrawItems(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), and DIALOG_EDIT_ONE_FIELD::updateText().

TEXT_EFFECTS m_e

Definition: eda_text.h:381

TEXT_EFFECTS::vjustify

signed char vjustify

vertical justification

Definition: eda_text.h:102

References EDA_TEXT::m_e, and TEXT_EFFECTS::vjustify.

◆ SetVisible()

void EDA_TEXT::SetVisible ( bool aVisible )

inlineinherited

Definition at line 191 of file eda_text.h.

191 { m_e.Bit( TE_VISIBLE, aVisible ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:381