KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_find_replace_tool.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2019 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25
26#ifndef SCH_FIND_REPLACE_TOOL_H
27#define SCH_FIND_REPLACE_TOOL_H
28
29#include <sch_base_frame.h>
30#include <tools/sch_tool_base.h>
31
32
36class SCH_FIND_REPLACE_TOOL : public wxEvtHandler, public SCH_TOOL_BASE<SCH_BASE_FRAME>
37{
38public:
40 SCH_TOOL_BASE<SCH_BASE_FRAME>( "eeschema.FindReplace" ),
42 { }
43
45
46 int FindAndReplace( const TOOL_EVENT& aEvent );
47
48 int FindNext( const TOOL_EVENT& aEvent );
49 bool HasMatch();
50 int ReplaceAndFindNext( const TOOL_EVENT& aEvent );
51 int ReplaceAll( const TOOL_EVENT& aEvent );
52
53 int UpdateFind( const TOOL_EVENT& aEvent );
54
55private:
57 void setTransitions() override;
58
68 SCH_ITEM* nextMatch( SCH_SCREEN* aScreen, SCH_SHEET_PATH* aSheet, SCH_ITEM* aAfter,
69 EDA_SEARCH_DATA& aData, bool reverse );
71
72private:
75 wxTimer m_wrapAroundTimer; // A timer during which a subsequent FindNext will
76 // result in a wrap-around
77};
78
79
80#endif // SCH_FIND_REPLACE_TOOL_H
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:98
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
Handle actions specific to the schematic editor.
void setTransitions() override
< Set up handlers for various events.
int UpdateFind(const TOOL_EVENT &aEvent)
int FindNext(const TOOL_EVENT &aEvent)
SCH_ITEM * nextMatch(SCH_SCREEN *aScreen, SCH_SHEET_PATH *aSheet, SCH_ITEM *aAfter, EDA_SEARCH_DATA &aData, bool reverse)
Advance the search and returns the next matching item after aAfter.
int ReplaceAll(const TOOL_EVENT &aEvent)
int FindAndReplace(const TOOL_EVENT &aEvent)
int ReplaceAndFindNext(const TOOL_EVENT &aEvent)
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:168
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
A foundation class for a tool operating on a schematic or symbol.
Definition: sch_tool_base.h:49
Generic, UI-independent tool event.
Definition: tool_event.h:168