dialog_generated_table_properties.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef DIALOG_GENERATED_TABLE_PROPERTIES_H
#define DIALOG_GENERATED_TABLE_PROPERTIES_H
 
#include <functional>
#include <optional>
#include <vector>
 
#include <board_tables/generated_table_schema.h>
#include <dialog_generated_table_properties_base.h>
#include <widgets/unit_binder.h>
 
 
class GENERATED_TABLE_REFRESH;
class PCB_BASE_EDIT_FRAME;
class PCB_GENERATED_TABLE;
 

struct GENERATED_TABLE_FORMAT
{
    std::vector<GENERATED_TABLE_COLUMN> m_Columns; 
    GENERATED_TABLE_UNITS               m_Units = GENERATED_TABLE_UNITS::MM;
    int                                 m_Precision = 0;
};
 

class GENERATED_TABLE_OPTIONS_PANEL : public wxPanel
{
public:
    using wxPanel::wxPanel;
 
    virtual void TransferToWindow( const PCB_GENERATED_TABLE& aTable ) = 0;

    virtual bool TransferFromWindow( PCB_GENERATED_TABLE& aTable, GENERATED_TABLE_REFRESH& aRefresh ) = 0;

    std::function<std::optional<GENERATED_TABLE_FORMAT>()> m_GetFormat;

    std::function<void( const GENERATED_TABLE_FORMAT& )> m_SetFormat;
};
 

using GENERATED_TABLE_OPTIONS_FACTORY = std::function<GENERATED_TABLE_OPTIONS_PANEL*( wxWindow* aParent )>;
 

class DIALOG_GENERATED_TABLE_PROPERTIES : public DIALOG_GENERATED_TABLE_PROPERTIES_BASE
{
public:
    DIALOG_GENERATED_TABLE_PROPERTIES( PCB_BASE_EDIT_FRAME* aFrame, PCB_GENERATED_TABLE* aTable,
                                       GENERATED_TABLE_OPTIONS_FACTORY aOptions );
 
private:
    bool TransferDataToWindow() override;
    bool TransferDataFromWindow() override;
 
    void onBorderChecked( wxCommandEvent& aEvent ) override;
    void onMoveUp( wxCommandEvent& aEvent ) override;
    void onMoveDown( wxCommandEvent& aEvent ) override;
    void onResetColumns( wxCommandEvent& aEvent ) override;

    void setColumns( const std::vector<GENERATED_TABLE_COLUMN>& aColumns );
 
    std::vector<GENERATED_TABLE_COLUMN> shownColumns() const;
 
    std::optional<GENERATED_TABLE_FORMAT> getFormat();
    void                                  setFormat( const GENERATED_TABLE_FORMAT& aFormat );

    void fillColumnGrid();

    bool harvestColumnGrid();
 
    void moveColumn( int aDelta );

    void fitColumnGrid();
 
    void onColumnGridSize( wxSizeEvent& aEvent );
 
    PCB_BASE_EDIT_FRAME*           m_frame;
    PCB_GENERATED_TABLE*           m_table;
    GENERATED_TABLE_OPTIONS_PANEL* m_options;
 
    struct COLUMN_ROW
    {
        GENERATED_TABLE_COLUMN m_Column;
        bool                   m_Shown;
    };

    std::vector<COLUMN_ROW> m_rows;
 
    UNIT_BINDER m_borderWidth;
    UNIT_BINDER m_separatorsWidth;
};
 
#endif // DIALOG_GENERATED_TABLE_PROPERTIES_H