dialog_fp_plugin_options.cpp 11 KB
Newer Older
1 2 3 4
/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
5
 * Copyright (C) 2013 CERN
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 * Copyright (C) 2013 KiCad Developers, see change_log.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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */


27
#include <fctsys.h>
28 29 30
#include <invoke_pcb_dialog.h>
#include <dialog_fp_plugin_options_base.h>
#include <fp_lib_table.h>
31
#include <grid_tricks.h>
32

33 34 35 36 37

#define INITIAL_HELP    \
    _(  "Select an <b>Option Choice</b> in the listbox above, and then click the <b>Append Selected Option</b> button." )


38 39 40 41 42 43
using std::string;

// re-enter the dialog with the column sizes preserved from last time.
static int col_width_option;
static int col_width_value;

44

45 46 47 48 49 50
/**
 * Class DIALOG_FP_PLUGIN_OPTIONS
 * is an options editor in the form of a two column name/value
 * spreadsheet like (table) UI.  It takes hints from a pcbnew PLUGIN as to
 * supported options.
 */
51 52 53 54 55
class DIALOG_FP_PLUGIN_OPTIONS : public DIALOG_FP_PLUGIN_OPTIONS_BASE
{

public:
    DIALOG_FP_PLUGIN_OPTIONS( wxTopLevelWindow* aParent,
56 57
            const wxString& aNickname, const wxString& aPluginType,
            const wxString& aOptions, wxString* aResult ) :
58 59
        DIALOG_FP_PLUGIN_OPTIONS_BASE( aParent ),
        m_callers_options( aOptions ),
60 61
        m_result( aResult ),
        m_initial_help( INITIAL_HELP )
62 63 64 65 66
    {
        wxString title = wxString::Format(
                _( "Options for Library '%s'" ), GetChars( aNickname ) );

        SetTitle( title );
67

Dick Hollenbeck's avatar
Dick Hollenbeck committed
68
        // add Cut, Copy, and Paste to wxGrid
69 70
        m_grid->PushEventHandler( new GRID_TRICKS( m_grid ) );

71 72 73
        m_grid->SetColMinimalWidth( 1, 250 );

        // Fill the grid with existing aOptions
74 75 76 77 78 79
        string options = TO_UTF8( aOptions );

        PROPERTIES* props = FP_LIB_TABLE::ParseOptions( options );

        if( props )
        {
80
            if( (int) props->size() > m_grid->GetNumberRows() )
Dick Hollenbeck's avatar
Dick Hollenbeck committed
81
                m_grid->AppendRows( props->size() - m_grid->GetNumberRows() );
82 83 84 85 86 87 88

            int row = 0;
            for( PROPERTIES::const_iterator it = props->begin();  it != props->end();  ++it, ++row )
            {
                m_grid->SetCellValue( row, 0, FROM_UTF8( it->first.c_str() ) );
                m_grid->SetCellValue( row, 1, FROM_UTF8( it->second.c_str() ) );
            }
Dick Hollenbeck's avatar
Dick Hollenbeck committed
89 90

            delete props;
91 92
        }

93 94 95 96 97
        // Option Choices Panel:

        IO_MGR::PCB_FILE_T  pi_type = IO_MGR::EnumFromStr( aPluginType );
        PLUGIN::RELEASER    pi( IO_MGR::PluginFind( pi_type ) );

98
        pi->FootprintLibOptions( &m_choices );
99

100
        if( m_choices.size() )
101 102
        {
            int row = 0;
103
            for( PROPERTIES::const_iterator it = m_choices.begin();  it != m_choices.end();  ++it, ++row )
104
            {
105 106 107
                wxString item = FROM_UTF8( it->first.c_str() );

                m_listbox->InsertItems( 1, &item, row );
108 109 110
            }
        }

111
        m_html->SetPage( m_initial_help );
112

113 114 115 116 117 118 119 120 121 122
        if( !col_width_option )
        {
            m_grid->AutoSizeColumns( false );
        }
        else
        {
            m_grid->SetColSize( 0, col_width_option );
            m_grid->SetColSize( 1, col_width_value );
        }

123 124
        Fit();

125 126 127 128 129 130
        // initial focus on the grid please.
        m_grid->SetFocus();
    }

    ~DIALOG_FP_PLUGIN_OPTIONS()
    {
131
        // destroy GRID_TRICKS before m_grid.
132
        m_grid->PopEventHandler( true );
133 134 135 136 137 138
    }


private:
    const wxString& m_callers_options;
    wxString*       m_result;
139 140 141
    PROPERTIES      m_choices;
    wxString        m_initial_help;

142

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
    /// If the cursor is not on a valid cell, because there are no rows at all, return -1,
    /// else return a 0 based column index.
    int getCursorCol() const
    {
        return m_grid->GetGridCursorCol();
    }

    /// If the cursor is not on a valid cell, because there are no rows at all, return -1,
    /// else return a 0 based row index.
    int getCursorRow() const
    {
        return m_grid->GetGridCursorRow();
    }

    wxArrayString getRow( int aRow )
    {
        wxArrayString row;

        const int col_count = m_grid->GetNumberCols();
        for( int col = 0;  col < col_count;  ++col )
        {
            row.Add( m_grid->GetCellValue( aRow, col ) );
        }

        return row;
    }

    void setRow( int aRow, const wxArrayString& aPair )
    {
        const int col_count = m_grid->GetNumberCols();
        for( int col = 0;  col < col_count;  ++col )
        {
            m_grid->SetCellValue( aRow, col, aPair[col] );
        }
    }

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
    wxString makeResult()
    {
        PROPERTIES  props;
        const int   rowCount = m_grid->GetNumberRows();

        for( int row = 0;  row<rowCount;  ++row )
        {
            string  name  = TO_UTF8( m_grid->GetCellValue( row, 0 ).Trim( false ).Trim() );
            string  value = TO_UTF8( m_grid->GetCellValue( row, 1 ).Trim( false ).Trim() );

            if( name.size() )
            {
                props[name] = value;
            }
        }

        string  options = FP_LIB_TABLE::FormatOptions( &props );

        return FROM_UTF8( options.c_str() );
    }

