GRID_CELL_PATH_EDITOR Class Reference

Editor for wxGrid cells that adds a file/folder browser to the grid input field. More...

#include <grid_text_button_helpers.h>

Inheritance diagram for GRID_CELL_PATH_EDITOR:

Public Member Functions
	GRID_CELL_PATH_EDITOR (DIALOG_SHIM *aParentDialog, WX_GRID *aGrid, wxString *aCurrentDir, const wxString &aExt, bool aNormalize=false, wxString aNormalizeBasePath=wxEmptyString)
	Constructor. More...
wxGridCellEditor *	Clone () const override
void	Create (wxWindow *aParent, wxWindowID aId, wxEvtHandler *aEventHandler) override
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
DIALOG_SHIM *	m_dlg
WX_GRID *	m_grid
wxString *	m_currentDir
wxString	m_ext
bool	m_normalize
wxString	m_normalizeBasePath
wxString	m_value

Detailed Description

Editor for wxGrid cells that adds a file/folder browser to the grid input field.

Definition at line 136 of file grid_text_button_helpers.h.

Constructor & Destructor Documentation

GRID_CELL_PATH_EDITOR()

GRID_CELL_PATH_EDITOR::GRID_CELL_PATH_EDITOR ( DIALOG_SHIM *  aParentDialog, WX_GRID *  aGrid, wxString *  aCurrentDir, const wxString &  aExt, bool  aNormalize = false, wxString  aNormalizeBasePath = wxEmptyString  )

inline

Constructor.

Parameters

aCurrentDir	is current directory the path editor will open at
aExt	is the file extension(s) to filter by. If empty, the path editor will switch to folder mode instead of file.
aNormalize	indicates whether to normalize the selected path (replace part of path with variables or relative path)
aNormalizeBasePath	is the path to use when trying to base variables (generally current project path)

Definition at line 150 of file grid_text_button_helpers.h.

                                                                         :
            m_dlg( aParentDialog ),
            m_grid( aGrid ),
            m_currentDir( aCurrentDir ),
            m_ext( aExt ),
            m_normalize( aNormalize ),
            m_normalizeBasePath( aNormalizeBasePath )
    { }

Referenced by Clone().

Member Function Documentation

ApplyEdit()

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

overrideinherited

Definition at line 150 of file grid_text_button_helpers.cpp.

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

References GRID_CELL_TEXT_BUTTON::m_value.

BeginEdit()

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

overrideinherited

Definition at line 120 of file grid_text_button_helpers.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 );

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

    Combo()->SetValue( m_value );
    Combo()->SetFocus();
}

References GRID_CELL_TEXT_BUTTON::Combo(), and GRID_CELL_TEXT_BUTTON::m_value.

Clone()

wxGridCellEditor* GRID_CELL_PATH_EDITOR::Clone ( ) const

inlineoverride

Definition at line 161 of file grid_text_button_helpers.h.

    {
        return new GRID_CELL_PATH_EDITOR( m_dlg, m_grid, m_currentDir, m_ext );
    }

References GRID_CELL_PATH_EDITOR(), m_currentDir, m_dlg, m_ext, and m_grid.

Combo()

wxComboCtrl* GRID_CELL_TEXT_BUTTON::Combo ( ) const

inlineprotectedinherited

Definition at line 58 of file grid_text_button_helpers.h.

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

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

Create()

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

override

Definition at line 421 of file grid_text_button_helpers.cpp.

{
    if( m_ext.IsEmpty() )
        m_control = new TEXT_BUTTON_FILE_BROWSER( aParent, m_dlg, m_grid, m_currentDir, nullptr,
                                                  m_normalize, m_normalizeBasePath );
    else
        m_control = new TEXT_BUTTON_FILE_BROWSER( aParent, m_dlg, m_grid, m_currentDir, &m_ext,
                                                  m_normalize, m_normalizeBasePath );

#if wxUSE_VALIDATORS
    // validate text in textctrl, if validator is set
    if ( m_validator )
    {
        Combo()->SetValidator( *m_validator );
    }
#endif

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

References GRID_CELL_TEXT_BUTTON::Combo(), m_currentDir, m_dlg, m_ext, m_grid, m_normalize, and m_normalizeBasePath.

EndEdit()

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

overrideinherited

Definition at line 134 of file grid_text_button_helpers.cpp.

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

    if( value == m_value )
        return false;

    m_value = value;

    if( aNewVal )
        *aNewVal = value;

    return true;
}

