kicad/include/widgets/grid_text_helpers.h

107 lines
3.3 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020-2023 KiCad Developers, see AUTHORS.txt for contributors.
* @author Jon Evans <jon@craftyjon.com>
*
* 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 3 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, see <http://www.gnu.org/licenses/>.
*/
#ifndef KICAD_GRID_TEXT_HELPERS_H
#define KICAD_GRID_TEXT_HELPERS_H
#include <functional>
#include <memory>
#include <wx/generic/gridctrl.h>
class wxGrid;
class wxStyledTextCtrl;
class wxStyledTextEvent;
class SCINTILLA_TRICKS;
/**
* This class works around a bug in wxGrid where the first keystroke doesn't get sent through
* the validator if the editor wasn't already open.
*/
class GRID_CELL_TEXT_EDITOR : public wxGridCellTextEditor
{
public:
GRID_CELL_TEXT_EDITOR();
void SetSize( const wxRect& aRect ) override;
virtual void SetValidator( const wxValidator& validator ) override;
virtual void StartingKey( wxKeyEvent& event ) override;
protected:
std::unique_ptr<wxValidator> m_validator;
};
/**
* A text renderer that can unescape text for display
* This is useful where it's desired to keep the underlying storage escaped.
*/
class GRID_CELL_ESCAPED_TEXT_RENDERER : public wxGridCellStringRenderer
{
public:
GRID_CELL_ESCAPED_TEXT_RENDERER();
void Draw( wxGrid& aGrid, wxGridCellAttr& aAttr, wxDC& aDC, const wxRect& aRect, int aRow,
int aCol, bool isSelected ) override;
wxSize GetBestSize( wxGrid& grid, wxGridCellAttr& attr, wxDC& dc, int row, int col ) override;
};
class GRID_CELL_STC_EDITOR : public wxGridCellEditor
{
public:
GRID_CELL_STC_EDITOR( bool aIgnoreCase,
std::function<void( wxStyledTextEvent&, SCINTILLA_TRICKS* )> onCharFn );
void SetSize( const wxRect& aRect ) override;
void Create( wxWindow* aParent, wxWindowID aId, wxEvtHandler* aEventHandler ) override;
wxGridCellEditor* Clone() const override
{
return new GRID_CELL_STC_EDITOR( m_ignoreCase, m_onCharFn );
}
wxString GetValue() const override;
void StartingKey( wxKeyEvent& event ) override;
void Show( bool aShow, wxGridCellAttr *aAttr = nullptr ) override;
void BeginEdit( int aRow, int aCol, wxGrid* aGrid ) override;
bool EndEdit( int aRow, int aCol, const wxGrid*, const wxString&, wxString* aNewVal ) override;
void ApplyEdit( int aRow, int aCol, wxGrid* aGrid ) override;
void Reset() override {}
protected:
void onFocusLoss( wxFocusEvent& aEvent );
wxStyledTextCtrl* stc_ctrl() const;
protected:
SCINTILLA_TRICKS* m_scintillaTricks;
bool m_ignoreCase;
wxString m_value;
std::function<void( wxStyledTextEvent&, SCINTILLA_TRICKS* )> m_onCharFn;
};
#endif // KICAD_GRID_TEXT_HELPERS_H