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 (C) 2019-2023 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/ee_tool_base.h>
31
32class SCH_EDIT_FRAME;
33
37class SCH_FIND_REPLACE_TOOL : public wxEvtHandler, public EE_TOOL_BASE<SCH_EDIT_FRAME>
38{
39public:
41 EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.FindReplace" ),
43 { }
44
46
47 int FindAndReplace( const TOOL_EVENT& aEvent );
48
49 int FindNext( const TOOL_EVENT& aEvent );
50 bool HasMatch();
51 int ReplaceAndFindNext( const TOOL_EVENT& aEvent );
52 int ReplaceAll( const TOOL_EVENT& aEvent );
53
54 int UpdateFind( const TOOL_EVENT& aEvent );
55
67 SCH_ITEM* FindSymbolAndItem( const wxString* aPath, const wxString* aReference,
68 bool aSearchHierarchy, SCH_SEARCH_T aSearchType,
69 const wxString& aSearchText );
70
71private:
73 void setTransitions() override;
74
84 SCH_ITEM* nextMatch( SCH_SCREEN* aScreen, SCH_SHEET_PATH* aSheet, SCH_ITEM* aAfter,
85 EDA_SEARCH_DATA& aData, bool reverse );
87
88private:
91 wxTimer m_wrapAroundTimer; // A timer during which a subsequent FindNext will
92 // result in a wrap-around
93};
94
95
96#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:89
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:48
Schematic editor (Eeschema) main window.
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 * FindSymbolAndItem(const wxString *aPath, const wxString *aReference, bool aSearchHierarchy, SCH_SEARCH_T aSearchType, const wxString &aSearchText)
Find a symbol in the schematic and an item in this symbol and select it.
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:166
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Generic, UI-independent tool event.
Definition: tool_event.h:167
SCH_SEARCH_T
Schematic search type used by the socket link with Pcbnew.