References GRID_CELL_TEXT_BUTTON::Combo(), and GRID_CELL_TEXT_BUTTON::m_value.

GetValue()

wxString GRID_CELL_TEXT_BUTTON::GetValue ( ) const

overrideinherited

Definition at line 51 of file grid_text_button_helpers.cpp.

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

References GRID_CELL_TEXT_BUTTON::Combo().

Reset()

void GRID_CELL_TEXT_BUTTON::Reset ( )

overrideinherited

Definition at line 156 of file grid_text_button_helpers.cpp.

{
    Combo()->SetValue( m_value );
}

References GRID_CELL_TEXT_BUTTON::Combo(), and GRID_CELL_TEXT_BUTTON::m_value.

SetSize()

void GRID_CELL_TEXT_BUTTON::SetSize ( const wxRect &  aRect )

overrideinherited

Definition at line 57 of file grid_text_button_helpers.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 GRID_CELL_TEXT_BUTTON::Combo().

StartingKey()

void GRID_CELL_TEXT_BUTTON::StartingKey ( wxKeyEvent &  event )

overrideinherited

Definition at line 70 of file grid_text_button_helpers.cpp.

{
    // Note: this is a copy of wxGridCellTextEditor's StartingKey()

    // Since this is now happening in the EVT_CHAR event EmulateKeyPress is no
    // longer an appropriate way to get the character into the text control.
    // Do it ourselves instead.  We know that if we get this far that we have
    // a valid character, so not a whole lot of testing needs to be done.

    // wxComboCtrl inherits from wxTextEntry, so can staticly cast
    wxTextEntry* textEntry = static_cast<wxTextEntry*>( Combo() );
    int ch;

    bool isPrintable;

#if wxUSE_UNICODE
    ch = event.GetUnicodeKey();

    if( ch != WXK_NONE )
        isPrintable = true;
    else
#endif // wxUSE_UNICODE
    {
        ch = event.GetKeyCode();
        isPrintable = ch >= WXK_SPACE && ch < WXK_START;
    }

    switch( ch )
    {
    case WXK_DELETE:
        // Delete the initial character when starting to edit with DELETE.
        textEntry->Remove( 0, 1 );
        break;

    case WXK_BACK:
        // Delete the last character when starting to edit with BACKSPACE.
    {
        const long pos = textEntry->GetLastPosition();
        textEntry->Remove( pos - 1, pos );
    }
        break;

    default:
        if( isPrintable )
            textEntry->WriteText( static_cast<wxChar>( ch ) );
        break;
    }
}

References GRID_CELL_TEXT_BUTTON::Combo().

wxDECLARE_NO_COPY_CLASS()

GRID_CELL_TEXT_BUTTON::wxDECLARE_NO_COPY_CLASS ( GRID_CELL_TEXT_BUTTON  )

protectedinherited

Member Data Documentation

m_currentDir

wxString* GRID_CELL_PATH_EDITOR::m_currentDir

protected

Definition at line 171 of file grid_text_button_helpers.h.

Referenced by Clone(), and Create().

m_dlg

DIALOG_SHIM* GRID_CELL_PATH_EDITOR::m_dlg

protected

Definition at line 169 of file grid_text_button_helpers.h.

Referenced by Clone(), and Create().

m_ext

wxString GRID_CELL_PATH_EDITOR::m_ext

protected

Definition at line 172 of file grid_text_button_helpers.h.

Referenced by Clone(), and Create().

m_grid

WX_GRID* GRID_CELL_PATH_EDITOR::m_grid

protected

Definition at line 170 of file grid_text_button_helpers.h.

Referenced by Clone(), and Create().

m_normalize

bool GRID_CELL_PATH_EDITOR::m_normalize

protected

Definition at line 173 of file grid_text_button_helpers.h.

Referenced by Create().

m_normalizeBasePath

wxString GRID_CELL_PATH_EDITOR::m_normalizeBasePath

protected

Definition at line 174 of file grid_text_button_helpers.h.

Referenced by Create().

m_value

wxString GRID_CELL_TEXT_BUTTON::m_value

protectedinherited

Definition at line 64 of file grid_text_button_helpers.h.

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

---

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

• grid_text_button_helpers.h
• grid_text_button_helpers.cpp