KiCad PCB EDA Suite
GRID_CELL_TEXT_BUTTON Class Reference

#include <grid_text_button_helpers.h>

Inheritance diagram for GRID_CELL_TEXT_BUTTON:
GRID_CELL_FPID_EDITOR GRID_CELL_PATH_EDITOR GRID_CELL_SYMBOL_ID_EDITOR GRID_CELL_URL_EDITOR

Public Member Functions

 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
 

Protected Member Functions

wxComboCtrl * Combo () const
 
 wxDECLARE_NO_COPY_CLASS (GRID_CELL_TEXT_BUTTON)
 

Protected Attributes

wxString m_value
 

Detailed Description

Definition at line 38 of file grid_text_button_helpers.h.

Constructor & Destructor Documentation

◆ GRID_CELL_TEXT_BUTTON()

GRID_CELL_TEXT_BUTTON::GRID_CELL_TEXT_BUTTON ( )
inline

Definition at line 41 of file grid_text_button_helpers.h.

41{};

Member Function Documentation

◆ ApplyEdit()

void GRID_CELL_TEXT_BUTTON::ApplyEdit ( int  aRow,
int  aCol,
wxGrid *  aGrid 
)
override

Definition at line 160 of file grid_text_button_helpers.cpp.

161{
162 aGrid->GetTable()->SetValue( aRow, aCol, m_value );
163}

References m_value.

◆ BeginEdit()

void GRID_CELL_TEXT_BUTTON::BeginEdit ( int  aRow,
int  aCol,
wxGrid *  aGrid 
)
override

Definition at line 130 of file grid_text_button_helpers.cpp.

131{
132 auto evtHandler = static_cast< wxGridCellEditorEvtHandler* >( m_control->GetEventHandler() );
133
134 // Don't immediately end if we get a kill focus event within BeginEdit
135 evtHandler->SetInSetFocus( true );
136
137 m_value = aGrid->GetTable()->GetValue( aRow, aCol );
138
139 Combo()->SetValue( m_value );
140 Combo()->SetFocus();
141}
wxComboCtrl * Combo() const

References Combo(), and m_value.

◆ Combo()

wxComboCtrl * GRID_CELL_TEXT_BUTTON::Combo ( ) const
inlineprotected

Definition at line 58 of file grid_text_button_helpers.h.

58{ return static_cast<wxComboCtrl*>( m_control ); }

Referenced by BeginEdit(), GRID_CELL_FPID_EDITOR::Create(), GRID_CELL_URL_EDITOR::Create(), GRID_CELL_PATH_EDITOR::Create(), EndEdit(), GetValue(), Reset(), SetSize(), and StartingKey().

◆ EndEdit()

bool GRID_CELL_TEXT_BUTTON::EndEdit ( int  ,
int  ,
const wxGrid *  ,
const wxString &  ,
wxString *  aNewVal 
)
override

Definition at line 144 of file grid_text_button_helpers.cpp.

145{
146 const wxString value = Combo()->GetValue();
147
148 if( value == m_value )
149 return false;
150
151 m_value = value;
152
153 if( aNewVal )
154 *aNewVal = value;
155
156 return true;
157}

References Combo(), and m_value.

◆ GetValue()

wxString GRID_CELL_TEXT_BUTTON::GetValue ( ) const
override

Definition at line 54 of file grid_text_button_helpers.cpp.

55{
56 return Combo()->GetValue();
57}

References Combo().

◆ Reset()

void GRID_CELL_TEXT_BUTTON::Reset ( )
override

Definition at line 166 of file grid_text_button_helpers.cpp.

167{
168 Combo()->SetValue( m_value );
169}

References Combo(), and m_value.

◆ SetSize()

void GRID_CELL_TEXT_BUTTON::SetSize ( const wxRect &  aRect)
override

Definition at line 60 of file grid_text_button_helpers.cpp.

61{
62 wxRect rect( aRect );
63
64#if defined( __WXMAC__ )
65 rect.Inflate( 2 ); // ignore FOCUS_RING
66#elif defined( __WXGTK__ )
67 rect.Inflate( -3 ); // The -3 is a very sad hack here. Some GTK themes overrun the
68 // default -1, preventing display. Unfortunately, we don't appear to
69 // have a good method of finding the current margin needed.
70 // Some GTK resize events seem to update the cell size but not all and
71 // not consistently.
72#else
73 rect.Inflate( -1 );
74#endif
75
76 Combo()->SetSize( rect, wxSIZE_ALLOW_MINUS_ONE );
77}

References Combo().

◆ StartingKey()

void GRID_CELL_TEXT_BUTTON::StartingKey ( wxKeyEvent &  event)
override

Definition at line 80 of file grid_text_button_helpers.cpp.

81{
82 // Note: this is a copy of wxGridCellTextEditor's StartingKey()
83
84 // Since this is now happening in the EVT_CHAR event EmulateKeyPress is no
85 // longer an appropriate way to get the character into the text control.
86 // Do it ourselves instead. We know that if we get this far that we have
87 // a valid character, so not a whole lot of testing needs to be done.
88
89 // wxComboCtrl inherits from wxTextEntry, so can statically cast
90 wxTextEntry* textEntry = static_cast<wxTextEntry*>( Combo() );
91 int ch;
92
93 bool isPrintable;
94
95#if wxUSE_UNICODE
96 ch = event.GetUnicodeKey();
97
98 if( ch != WXK_NONE )
99 isPrintable = true;
100 else
101#endif // wxUSE_UNICODE
102 {
103 ch = event.GetKeyCode();
104 isPrintable = ch >= WXK_SPACE && ch < WXK_START;
105 }
106
107 switch( ch )
108 {
109 case WXK_DELETE:
110 // Delete the initial character when starting to edit with DELETE.
111 textEntry->Remove( 0, 1 );
112 break;
113
114 case WXK_BACK:
115 // Delete the last character when starting to edit with BACKSPACE.
116 {
117 const long pos = textEntry->GetLastPosition();
118 textEntry->Remove( pos - 1, pos );
119 }
120 break;
121
122 default:
123 if( isPrintable )
124 textEntry->WriteText( static_cast<wxChar>( ch ) );
125 break;
126 }
127}

References Combo().

◆ wxDECLARE_NO_COPY_CLASS()

GRID_CELL_TEXT_BUTTON::wxDECLARE_NO_COPY_CLASS ( GRID_CELL_TEXT_BUTTON  )
protected

Member Data Documentation

◆ m_value

wxString GRID_CELL_TEXT_BUTTON::m_value
protected

Definition at line 64 of file grid_text_button_helpers.h.

Referenced by ApplyEdit(), BeginEdit(), EndEdit(), and Reset().


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