grid_text_button_helpers.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2021 CERN
 * Copyright (C) 2018-2022 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 GRID_TEXT_BUTTON_HELPERS_H
#define GRID_TEXT_BUTTON_HELPERS_H
 
#include <memory>
 
#include <wx/combo.h>
#include <wx/generic/gridctrl.h>
#include <wx/generic/grideditors.h>
 
 
class wxGrid;
class WX_GRID;
class DIALOG_SHIM;
class EMBEDDED_FILES;
 
 
class GRID_CELL_TEXT_BUTTON : public wxGridCellEditor
{
public:
 GRID_CELL_TEXT_BUTTON() {};
 
 wxString GetValue() const override;
 
 void SetSize( const wxRect& aRect ) override;
 
 void StartingKey( wxKeyEvent& event ) override;
 void BeginEdit( int aRow, int aCol, wxGrid* aGrid ) override;
 bool EndEdit( int , int , const wxGrid* , const wxString& , wxString *aNewVal ) override;
 void ApplyEdit( int aRow, int aCol, wxGrid* aGrid ) override;
 void Reset() override;
 
#if wxUSE_VALIDATORS
 void SetValidator( const wxValidator& validator );
#endif
 
protected:
 wxComboCtrl* Combo() const { return static_cast<wxComboCtrl*>( m_control ); }
 
#if wxUSE_VALIDATORS
 std::unique_ptr< wxValidator > m_validator;
#endif
 
 wxString m_value;
 
 wxDECLARE_NO_COPY_CLASS( GRID_CELL_TEXT_BUTTON );
};
 
 
class GRID_CELL_SYMBOL_ID_EDITOR : public GRID_CELL_TEXT_BUTTON
{
public:
 GRID_CELL_SYMBOL_ID_EDITOR( DIALOG_SHIM* aParent,
 const wxString& aPreselect = wxEmptyString ) :
 m_dlg( aParent ),
 m_preselect( aPreselect )
 { }
 
 wxGridCellEditor* Clone() const override
 {
 return new GRID_CELL_SYMBOL_ID_EDITOR( m_dlg, m_preselect );
 }
 
 void Create( wxWindow* aParent, wxWindowID aId, wxEvtHandler* aEventHandler ) override;
 
protected:
 DIALOG_SHIM* m_dlg;
 wxString m_preselect;
};
 
 
class GRID_CELL_FPID_EDITOR : public GRID_CELL_TEXT_BUTTON
{
public:
 GRID_CELL_FPID_EDITOR( DIALOG_SHIM* aParent, const wxString& aSymbolNetlist,
 const wxString& aPreselect = wxEmptyString ) :
 m_dlg( aParent ),
 m_preselect( aPreselect ),
 m_symbolNetlist( aSymbolNetlist )
 { }
 
 wxGridCellEditor* Clone() const override
 {
 return new GRID_CELL_FPID_EDITOR( m_dlg, m_symbolNetlist );
 }
 
 void Create( wxWindow* aParent, wxWindowID aId, wxEvtHandler* aEventHandler ) override;
 
protected:
 DIALOG_SHIM* m_dlg;
 wxString m_preselect;
 wxString m_symbolNetlist;
};
 
 
class GRID_CELL_URL_EDITOR : public GRID_CELL_TEXT_BUTTON
{
public:
 GRID_CELL_URL_EDITOR( DIALOG_SHIM* aParent, SEARCH_STACK* aSearchStack = nullptr,
 EMBEDDED_FILES* aFiles = nullptr ) :
 m_dlg( aParent ), m_searchStack( aSearchStack ), m_files( aFiles )
 { }
 
 wxGridCellEditor* Clone() const override
 {
 return new GRID_CELL_URL_EDITOR( m_dlg );
 }
 
 void Create( wxWindow* aParent, wxWindowID aId, wxEvtHandler* aEventHandler ) override;
 
protected:
 DIALOG_SHIM* m_dlg;
 SEARCH_STACK* m_searchStack;
 EMBEDDED_FILES* m_files;
};
 
 
class GRID_CELL_PATH_EDITOR : public GRID_CELL_TEXT_BUTTON
{
public:
 GRID_CELL_PATH_EDITOR( DIALOG_SHIM* aParentDialog, WX_GRID* aGrid, wxString* aCurrentDir,
 bool aNormalize, const wxString& aNormalizeBasePath,
 std::function<wxString( WX_GRID* grid, int row )> aFileFilterFn ) :
 m_dlg( aParentDialog ),
 m_grid( aGrid ),
 m_currentDir( aCurrentDir ),
 m_normalize( aNormalize ),
 m_normalizeBasePath( aNormalizeBasePath ),
 m_fileFilterFn( std::move( aFileFilterFn ) )
 { }
 
 GRID_CELL_PATH_EDITOR( DIALOG_SHIM* aParentDialog, WX_GRID* aGrid, wxString* aCurrentDir,
 const wxString& aFileFilter, bool aNormalize = false,
 const wxString& aNormalizeBasePath = wxEmptyString ) :
 m_dlg( aParentDialog ),
 m_grid( aGrid ),
 m_currentDir( aCurrentDir ),
 m_normalize( aNormalize ),
 m_normalizeBasePath( aNormalizeBasePath ),
 m_fileFilter( aFileFilter )
 { }
 
 wxGridCellEditor* Clone() const override
 {
 if( m_fileFilterFn )
 {
 return new GRID_CELL_PATH_EDITOR( m_dlg, m_grid, m_currentDir, m_normalize,
 m_normalizeBasePath, m_fileFilterFn );
 }
 else
 {
 return new GRID_CELL_PATH_EDITOR( m_dlg, m_grid, m_currentDir, m_fileFilter,
 m_normalize, m_normalizeBasePath );
 }
 }
 
 void Create( wxWindow* aParent, wxWindowID aId, wxEvtHandler* aEventHandler ) override;
 
protected:
 DIALOG_SHIM* m_dlg;
 WX_GRID* m_grid;
 wxString* m_currentDir;
 bool m_normalize;
 wxString m_normalizeBasePath;
 
 wxString m_fileFilter;
 std::function<wxString( WX_GRID* aGrid, int aRow )> m_fileFilterFn;
};
 
 
#endif // GRID_TEXT_BUTTON_HELPERS_H