action_plugin.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 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 CLASS_ACTION_PLUGIN_H
#define CLASS_ACTION_PLUGIN_H
#include <vector>
#include <pcb_edit_frame.h>

class ACTION_PLUGIN
{
public:
    ACTION_PLUGIN() : m_actionMenuId( 0 ), m_actionButtonId( 0 ),
                      show_on_toolbar( false ) {}
    virtual ~ACTION_PLUGIN();

    virtual wxString GetCategoryName() = 0;

    virtual wxString GetName() = 0;

    virtual wxString GetDescription() = 0;

    virtual bool GetShowToolbarButton() = 0;

    virtual wxString GetIconFileName( bool aDark ) = 0;

    virtual wxString GetPluginPath() = 0;

    virtual void* GetObject() = 0;

    virtual void Run() = 0;

    void register_action();

    // association between the plugin and its menu id
    // m_actionMenuId set to 0 means the corresponding menuitem to call this
    // action is not yet created
    int m_actionMenuId;

    // Same for button id
    int m_actionButtonId;

    // Icon for the action button and menu entry
    wxBitmap iconBitmap;

    // If show_on_toolbar is true a button will be added to top toolbar
    bool show_on_toolbar;

};


class ACTION_PLUGINS
{
public:
    static void register_action( ACTION_PLUGIN* aAction );

    static bool deregister_object( void* aObject );

    static ACTION_PLUGIN* GetAction( const wxString& aName );

    static void SetActionMenu( int aIndex, int idMenu );

    static ACTION_PLUGIN* GetActionByMenu( int aMenu );

    static void SetActionButton( ACTION_PLUGIN* aAction, int idButton );

    static ACTION_PLUGIN* GetActionByButton( int aButton );

    static ACTION_PLUGIN* GetActionByPath( const wxString& aPath );

    static ACTION_PLUGIN* GetAction( int aIndex );

    static int GetActionsCount();

    static bool IsActionRunning();

    static void SetActionRunning( bool aRunning );

    static void UnloadAll();

private:
    static std::vector<ACTION_PLUGIN*> m_actionsList;
    static bool m_actionRunning;
};

#endif /* PCBNEW_ACTION_PLUGINS_H */