7
mirror of https://gitlab.com/kicad/code/kicad.git synced 2024-11-22 00:05:04 +00:00
kicad/common/widgets/properties_panel.h
Wayne Stambaugh 8a1347d2c8 Property grid navigation improvements.
* Do not handle tab key event when committing property changes so the
  property grid tab navigation works correctly.
* Do not call commit property changes on tab key when no changes are
  pending.
* Skip event handling in the base object value change and changing event
  handlers in case they do not get overloaded in derived objects.
* Do not force focus to canvas on property change so arrow and tab key
  grid navigation work properly.  Forcing the user to click the property
  grid control to edit a single property doesn't make sense.
* Pass properties panel show event up the event stack.
* Do not set focus to canvas in tool dispatcher if it already has the
  focus.

Fixes https://gitlab.com/kicad/code/kicad/-/issues/16957
2024-04-24 07:25:19 -04:00

118 lines
3.8 KiB
C++

/*
* This program source code file is part of KICAD, a free EDA CAD application.
*
* Copyright (C) 2016 CERN
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* 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
*/
#ifndef PROPERTIES_PANEL_H
#define PROPERTIES_PANEL_H
#include <wx/panel.h>
#include <wx/propgrid/propgrid.h>
#include <vector>
#include <memory>
class EDA_BASE_FRAME;
class EDA_ITEM;
class SELECTION;
class PROPERTY_BASE;
class wxStaticText;
class PROPERTIES_PANEL : public wxPanel
{
public:
PROPERTIES_PANEL( wxWindow* aParent, EDA_BASE_FRAME* aFrame );
virtual ~PROPERTIES_PANEL();
virtual void UpdateData() = 0;
virtual void AfterCommit() {}
wxPropertyGrid* GetPropertyGrid()
{
return m_grid;
}
int PropertiesCount() const
{
return m_displayed.size();
}
const std::vector<PROPERTY_BASE*>& Properties() const
{
return m_displayed;
}
void RecalculateSplitterPos();
void SetSplitterProportion( float aProportion );
float SplitterProportion() const { return m_splitter_key_proportion; }
protected:
/**
* Generates the property grid for a given selection of items.
*
* @param aSelection is a set of items to show properties for.
*/
virtual void rebuildProperties( const SELECTION& aSelection );
virtual wxPGProperty* createPGProperty( const PROPERTY_BASE* aProperty ) const = 0;
// Event handlers
virtual void valueChanging( wxPropertyGridEvent& aEvent ) { aEvent.Skip(); }
virtual void valueChanged( wxPropertyGridEvent& aEvent ) { aEvent.Skip(); }
void onCharHook( wxKeyEvent& aEvent );
void onShow( wxShowEvent& aEvent );
virtual void OnLanguageChanged( wxCommandEvent& aEvent );
/**
* Utility to fetch a property value and convert to wxVariant
* Precondition: aItem is known to have property aProperty
* @return true if conversion succeeded
*/
bool getItemValue( EDA_ITEM* aItem, PROPERTY_BASE* aProperty, wxVariant& aValue );
/**
* 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.
* @param aSelection is a set of EDA_ITEMs to process
* @param aProperty is the property to look up
* @param aValue will be filled with the value common to the selection, or null if different
* @param aWritable will be set to whether or not the property can be written for the selection
* @return true if the property is available for all the items in the selection
*/
bool extractValueAndWritability( const SELECTION& aSelection, PROPERTY_BASE* aProperty,
wxVariant& aValue, bool& aWritable );
protected:
std::vector<PROPERTY_BASE*> m_displayed;
wxPropertyGrid* m_grid;
EDA_BASE_FRAME* m_frame;
wxStaticText* m_caption;
/// Proportion of the grid column splitter that is used for the key column (0.0 - 1.0)
float m_splitter_key_proportion;
};
#endif /* PROPERTIES_PANEL_H */