group_tool.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/>.
 */
 
#pragma once
 
#include <tool/tool_interactive.h>
 
class COMMIT;
class DIALOG_GROUP_PROPERTIES;
class EDA_DRAW_FRAME;
class EDA_GROUP;
class SELECTION_TOOL;
class wxString;
 
 
class GROUP_TOOL : public TOOL_INTERACTIVE
{
public:
    GROUP_TOOL();
 
    void Reset( RESET_REASON aReason ) override;

    bool Init() override;
 
    virtual int GroupProperties( const TOOL_EVENT& aEvent );

    virtual int PickNewMember( const TOOL_EVENT& aEvent ) = 0;

    virtual int Group( const TOOL_EVENT& aEvent ) = 0;

    virtual int Ungroup( const TOOL_EVENT& aEvent );

    virtual int AddToGroup( const TOOL_EVENT& aEvent );

    virtual int RemoveFromGroup( const TOOL_EVENT& aEvent );

    virtual int EnterGroup( const TOOL_EVENT& aEvent );

    virtual int LeaveGroup( const TOOL_EVENT& aEvent );
 
protected:
    void setTransitions() override;

    virtual bool canGroupItem( EDA_ITEM* aItem, wxString& aErrorMsg ) const = 0;

    virtual EDA_GROUP* getGroupFromItem( EDA_ITEM* ) = 0;

    virtual std::shared_ptr<COMMIT> createCommit() = 0;
 
    EDA_DRAW_FRAME*          m_frame = nullptr;
    DIALOG_GROUP_PROPERTIES* m_propertiesDialog = nullptr;
    SELECTION_TOOL*          m_selectionTool = nullptr;
    std::shared_ptr<COMMIT>  m_commit;
};