KiCad PCB EDA Suite
pcbnew/kicad_plugin.h File Reference
#include <io_mgr.h>
#include <string>
#include <layers_id_colors_and_visibility.h>

Go to the source code of this file.

Classes

class  PCB_IO
 PCB_IO is a PLUGIN derivation for saving and loading Pcbnew s-expression formatted files. More...
 

Macros

#define SEXPR_BOARD_FILE_VERSION   20200119
 Current s-expression file format version. 2 was the last legacy format version. More...
 
#define CTL_STD_LAYER_NAMES   (1 << 0)
 Use English Standard layer names. More...
 
#define CTL_OMIT_NETS   (1 << 1)
 Omit pads net names (useless in library) More...
 
#define CTL_OMIT_TSTAMPS   (1 << 2)
 Omit component time stamp (useless in library) More...
 
#define CTL_OMIT_INITIAL_COMMENTS   (1 << 3)
 omit MODULE initial comments More...
 
#define CTL_OMIT_PATH   (1 << 4)
 Omit component sheet time stamp (useless in library) More...
 
#define CTL_OMIT_AT   (1 << 5)
 Omit position and rotation. More...
 
#define CTL_FOR_CLIPBOARD   (CTL_STD_LAYER_NAMES|CTL_OMIT_NETS)
 Format output for the clipboard instead of footprint library or BOARD. More...
 
#define CTL_FOR_LIBRARY   (CTL_STD_LAYER_NAMES|CTL_OMIT_NETS|CTL_OMIT_TSTAMPS|CTL_OMIT_PATH|CTL_OMIT_AT)
 Format output for a footprint library instead of clipboard or BOARD. More...
 
#define CTL_FOR_BOARD   (CTL_OMIT_INITIAL_COMMENTS)
 The zero arg constructor when PCB_IO is used for PLUGIN::Load() and PLUGIN::Save()ing a BOARD file underneath IO_MGR. More...
 

Macro Definition Documentation

◆ CTL_FOR_BOARD

#define CTL_FOR_BOARD   (CTL_OMIT_INITIAL_COMMENTS)

The zero arg constructor when PCB_IO is used for PLUGIN::Load() and PLUGIN::Save()ing a BOARD file underneath IO_MGR.

Definition at line 91 of file pcbnew/kicad_plugin.h.

◆ CTL_FOR_CLIPBOARD

#define CTL_FOR_CLIPBOARD   (CTL_STD_LAYER_NAMES|CTL_OMIT_NETS)

Format output for the clipboard instead of footprint library or BOARD.

Definition at line 84 of file pcbnew/kicad_plugin.h.

◆ CTL_FOR_LIBRARY

Format output for a footprint library instead of clipboard or BOARD.

Definition at line 87 of file pcbnew/kicad_plugin.h.

◆ CTL_OMIT_AT

#define CTL_OMIT_AT   (1 << 5)

Omit position and rotation.

Definition at line 76 of file pcbnew/kicad_plugin.h.

◆ CTL_OMIT_INITIAL_COMMENTS

#define CTL_OMIT_INITIAL_COMMENTS   (1 << 3)

omit MODULE initial comments

Definition at line 74 of file pcbnew/kicad_plugin.h.

◆ CTL_OMIT_NETS

#define CTL_OMIT_NETS   (1 << 1)

Omit pads net names (useless in library)

Definition at line 72 of file pcbnew/kicad_plugin.h.

◆ CTL_OMIT_PATH

#define CTL_OMIT_PATH   (1 << 4)

Omit component sheet time stamp (useless in library)

Definition at line 75 of file pcbnew/kicad_plugin.h.

◆ CTL_OMIT_TSTAMPS

#define CTL_OMIT_TSTAMPS   (1 << 2)

Omit component time stamp (useless in library)

Definition at line 73 of file pcbnew/kicad_plugin.h.

◆ CTL_STD_LAYER_NAMES

#define CTL_STD_LAYER_NAMES   (1 << 0)

Use English Standard layer names.

Definition at line 71 of file pcbnew/kicad_plugin.h.

◆ SEXPR_BOARD_FILE_VERSION

#define SEXPR_BOARD_FILE_VERSION   20200119

Current s-expression file format version. 2 was the last legacy format version.

Definition at line 69 of file pcbnew/kicad_plugin.h.