    void saveColSizes()
    {
        col_width_option = m_grid->GetColSize( 0 );
        col_width_value  = m_grid->GetColSize( 1 );
    }

    void abort()
    {
        saveColSizes();

        *m_result = m_callers_options;      // tell caller "no change"
        EndModal( 0 );
    }

214
    int appendRow()
215
    {
216 217 218 219 220 221 222
        if( m_grid->AppendRows( 1 ) )
        {
            int last_row = m_grid->GetNumberRows() - 1;

            // wx documentation is wrong, SetGridCursor does not make visible.
            m_grid->MakeCellVisible( last_row, 0 );
            m_grid->SetGridCursor( last_row, 0 );
223 224 225 226 227 228 229

            return last_row;
        }

        return -1;
    }

230
    void appendOption()
231
    {
232 233
        int selected_row = m_listbox->GetSelection();
        if( selected_row != wxNOT_FOUND )
234
        {
235
            wxString    option = m_listbox->GetString( selected_row );
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252

            int row_count = m_grid->GetNumberRows();
            int row;

            for( row=0;  row<row_count;  ++row )
            {
                wxString col0 = m_grid->GetCellValue( row, 0 );

                if( !col0 )     // empty col0
                    break;
            }

            if( row == row_count )
                row = appendRow();

            m_grid->SetCellValue( row, 0, option );
            m_grid->AutoSizeColumns( false );
253
        }
254
    }
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286

    //-----<event handlers>------------------------------------------------------

    void onListBoxItemSelected( wxCommandEvent& event )
    {
        if( event.IsSelection() )
        {
            const char* option = TO_UTF8( event.GetString() );
            string      help_text;

            if( m_choices.Value( option, &help_text ) )
            {
                wxString page( FROM_UTF8( help_text.c_str() ) );

                m_html->SetPage( page );
            }
            else
            {
                m_html->SetPage( m_initial_help );
            }
        }
    }

    void onListBoxItemDoubleClicked( wxCommandEvent& event )
    {
        appendOption();
    }

    void onAppendOption( wxCommandEvent& event )
    {
        appendOption();
    }
287

288 289 290 291 292 293
    void onAppendRow( wxMouseEvent& event )
    {
        appendRow();
    }

    void onDeleteRow( wxMouseEvent& event )
294
    {
295 296 297 298 299 300 301 302 303 304
        int rowCount = m_grid->GetNumberRows();
        int curRow   = getCursorRow();

        m_grid->DeleteRows( curRow );

        if( curRow && curRow == rowCount - 1 )
        {
            m_grid->MakeCellVisible( curRow-1, getCursorCol() );
            m_grid->SetGridCursor( curRow-1, getCursorCol() );
        }
305 306
    }

307
    void onMoveUp( wxMouseEvent& event )
308
    {
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
        int curRow = getCursorRow();
        if( curRow >= 1 )
        {
            int curCol = getCursorCol();

            wxArrayString move_me = getRow( curRow );

            m_grid->DeleteRows( curRow );
            --curRow;
            m_grid->InsertRows( curRow );

            setRow( curRow, move_me );

            wxGridTableBase* tbl = m_grid->GetTable();

            if( tbl->GetView() )
            {
                // fire a msg to cause redrawing
                wxGridTableMessage msg( tbl,
                                        wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
                                        curRow,
                                        0 );

                tbl->GetView()->ProcessTableMessage( msg );
            }

            m_grid->MakeCellVisible( curRow, curCol );
            m_grid->SetGridCursor( curRow, curCol );
        }
338 339
    }

340
    void onMoveDown( wxMouseEvent& event )
341
    {
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
        int curRow = getCursorRow();
        if( curRow + 1 < m_grid->GetNumberRows() )
        {
            int curCol  = getCursorCol();

            wxArrayString move_me = getRow( curRow );

            m_grid->DeleteRows( curRow );
             ++curRow;
            m_grid->InsertRows( curRow );
            setRow( curRow, move_me );

            wxGridTableBase* tbl = m_grid->GetTable();

            if( tbl->GetView() )
            {
                // fire a msg to cause redrawing
                wxGridTableMessage msg( tbl,
                                        wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
                                        curRow - 1,
                                        0 );

                tbl->GetView()->ProcessTableMessage( msg );
            }

            m_grid->MakeCellVisible( curRow, curCol );
            m_grid->SetGridCursor( curRow, curCol );
        }
370 371 372 373
    }

    void onCancelButtonClick( wxCommandEvent& event )
    {
374
        abort();
375 376 377 378
    }

    void onCancelButtonClick( wxCloseEvent& event )
    {
379
        abort();
380 381 382 383
    }

    void onOKButtonClick( wxCommandEvent& event )
    {
384
        saveColSizes();
385

386
        *m_result = makeResult();       // change from edits
387 388 389 390 391 392 393
        EndModal( 1 );
    }
    //-----</event handlers>-----------------------------------------------------
};


void InvokePluginOptionsEditor( wxTopLevelWindow* aCaller,
394 395
        const wxString& aNickname, const wxString& aPluginType,
        const wxString& aOptions, wxString* aResult )
396
{
397
    DIALOG_FP_PLUGIN_OPTIONS    dlg( aCaller, aNickname, aPluginType, aOptions, aResult );
398 399 400

    dlg.ShowModal();
}