KiCad PCB EDA Suite: DS_DRAW_ITEM

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(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 132 of file eda_item.h.

132 { ClearFlags( SELECTED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:154

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 166 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 148 of file view_item.h.

     {
         m_viewPrivData = nullptr;
     }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * EDA_ITEM::Clone ( ) const

virtualinherited

Create 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 in FP_ZONE, ZONE, SCH_SYMBOL, PAD, FOOTPRINT, PCB_DIM_CENTER, PCB_DIM_LEADER, SCH_HIERLABEL, PCB_DIM_ORTHOGONAL, PCB_VIA, SCH_SHEET, PCB_DIM_ALIGNED, SCH_GLOBALLABEL, PCB_SHAPE, SCH_LABEL, PCB_ARC, SCH_TEXT, SCH_LINE, LIB_PIN, FP_TEXT, SCH_BUS_BUS_ENTRY, PCB_TRACK, SCH_FIELD, SCH_SHEET_PIN, LIB_FIELD, SCH_BUS_WIRE_ENTRY, FP_SHAPE, PCB_TEXT, SCH_BITMAP, PCB_GROUP, LIB_ARC, LIB_TEXT, SCH_JUNCTION, SCH_NO_CONNECT, SCH_MARKER, LIB_POLYLINE, PCB_TARGET, LIB_BEZIER, LIB_CIRCLE, LIB_RECTANGLE, and KIGFX::ORIGIN_VIEWITEM.

Definition at line 83 of file eda_item.cpp.

 {
     wxCHECK_MSG( false, nullptr, wxT( "Clone not implemented in derived class " ) + GetClass() +
                  wxT( ".  Bad programmer!" ) );
 }

References EDA_ITEM::GetClass().

Referenced by DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), PCB_DIMENSION_BASE::GetEffectiveShape(), LIB_SYMBOL::LIB_SYMBOL(), new_clone(), LIB_SYMBOL::operator=(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), LIB_SYMBOL::SetConversion(), LIB_SYMBOL::SetUnitCount(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMIT::Stage(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT & aSrc )

inherited

Definition at line 121 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().

◆ Empty()

void EDA_TEXT::Empty ( )

inlineinherited

Definition at line 254 of file eda_text.h.

254 { m_text.Empty(); }

EDA_TEXT::m_text

wxString m_text

Definition: eda_text.h:385

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 526 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 86 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 BOOST_AUTO_TEST_CASE(), 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 95 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 104 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 = T();
 
         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 DS_DRAW_ITEM_TEXT::GetBoundingBox ( ) const

overridevirtual

Return 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.

Implements DS_DRAW_ITEM_BASE.

Definition at line 167 of file ds_draw_item.cpp.

 {
     return EDA_TEXT::GetTextBox();
 }

References EDA_TEXT::GetTextBox().

◆ GetClass()

virtual wxString DS_DRAW_ITEM_TEXT::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 313 of file ds_draw_item.h.

313 { return wxT( "DS_DRAW_ITEM_TEXT" ); }

◆ GetDrawRotation()

double EDA_TEXT::GetDrawRotation ( ) const

virtualinherited

Reimplemented in FP_TEXT.

Definition at line 646 of file eda_text.cpp.

 {
     return GetTextAngle();
 }

References EDA_TEXT::GetTextAngle().

Referenced by PCB_TEXT::TextHitTest(), and EDA_TEXT::TransformToSegmentList().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 158 of file eda_item.h.

     {
         constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
                                | IS_WIRE_IMAGE | STRUCT_DELETED );
 
         return m_flags & mask;
     }

References IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, IS_WIRE_IMAGE, EDA_ITEM::m_flags, and STRUCT_DELETED.

Referenced by EDA_ITEM::ClearEditFlags(), SCH_EDIT_FRAME::DeleteJunction(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SCH_SYMBOL::GetMsgPanelInfo(), SELECTION_CONDITIONS::Idle(), SELECTION_CONDITIONS::IdleSelection(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_POINT_EDITOR::OnSelectionChange(), SYMBOL_EDITOR_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_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetEffectiveTextPenWidth()

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

inherited

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

Definition at line 149 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::addShapeWithClearance(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), SCH_HIERLABEL::GetBoundingBox(), SCH_GLOBALLABEL::GetBoundingBoxBase(), EDA_TEXT::GetEffectiveTextShape(), LIB_TEXT::GetPenWidth(), LIB_FIELD::GetPenWidth(), SCH_FIELD::GetPenWidth(), SCH_TEXT::GetPenWidth(), EDA_TEXT::GetTextBox(), KIGFX::SCH_PAINTER::getTextThickness(), LIB_TEXT::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_TEXT::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), PNS_KICAD_IFACE_BASE::syncTextItem(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ GetEffectiveTextShape()

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

inherited

Definition at line 633 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().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 155 of file eda_item.h.

155 { return m_flags; }

Referenced by BACK_ANNOTATE::applyChangelist(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), insideArea(), BOARD_INSPECTION_TOOL::InspectConstraints(), LIB_SYMBOL::LIB_SYMBOL(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), FOOTPRINT::Remove(), BOARD::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

◆ GetFocusPosition()

virtual const wxPoint EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

Similar to GetPosition, but allows items to return their visual center rather than their anchor.

Reimplemented in BOARD, PCB_SHAPE, and PCB_TRACK.

Definition at line 259 of file eda_item.h.

259 { return GetPosition(); }

EDA_ITEM::GetPosition

virtual wxPoint GetPosition() const

Definition: eda_item.h:252

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 198 of file eda_text.h.

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

EDA_TEXT_HJUSTIFY_T

Definition: eda_text.h:61

Referenced by BOARD_ADAPTER::addShapeWithClearance(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), AUTOPLACER::fieldHorizPlacement(), EDA_TEXT::Format(), EDA_TEXT::GetTextBox(), 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::MirrorHorizontally(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), 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_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

TEXT_EFFECTS::hjustify

signed char hjustify

horizontal justification

Definition: eda_text.h:101

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

◆ GetIndexInPeer()

int DS_DRAW_ITEM_BASE::GetIndexInPeer ( ) const

inlineinherited

Definition at line 64 of file ds_draw_item.h.

64 { return m_index; }

DS_DRAW_ITEM_BASE::m_index

int m_index

Definition: ds_draw_item.h:113

References DS_DRAW_ITEM_BASE::m_index.

◆ 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 223 of file eda_text.cpp.

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

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

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

◆ 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 430 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 SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::Print(), and EDA_TEXT::TransformToSegmentList().

◆ GetMenuImage()

BITMAPS EDA_ITEM::GetMenuImage ( ) const

virtualinherited

Return 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 in ZONE, SCH_SYMBOL, PAD, FOOTPRINT, PCB_DIM_CENTER, PCB_DIM_LEADER, SCH_HIERLABEL, PCB_DIM_ORTHOGONAL, PCB_VIA, SCH_GLOBALLABEL, SCH_SHEET, PCB_DIM_ALIGNED, PCB_SHAPE, SCH_LABEL, GERBER_DRAW_ITEM, SCH_TEXT, LIB_PIN, FP_TEXT, SCH_LINE, SCH_BUS_BUS_ENTRY, PCB_TRACK, PCB_GROUP, SCH_FIELD, SCH_SHEET_PIN, LIB_FIELD, SCH_BUS_WIRE_ENTRY, FP_SHAPE, PCB_TEXT, SCH_BITMAP, LIB_ARC, LIB_TEXT, LIB_POLYLINE, SCH_NO_CONNECT, SCH_MARKER, PCB_MARKER, PCB_TARGET, SCH_JUNCTION, LIB_CIRCLE, and LIB_RECTANGLE.

Definition at line 211 of file eda_item.cpp.

 {
     return BITMAPS::dummy_item;
 }

References dummy_item.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), and PCB_SELECTION_TOOL::doSelectionMenu().

◆ GetMsgPanelInfo() [1/2]

void DS_DRAW_ITEM_BASE::GetMsgPanelInfo	(	EDA_DRAW_FRAME *	aFrame,
		MSG_PANEL_ITEMS &	aList
	)

overrideinherited

Definition at line 101 of file ds_draw_item.cpp.

 {
     wxString      msg;
     DS_DATA_ITEM* dataItem = GetPeer();
 
     if( dataItem == nullptr )   // Is only a pure graphic item used in drawing sheet editor to
                                 // handle the page limits
         return;
 
     switch( dataItem->GetType() )
     {
     case DS_DATA_ITEM::DS_SEGMENT:
         aList.push_back( MSG_PANEL_ITEM( _( "Line" ), msg ) );
         break;
 
     case DS_DATA_ITEM::DS_RECT:
         aList.push_back( MSG_PANEL_ITEM( _( "Rectangle" ), msg ) );
         break;
 
     case DS_DATA_ITEM::DS_TEXT:
         msg = static_cast<DS_DRAW_ITEM_TEXT*>( this )->GetShownText();
         aList.push_back( MSG_PANEL_ITEM( _( "Text" ), msg ) );
         break;
 
     case DS_DATA_ITEM::DS_POLYPOLYGON:
         aList.push_back( MSG_PANEL_ITEM( _( "Imported Shape" ), msg ) );
         break;
 
     case DS_DATA_ITEM::DS_BITMAP:
         aList.push_back( MSG_PANEL_ITEM( _( "Image" ), msg ) );
         break;
     }
 
     switch( dataItem->GetPage1Option() )
     {
     case FIRST_PAGE_ONLY:  msg = _( "First Page Only" );  break;
     case SUBSEQUENT_PAGES: msg = _( "Subsequent Pages" ); break;
     default:               msg = _( "All Pages" );        break;
     }
 
     aList.push_back( MSG_PANEL_ITEM( _( "First Page Option" ), msg ) );
 
     msg = MessageTextFromValue( EDA_UNITS::UNSCALED, dataItem->m_RepeatCount );
     aList.push_back( MSG_PANEL_ITEM( _( "Repeat Count" ), msg ) );
 
     msg = MessageTextFromValue( EDA_UNITS::UNSCALED, dataItem->m_IncrementLabel );
     aList.push_back( MSG_PANEL_ITEM( _( "Repeat Label Increment" ), msg ) );
 
     msg.Printf( wxT( "(%s, %s)" ),
                 MessageTextFromValue( aFrame->GetUserUnits(), dataItem->m_IncrementVector.x ),
                 MessageTextFromValue( aFrame->GetUserUnits(), dataItem->m_IncrementVector.y ) );
 
     aList.push_back( MSG_PANEL_ITEM( _( "Repeat Position Increment" ), msg ) );
 
     aList.push_back( MSG_PANEL_ITEM( _( "Comment" ), dataItem->m_Info ) );
 }

References _, DS_DATA_ITEM::DS_BITMAP, DS_DATA_ITEM::DS_POLYPOLYGON, DS_DATA_ITEM::DS_RECT, DS_DATA_ITEM::DS_SEGMENT, DS_DATA_ITEM::DS_TEXT, FIRST_PAGE_ONLY, DS_DATA_ITEM::GetPage1Option(), DS_DRAW_ITEM_BASE::GetPeer(), DS_DATA_ITEM::GetType(), EDA_BASE_FRAME::GetUserUnits(), DS_DATA_ITEM::m_IncrementLabel, DS_DATA_ITEM::m_IncrementVector, DS_DATA_ITEM::m_Info, DS_DATA_ITEM::m_RepeatCount, MessageTextFromValue(), SUBSEQUENT_PAGES, UNSCALED, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetMsgPanelInfo() [2/2]

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

inlinevirtualinherited

Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

Parameters

aList is the list to populate.

Reimplemented in BOARD, PAD, PCB_DIM_LEADER, PCB_DIM_ALIGNED, FOOTPRINT, PCB_VIA, SCH_SYMBOL, PCB_SHAPE, SCH_TEXT, PCB_DIMENSION_BASE, SCH_LINE, PCB_GROUP, GERBER_DRAW_ITEM, FP_TEXT, LIB_ITEM, PCB_TRACK, LIB_PIN, SCH_SHEET, NETINFO_ITEM, FP_SHAPE, SCH_BITMAP, LIB_FIELD, ZONE, SCH_BUS_ENTRY_BASE, PCB_TARGET, PCB_TEXT, SCH_MARKER, LIB_BEZIER, PCB_MARKER, LIB_TEXT, LIB_POLYLINE, LIB_RECTANGLE, LIB_ARC, and LIB_CIRCLE.

Definition at line 214 of file eda_item.h.

215 {

216 }

Referenced by EDA_DRAW_FRAME::SetMsgPanel(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), and FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel().

◆ GetParent()

EDA_ITEM* EDA_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 115 of file eda_item.h.

115 { return m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:479

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(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), 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(), PCB_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_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), EE_SELECTION_TOOL::unhighlight(), DIALOG_SCH_EDIT_ONE_FIELD::UpdateField(), EE_TOOL_BASE< SCH_BASE_FRAME >::updateItem(), and SCH_BASE_FRAME::UpdateItem().

◆ GetPeer()

DS_DATA_ITEM* DS_DRAW_ITEM_BASE::GetPeer ( ) const

inlineinherited

Definition at line 63 of file ds_draw_item.h.

63 { return m_peer; }

DS_DRAW_ITEM_BASE::m_peer

DS_DATA_ITEM * m_peer

Definition: ds_draw_item.h:112

References DS_DRAW_ITEM_BASE::m_peer.

Referenced by PL_EDIT_TOOL::DoDelete(), KIGFX::DS_PAINTER::draw(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), PL_EDIT_TOOL::Main(), PROPERTIES_FRAME::OnAcceptPrms(), PL_DRAWING_TOOLS::PlaceItem(), PlotDrawingSheet(), DS_DRAW_ITEM_BITMAP::PrintWsItem(), and DS_DRAW_ITEM_BASE::ViewGetLayers().

◆ GetPenWidth()

virtual int DS_DRAW_ITEM_BASE::GetPenWidth ( ) const

inlinevirtualinherited

Definition at line 70 of file ds_draw_item.h.

     {
         if( m_penWidth > 0 )
             return m_penWidth;
         else
             return 1;
     }

References DS_DRAW_ITEM_BASE::m_penWidth.

Referenced by KIGFX::DS_PAINTER::draw(), DS_DRAW_ITEM_LINE::HitTest(), DS_DRAW_ITEM_RECT::HitTest(), PlotDrawingSheet(), DS_DRAW_ITEM_LINE::PrintWsItem(), DS_DRAW_ITEM_POLYPOLYGONS::PrintWsItem(), and DS_DRAW_ITEM_RECT::PrintWsItem().

◆ GetPosition()

wxPoint DS_DRAW_ITEM_TEXT::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 319 of file ds_draw_item.h.

319 { return GetTextPos(); }

EDA_TEXT::GetTextPos

const wxPoint & GetTextPos() const

Definition: eda_text.h:247

References EDA_TEXT::GetTextPos().

◆ GetSelectMenuText()

wxString DS_DRAW_ITEM_TEXT::GetSelectMenuText ( EDA_UNITS aUnits ) const

overridevirtual

Return 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.

Definition at line 185 of file ds_draw_item.cpp.

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

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

◆ GetShownText()

virtual wxString EDA_TEXT::GetShownText ( int aDepth = 0 ) const

inlinevirtualinherited

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

Parameters

aDepth is used to prevent infinite recursions and loops when expanding text variables.

Reimplemented in FP_TEXT, SCH_TEXT, SCH_FIELD, and PCB_TEXT.

Definition at line 141 of file eda_text.h.

141 { return m_shown_text; }

EDA_TEXT::m_shown_text

wxString m_shown_text

Definition: eda_text.h:386

References EDA_TEXT::m_shown_text.

Referenced by KIGFX::DS_PAINTER::draw(), LIB_FIELD::GetMsgPanelInfo(), GetSelectMenuText(), PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), FP_TEXT::GetShownText(), EDA_TEXT::GetTextBox(), LIB_FIELD::Plot(), LIB_SYMBOL::PlotLibFields(), LIB_TEXT::print(), EDA_TEXT::Print(), EDA_TEXT::ShortenedShownText(), and EDA_TEXT::TransformToSegmentList().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 137 of file eda_item.h.

     {
         return m_status & type;
     }

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 150 of file eda_item.h.

150 { return m_status; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:478

References EDA_ITEM::m_status.

◆ 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:385

References EDA_TEXT::m_text.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), NETLIST_EXPORTER_XML::addSymbolFields(), SIM_PLOT_FRAME::AddTuner(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CONNECTION_GRAPH::buildConnectionGraph(), 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_LIB_EDIT_ONE_FIELD::DIALOG_LIB_EDIT_ONE_FIELD(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), KIGFX::SCH_VIEW::DisplaySymbol(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), SCH_FIELD::DoHypertextMenu(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CONNECTION_GRAPH::ercCheckHierSheets(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), LIB_SYMBOL::Flatten(), PCB_IO::format(), FormatProbeItem(), SCH_SYMBOL::GetFootprint(), LIB_FIELD::GetFullText(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), FP_TEXT::GetLength(), getMatchingTextItem(), PCB_TEXT::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_SYMBOL::GetRef(), FOOTPRINT::GetReference(), LIB_SYMBOL::GetSearchText(), PCB_DIMENSION_BASE::GetText(), FOOTPRINT::GetValue(), SCH_SYMBOL::GetValue(), LIB_FIELD::HitTest(), SCH_DRAWING_TOOLS::importHierLabel(), SCH_TEXT::IncrementLabel(), GENERAL_COLLECTOR::Inspect(), SCH_FIELD::IsVoid(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EAGLE_PLUGIN::loadSegments(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_TEXT::operator<(), SCH_FIELD::operator<(), LIB_FIELD::operator=(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), 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::RecomputeIntersheetRefs(), SCH_GLOBALLABEL::ResolveTextVar(), 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::saveSymbol(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_LEGACY_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SYMBOL_VIEWER_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_SHEET::SymbolCount(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), TUNER_SLIDER::TUNER_SLIDER(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and FP_TEXT::ViewGetLOD().

◆ GetTextAngle()

double EDA_TEXT::GetTextAngle ( ) const

inlineinherited

Definition at line 174 of file eda_text.h.

174 { return m_e.angle; }

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), BOARD_ADAPTER::addShapeWithClearance(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::DS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), PCB_TEXT::Flip(), FP_TEXT::Flip(), PCB_IO::format(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), LIB_FIELD::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_LABEL::GetBoundingBox(), FP_TEXT::GetDrawRotation(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetLinePositions(), EDA_TEXT::GetTextAngleDegrees(), EDA_TEXT::GetTextAngleRadians(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), FP_TEXT::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_DIMENSION_BASE::Mirror(), LIB_TEXT::MirrorHorizontal(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), EAGLE_PLUGIN::orientFPText(), ALTIUM_PCB::ParseTexts6Data(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), positioningChanged(), LIB_TEXT::print(), SCH_FIELD::Print(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), SCH_EDIT_TOOL::Rotate(), PCB_TEXT::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), LIB_FIELD::Rotate(), PCB_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(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxWithClearanceToPolygon(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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 176 of file eda_text.h.

176 { return GetTextAngle() / 10.0; }

EDA_TEXT::GetTextAngle

double GetTextAngle() const

Definition: eda_text.h:174

References EDA_TEXT::GetTextAngle().

Referenced by CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_TEXT::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), and SCH_SEXPR_PLUGIN::saveField().

◆ GetTextAngleRadians()

double EDA_TEXT::GetTextAngleRadians ( ) const

inlineinherited

Definition at line 177 of file eda_text.h.

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

EDA_TEXT::GetTextAngle

double GetTextAngle() const

Definition: eda_text.h:174

References EDA_TEXT::GetTextAngle().

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and PCB_DIM_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 229 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 < static_cast<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( IsMultilineAllowed() && aLine > 0 && ( aLine < static_cast<int>( strings.GetCount() ) ) )
     {
         pos.y -= aLine * GetInterline();
     }
 
     if( aInvertY )
         pos.y = -pos.y;
 
     rect.SetOrigin( pos );
 
     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;
     }
 
     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;
         }
     }
 
     // Many fonts draw diacriticals, descenders, etc. outside the X-height of the font.  This
     // will cacth most (but probably not all) of them.
     rect.Inflate( 0, thickness * 1.5 );
 
     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_RECT::Inflate(), 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(), text, wxStringSplit(), and VECTOR2< T >::y.

◆ GetTextHeight()

int EDA_TEXT::GetTextHeight ( ) const

inlineinherited

Definition at line 244 of file eda_text.h.

244 { return m_e.size.y; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by LIB_TEXT::compare(), LIB_FIELD::compare(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_HIERLABEL::CreateGraphicShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), SCH_HIERLABEL::GetBoundingBox(), SCH_GLOBALLABEL::GetBoundingBoxBase(), EDA_TEXT::GetInterline(), PCB_TEXT::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_GLOBALLABEL::GetSchematicTextOffset(), EDA_TEXT::GetTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_SEXPR_PLUGIN::saveField(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

wxSize size

Definition: eda_text.h:103

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

◆ GetTextPos()

const wxPoint& EDA_TEXT::GetTextPos ( ) const

inlineinherited

Definition at line 247 of file eda_text.h.

247 { return m_e.pos; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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 238 of file eda_text.h.

238 { return m_e.size; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by BOARD_ADAPTER::addShapeWithClearance(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT::GetEffectiveTextPenWidth(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), EDA_TEXT::GetTextBox(), SCH_TEXT::GetTextOffset(), EDA_TEXT::LenSize(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), EAGLE_PLUGIN::orientFPText(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_TEXT::print(), SCH_FIELD::Print(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN::saveSheet(), KIGFX::GAL::SetTextAttributes(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), 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 491 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 160 of file eda_text.h.

160 { return m_e.penwidth; };

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

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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 241 of file eda_text.h.

241 { return m_e.size.x; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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(), SCH_TEXT::GetMsgPanelInfo(), SCH_HIERLABEL::GetSchematicTextOffset(), 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(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and PCB_DIM_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 199 of file eda_text.h.

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

Referenced by BOARD_ADAPTER::addShapeWithClearance(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetLinePositions(), EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), 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::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), EDA_TEXT::TransformToSegmentList(), and DIALOG_SCH_EDIT_ONE_FIELD::UpdateField().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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 ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 156 of file eda_item.h.

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

EDA_TEXT::m_shown_text_has_text_var_refs

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

Referenced by TRACKS_CLEANER::cleanup(), GRAPHICS_CLEANER::cleanupSegments(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList().

◆ HasTextVars()

bool EDA_TEXT::HasTextVars ( ) const

inlineinherited

Indicates the ShownText has text var references which need to be processed.

Definition at line 151 of file eda_text.h.

151 { return m_shown_text_has_text_var_refs; }

bool m_shown_text_has_text_var_refs

Definition: eda_text.h:387

References EDA_TEXT::m_shown_text_has_text_var_refs.

Referenced by PCB_TEXT::GetShownText(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), and FP_TEXT::GetShownText().

◆ HitTest() [1/2]

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

overridevirtual

Test 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 DS_DRAW_ITEM_BASE.

Definition at line 173 of file ds_draw_item.cpp.

 {
     return EDA_TEXT::TextHitTest( aPosition, aAccuracy );
 }

References EDA_TEXT::TextHitTest().

◆ HitTest() [2/2]

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

overridevirtual

Test 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 DS_DRAW_ITEM_BASE.

Definition at line 179 of file ds_draw_item.cpp.

 {
     return EDA_TEXT::TextHitTest( aRect, aContains, aAccuracy );
 }

References EDA_TEXT::TextHitTest().

◆ IsBold()

bool EDA_TEXT::IsBold ( ) const

inlineinherited

Definition at line 183 of file eda_text.h.

183 { return m_e.Bit( TE_BOLD ); }

EDA_TEXT::TE_BOLD

Definition: eda_text.h:394

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by BOARD_ADAPTER::addShapeWithClearance(), 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(), SCH_TEXT::GetMsgPanelInfo(), EDA_TEXT::GetTextStyleName(), EDA_TEXT::IsDefaultFormatting(), EDA_TEXT::LenSize(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), LIB_TEXT::print(), SCH_FIELD::Print(), LIB_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(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), 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 126 of file eda_item.h.

126 { return m_flags & BRIGHTENED; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const

inherited

Definition at line 512 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 121 of file eda_item.h.

121 { return m_flags & IS_DRAGGING; }

IS_DRAGGING

#define IS_DRAGGING

Item being dragged.

Definition: eda_item_flags.h:43

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

124 { return m_flags & ENTERED; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_PAINTER::draw().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

206 { return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:480

References EDA_ITEM::m_forceVisible.

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

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const

inlineinherited

Definition at line 180 of file eda_text.h.

180 { return m_e.Bit( TE_ITALIC ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by BOARD_ADAPTER::addShapeWithClearance(), 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(), SCH_TEXT::GetMsgPanelInfo(), EDA_TEXT::GetTextStyleName(), EDA_TEXT::IsDefaultFormatting(), EDA_TEXT::LenSize(), LIB_TEXT::Plot(), LIB_FIELD::Plot(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_TEXT::print(), SCH_FIELD::Print(), LIB_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_LIB_EDIT_TEXT::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LABEL_EDITOR::TransferDataToWindow(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), 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:393

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

◆ IsMirrored()

bool EDA_TEXT::IsMirrored ( ) const

inlineinherited

Definition at line 189 of file eda_text.h.

189 { return m_e.Bit( TE_MIRROR ); }

EDA_TEXT::TE_MIRROR

Definition: eda_text.h:392

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by BOARD_ADAPTER::addShapeWithClearance(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_TEXT::Flip(), EDA_TEXT::Format(), PCB_TEXT::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), PCB_DIMENSION_BASE::Mirror(), EAGLE_PLUGIN::orientFPText(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::printOneLineOfText(), KIGFX::GAL::SetTextAttributes(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), 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 118 of file eda_item.h.

118 { return m_flags & IS_CHANGED; }

IS_CHANGED

#define IS_CHANGED

Item was edited, and modified.

Definition: eda_item_flags.h:37

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

120 { return m_flags & IS_MOVING; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

IS_MOVING

#define IS_MOVING

Item being moved.

Definition: eda_item_flags.h:40

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsMultilineAllowed()

bool EDA_TEXT::IsMultilineAllowed ( ) const

inlineinherited

Definition at line 196 of file eda_text.h.

196 { return m_e.Bit( TE_MULTILINE ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_MULTILINE

Definition: eda_text.h:395

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

Referenced by DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::Print(), and EDA_TEXT::TransformToSegmentList().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

119 { return m_flags & IS_NEW; }

IS_NEW

#define IS_NEW

New item, just created.

Definition: eda_item_flags.h:41

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_MOVE_TOOL::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_NEW, and EDA_ITEM::m_flags.

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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 in SCH_SYMBOL, SCH_SHEET, SCH_LABEL, SCH_TEXT, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 403 of file eda_item.h.

403 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

125 { return m_flags & IS_RESIZING; }

IS_RESIZING

#define IS_RESIZING

Item being resized.

Definition: eda_item_flags.h:42

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

123 { return m_flags & SELECTED; }

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), KIGFX::DS_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(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), EE_SELECTION_TOOL::RebuildSelection(), RENDER_3D_LEGACY::renderFootprint(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), SCH_EDIT_FRAME::SchematicCleanUp(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectionContains(), EE_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), KIGFX::SCH_PAINTER::setDeviceColors(), and GERBVIEW_SELECTION_TOOL::unselect().

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References EDA_ITEM::m_flags, and SELECTED.

◆ IsType()

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

inlinevirtualinherited

Check 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 PCB_VIA, SCH_LABEL, PCB_DIMENSION_BASE, PAD, SCH_FIELD, FP_TEXT, SCH_LINE, PCB_SHAPE, FP_SHAPE, and PCB_TEXT.

Definition at line 183 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 ROUTER_TOOL::CanInlineDrag(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingBus(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLine(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingWire(), PCB_TEXT::IsType(), FP_SHAPE::IsType(), PCB_SHAPE::IsType(), SCH_LINE::IsType(), FP_TEXT::IsType(), SCH_FIELD::IsType(), PAD::IsType(), PCB_DIMENSION_BASE::IsType(), SCH_LABEL::IsType(), PCB_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()

virtual bool EDA_TEXT::IsVisible ( ) const

inlinevirtualinherited

Reimplemented in PCB_TEXT.

Definition at line 186 of file eda_text.h.

186 { return m_e.Bit( TE_VISIBLE ); }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by BOARD_ADAPTER::addFootprintShapesWithClearance(), SCH_EDITOR_CONTROL::AssignFootprints(), DIALOG_EDIT_ONE_FIELD::DIALOG_EDIT_ONE_FIELD(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_IO::format(), EDA_TEXT::Format(), FOOTPRINT::GetBoundingBox(), FP_TEXT::GetMsgPanelInfo(), SCH_FIELD::HitTest(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::Matches(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_FIELD::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_SYMBOL::Print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), processTextItem(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and FP_TEXT::ViewGetLayers().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_VISIBLE

Definition: eda_text.h:396

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 122 of file eda_item.h.

122 { return m_flags & IS_WIRE_IMAGE; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

IS_WIRE_IMAGE

#define IS_WIRE_IMAGE

Item to be drawn as wireframe while editing.

Definition: eda_item_flags.h:45

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

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

Definition at line 295 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

Change first parameter to avoid the DList and use std::vector instead.

Definition at line 314 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 194 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_HIERLABEL::GetBoundingBox(), and SCH_GLOBALLABEL::GetBoundingBoxBase().

◆ 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 static_cast<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 static_cast<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]

virtual bool EDA_ITEM::Matches	(	const wxFindReplaceData &	aSearchData,
		void *	aAuxData
	)		const

inlinevirtualinherited

Compare 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 in SCH_SYMBOL, SCH_SHEET, SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, ZONE, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 365 of file eda_item.h.

     {
         return false;
     }

Referenced by SCH_EDITOR_CONTROL::HasMatch(), PCB_TEXT::Matches(), FP_TEXT::Matches(), PCB_MARKER::Matches(), SCH_MARKER::Matches(), SCH_PIN::Matches(), ZONE::Matches(), SCH_SHEET_PIN::Matches(), SCH_FIELD::Matches(), SCH_TEXT::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), and SCH_EDITOR_CONTROL::UpdateFind().

◆ Matches() [2/2]

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

protectedinherited

Compare 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 118 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, EDA_ITEM::IsReplaceable(), and text.

◆ Offset()

void EDA_TEXT::Offset ( const wxPoint & aOffset )

inlineinherited

Definition at line 252 of file eda_text.h.

252 { m_e.pos += aOffset; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

wxPoint pos

Definition: eda_text.h:106

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

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

◆ operator<()

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 171 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().

◆ Print()

void EDA_TEXT::Print	(	const RENDER_SETTINGS *	aSettings,
		const wxPoint &	aOffset,
		const 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 407 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 SCH_TEXT::Print(), SCH_GLOBALLABEL::Print(), SCH_HIERLABEL::Print(), and PrintWsItem().

◆ PrintWsItem() [1/2]

virtual void DS_DRAW_ITEM_BASE::PrintWsItem ( const RENDER_SETTINGS * aSettings )

inlinevirtualinherited

Definition at line 79 of file ds_draw_item.h.

     {
         PrintWsItem( aSettings, wxPoint( 0, 0 ) );
     }

◆ PrintWsItem() [2/2]

void DS_DRAW_ITEM_TEXT::PrintWsItem	(	const RENDER_SETTINGS *	aSettings,
		const wxPoint &	aOffset
	)

overridevirtual

Implements DS_DRAW_ITEM_BASE.

Definition at line 161 of file ds_draw_item.cpp.

 {
     Print( aSettings, aOffset, aSettings->GetLayerColor( LAYER_DRAWINGSHEET ), FILLED );
 }

References FILLED, KIGFX::RENDER_SETTINGS::GetLayerColor(), LAYER_DRAWINGSHEET, and EDA_TEXT::Print().

◆ Replace() [1/3]

bool EDA_TEXT::Replace ( const 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 170 of file eda_text.cpp.

 {
     bool retval = EDA_ITEM::Replace( aSearchData, m_text );
     cacheShownText();
 
     return retval;
 }

References EDA_TEXT::cacheShownText(), EDA_TEXT::m_text, and EDA_ITEM::Replace().

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

◆ Replace() [2/3]

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

staticinherited

Perform 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 145 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().

◆ Replace() [3/3]

virtual bool EDA_ITEM::Replace	(	const wxFindReplaceData &	aSearchData,
		void *	aAuxData = `nullptr`
	)

inlinevirtualinherited

Perform 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 in SCH_TEXT, SCH_FIELD, SCH_SHEET_PIN, and SCH_PIN.

Definition at line 392 of file eda_item.h.

     {
         return false;
     }

◆ Set() [1/3]

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

inlineinherited

Definition at line 42 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().

Referenced by isCoupledDiffPair().

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 55 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 68 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 182 of file eda_text.h.

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

EDA_TEXT::TE_BOLD

Definition: eda_text.h:394

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewText(), DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_LEGACY_PLUGIN::loadSymbol(), 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(), and DIALOG_EDIT_ONE_FIELD::updateText().

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 130 of file eda_item.h.

130 { SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:153

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

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(), PCB_SELECTION_TOOL::highlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ 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 129 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(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), LIB_FIELD::operator=(), DIALOG_CHANGE_SYMBOLS::processSymbol(), CLIPBOARD_IO::SaveSelection(), and FP_TEXT::SetEffects().

◆ SetEnd()

virtual void DS_DRAW_ITEM_BASE::SetEnd ( const wxPoint & aPos )

inlinevirtualinherited

Reimplemented in DS_DRAW_ITEM_RECT, and DS_DRAW_ITEM_LINE.

Definition at line 68 of file ds_draw_item.h.

68 { /* not all types will need this */ }

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 153 of file eda_item.h.

153 { m_flags |= aMask; }

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:481

References EDA_ITEM::m_flags.

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

Set and clear 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 204 of file eda_item.h.

204 { m_forceVisible = aEnable; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:480

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 201 of file eda_text.h.

201 { 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(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Radial(), AUTOPLACER::justifyField(), FP_TEXT::KeepUpright(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), FABMASTER::loadFootprints(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), SCH_GLOBALLABEL::MirrorHorizontally(), SCH_GLOBALLABEL::MirrorSpinStyle(), LIB_TEXT::MirrorVertical(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), ALTIUM_PCB::ParseTexts6Data(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), LIB_TEXT::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_TEXT::SetLabelSpinStyle(), SCH_GLOBALLABEL::SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), PCAD2KICAD::SetTextJustify(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_EDIT_ONE_FIELD::updateText().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

TEXT_EFFECTS::hjustify

signed char hjustify

horizontal justification

Definition: eda_text.h:101

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

◆ SetItalic()

void EDA_TEXT::SetItalic ( bool isItalic )

inlineinherited

Definition at line 179 of file eda_text.h.

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

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawSpecificationStackup(), DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), SCH_LEGACY_PLUGIN_CACHE::loadField(), FABMASTER::loadFootprints(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN::loadSymbol(), DIALOG_FOOTPRINT_PROPERTIES_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(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), SCH_GLOBALLABEL::UpdateIntersheetRefProps(), and DIALOG_EDIT_ONE_FIELD::updateText().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_ITALIC

Definition: eda_text.h:393

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

◆ SetMirrored()

void EDA_TEXT::SetMirrored ( bool isMirrored )

inlineinherited

Definition at line 188 of file eda_text.h.

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

EDA_TEXT::TE_MIRROR

Definition: eda_text.h:392

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), PCB_DIMENSION_BASE::Mirror(), 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(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

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 65 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 SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_SYMBOL::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), LIB_SYMBOL::RemoveDrawItem(), SCH_SYMBOL::SetConvert(), SCH_SYMBOL::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_SYMBOL::SetTransform(), and SCH_SYMBOL::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 195 of file eda_text.h.

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

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), FOOTPRINT::operator=(), LIB_SYMBOL::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), 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_SYMBOL::SetFields(), PCB_DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_SHEET::SwapData(), SCH_GLOBALLABEL::SwapData(), SCH_SYMBOL::SwapData(), and SwapItemData().

void Bit(int aBit, bool aValue)

Definition: eda_text.h:108

EDA_TEXT::TE_MULTILINE

Definition: eda_text.h:395

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

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_TEXT::PCB_TEXT(), SCH_HIERLABEL::SCH_HIERLABEL(), SCH_LABEL::SCH_LABEL(), and SCH_TEXT::SCH_TEXT().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in PCB_DIMENSION_BASE.

Definition at line 116 of file eda_item.h.

116 { m_parent = aParent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:479

References EDA_ITEM::m_parent.

◆ SetPosition()

void DS_DRAW_ITEM_TEXT::SetPosition ( const wxPoint & aPos )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 320 of file ds_draw_item.h.

320 { SetTextPos( aPos ); }

EDA_TEXT::SetTextPos

void SetTextPos(const wxPoint &aPoint)

Definition: eda_text.h:246

References EDA_TEXT::SetTextPos().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 129 of file eda_item.h.

129 { SetFlags( SELECTED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:153

SELECTED

#define SELECTED

Definition: eda_item_flags.h:48

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), PL_SELECTION_TOOL::highlight(), EE_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), DS_PROXY_UNDO_ITEM::Restore(), EE_TOOL_BASE< SCH_BASE_FRAME >::saveCopyInUndoList(), and GERBVIEW_SELECTION_TOOL::selectVisually().

◆ SetState()

void EDA_ITEM::SetState	(	EDA_ITEM_FLAGS	type,
		bool	state
	)

inlineinherited

Definition at line 142 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(), and BOARD_ITEM::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 151 of file eda_item.h.

151 { m_status = aStatus; }

EDA_ITEM::m_status

EDA_ITEM_FLAGS m_status

Definition: eda_item.h:478

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetText()

void EDA_TEXT::SetText ( const wxString & aText )

virtualinherited

Definition at line 114 of file eda_text.cpp.

 {
     m_text = aText;
     cacheShownText();
 }

References EDA_TEXT::cacheShownText(), and EDA_TEXT::m_text.

◆ SetTextAngle()

void DS_DRAW_ITEM_TEXT::SetTextAngle ( double aAngle )

overridevirtual

Reimplemented from EDA_TEXT.

Definition at line 192 of file ds_draw_item.cpp.

 {
     EDA_TEXT::SetTextAngle( NormalizeAngle360Min( aAngle ) );
 }

References NormalizeAngle360Min(), and EDA_TEXT::SetTextAngle().

◆ SetTextHeight()

void EDA_TEXT::SetTextHeight ( int aHeight )

inlineinherited

Definition at line 243 of file eda_text.h.

243 { m_e.size.y = aHeight; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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(), and FABMASTER::loadFootprints().

◆ SetTextPos()

void EDA_TEXT::SetTextPos ( const wxPoint & aPoint )

inlineinherited

Definition at line 246 of file eda_text.h.

246 { m_e.pos = aPoint; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), SCH_GLOBALLABEL::AutoplaceFields(), LIB_TEXT::BeginEdit(), LIB_FIELD::BeginEdit(), LIB_TEXT::CalcEdit(), LIB_FIELD::CalcEdit(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), DS_DRAW_ITEM_TEXT(), FP_TEXT::FP_TEXT(), LIB_TEXT::HitTest(), LIB_FIELD::HitTest(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), FABMASTER::loadFootprints(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), PCB_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(), PCB_TEXT::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), LIB_FIELD::Rotate(), SCH_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), SCH_GLOBALLABEL::Rotate(), SCH_GLOBALLABEL::Rotate90(), SCH_FIELD::SCH_FIELD(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), FP_TEXT::SetDrawCoord(), PCB_TEXT::SetPosition(), FP_TEXT::SetPosition(), SCH_FIELD::SetPosition(), SCH_TEXT::SetPosition(), SetPosition(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), SCH_SYMBOL::UpdateFields(), DIALOG_EDIT_ONE_FIELD::updateText(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

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 237 of file eda_text.h.

237 { m_e.size = aNewSize; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), 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(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawSpecificationStackup(), DS_DRAW_ITEM_TEXT(), EDA_TEXT::EDA_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), LIB_TEXT::LIB_TEXT(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EAGLE_PLUGIN::loadFrame(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_LEGACY_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_SYMBOL_PROPERTIES::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(), PCB_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(), SCH_GLOBALLABEL::UpdateIntersheetRefProps(), and DIALOG_EDIT_ONE_FIELD::updateText().

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 159 of file eda_text.h.

159 { m_e.penwidth = aWidth; };

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawSpecificationStackup(), DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::loadFootprints(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_FOOTPRINT_PROPERTIES_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(), LIB_TEXT::SetWidth(), LIB_FIELD::SetWidth(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_EDITOR::TransferDataFromWindow(), and SCH_GLOBALLABEL::UpdateIntersheetRefProps().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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 240 of file eda_text.h.

240 { m_e.size.x = aWidth; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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(), and FABMASTER::loadFootprints().

◆ SetTextX()

void EDA_TEXT::SetTextX ( int aX )

inlineinherited

Definition at line 249 of file eda_text.h.

249 { m_e.pos.x = aX; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), and SCH_SHEET_PIN::SetEdge().

◆ SetTextY()

void EDA_TEXT::SetTextY ( int aY )

inlineinherited

Definition at line 250 of file eda_text.h.

250 { m_e.pos.y = aY; }

TEXT_EFFECTS m_e

Definition: eda_text.h:389

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::MirrorVertically(), SCH_TEXT::MirrorVertically(), and SCH_SHEET_PIN::SetEdge().

◆ SetVertJustify()

void EDA_TEXT::SetVertJustify ( EDA_TEXT_VJUSTIFY_T aType )

inlineinherited

Definition at line 202 of file eda_text.h.

202 { m_e.vjustify = aType; };

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawSpecificationStackup(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Radial(), AUTOPLACER::justifyField(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseEDA_TEXT(), ALTIUM_PCB::ParseTexts6Data(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), LIB_TEXT::Rotate(), SCH_TEXT::SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), PCAD2KICAD::SetTextJustify(), DIALOG_LIB_EDIT_TEXT::TransferDataFromWindow(), and DIALOG_EDIT_ONE_FIELD::updateText().

TEXT_EFFECTS m_e

Definition: eda_text.h:389

TEXT_EFFECTS::vjustify

signed char vjustify

vertical justification

Definition: eda_text.h:102

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

◆ SetVisible()

virtual void EDA_TEXT::SetVisible ( bool aVisible )

inlinevirtualinherited

Reimplemented in PCB_TEXT.

Definition at line 185 of file eda_text.h.

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

TEXT_EFFECTS m_e

Definition: eda_text.h:389