mail_type.h File Reference

Go to the source code of this file.

Macros
#define	MAIL_SCH_GET_NETLIST_CANCELLED   "\x01__netlist_cancelled__"
	Reply payload for MAIL_SCH_GET_NETLIST when the user deliberately aborts netlist generation (for example, answering No to the duplicate-sheet-names prompt).

Enumerations
enum	MAIL_T {   MAIL_CROSS_PROBE , MAIL_SELECTION , MAIL_SELECTION_FORCE , MAIL_ASSIGN_FOOTPRINTS ,   MAIL_SCH_SAVE , MAIL_PCB_SAVE , MAIL_EESCHEMA_NETLIST , MAIL_SYMBOL_NETLIST ,   MAIL_PCB_UPDATE , MAIL_SCH_UPDATE , MAIL_IMPORT_FILE , MAIL_SCH_GET_NETLIST ,   MAIL_SCH_GET_ITEM , MAIL_PCB_GET_NETLIST , MAIL_PCB_UPDATE_LINKS , MAIL_SCH_REFRESH ,   MAIL_ADD_LOCAL_LIB , MAIL_LIB_EDIT , MAIL_FP_EDIT , MAIL_RELOAD_LIB ,   MAIL_RELOAD_PLUGINS , MAIL_REFRESH_SYMBOL , MAIL_SCH_NAVIGATE_TO_SHEET }
	The set of mail types sendable via KIWAY::ExpressMail() and supplied as the aCommand parameter to that function. More...

Macro Definition Documentation

MAIL_SCH_GET_NETLIST_CANCELLED

#define MAIL_SCH_GET_NETLIST_CANCELLED   "\x01__netlist_cancelled__"

Reply payload for MAIL_SCH_GET_NETLIST when the user deliberately aborts netlist generation (for example, answering No to the duplicate-sheet-names prompt).

The caller treats this as a silent cancel, distinct from an unannotated schematic which echoes the original annotation message back.

Definition at line 66 of file mail_type.h.

Referenced by PCB_EDIT_FRAME::FetchNetlistFromSchematic(), PCBNEW_JOBS_HANDLER::JobExportDrc(), and SCH_EDIT_FRAME::KiwayMailIn().

Enumeration Type Documentation

MAIL_T

enum MAIL_T

The set of mail types sendable via KIWAY::ExpressMail() and supplied as the aCommand parameter to that function.

Such mail will be received in KIWAY_PLAYER::KiwayMailIn( KIWAY_MAIL_EVENT& aEvent ) and aEvent.Command() will match aCommand to KIWAY::ExpressMail().

Enumerator
MAIL_CROSS_PROBE
MAIL_SELECTION
MAIL_SELECTION_FORCE
MAIL_ASSIGN_FOOTPRINTS
MAIL_SCH_SAVE
MAIL_PCB_SAVE
MAIL_EESCHEMA_NETLIST
MAIL_SYMBOL_NETLIST
MAIL_PCB_UPDATE
MAIL_SCH_UPDATE
MAIL_IMPORT_FILE
MAIL_SCH_GET_NETLIST
MAIL_SCH_GET_ITEM
MAIL_PCB_GET_NETLIST
MAIL_PCB_UPDATE_LINKS
MAIL_SCH_REFRESH
MAIL_ADD_LOCAL_LIB
MAIL_LIB_EDIT
MAIL_FP_EDIT
MAIL_RELOAD_LIB
MAIL_RELOAD_PLUGINS
MAIL_REFRESH_SYMBOL
MAIL_SCH_NAVIGATE_TO_SHEET

Definition at line 33 of file mail_type.h.