lib_table_grid.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017-2021 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 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 __LIB_TABLE_GRID_H__
#define __LIB_TABLE_GRID_H__
 
#include <lib_table_base.h>
#include <string_utils.h>
#include <wx/grid.h>
 
class LIB_TABLE_GRID_TRICKS;
 
const wxColour COLOUR_ROW_ENABLED( 0, 0, 0 );
const wxColour COLOUR_ROW_DISABLED( 100, 100, 100 );
 
enum COL_ORDER
{
 COL_ENABLED,
 COL_VISIBLE,
 COL_NICKNAME,
 COL_URI,
 COL_TYPE,
 COL_OPTIONS,
 COL_DESCR,
 
 COL_COUNT // keep as last
};
 
class LIB_TABLE_GRID : public wxGridTableBase
{
 friend class LIB_TABLE_GRID_TRICKS;
 
public:
 
 //-----<wxGridTableBase overloads>-------------------------------------------
 
 int GetNumberRows() override { return (int) size(); }
 
 int GetNumberCols() override { return COL_COUNT; }
 
 wxString GetValue( int aRow, int aCol ) override
 {
 if( aRow < (int) size() )
 {
 const LIB_TABLE_ROW* r = at( (size_t) aRow );
 
 switch( aCol )
 {
 case COL_NICKNAME: return UnescapeString( r->GetNickName() );
 case COL_URI: return r->GetFullURI();
 case COL_TYPE: return r->GetType();
 case COL_OPTIONS: return r->GetOptions();
 case COL_DESCR: return r->GetDescr();
 case COL_ENABLED: return r->GetIsEnabled() ? wxT( "1" ) : wxT( "0" );
 case COL_VISIBLE: return r->GetIsVisible() ? wxT( "1" ) : wxT( "0" );
 default: return wxEmptyString;
 }
 }
 
 return wxEmptyString;
 }
 
 bool GetValueAsBool( int aRow, int aCol ) override
 {
 if( aRow < (int) size() && aCol == COL_ENABLED )
 return at( (size_t) aRow )->GetIsEnabled();
 else if( aRow < (int) size() && aCol == COL_VISIBLE )
 return at( (size_t) aRow )->GetIsVisible();
 else
 return false;
 }
 
 void SetValue( int aRow, int aCol, const wxString& aValue ) override
 {
 if( aRow < (int) size() )
 {
 LIB_TABLE_ROW* r = at( (size_t) aRow );
 
 switch( aCol )
 {
 case COL_NICKNAME: r->SetNickName( EscapeString( aValue, CTX_LIBID ) ); break;
 case COL_URI: r->SetFullURI( aValue ); break;
 case COL_TYPE: r->SetType( aValue ); break;
 case COL_OPTIONS: r->SetOptions( aValue ); break;
 case COL_DESCR: r->SetDescr( aValue ); break;
 case COL_ENABLED: r->SetEnabled( aValue == wxT( "1" ) ); break;
 case COL_VISIBLE: r->SetVisible( aValue == wxT( "1" ) ); break;
 }
 }
 }
 
 void SetValueAsBool( int aRow, int aCol, bool aValue ) override
 {
 if( aRow < (int) size() && aCol == COL_ENABLED )
 at( (size_t) aRow )->SetEnabled( aValue );
 else if( aRow < (int) size() && aCol == COL_VISIBLE )
 at( (size_t) aRow )->SetVisible( aValue );
 }
 
 bool IsEmptyCell( int aRow, int aCol ) override
 {
 return !GetValue( aRow, aCol );
 }
 
 bool InsertRows( size_t aPos = 0, size_t aNumRows = 1 ) override
 {
 if( aPos < size() )
 {
 for( size_t i = 0; i < aNumRows; i++ )
 {
 insert( begin() + i, makeNewRow() );
 }
 
 // use the (wxGridStringTable) source Luke.
 if( GetView() )
 {
 wxGridTableMessage msg( this,
 wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
 aPos,
 aNumRows );
 
 GetView()->ProcessTableMessage( msg );
 }
 
 return true;
 }
 
 return false;
 }
 
 bool AppendRows( size_t aNumRows = 1 ) override
 {
 // do not modify aNumRows, original value needed for wxGridTableMessage below
 for( int i = aNumRows; i; --i )
 push_back( makeNewRow() );
 
 if( GetView() )
 {
 wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, aNumRows );
 GetView()->ProcessTableMessage( msg );
 }
 
 return true;
 }
 
 bool DeleteRows( size_t aPos, size_t aNumRows ) override
 {
 // aPos may be a large positive, e.g. size_t(-1), and the sum of
 // aPos+aNumRows may wrap here, so both ends of the range are tested.
 if( aPos < size() && aPos + aNumRows <= size() )
 {
 LIB_TABLE_ROWS_ITER start = begin() + aPos;
 erase( start, start + aNumRows );
 if( GetView() )
 {
 wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_DELETED, aPos, aNumRows );
 GetView()->ProcessTableMessage( msg );
 }
 return true;
 }
 
 return false;
 }
 
 wxString GetColLabelValue( int aCol ) override
 {
 switch( aCol )
 {
 case COL_NICKNAME: return _( "Nickname" );
 case COL_URI: return _( "Library Path" );
 
 // keep this "Library Format" text fairly long so column is sized wide enough
 case COL_TYPE: return _( "Library Format" );
 case COL_OPTIONS: return _( "Options" );
 case COL_DESCR: return _( "Description" );
 case COL_ENABLED: return _( "Active" );
 case COL_VISIBLE: return _( "Visible" );
 
 default: return wxEmptyString;
 }
 }
 
 bool ContainsNickname( const wxString& aNickname )
 {
 for( size_t i = 0; i < size(); ++i )
 {
 LIB_TABLE_ROW* row = at( i );
 
 if( row->GetNickName() == aNickname )
 return true;
 }
 return false;
 }
 
 LIB_TABLE_ROW* At( size_t aIndex )
 {
 return at( aIndex );
 }
 
protected:
 virtual LIB_TABLE_ROW* at( size_t aIndex ) = 0;
 
 virtual size_t size() const = 0;
 
 virtual LIB_TABLE_ROW* makeNewRow() = 0;
 
 virtual LIB_TABLE_ROWS_ITER begin() = 0;
 
 virtual LIB_TABLE_ROWS_ITER insert( LIB_TABLE_ROWS_ITER aIterator, LIB_TABLE_ROW* aRow ) = 0;
 
 virtual void push_back( LIB_TABLE_ROW* aRow ) = 0;
 
 virtual LIB_TABLE_ROWS_ITER erase( LIB_TABLE_ROWS_ITER aFirst, LIB_TABLE_ROWS_ITER aLast ) = 0;
};
 
 
#endif // __LIB_TABLE_GRID_H__