PROPERTIES_PANEL Class Reference

#include <properties_panel.h>

Inheritance diagram for PROPERTIES_PANEL:

Public Member Functions
	PROPERTIES_PANEL (wxWindow *aParent, EDA_BASE_FRAME *aFrame)
virtual	~PROPERTIES_PANEL ()
virtual void	UpdateData ()=0
virtual void	AfterCommit ()
wxPropertyGrid *	GetPropertyGrid ()
int	PropertiesCount () const
const std::vector< PROPERTY_BASE * > &	Properties () const
void	RecalculateSplitterPos ()
void	SetSplitterProportion (float aProportion)
float	SplitterProportion () const
void	OnLanguageChanged ()

Protected Member Functions
virtual void	rebuildProperties (const SELECTION &aSelection)
	Generates the property grid for a given selection of items. More...
virtual void	updatePropertyValues (const SELECTION &aSelection)
	Updates the values shown in the property grid for the current selection. More...
virtual wxPGProperty *	createPGProperty (const PROPERTY_BASE *aProperty) const =0
virtual void	valueChanging (wxPropertyGridEvent &aEvent)
virtual void	valueChanged (wxPropertyGridEvent &aEvent)
void	onCharHook (wxKeyEvent &aEvent)
void	onShow (wxShowEvent &aEvent)
bool	getItemValue (EDA_ITEM *aItem, PROPERTY_BASE *aProperty, wxVariant &aValue)
	Utility to fetch a property value and convert to wxVariant Precondition: aItem is known to have property aProperty. More...
bool	extractValueAndWritability (const SELECTION &aSelection, PROPERTY_BASE *aProperty, wxVariant &aValue, bool &aWritable)
	Processes a selection and determines whether the given property should be available or not and what the common value should be for the items in the selection. More...

Protected Attributes
std::vector< PROPERTY_BASE * >	m_displayed
wxPropertyGrid *	m_grid
EDA_BASE_FRAME *	m_frame
wxStaticText *	m_caption
float	m_splitter_key_proportion
	Proportion of the grid column splitter that is used for the key column (0.0 - 1.0) More...
std::unique_ptr< SELECTION >	m_cachedSelection
	A copy of the most recent selection passed to rebuildProperties. More...

Detailed Description

Definition at line 39 of file properties_panel.h.

Constructor & Destructor Documentation

PROPERTIES_PANEL()

PROPERTIES_PANEL::PROPERTIES_PANEL	(	wxWindow *	aParent,
		EDA_BASE_FRAME *	aFrame
	)

Definition at line 39 of file properties_panel.cpp.

 :
 wxPanel( aParent ),
 m_frame( aFrame ),
 m_splitter_key_proportion( -1 )
{
 wxBoxSizer* mainSizer = new wxBoxSizer( wxVERTICAL );
 
 // on some platforms wxPGGlobalVars is initialized automatically,
 // but others need an explicit init
 if( !wxPGGlobalVars )
 wxPGInitResourceModule();
 
 // See https://gitlab.com/kicad/code/kicad/-/issues/12297
 // and https://github.com/wxWidgets/wxWidgets/issues/11787
 if( wxPGGlobalVars->m_mapEditorClasses.empty() )
 {
 wxPGEditor_TextCtrl = nullptr;
 wxPGEditor_Choice = nullptr;
 wxPGEditor_ComboBox = nullptr;
 wxPGEditor_TextCtrlAndButton = nullptr;
 wxPGEditor_CheckBox = nullptr;
 wxPGEditor_ChoiceAndButton = nullptr;
 wxPGEditor_SpinCtrl = nullptr;
 wxPGEditor_DatePickerCtrl = nullptr;
 }
 
 delete wxPGGlobalVars->m_defaultRenderer;
 wxPGGlobalVars->m_defaultRenderer = new PG_CELL_RENDERER();
 
 m_cachedSelection = std::make_unique<SELECTION>();
 
 m_caption = new wxStaticText( this, wxID_ANY, _( "No objects selected" ) );
 mainSizer->Add( m_caption, 0, wxALL | wxEXPAND, 5 );
 
 m_grid = new wxPropertyGrid( this, wxID_ANY, wxDefaultPosition, wxSize( 300, 400 ),
 wxPG_DEFAULT_STYLE );
 m_grid->SetUnspecifiedValueAppearance( wxPGCell( wxT( "<...>" ) ) );
 m_grid->SetExtraStyle( wxPG_EX_HELP_AS_TOOLTIPS );
 m_grid->AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY, WXK_RETURN );
 m_grid->AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY, WXK_NUMPAD_ENTER );
 m_grid->AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY, WXK_DOWN );
 m_grid->AddActionTrigger( wxPG_ACTION_PREV_PROPERTY, WXK_UP );
 m_grid->AddActionTrigger( wxPG_ACTION_EDIT, WXK_SPACE );
 m_grid->DedicateKey( WXK_RETURN );
 m_grid->DedicateKey( WXK_NUMPAD_ENTER );
 m_grid->DedicateKey( WXK_DOWN );
 m_grid->DedicateKey( WXK_UP );
 mainSizer->Add( m_grid, 1, wxEXPAND, 5 );
 
 m_grid->SetCellDisabledTextColour( wxSystemSettings::GetColour( wxSYS_COLOUR_GRAYTEXT ) );
 
