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

Options controlling how a derived symbol's fields are reconciled with its parent. More...

#include <lib_symbol.h>

Public Attributes

bool m_updateAllFields = true
 Reconcile every field. When false only the names in m_updateFields are touched.
 
std::set< wxString > m_updateFields
 Field names to reconcile when m_updateAllFields is false.
 
bool m_removeExtraFields = false
 Drop fields not present in the parent.
 
bool m_resetVisibility = false
 Copy parent visibility and name-shown flags.
 
bool m_resetEffects = false
 Copy parent text effects (font, justification, etc.) but keep local visibility/position.
 
bool m_resetPositions = false
 Copy parent field positions.
 
bool m_resetText = false
 Copy parent text when the parent value is non-empty.
 
bool m_resetEmptyText = false
 Copy parent text even when the parent value is empty.
 

Detailed Description

Options controlling how a derived symbol's fields are reconciled with its parent.

See also
LIB_SYMBOL::SyncFieldsFromParent

Definition at line 79 of file lib_symbol.h.

Member Data Documentation

◆ m_removeExtraFields

bool LIB_FIELD_SYNC_OPTIONS::m_removeExtraFields = false

Drop fields not present in the parent.

Definition at line 88 of file lib_symbol.h.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), and LIB_SYMBOL::SyncFieldsFromParent().

◆ m_resetEffects

bool LIB_FIELD_SYNC_OPTIONS::m_resetEffects = false

Copy parent text effects (font, justification, etc.) but keep local visibility/position.

Definition at line 94 of file lib_symbol.h.

Referenced by DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), and LIB_SYMBOL::SyncFieldsFromParent().

◆ m_resetEmptyText

bool LIB_FIELD_SYNC_OPTIONS::m_resetEmptyText = false

Copy parent text even when the parent value is empty.

Definition at line 103 of file lib_symbol.h.

Referenced by DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), and LIB_SYMBOL::SyncFieldsFromParent().

◆ m_resetPositions

bool LIB_FIELD_SYNC_OPTIONS::m_resetPositions = false

Copy parent field positions.

Definition at line 97 of file lib_symbol.h.

Referenced by DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), and LIB_SYMBOL::SyncFieldsFromParent().

◆ m_resetText

bool LIB_FIELD_SYNC_OPTIONS::m_resetText = false

◆ m_resetVisibility

bool LIB_FIELD_SYNC_OPTIONS::m_resetVisibility = false

Copy parent visibility and name-shown flags.

Definition at line 91 of file lib_symbol.h.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), and LIB_SYMBOL::SyncFieldsFromParent().

◆ m_updateAllFields

bool LIB_FIELD_SYNC_OPTIONS::m_updateAllFields = true

Reconcile every field. When false only the names in m_updateFields are touched.

Definition at line 82 of file lib_symbol.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), and LIB_SYMBOL::SyncFieldsFromParent().

◆ m_updateFields

std::set<wxString> LIB_FIELD_SYNC_OPTIONS::m_updateFields

Field names to reconcile when m_updateAllFields is false.

Definition at line 85 of file lib_symbol.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), and LIB_SYMBOL::SyncFieldsFromParent().


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