pl_selection_tool.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 CERN
 * Copyright (C) 2019-2022 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 PL_SELECTION_TOOL_H
#define PL_SELECTION_TOOL_H
 
#include <tool/selection_tool.h>
#include <tool/tool_interactive.h>
#include <tool/tool_menu.h>
#include "tools/pl_selection.h"
 
class PL_EDITOR_FRAME;
class SCH_ITEM;
class COLLECTOR;
 
namespace KIGFX
{
    class GAL;
}
 
 
class PL_SELECTION_TOOL : public SELECTION_TOOL
{
public:
    PL_SELECTION_TOOL();
    ~PL_SELECTION_TOOL() override { }
 
    bool Init() override;
 
    void Reset( RESET_REASON aReason ) override;
 
    int Main( const TOOL_EVENT& aEvent );
 
    PL_SELECTION& GetSelection();
 
    PL_SELECTION& RequestSelection();
 
    void SelectPoint( const VECTOR2I& aWhere, bool* aSelectionCancelledFlag = nullptr );
 
    int ClearSelection( const TOOL_EVENT& aEvent );
    void ClearSelection();
 
    void RebuildSelection();
 
protected:
    SELECTION& selection() override { return m_selection; }
 
private:
    bool selectMultiple();
 
    void guessSelectionCandidates( COLLECTOR& collector, const VECTOR2I& aWhere );
 
    int disambiguateCursor( const TOOL_EVENT& aEvent );
 
    void select( EDA_ITEM* aItem ) override;
 
    void unselect( EDA_ITEM* aItem ) override;
 
    void highlight( EDA_ITEM* aItem, int aHighlightMode, SELECTION* aGroup = nullptr ) override;
 
    void unhighlight( EDA_ITEM* aItem, int aHighlightMode, SELECTION* aGroup = nullptr ) override;
 
    bool selectionContains( const VECTOR2I& aPoint ) const;
 
    void setTransitions() override;
 
private:
    PL_EDITOR_FRAME* m_frame;   // Pointer to the parent frame
    PL_SELECTION m_selection;   // Current state of selection
};
 
#endif //PL_SELECTION_TOOL_H