#ifdef __WXGTK__
 // Needed for dark mode, on wx 3.0 at least.
 m_grid->SetCaptionTextColour( wxSystemSettings::GetColour( wxSYS_COLOUR_CAPTIONTEXT ) );
#endif
 
 SetFont( KIUI::GetDockedPaneFont( this ) );
 
 SetSizer( mainSizer );
 Layout();
 
 m_grid->CenterSplitter();
 
 Connect( wxEVT_CHAR_HOOK, wxKeyEventHandler( PROPERTIES_PANEL::onCharHook ), nullptr, this );
 Connect( wxEVT_PG_CHANGED, wxPropertyGridEventHandler( PROPERTIES_PANEL::valueChanged ), nullptr, this );
 Connect( wxEVT_PG_CHANGING, wxPropertyGridEventHandler( PROPERTIES_PANEL::valueChanging ), nullptr, this );
 Connect( wxEVT_SHOW, wxShowEventHandler( PROPERTIES_PANEL::onShow ), nullptr, this );
 
 Bind( wxEVT_PG_COL_END_DRAG,
 [&]( wxPropertyGridEvent& )
 {
 m_splitter_key_proportion =
 static_cast<float>( m_grid->GetSplitterPosition() ) / m_grid->GetSize().x;
 } );
 
 Bind( wxEVT_SIZE,
 [&]( wxSizeEvent& aEvent )
 {
 CallAfter( [&]()
 {
 RecalculateSplitterPos();
 } );
 aEvent.Skip();
 } );
}

References _, KIUI::GetDockedPaneFont(), m_cachedSelection, m_caption, m_grid, m_splitter_key_proportion, onCharHook(), onShow(), RecalculateSplitterPos(), valueChanged(), valueChanging(), and wxPGGlobalVars.

~PROPERTIES_PANEL()

virtual PROPERTIES_PANEL::~PROPERTIES_PANEL ( )

inlinevirtual

Definition at line 44 of file properties_panel.h.

 {
 }

Member Function Documentation

AfterCommit()

virtual void PROPERTIES_PANEL::AfterCommit ( )

inlinevirtual

Reimplemented in PCB_PROPERTIES_PANEL.

Definition at line 50 of file properties_panel.h.

{}

createPGProperty()

virtual wxPGProperty * PROPERTIES_PANEL::createPGProperty ( const PROPERTY_BASE *  aProperty ) const

protectedpure virtual

Implemented in PCB_PROPERTIES_PANEL.

Referenced by rebuildProperties().

extractValueAndWritability()

