GRID_CELL_COMBOBOX Class Reference

#include <grid_combobox.h>

Inheritance diagram for GRID_CELL_COMBOBOX:

Public Member Functions
	GRID_CELL_COMBOBOX (const wxArrayString &names)
wxGridCellEditor *	Clone () const override
void	Create (wxWindow *aParent, wxWindowID aId, wxEvtHandler *aEventHandler) override
wxString	GetValue () const override
void	SetSize (const wxRect &aRect) 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
wxComboBox *	Combo () const
void	onComboCloseUp (wxCommandEvent &aEvent)
void	onComboDropDown (wxCommandEvent &aEvent)
	wxDECLARE_NO_COPY_CLASS (GRID_CELL_COMBOBOX)

Protected Attributes
wxArrayString	m_names
wxString	m_value

Detailed Description

Definition at line 35 of file grid_combobox.h.

Constructor & Destructor Documentation

GRID_CELL_COMBOBOX()

GRID_CELL_COMBOBOX::GRID_CELL_COMBOBOX

(

const wxArrayString &

names

)

Definition at line 37 of file grid_combobox.cpp.

                                                                   :
        m_names( names )
{
}

Referenced by Clone().

Member Function Documentation

ApplyEdit()

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

override

Definition at line 122 of file grid_combobox.cpp.

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

References m_value.

BeginEdit()

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

override

Definition at line 75 of file grid_combobox.cpp.

{
    auto evtHandler = static_cast<wxGridCellEditorEvtHandler*>( m_control->GetEventHandler() );

    // Don't immediately end if we get a kill focus event within BeginEdit
    evtHandler->SetInSetFocus( true );

    // These event handlers are needed to properly dismiss the editor when the popup is closed
    m_control->Bind(wxEVT_COMBOBOX_DROPDOWN, &GRID_CELL_COMBOBOX::onComboDropDown, this);
    m_control->Bind(wxEVT_COMBOBOX_CLOSEUP, &GRID_CELL_COMBOBOX::onComboCloseUp, this);

    m_value = aGrid->GetTable()->GetValue( aRow, aCol );

    Combo()->SetFocus();

#ifdef __WXOSX_COCOA__
    // This is a work around for the combobox being simply dismissed when a
    // choice is made in it under OS X. The bug is almost certainly due to a
    // problem in focus events generation logic but it's not obvious to fix and
    // for now this at least allows to use wxGrid.
    Combo()->Popup();
#endif

    // When dropping down the menu, a kill focus event
    // happens after this point, so we can't reset the flag yet.
#if !defined(__WXGTK20__)
    evtHandler->SetInSetFocus( false );
#endif
}

References Combo(), m_value, onComboCloseUp(), and onComboDropDown().

Clone()

wxGridCellEditor * GRID_CELL_COMBOBOX::Clone ( ) const

override

Definition at line 43 of file grid_combobox.cpp.

{
    return new GRID_CELL_COMBOBOX( m_names );
}

References GRID_CELL_COMBOBOX(), and m_names.

Combo()

wxComboBox* GRID_CELL_COMBOBOX::Combo ( ) const

inlineprotected

Definition at line 53 of file grid_combobox.h.

{ return static_cast<wxComboBox*>( m_control ); }

Referenced by BeginEdit(), EndEdit(), GetValue(), and SetSize().

Create()

void GRID_CELL_COMBOBOX::Create ( wxWindow *  aParent, wxWindowID  aId, wxEvtHandler *  aEventHandler  )

override

Definition at line 49 of file grid_combobox.cpp.

{
    m_control = new wxComboBox( aParent, wxID_ANY, wxEmptyString,
                                wxDefaultPosition, wxDefaultSize, m_names );

    wxGridCellEditor::Create(aParent, aId, aEventHandler);
}

References m_names.

EndEdit()

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

override

Definition at line 106 of file grid_combobox.cpp.

{
    const wxString value = Combo()->GetValue();

    if( value == m_value )
        return false;

    m_value = value;

    if( aNewVal )
        *aNewVal = value;

    return true;
}

References Combo(), and m_value.

GetValue()

wxString GRID_CELL_COMBOBOX::GetValue ( ) const

override

Definition at line 57 of file grid_combobox.cpp.

{
    return Combo()->GetValue();
}

References Combo().

onComboCloseUp()

void GRID_CELL_COMBOBOX::onComboCloseUp ( wxCommandEvent &  aEvent )

protected

Definition at line 143 of file grid_combobox.cpp.

{
    auto evtHandler = static_cast<wxGridCellEditorEvtHandler*>( m_control->GetEventHandler() );

    // Forward the combobox close up event to the cell event handler as a focus kill event
    // so that the grid editor is dismissed when the combox closes, otherwise it leaves the
    // dropdown arrow visible in the cell.
    wxFocusEvent event( wxEVT_KILL_FOCUS, m_control->GetId() );
    event.SetEventObject( m_control );
    evtHandler->ProcessEvent( event );
}

Referenced by BeginEdit().

onComboDropDown()

void GRID_CELL_COMBOBOX::onComboDropDown ( wxCommandEvent &  aEvent )

protected

Definition at line 133 of file grid_combobox.cpp.

{
    auto evtHandler = static_cast<wxGridCellEditorEvtHandler*>( m_control->GetEventHandler() );

    // Once the combobox is dropped, reset the flag to allow the focus-loss handler
    // to function and close the editor.
    evtHandler->SetInSetFocus( false );
}

Referenced by BeginEdit().

Reset()

void GRID_CELL_COMBOBOX::Reset ( )

override

Definition at line 128 of file grid_combobox.cpp.

{
}

SetSize()

void GRID_CELL_COMBOBOX::SetSize ( const wxRect &  aRect )

override

Definition at line 62 of file grid_combobox.cpp.

{
    wxRect rect( aRect );
    rect.Inflate( -1 );

#if defined( __WXMAC__ )
    rect.Inflate( 3 );      // no FOCUS_RING, even on Mac
#endif

    Combo()->SetSize( rect, wxSIZE_ALLOW_MINUS_ONE );
}

References Combo().

wxDECLARE_NO_COPY_CLASS()

GRID_CELL_COMBOBOX::wxDECLARE_NO_COPY_CLASS ( GRID_CELL_COMBOBOX  )

protected

Member Data Documentation

m_names

wxArrayString GRID_CELL_COMBOBOX::m_names

protected

Definition at line 58 of file grid_combobox.h.

Referenced by Clone(), and Create().

m_value

wxString GRID_CELL_COMBOBOX::m_value

protected

Definition at line 59 of file grid_combobox.h.

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

---

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

• grid_combobox.h
• grid_combobox.cpp