KiCad PCB EDA Suite
dialog_schematic_find.h File Reference

Subclass of DIALOG_SCH_FIND_BASE, which is generated by wxFormBuilder. More...

#include "dialog_schematic_find_base.h"
#include <wx/fdrepdlg.h>

Go to the source code of this file.

Classes

class  SCH_FIND_REPLACE_DATA
 Class SCH_FIND_REPLACE_DATA adds missing useful comparison and assignment operators to the wxFindReplaceData object. More...
 
class  DIALOG_SCH_FIND
 Implementing DIALOG_SCH_FIND_BASE. More...
 

Macros

#define FR_MASK_NON_COMPARE_FLAGS
 Definition FR_MASK_NON_COMPARE_FLAGS is used to mask find/replace flag bits that do not effect the search results. More...
 
#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 ) )
 

Enumerations

enum  SchematicFindReplaceFlags {
  FR_CURRENT_SHEET_ONLY = wxFR_MATCHCASE << 1, FR_SEARCH_ALL_FIELDS = wxFR_MATCHCASE << 2, FR_SEARCH_ALL_PINS = wxFR_MATCHCASE << 3, FR_MATCH_WILDCARD = wxFR_MATCHCASE << 4,
  FR_SEARCH_WRAP = wxFR_MATCHCASE << 5, FR_NO_WARP_CURSOR = wxFR_MATCHCASE << 6, FR_SEARCH_REPLACE = wxFR_MATCHCASE << 7, FR_REPLACE_ITEM_FOUND = wxFR_MATCHCASE << 8,
  FR_REPLACE_REFERENCES = wxFR_MATCHCASE << 9
}
 Define schematic specific find and replace dialog flags based on the enum entries in wxFindReplaceFlags. More...
 

Detailed Description

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.

Definition in file dialog_schematic_find.h.

Macro Definition Documentation

#define EVT_FIND_COMPONENT_IN_LIB (   id,
  fn 
)    wx__DECLARE_EVT1( EVT_COMMAND_FIND_COMPONENT_IN_LIB, id, wxFindDialogEventHandler( fn ) )

Definition at line 199 of file dialog_schematic_find.h.

#define EVT_FIND_DRC_MARKER (   id,
  fn 
)    wx__DECLARE_EVT1( EVT_COMMAND_FIND_DRC_MARKER, id, wxFindDialogEventHandler( fn ) )

Definition at line 196 of file dialog_schematic_find.h.

#define FR_MASK_NON_COMPARE_FLAGS
Value:
Used by the search event handler to let the dialog know that a replaceable item has been found...
Wrap around the beginning or end of search list.
Don't warp cursor to found item until the dialog is closed.

Definition FR_MASK_NON_COMPARE_FLAGS is used to mask find/replace flag bits that do not effect the search results.

Definition at line 87 of file dialog_schematic_find.h.

Referenced by SCH_FIND_REPLACE_DATA::GetCompareFlags().

Enumeration Type Documentation

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.

Enumerator
FR_CURRENT_SHEET_ONLY 

Search the current sheet only.

FR_SEARCH_ALL_FIELDS 

Search all fields in component, not just the value and reference fields.

FR_SEARCH_ALL_PINS 

Search texts (name and number (a 4 letters text) )in pins.

FR_MATCH_WILDCARD 

Perform search using simple wild card matching (* & ?).

FR_SEARCH_WRAP 

Wrap around the beginning or end of search list.

FR_NO_WARP_CURSOR 

Don't warp cursor to found item until the dialog is closed.

FR_SEARCH_REPLACE 

Perform a search for a item that has replaceable text.

FR_REPLACE_ITEM_FOUND 

Used by the search event handler to let the dialog know that a replaceable item has been found.

FR_REPLACE_REFERENCES 

Used by replace to ignore the component reference designator field.

Definition at line 49 of file dialog_schematic_find.h.

50 {
51  // The last wxFindReplaceFlag enum is wxFR_MATCHCASE = 0x4.
52 
54  FR_CURRENT_SHEET_ONLY = wxFR_MATCHCASE << 1,
55 
57  FR_SEARCH_ALL_FIELDS = wxFR_MATCHCASE << 2,
58 
60  FR_SEARCH_ALL_PINS = wxFR_MATCHCASE << 3,
61 
63  FR_MATCH_WILDCARD = wxFR_MATCHCASE << 4,
64 
66  FR_SEARCH_WRAP = wxFR_MATCHCASE << 5,
67 
69  FR_NO_WARP_CURSOR = wxFR_MATCHCASE << 6,
70 
72  FR_SEARCH_REPLACE = wxFR_MATCHCASE << 7,
73 
76  FR_REPLACE_ITEM_FOUND = wxFR_MATCHCASE << 8,
77 
79  FR_REPLACE_REFERENCES = wxFR_MATCHCASE << 9
80 };
Search texts (name and number (a 4 letters text) )in pins.
Used by the search event handler to let the dialog know that a replaceable item has been found...
Wrap around the beginning or end of search list.
Search all fields in component, not just the value and reference fields.
Perform search using simple wild card matching (* & ?).
Search the current sheet only.
Don't warp cursor to found item until the dialog is closed.
Used by replace to ignore the component reference designator field.
Perform a search for a item that has replaceable text.