bool PROPERTIES_PANEL::extractValueAndWritability ( const SELECTION &  aSelection, PROPERTY_BASE *  aProperty, wxVariant &  aValue, bool &  aWritable  )

protected

Processes a selection and determines whether the given property should be available or not and what the common value should be for the items in the selection.

Parameters

aSelection	is a set of EDA_ITEMs to process
aProperty	is the property to look up
aValue	will be filled with the value common to the selection, or null if different
aWritable	will be set to whether or not the property can be written for the selection

Returns

true if the property is available for all the items in the selection

Definition at line 305 of file properties_panel.cpp.

{
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 propMgr.SetUnits( m_frame->GetUserUnits() );
 propMgr.SetTransforms( &m_frame->GetOriginTransforms() );
 
 bool different = false;
 wxVariant commonVal;
 
 aWritable = true;
 
 for( EDA_ITEM* item : aSelection )
 {
 if( !propMgr.IsAvailableFor( TYPE_HASH( *item ), aProperty, item ) )
 return false;
 
 // If read-only for any of the selection, read-only for the whole selection.
 if( !aProperty->Writeable( item ) )
 aWritable = false;
 
 wxVariant value;
 
 if( getItemValue( item, aProperty, value ) )
 {
 // Null value indicates different property values between items
 if( !different && !aValue.IsNull() && value != aValue )
 {
 different = true;
 aValue.MakeNull();
 }
 else if( !different )
 {
 aValue = value;
 }
 }
 else
 {
 // getItemValue returned false -- not available for this item
 return false;
 }
 }
 
 return true;
}

References getItemValue(), EDA_BASE_FRAME::GetOriginTransforms(), UNITS_PROVIDER::GetUserUnits(), PROPERTY_MANAGER::Instance(), PROPERTY_MANAGER::IsAvailableFor(), m_frame, PROPERTY_MANAGER::SetTransforms(), PROPERTY_MANAGER::SetUnits(), TYPE_HASH, and PROPERTY_BASE::Writeable().

Referenced by rebuildProperties(), and PCB_PROPERTIES_PANEL::updatePropertyValues().

getItemValue()

bool PROPERTIES_PANEL::getItemValue ( EDA_ITEM *  aItem, PROPERTY_BASE *  aProperty, wxVariant &  aValue  )

protected

Utility to fetch a property value and convert to wxVariant Precondition: aItem is known to have property aProperty.

Returns

true if conversion succeeded

Definition at line 280 of file properties_panel.cpp.

{
 const wxAny& any = aItem->Get( aProperty );
 bool converted = false;
 
 if( aProperty->HasChoices() )
 {
 // handle enums as ints, since there are no default conversion functions for wxAny
 int tmp;
 converted = any.GetAs<int>( &tmp );
 
 if( converted )
 aValue = wxVariant( tmp );
 }
 
 if( !converted ) // all other types
 converted = any.GetAs( &aValue );
 
 if( !converted )
 wxFAIL_MSG( wxS( "Could not convert wxAny to wxVariant" ) );
 
 return converted;
}

References INSPECTABLE::Get(), and PROPERTY_BASE::HasChoices().

Referenced by extractValueAndWritability().

GetPropertyGrid()

wxPropertyGrid * PROPERTIES_PANEL::GetPropertyGrid ( )

inline

Definition at line 52 of file properties_panel.h.

 {
 return m_grid;
 }

References m_grid.

onCharHook()

void PROPERTIES_PANEL::onCharHook ( wxKeyEvent &  aEvent )

protected

Definition at line 360 of file properties_panel.cpp.

{
 if( aEvent.GetKeyCode() == WXK_TAB && !aEvent.ShiftDown() )
 {
 m_grid->CommitChangesFromEditor();
 return;
 }
 
 if( aEvent.GetKeyCode() == WXK_SPACE )
 {
 if( wxPGProperty* prop = m_grid->GetSelectedProperty() )
 {
 if( prop->GetValueType() == wxT( "bool" ) )
 {
 m_grid->SetPropertyValue( prop, !prop->GetValue().GetBool() );
 return;
 }
 }
 }
 
 if( aEvent.GetKeyCode() == WXK_RETURN || aEvent.GetKeyCode() == WXK_NUMPAD_ENTER )
 {
 m_grid->CommitChangesFromEditor();
 /* don't skip this one; if we're not the last property we'll also go to the next row */
 }
 
 aEvent.Skip();
}

