/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2014-2015 CERN * Copyright (C) 2020-2023 KiCad Developers, see AUTHORS.txt for contributors. * Author: Maciej Suminski * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ #include #include #include #include #include #include #include "widgets/unit_binder.h" #include "wx/dcclient.h" wxDEFINE_EVENT( DELAY_FOCUS, wxCommandEvent ); UNIT_BINDER::UNIT_BINDER( EDA_DRAW_FRAME* aParent, wxStaticText* aLabel, wxWindow* aValueCtrl, wxStaticText* aUnitLabel, bool allowEval, bool aBindFrameEvents ) : UNIT_BINDER( aParent, aParent, aLabel, aValueCtrl, aUnitLabel, allowEval, aBindFrameEvents ) { } UNIT_BINDER::UNIT_BINDER( UNITS_PROVIDER* aUnitsProvider, wxWindow* aEventSource, wxStaticText* aLabel, wxWindow* aValueCtrl, wxStaticText* aUnitLabel, bool aAllowEval, bool aBindFocusEvent ) : m_bindFocusEvent( aBindFocusEvent ), m_label( aLabel ), m_valueCtrl( aValueCtrl ), m_unitLabel( aUnitLabel ), m_iuScale( &aUnitsProvider->GetIuScale() ), m_negativeZero( false ), m_dataType( EDA_DATA_TYPE::DISTANCE ), m_precision( 0 ), m_eval( aUnitsProvider->GetUserUnits() ), m_unitsInValue( false ), m_originTransforms( aUnitsProvider->GetOriginTransforms() ), m_coordType( ORIGIN_TRANSFORMS::NOT_A_COORD ) { init( aUnitsProvider ); m_allowEval = aAllowEval && ( !m_valueCtrl || dynamic_cast( m_valueCtrl ) ); wxTextEntry* textEntry = dynamic_cast( m_valueCtrl ); if( textEntry ) { wxClientDC dc( m_valueCtrl ); // Gives enough room to display a value in inches in textEntry // 3 digits + '.' + 10 digits wxSize minSize = m_valueCtrl->GetMinSize(); int minWidth = dc.GetTextExtent( wxT( "XXX.XXXXXXXXXX" ) ).GetWidth(); if( minSize.GetWidth() < minWidth ) m_valueCtrl->SetMinSize( wxSize( minWidth, minSize.GetHeight() ) ); // Use ChangeValue() instead of SetValue() so we don't generate events. if( m_negativeZero ) textEntry->ChangeValue( wxT( "-0" ) ); else textEntry->ChangeValue( wxT( "0" ) ); } if( m_unitLabel ) m_unitLabel->SetLabel( EDA_UNIT_UTILS::GetLabel( m_units, m_dataType ) ); if( m_valueCtrl ) { m_valueCtrl->Connect( wxEVT_SET_FOCUS, wxFocusEventHandler( UNIT_BINDER::onSetFocus ), nullptr, this ); m_valueCtrl->Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( UNIT_BINDER::onKillFocus ), nullptr, this ); m_valueCtrl->Connect( wxEVT_LEFT_UP, wxMouseEventHandler( UNIT_BINDER::onClick ), nullptr, this ); } if( m_bindFocusEvent ) { Connect( DELAY_FOCUS, wxCommandEventHandler( UNIT_BINDER::delayedFocusHandler ), nullptr, this ); } if( aEventSource ) { aEventSource->Connect( EDA_EVT_UNITS_CHANGED, wxCommandEventHandler( UNIT_BINDER::onUnitsChanged ), nullptr, this ); } } UNIT_BINDER::~UNIT_BINDER() { if( m_bindFocusEvent ) { Disconnect( DELAY_FOCUS, wxCommandEventHandler( UNIT_BINDER::delayedFocusHandler ), nullptr, this ); } if( m_valueCtrl ) { m_valueCtrl->Disconnect( wxEVT_SET_FOCUS, wxFocusEventHandler( UNIT_BINDER::onSetFocus ), nullptr, this ); m_valueCtrl->Disconnect( wxEVT_KILL_FOCUS, wxFocusEventHandler( UNIT_BINDER::onKillFocus ), nullptr, this ); m_valueCtrl->Disconnect( wxEVT_LEFT_UP, wxMouseEventHandler( UNIT_BINDER::onClick ), nullptr, this ); } } void UNIT_BINDER::init( UNITS_PROVIDER* aProvider ) { m_units = aProvider->GetUserUnits(); m_needsEval = false; m_selStart = 0; m_selEnd = 0; } void UNIT_BINDER::SetUnits( EDA_UNITS aUnits ) { m_units = aUnits; m_eval.SetDefaultUnits( m_units ); m_eval.LocaleChanged(); // In case locale changed since last run if( m_unitLabel ) m_unitLabel->SetLabel( EDA_UNIT_UTILS::GetLabel( m_units, m_dataType ) ); } void UNIT_BINDER::SetPrecision( int aLength ) { m_precision = std::min( aLength, 6 ); } void UNIT_BINDER::SetDataType( EDA_DATA_TYPE aDataType ) { m_dataType = aDataType; if( m_unitLabel ) m_unitLabel->SetLabel( EDA_UNIT_UTILS::GetLabel( m_units, m_dataType ) ); } void UNIT_BINDER::onUnitsChanged( wxCommandEvent& aEvent ) { EDA_BASE_FRAME* provider = static_cast( aEvent.GetClientData() ); if( m_units != EDA_UNITS::UNSCALED && m_units != EDA_UNITS::DEGREES && m_units != EDA_UNITS::PERCENT ) { int temp = GetIntValue(); SetUnits( provider->GetUserUnits() ); m_iuScale = &provider->GetIuScale(); if( !IsIndeterminate() ) SetValue( temp ); } aEvent.Skip(); } void UNIT_BINDER::onClick( wxMouseEvent& aEvent ) { wxTextEntry* textEntry = dynamic_cast( m_valueCtrl ); if( textEntry && ( textEntry->GetValue() == INDETERMINATE_ACTION || textEntry->GetValue() == INDETERMINATE_STATE ) ) { // These are tokens, not strings, so do a select all textEntry->SelectAll(); } // Needed at least on Windows to avoid hanging aEvent.Skip(); } void UNIT_BINDER::onSetFocus( wxFocusEvent& aEvent ) { wxTextEntry* textEntry = dynamic_cast( m_valueCtrl ); if( textEntry ) { if( m_allowEval ) { wxString oldStr = m_eval.OriginalText(); if( oldStr.length() && oldStr != textEntry->GetValue() ) { textEntry->ChangeValue( oldStr ); textEntry->SetSelection( m_selStart, m_selEnd ); } m_needsEval = true; } if( textEntry->GetValue() == INDETERMINATE_ACTION || textEntry->GetValue() == INDETERMINATE_STATE ) { // These are tokens, not strings, so do a select all textEntry->SelectAll(); } } aEvent.Skip(); } void UNIT_BINDER::onKillFocus( wxFocusEvent& aEvent ) { wxTextEntry* textEntry = dynamic_cast( m_valueCtrl ); if( m_allowEval && textEntry ) { wxString value = textEntry->GetValue(); if( !value.IsEmpty() && m_eval.Process( value ) ) { textEntry->GetSelection( &m_selStart, &m_selEnd ); value = m_eval.Result(); if( m_unitsInValue && !value.IsEmpty() ) { if( !( m_units == EDA_UNITS::DEGREES || m_units == EDA_UNITS::PERCENT ) ) value += wxT( " " ); value += EDA_UNIT_UTILS::GetLabel( m_units, m_dataType ); } textEntry->ChangeValue( value ); #ifdef __WXGTK__ // Manually copy the selected text to the primary selection clipboard if( wxTheClipboard->Open() ) { wxString sel = textEntry->GetStringSelection(); bool clipTarget = wxTheClipboard->IsUsingPrimarySelection(); wxTheClipboard->UsePrimarySelection( true ); wxTheClipboard->SetData( new wxTextDataObject( sel ) ); wxTheClipboard->UsePrimarySelection( clipTarget ); wxTheClipboard->Close(); } #endif } m_needsEval = false; } aEvent.Skip(); } wxString valueDescriptionFromLabel( wxStaticText* aLabel ) { wxString desc = aLabel->GetLabel(); desc.EndsWith( wxT( ":" ), &desc ); return desc; } void UNIT_BINDER::delayedFocusHandler( wxCommandEvent& ) { if( !m_errorMessage.IsEmpty() ) DisplayError( m_valueCtrl->GetParent(), m_errorMessage ); m_errorMessage = wxEmptyString; m_valueCtrl->SetFocus(); } bool UNIT_BINDER::Validate( double aMin, double aMax, EDA_UNITS aUnits ) { wxTextEntry* textEntry = dynamic_cast( m_valueCtrl ); if( !textEntry || textEntry->GetValue() == INDETERMINATE_ACTION || textEntry->GetValue() == INDETERMINATE_STATE ) { return true; } // TODO: Validate() does not currently support m_dataType being anything other than DISTANCE // Note: aMin and aMax are not always given in internal units if( GetValue() < EDA_UNIT_UTILS::UI::FromUserUnit( *m_iuScale, aUnits, aMin ) ) { double val_min_iu = EDA_UNIT_UTILS::UI::FromUserUnit( *m_iuScale, aUnits, aMin ); m_errorMessage = wxString::Format( _( "%s must be at least %s." ), valueDescriptionFromLabel( m_label ), EDA_UNIT_UTILS::UI::StringFromValue( *m_iuScale, m_units, val_min_iu, true ) ); textEntry->SelectAll(); // Don't focus directly; we might be inside a KillFocus event handler wxPostEvent( this, wxCommandEvent( DELAY_FOCUS ) ); return false; } if( GetValue() > EDA_UNIT_UTILS::UI::FromUserUnit( *m_iuScale, aUnits, aMax ) ) { double val_max_iu = EDA_UNIT_UTILS::UI::FromUserUnit( *m_iuScale, aUnits, aMax ); m_errorMessage = wxString::Format( _( "%s must be less than %s." ), valueDescriptionFromLabel( m_label ), EDA_UNIT_UTILS::UI::StringFromValue( *m_iuScale, m_units, val_max_iu, true ) ); textEntry->SelectAll(); // Don't focus directly; we might be inside a KillFocus event handler wxPostEvent( this, wxCommandEvent( DELAY_FOCUS ) ); return false; } return true; } void UNIT_BINDER::SetValue( long long int aValue ) { double displayValue = m_originTransforms.ToDisplay( aValue, m_coordType ); wxString textValue = EDA_UNIT_UTILS::UI::StringFromValue( *m_iuScale, m_units, displayValue, false, m_dataType ); if( displayValue == 0 && m_negativeZero ) SetValue( wxT( "-" ) + textValue ); else SetValue( textValue ); } void UNIT_BINDER::SetDoubleValue( double aValue ) { double displayValue = m_originTransforms.ToDisplay( aValue, m_coordType ); wxString textValue = EDA_UNIT_UTILS::UI::StringFromValue( *m_iuScale, m_units, setPrecision( displayValue, false ), false, m_dataType ); if( displayValue == 0 && !std::signbit( displayValue ) && m_negativeZero ) SetValue( wxT( "-" ) + textValue ); else SetValue( textValue ); } void UNIT_BINDER::SetAngleValue( const EDA_ANGLE& aValue ) { SetDoubleValue( aValue.AsDegrees() ); } void UNIT_BINDER::SetValue( const wxString& aValue ) { wxTextEntry* textEntry = dynamic_cast( m_valueCtrl ); wxStaticText* staticText = dynamic_cast( m_valueCtrl ); wxString value = aValue; if( m_unitsInValue && !value.IsEmpty() ) { if( !( m_units == EDA_UNITS::DEGREES || m_units == EDA_UNITS::PERCENT ) ) value += wxT( " " ); value += EDA_UNIT_UTILS::GetLabel( m_units, m_dataType ); } if( textEntry ) textEntry->SetValue( value ); else if( staticText ) staticText->SetLabel( value ); if( m_allowEval ) m_eval.Clear(); if( m_unitLabel ) m_unitLabel->SetLabel( EDA_UNIT_UTILS::GetLabel( m_units, m_dataType ) ); } void UNIT_BINDER::ChangeValue( int aValue ) { double displayValue = m_originTransforms.ToDisplay( aValue, m_coordType ); wxString textValue = EDA_UNIT_UTILS::UI::StringFromValue( *m_iuScale, m_units, setPrecision( displayValue, false ), false, m_dataType ); if( displayValue == 0 && m_negativeZero ) ChangeValue( wxT( "-" ) + textValue ); else ChangeValue( textValue ); } void UNIT_BINDER::ChangeDoubleValue( double aValue ) { double displayValue = m_originTransforms.ToDisplay( aValue, m_coordType ); wxString textValue = EDA_UNIT_UTILS::UI::StringFromValue( *m_iuScale, m_units, setPrecision( displayValue, false ), false, m_dataType ); if( displayValue == 0 && !std::signbit( displayValue ) && m_negativeZero ) ChangeValue( wxT( "-" ) + textValue ); else ChangeValue( textValue ); } void UNIT_BINDER::ChangeAngleValue( const EDA_ANGLE& aValue ) { ChangeDoubleValue( aValue.AsDegrees() ); } void UNIT_BINDER::ChangeValue( const wxString& aValue ) { wxTextEntry* textEntry = dynamic_cast( m_valueCtrl ); wxStaticText* staticText = dynamic_cast( m_valueCtrl ); wxString value = aValue; if( m_unitsInValue && !value.IsEmpty() ) { if( !( m_units == EDA_UNITS::DEGREES || m_units == EDA_UNITS::PERCENT ) ) value += wxT( " " ); value += EDA_UNIT_UTILS::GetLabel( m_units, m_dataType ); } if( textEntry ) textEntry->ChangeValue( value ); else if( staticText ) staticText->SetLabel( value ); if( m_allowEval ) m_eval.Clear(); if( m_unitLabel ) m_unitLabel->SetLabel( EDA_UNIT_UTILS::GetLabel( m_units, m_dataType ) ); } long long int UNIT_BINDER::GetValue() { wxTextEntry* textEntry = dynamic_cast( m_valueCtrl ); wxStaticText* staticText = dynamic_cast( m_valueCtrl ); wxString value; if( textEntry ) { value = textEntry->GetValue(); if( m_needsEval && !value.IsEmpty() && m_eval.Process( value ) ) value = m_eval.Result(); else value = textEntry->GetValue(); } else if( staticText ) { value = staticText->GetLabel(); } else { return 0; } long long int displayValue = EDA_UNIT_UTILS::UI::ValueFromString( *m_iuScale, m_units, value, m_dataType ); return m_originTransforms.FromDisplay( displayValue, m_coordType ); } double UNIT_BINDER::setPrecision( double aValue, bool aValueUsesUserUnits ) { if( m_precision > 1 ) { int scale = pow( 10, m_precision ); int64_t tmp = aValue; if( !aValueUsesUserUnits ) { tmp = EDA_UNIT_UTILS::UI::ToUserUnit( *m_iuScale, m_units, aValue ) * scale; } aValue = static_cast( tmp ) / scale; if( !aValueUsesUserUnits ) aValue = EDA_UNIT_UTILS::UI::FromUserUnit( *m_iuScale, m_units, aValue ); } return aValue; } double UNIT_BINDER::GetDoubleValue() { wxTextEntry* textEntry = dynamic_cast( m_valueCtrl ); wxStaticText* staticText = dynamic_cast( m_valueCtrl ); wxString value; if( textEntry ) { value = textEntry->GetValue(); if( m_needsEval && !value.IsEmpty() && m_eval.Process( value ) ) value = m_eval.Result(); else value = textEntry->GetValue(); } else if( staticText ) { value = staticText->GetLabel(); } else { return 0.0; } double displayValue = EDA_UNIT_UTILS::UI::DoubleValueFromString( *m_iuScale, m_units, value, m_dataType ); displayValue = setPrecision( displayValue, false ); return m_originTransforms.FromDisplay( displayValue, m_coordType ); } EDA_ANGLE UNIT_BINDER::GetAngleValue() { return EDA_ANGLE( GetDoubleValue(), DEGREES_T ); } bool UNIT_BINDER::IsIndeterminate() const { wxTextEntry* te = dynamic_cast( m_valueCtrl ); if( te ) return te->GetValue() == INDETERMINATE_STATE || te->GetValue() == INDETERMINATE_ACTION; return false; } bool UNIT_BINDER::IsNull() const { wxTextEntry* te = dynamic_cast( m_valueCtrl ); if( te ) return te->GetValue().IsEmpty(); return false; } void UNIT_BINDER::SetLabel( const wxString& aLabel ) { m_label->SetLabel( aLabel ); } void UNIT_BINDER::Enable( bool aEnable ) { if( m_label ) m_label->Enable( aEnable ); m_valueCtrl->Enable( aEnable ); if( m_unitLabel ) m_unitLabel->Enable( aEnable ); } void UNIT_BINDER::Show( bool aShow, bool aResize ) { m_label->Show( aShow ); m_valueCtrl->Show( aShow ); if( m_unitLabel ) m_unitLabel->Show( aShow ); if( aResize ) { if( aShow ) { m_label->SetSize( -1, -1 ); m_valueCtrl->SetSize( -1, -1 ); if( m_unitLabel ) m_unitLabel->SetSize( -1, -1 ); } else { m_label->SetSize( 0, 0 ); m_valueCtrl->SetSize( 0, 0 ); if( m_unitLabel ) m_unitLabel->SetSize( 0, 0 ); } } } PROPERTY_EDITOR_UNIT_BINDER::PROPERTY_EDITOR_UNIT_BINDER( EDA_DRAW_FRAME* aParent ) : UNIT_BINDER( aParent, nullptr, nullptr, nullptr, true, false ) { m_unitsInValue = true; } PROPERTY_EDITOR_UNIT_BINDER::~PROPERTY_EDITOR_UNIT_BINDER() { } void PROPERTY_EDITOR_UNIT_BINDER::SetControl( wxWindow* aControl ) { m_valueCtrl = aControl; if( m_valueCtrl ) { m_valueCtrl->Bind( wxEVT_SET_FOCUS, &PROPERTY_EDITOR_UNIT_BINDER::onSetFocus, this ); m_valueCtrl->Bind( wxEVT_KILL_FOCUS, &PROPERTY_EDITOR_UNIT_BINDER::onKillFocus, this ); m_valueCtrl->Bind( wxEVT_LEFT_UP, &PROPERTY_EDITOR_UNIT_BINDER::onClick, this ); m_valueCtrl->Bind( wxEVT_SHOW, [&]( wxShowEvent& e ) { if( !e.IsShown() ) SetControl( nullptr ); } ); } }