kiface_ids.h File Reference

Go to the source code of this file.

Enumerations
enum	KIFACE_ADDR_ID : int {   KIFACE_ID_INVALID , KIFACE_FOOTPRINT_LIBRARY_ADAPTER , KIFACE_FILTER_FOOTPRINTS , KIFACE_TRIGGER_FOOTPRINTS_LOAD ,   KIFACE_FOOTPRINTS_LOAD_PROGRESS , KIFACE_LOAD_SCHEMATIC , KIFACE_NETLIST_SCHEMATIC , KIFACE_MERGE_DOCUMENT ,   KIFACE_OPEN_DIFF_DIALOG , KIFACE_TEST_FOOTPRINT_LINK , KIFACE_TEST_FOOTPRINT_LINK_NO_LIBRARY , KIFACE_TEST_FOOTPRINT_LINK_LIBRARY_NOT_ENABLED ,   KIFACE_TEST_FOOTPRINT_LINK_NO_FOOTPRINT , KIFACE_FOOTPRINT_PAD_NUMBERS }
	IDs of objects that may be returned by KIFACE::IfaceOrAddress. More...

Enumeration Type Documentation

KIFACE_ADDR_ID

enum KIFACE_ADDR_ID : int

IDs of objects that may be returned by KIFACE::IfaceOrAddress.

Enumerator
KIFACE_ID_INVALID
KIFACE_FOOTPRINT_LIBRARY_ADAPTER
KIFACE_FILTER_FOOTPRINTS	Function pointer type: wxString (*)(const wxString& aFilterJson) Input JSON: {"pin_count": N, "filters": ["pattern1", ...], "zero_filters": bool, "max_results": N} Output JSON: {"matches": ["lib:footprint1", "lib:footprint2", ...], "limited": bool, "success": bool}.
KIFACE_TRIGGER_FOOTPRINTS_LOAD	Function pointer type: bool (*)() Starts loading the footprint libraries in the background. Never blocks. Returns true if a load was started, false if a load is already running, or if something failed.
KIFACE_FOOTPRINTS_LOAD_PROGRESS	Function pointer type: float (*)() Returns how far the library loader has gotten as a fraction of the queued libraries processed so far, or 1.0 when there is nothing to wait for. Never blocks.
KIFACE_LOAD_SCHEMATIC
KIFACE_NETLIST_SCHEMATIC
KIFACE_MERGE_DOCUMENT	int (*)( int aKind, const wxString& aAncestor, const wxString& aOurs, const wxString& aTheirs, const wxString& aOutput, bool aInteractive, REPORTER* aReporter ) aKind is a KICAD_DIFF::DOC_KIND. Runs a 3-way document/library merge in the kiface and returns a CLI exit code. Replaces the former merge JOBs.
KIFACE_OPEN_DIFF_DIALOG	int (*)( int aKind, const wxString& aFileA, const wxString& aFileB, const wxString& aLabelA, const wxString& aLabelB, wxWindow* aParent, REPORTER* aReporter ) aKind is a KICAD_DIFF::DOC_KIND. Loads the two files and opens DIALOG_KICAD_DIFF modally. Replaces the former JOB_OPEN_DIFF_DIALOG.
KIFACE_TEST_FOOTPRINT_LINK
KIFACE_TEST_FOOTPRINT_LINK_NO_LIBRARY
KIFACE_TEST_FOOTPRINT_LINK_LIBRARY_NOT_ENABLED
KIFACE_TEST_FOOTPRINT_LINK_NO_FOOTPRINT
KIFACE_FOOTPRINT_PAD_NUMBERS	Function pointer type: void (*)( const wxString& aFootprint, PROJECT* aProject, std::set<wxString>& aPadNumbers ) Fills aPadNumbers with the numbered pads of aFootprint.

Definition at line 26 of file kiface_ids.h.