References m_grid.

Referenced by PROPERTIES_PANEL().

OnLanguageChanged()

void PROPERTIES_PANEL::OnLanguageChanged

(

)

Definition at line 126 of file properties_panel.cpp.

{
 UpdateData();
}

References UpdateData().

Referenced by PCB_EDIT_FRAME::ShowChangedLanguage().

onShow()

void PROPERTIES_PANEL::onShow ( wxShowEvent &  aEvent )

protected

Definition at line 353 of file properties_panel.cpp.

{
 if( aEvent.IsShown() )
 UpdateData();
}

References UpdateData().

Referenced by PROPERTIES_PANEL().

Properties()

const std::vector< PROPERTY_BASE * > & PROPERTIES_PANEL::Properties ( ) const

inline

Definition at line 62 of file properties_panel.h.

 {
 return m_displayed;
 }

References m_displayed.

PropertiesCount()

int PROPERTIES_PANEL::PropertiesCount ( ) const

inline

Definition at line 57 of file properties_panel.h.

 {
 return m_displayed.size();
 }

References m_displayed.

rebuildProperties()

void PROPERTIES_PANEL::rebuildProperties ( const SELECTION &  aSelection )

protectedvirtual

Generates the property grid for a given selection of items.

Calling this will remove any existing properties shown, causing visible flicker on some platforms and canceling any pending edits. Make sure to only call this when the group of selected items has actually changed.

Parameters

aSelection

is a set of items to show properties for.

Definition at line 132 of file properties_panel.cpp.

