diff options
Diffstat (limited to 'eeschema/dialogs/dialog_schematic_find.h')
| -rw-r--r-- | eeschema/dialogs/dialog_schematic_find.h | 201 |
1 files changed, 201 insertions, 0 deletions
diff --git a/eeschema/dialogs/dialog_schematic_find.h b/eeschema/dialogs/dialog_schematic_find.h new file mode 100644 index 0000000..054cf01 --- /dev/null +++ b/eeschema/dialogs/dialog_schematic_find.h @@ -0,0 +1,201 @@ +/* + * This program source code file is part of KiCad, a free EDA CAD application. + * + * Copyright (C) 2010 Wayne Stambaugh <stambaughw@verizon.net> + * Copyright (C) 2010-2011 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 + */ + +/** + * @file + * + * Subclass of DIALOG_SCH_FIND_BASE, which is generated by wxFormBuilder. + * + * This dialog is used to define the search criteria used to search for items + * in the current schematic. What is searched depends on the schematic item + * type. Check the Matches() method for each item derived from SCH_ITEM() to + * find out how matching is performed against that item. + */ + +#ifndef __dialog_schematic_find__ +#define __dialog_schematic_find__ + +#include "dialog_schematic_find_base.h" + +#include <wx/fdrepdlg.h> // Use the wxFindReplaceDialog events, data, and enums. + + +/** + * Define schematic specific find and replace dialog flags based on the enum entries + * in wxFindReplaceFlags. These flags are intended to be used as bit masks in the + * wxFindReplaceData::m_Flags member variable. The variable is defined as a wxUint32. + */ +enum SchematicFindReplaceFlags +{ + // The last wxFindReplaceFlag enum is wxFR_MATCHCASE = 0x4. + + /// Search the current sheet only. + FR_CURRENT_SHEET_ONLY = wxFR_MATCHCASE << 1, + + /// Search all fields in component, not just the value and reference fields. + FR_SEARCH_ALL_FIELDS = wxFR_MATCHCASE << 2, + + /// Search texts (name and number (a 4 letters text) )in pins. + FR_SEARCH_ALL_PINS = wxFR_MATCHCASE << 3, + + /// Perform search using simple wild card matching (* & ?). + FR_MATCH_WILDCARD = wxFR_MATCHCASE << 4, + + /// Wrap around the beginning or end of search list. + FR_SEARCH_WRAP = wxFR_MATCHCASE << 5, + + /// Don't warp cursor to found item until the dialog is closed. + FR_NO_WARP_CURSOR = wxFR_MATCHCASE << 6, + + /// Perform a search for a item that has replaceable text. + FR_SEARCH_REPLACE = wxFR_MATCHCASE << 7, + + /// Used by the search event handler to let the dialog know that a replaceable + /// item has been found. + FR_REPLACE_ITEM_FOUND = wxFR_MATCHCASE << 8, + + /// Used by replace to ignore the component reference designator field. + FR_REPLACE_REFERENCES = wxFR_MATCHCASE << 9 +}; + + +/** + * Definition FR_MASK_NON_COMPARE_FLAGS + * is used to mask find/replace flag bits that do not effect the search results. + */ +#define FR_MASK_NON_COMPARE_FLAGS ~( wxFR_DOWN | FR_SEARCH_WRAP | FR_NO_WARP_CURSOR | \ + FR_REPLACE_ITEM_FOUND ) + + +/** + * Class SCH_FIND_REPLACE_DATA + * adds missing useful comparison and assignment operators to the wxFindReplaceData object. + */ +class SCH_FIND_REPLACE_DATA : public wxFindReplaceData +{ +public: + + SCH_FIND_REPLACE_DATA& operator =( SCH_FIND_REPLACE_DATA& aFindReplaceData ) + { + if( this == &aFindReplaceData ) + return *this; + + SetFlags( aFindReplaceData.GetFlags() ); + SetFindString( aFindReplaceData.GetFindString() ); + SetReplaceString( aFindReplaceData.GetReplaceString() ); + + return *this; + } + + bool operator ==( SCH_FIND_REPLACE_DATA& aFindReplaceData ) + { + return ( (GetFlags() == aFindReplaceData.GetFlags()) + && (GetFindString() == aFindReplaceData.GetFindString()) + && (GetReplaceString() == aFindReplaceData.GetReplaceString()) ); + } + + bool operator !=( SCH_FIND_REPLACE_DATA& aFindReplaceData ) + { + return !( *this == aFindReplaceData ); + } + + + /** + * Function ChangesCompare + * tests \a aFindReplaceData to see if it would result in a change in the search string + * comparison results. + * + * @param aFindReplaceData A reference to a #SCH_FIND_REPLACE_DATA object to compare + * against. + * @return True if \a aFindReplaceData would result in a search and/or replace change, + * otherwise false. + */ + bool ChangesCompare( const SCH_FIND_REPLACE_DATA& aFindReplaceData ) + { + return ( (GetFindString() != aFindReplaceData.GetFindString()) + || (GetCompareFlags() != aFindReplaceData.GetCompareFlags()) ); + } + + bool IsReplacing() const { return (GetFlags() & FR_SEARCH_REPLACE) != 0; } + bool IsWrapping() const { return (GetFlags() & FR_SEARCH_WRAP) != 0; } + +private: + /** + * Function GetSearchFlags + * @return The flags that only effect the search result. + */ + wxUint32 GetCompareFlags() const { return GetFlags() & FR_MASK_NON_COMPARE_FLAGS; } +}; + + +/** Implementing DIALOG_SCH_FIND_BASE */ +class DIALOG_SCH_FIND : public DIALOG_SCH_FIND_BASE +{ +protected: + // Handlers for DIALOG_SCH_FIND_BASE events. + void OnClose( wxCloseEvent& aEvent ); + void OnUpdateFindUI( wxUpdateUIEvent& aEvent ); + void OnUpdateReplaceUI( wxUpdateUIEvent& aEvent ); + void OnUpdateWholeWordUI( wxUpdateUIEvent& aEvent ); + void OnUpdateWildcardUI( wxUpdateUIEvent& aEvent ); + + void OnFind( wxCommandEvent& aEvent ); + void OnReplace( wxCommandEvent& aEvent ); + void OnCancel( wxCommandEvent& aEvent ); + + void SendEvent( const wxEventType& aEventType ); + + wxFindReplaceData *m_findReplaceData; + + DECLARE_NO_COPY_CLASS( DIALOG_SCH_FIND ) + +public: + DIALOG_SCH_FIND( wxWindow* aParent, wxFindReplaceData* aData, + const wxPoint& aPosition = wxDefaultPosition, + const wxSize& aSize = wxDefaultSize, int aStyle = 0 ); + + const wxFindReplaceData *GetData() const { return m_findReplaceData; } + void SetData(wxFindReplaceData *aData) { m_findReplaceData = aData; } + + void SetFindEntries( const wxArrayString& aEntries ); + wxArrayString GetFindEntries() const; + + void SetReplaceEntries( const wxArrayString& aEntries ); + wxArrayString GetReplaceEntries() const { return m_comboReplace->GetStrings(); } +}; + + +BEGIN_DECLARE_EVENT_TYPES() + DECLARE_LOCAL_EVENT_TYPE( EVT_COMMAND_FIND_DRC_MARKER, wxID_ANY ) + DECLARE_LOCAL_EVENT_TYPE( EVT_COMMAND_FIND_COMPONENT_IN_LIB, wxID_ANY ) +END_DECLARE_EVENT_TYPES() + + +#define EVT_FIND_DRC_MARKER( id, fn ) \ + wx__DECLARE_EVT1( EVT_COMMAND_FIND_DRC_MARKER, id, wxFindDialogEventHandler( fn ) ) + +#define EVT_FIND_COMPONENT_IN_LIB( id, fn ) \ + wx__DECLARE_EVT1( EVT_COMMAND_FIND_COMPONENT_IN_LIB, id, wxFindDialogEventHandler( fn ) ) + +#endif // __dialog_schematic_find__ |