notifications_manager.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 Mark Roszko <[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, 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
 */
 
#ifndef NOTIFICATIONS_MANAGER_H
#define NOTIFICATIONS_MANAGER_H
 
#include <kicommon.h>
#include <functional>
#include <vector>
 
class wxString;
class KISTATUSBAR;
struct NOTIFICATION;
class NOTIFICATIONS_LIST;
class wxWindow;
class wxCloseEvent;
 
 
struct KICOMMON_API NOTIFICATION
{
public:
    wxString title;       
    wxString description; 
    wxString href;        
    wxString key;         
    wxString date;        
};
 
 
class KICOMMON_API NOTIFICATIONS_MANAGER
{
public:
    NOTIFICATIONS_MANAGER();

    void CreateOrUpdate( const wxString& aKey, const wxString& aTitle, const wxString& aDescription,
                         const wxString& aHref = wxEmptyString );

    void Remove( const wxString& aKey );

    void Load();

    void Save();

    void ShowList( wxWindow* aParent, wxPoint aPos );

    void RegisterStatusBar( KISTATUSBAR* aStatusBar );

    void UnregisterStatusBar( KISTATUSBAR* aStatusBar );
 
private:
    void onListWindowClosed( wxCloseEvent& aEvent );
 
private:
    std::vector<NOTIFICATION>        m_notifications;

    std::vector<NOTIFICATIONS_LIST*> m_shownDialogs;

    std::vector<KISTATUSBAR*>        m_statusBars;

    wxFileName                       m_destFileName;
};
 
#endif