file_history.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019 Ian McInerney <[email protected]>
 * 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 FILEHISTORY_H_
#define FILEHISTORY_H_
 
#include <tool/action_menu.h>
#include <tool/selection_conditions.h>
#include <wx/filehistory.h>
#include <wx/menu.h>
 
 
class APP_SETTINGS_BASE;

class FILE_HISTORY : public wxFileHistory
{
public:
    FILE_HISTORY( size_t aMaxFiles, int aBaseFileId, int aClearId,
            wxString aClearText = _( "Clear Recent Files" ) );

    void Load( const APP_SETTINGS_BASE& aSettings );

    void Load( const std::vector<wxString>& aList );

    void Save( APP_SETTINGS_BASE& aSettings );

    void Save( std::vector<wxString>* aList );
 
    // Hide warnings about these virtual functions
    using wxFileHistory::Load;
    using wxFileHistory::Save;

    void AddFileToHistory( const wxString& aFile ) override;

    void AddFilesToMenu() override
    {
        // This is needed to ensure that the proper base class function is called
        wxFileHistory::AddFilesToMenu();
    }

    void AddFilesToMenu( wxMenu* aMenu ) override;

    void SetMaxFiles( size_t aMaxFiles );

    void SetClearText( wxString aClearText )
    {
        m_clearText = aClearText;
    }

    void UpdateClearText(  wxMenu* aMenu, wxString aClearText );

    void ClearFileHistory();

    static SELECTION_CONDITION FileHistoryNotEmpty( const FILE_HISTORY& aHistory );
 
protected:
    void doRemoveClearitem( wxMenu* aMenu );

    void doAddClearItem( wxMenu* aMenu );
 
private:
    static bool isHistoryNotEmpty( const SELECTION& aSelection, const FILE_HISTORY& aHistory );
 
    int      m_clearId;
    wxString m_clearText;
};
 
#endif