{
 if( *m_cachedSelection == aSelection )
 {
 updatePropertyValues( aSelection );
 return;
 }
 
 *m_cachedSelection = aSelection;
 
 if( m_grid->IsEditorFocused() )
 m_grid->CommitChangesFromEditor();
 
 m_grid->Clear();
 m_displayed.clear();
 
 if( aSelection.Empty() )
 {
 m_caption->SetLabel( _( "No objects selected" ) );
 return;
 }
 
 // Get all the selected types
 std::set<TYPE_ID> types;
 
 for( EDA_ITEM* item : aSelection )
 types.insert( TYPE_HASH( *item ) );
 
 wxCHECK( !types.empty(), /* void */ );
 
 if( aSelection.Size() > 1 )
 {
 m_caption->SetLabel( wxString::Format( _( "%d objects selected" ), aSelection.Size() ) );
 }
 else
 {
 m_caption->SetLabel( aSelection.Front()->GetFriendlyName() );
 }
 
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 propMgr.SetUnits( m_frame->GetUserUnits() );
 propMgr.SetTransforms( &m_frame->GetOriginTransforms() );
 
 std::set<PROPERTY_BASE*> commonProps;
 const PROPERTY_LIST& allProperties = propMgr.GetProperties( *types.begin() );
 copy( allProperties.begin(), allProperties.end(), inserter( commonProps, commonProps.begin() ) );
 
 PROPERTY_DISPLAY_ORDER displayOrder = propMgr.GetDisplayOrder( *types.begin() );
 
 std::vector<wxString> groupDisplayOrder = propMgr.GetGroupDisplayOrder( *types.begin() );
 std::set<wxString> groups( groupDisplayOrder.begin(), groupDisplayOrder.end() );
 
 std::map<wxPGProperty*, int> pgPropOrders;
 std::map<wxString, std::vector<wxPGProperty*>> pgPropGroups;
 
 // Get all possible properties
 for( const TYPE_ID& type : types )
 {
 const PROPERTY_LIST& itemProps = propMgr.GetProperties( type );
 
 const PROPERTY_DISPLAY_ORDER& itemDisplayOrder = propMgr.GetDisplayOrder( type );
 
 copy( itemDisplayOrder.begin(), itemDisplayOrder.end(),
 inserter( displayOrder, displayOrder.begin() ) );
 
 const std::vector<wxString>& itemGroups = propMgr.GetGroupDisplayOrder( type );
 
 for( const wxString& group : itemGroups )
 {
 if( !groups.count( group ) )
 {
 groupDisplayOrder.emplace_back( group );
 groups.insert( group );
 }
 }
 
 for( auto it = commonProps.begin(); it != commonProps.end(); /* ++it in the loop */ )
 {
 if( !binary_search( itemProps.begin(), itemProps.end(), *it ) )
 it = commonProps.erase( it );
 else
 ++it;
 }
 }
 
 // Find a set of properties that is common to all selected items
 for( PROPERTY_BASE* property : commonProps )
 {
 if( property->IsInternal() )
 continue;
 
 if( !propMgr.IsAvailableFor( TYPE_HASH( *aSelection.Front() ), property,
 aSelection.Front() ) )
 continue;
 
 // Either determine the common value for a property or "<...>" to indicate multiple values
 bool available;
 bool writeable;
 wxVariant commonVal;
 
 available = extractValueAndWritability( aSelection, property, commonVal, writeable );
 
 if( available )
 {
 wxPGProperty* pgProp = createPGProperty( property );
 
 if( pgProp )
 {
 pgProp->SetValue( commonVal );
 pgProp->Enable( writeable );
 m_displayed.push_back( property );
 
 wxASSERT( displayOrder.count( property ) );
 pgPropOrders[pgProp] = displayOrder[property];
 pgPropGroups[property->Group()].emplace_back( pgProp );
 }
 }
 }
 
 const wxString unspecifiedGroupCaption = _( "Basic Properties" );
 
 for( const wxString& groupName : groupDisplayOrder )
 {
 if( !pgPropGroups.count( groupName ) )
 continue;
 
 std::vector<wxPGProperty*>& properties = pgPropGroups[groupName];
 wxString groupCaption = wxGetTranslation( groupName );
 
 auto groupItem = new wxPropertyCategory( groupName.IsEmpty() ? unspecifiedGroupCaption
 : groupCaption );
 
 m_grid->Append( groupItem );
 
 std::sort( properties.begin(), properties.end(),
 [&]( wxPGProperty*& aFirst, wxPGProperty*& aSecond )
 {
 return pgPropOrders[aFirst] < pgPropOrders[aSecond];
 } );
 
 for( wxPGProperty* property : properties )
 m_grid->Append( property );
 }
 
 RecalculateSplitterPos();
}

References _, copy, createPGProperty(), SELECTION::Empty(), extractValueAndWritability(), Format(), SELECTION::Front(), PROPERTY_MANAGER::GetDisplayOrder(), EDA_ITEM::GetFriendlyName(), PROPERTY_MANAGER::GetGroupDisplayOrder(), EDA_BASE_FRAME::GetOriginTransforms(), PROPERTY_MANAGER::GetProperties(), UNITS_PROVIDER::GetUserUnits(), group, PROPERTY_MANAGER::Instance(), PROPERTY_MANAGER::IsAvailableFor(), m_cachedSelection, m_caption, m_displayed, m_frame, m_grid, RecalculateSplitterPos(), PROPERTY_MANAGER::SetTransforms(), PROPERTY_MANAGER::SetUnits(), SELECTION::Size(), TYPE_HASH, and updatePropertyValues().

Referenced by PCB_PROPERTIES_PANEL::UpdateData().

RecalculateSplitterPos()

void PROPERTIES_PANEL::RecalculateSplitterPos

(

)

Definition at line 390 of file properties_panel.cpp.

{
 if( m_splitter_key_proportion < 0 )
 m_grid->CenterSplitter();
 else
 m_grid->SetSplitterPosition( m_splitter_key_proportion * m_grid->GetSize().x );
}

References m_grid, and m_splitter_key_proportion.

Referenced by PROPERTIES_PANEL(), rebuildProperties(), and SetSplitterProportion().

SetSplitterProportion()

void PROPERTIES_PANEL::SetSplitterProportion

(

float

aProportion

)

Definition at line 399 of file properties_panel.cpp.

{
 m_splitter_key_proportion = aProportion;
 RecalculateSplitterPos();
}

References m_splitter_key_proportion, and RecalculateSplitterPos().

SplitterProportion()

float PROPERTIES_PANEL::SplitterProportion ( ) const

inline

Definition at line 70 of file properties_panel.h.

{ return m_splitter_key_proportion; }

References m_splitter_key_proportion.

Referenced by PCB_EDIT_FRAME::SaveSettings().

UpdateData()

virtual void PROPERTIES_PANEL::UpdateData ( )

pure virtual

Implemented in PCB_PROPERTIES_PANEL.

Referenced by OnLanguageChanged(), onShow(), and PCB_BASE_EDIT_FRAME::UpdateProperties().

updatePropertyValues()

virtual void PROPERTIES_PANEL::updatePropertyValues ( const SELECTION &  aSelection )

inlineprotectedvirtual

Updates the values shown in the property grid for the current selection.

Does not add or remove properties from the display (

See also

rebuildProperties) This implies that aSelection must have the same contents as m_cachedSelection.

Parameters

aSelection

is the set of selected items.

Reimplemented in PCB_PROPERTIES_PANEL.

Definition at line 94 of file properties_panel.h.

{}

Referenced by rebuildProperties().

valueChanged()

virtual void PROPERTIES_PANEL::valueChanged ( wxPropertyGridEvent &  aEvent )

inlineprotectedvirtual

Reimplemented in PCB_PROPERTIES_PANEL.

Definition at line 100 of file properties_panel.h.

{}

Referenced by PROPERTIES_PANEL().

valueChanging()

virtual void PROPERTIES_PANEL::valueChanging ( wxPropertyGridEvent &  aEvent )

inlineprotectedvirtual

Definition at line 99 of file properties_panel.h.

{}

Referenced by PROPERTIES_PANEL().

Member Data Documentation

m_cachedSelection

std::unique_ptr<SELECTION> PROPERTIES_PANEL::m_cachedSelection

protected

A copy of the most recent selection passed to rebuildProperties.

Definition at line 133 of file properties_panel.h.

Referenced by PROPERTIES_PANEL(), and rebuildProperties().

m_caption

wxStaticText* PROPERTIES_PANEL::m_caption

protected

Definition at line 127 of file properties_panel.h.

Referenced by PROPERTIES_PANEL(), and rebuildProperties().

m_displayed

std::vector<PROPERTY_BASE*> PROPERTIES_PANEL::m_displayed

protected

Definition at line 124 of file properties_panel.h.

Referenced by Properties(), PropertiesCount(), and rebuildProperties().

m_frame

EDA_BASE_FRAME* PROPERTIES_PANEL::m_frame

protected

Definition at line 126 of file properties_panel.h.

Referenced by extractValueAndWritability(), and rebuildProperties().

m_grid

wxPropertyGrid* PROPERTIES_PANEL::m_grid

protected

Definition at line 125 of file properties_panel.h.

Referenced by GetPropertyGrid(), onCharHook(), PROPERTIES_PANEL(), rebuildProperties(), RecalculateSplitterPos(), and PCB_PROPERTIES_PANEL::updatePropertyValues().

m_splitter_key_proportion

float PROPERTIES_PANEL::m_splitter_key_proportion

protected

Proportion of the grid column splitter that is used for the key column (0.0 - 1.0)

Definition at line 130 of file properties_panel.h.

Referenced by PROPERTIES_PANEL(), RecalculateSplitterPos(), SetSplitterProportion(), and SplitterProportion().

---

The documentation for this class was generated from the following files:

• properties_panel.h
• properties_panel.cpp