kiway_player.h File Reference

#include <wx/frame.h>
#include <vector>
#include <kiway_holder.h>
#include <eda_base_frame.h>

Go to the source code of this file.

Classes
class	KIWAY_PLAYER
	A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project. More...

Macros
#define	KICTL_NONKICAD_ONLY   (1<<0)
	chosen file is non-KiCad according to user
#define	KICTL_KICAD_ONLY   (1<<1)
	chosen file is from KiCad according to user
#define	KICTL_CREATE   (1<<2)
	caller thinks requested project files may not exist.
#define	KICTL_IMPORT_LIB   (1<<3)
	import all footprints into a project library.
#define	KICTL_REVERT   (1<<4)
	reverting to a previously-saved (KiCad) file.

Macro Definition Documentation

KICTL_CREATE

#define KICTL_CREATE   (1<<2)

caller thinks requested project files may not exist.

Definition at line 76 of file kiway_player.h.

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), PL_EDITOR_FRAME::DoWithAcceptedFiles(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), GERBVIEW_CONTROL::LoadGerbFiles(), SCH_EDIT_FRAME::NewProject(), PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::OpenProjectFiles().

KICTL_IMPORT_LIB

#define KICTL_IMPORT_LIB   (1<<3)

import all footprints into a project library.

Definition at line 77 of file kiway_player.h.

Referenced by PCB_EDIT_FRAME::importFile(), and PCB_EDIT_FRAME::OpenProjectFiles().

KICTL_KICAD_ONLY

#define KICTL_KICAD_ONLY   (1<<1)

chosen file is from KiCad according to user

Definition at line 75 of file kiway_player.h.

Referenced by PCB_CONTROL::AppendBoardFromFile(), AskLoadBoardFileName(), PCB_IO_MGR::FindPluginTypeFromBoardPath(), PCB_IO_MGR::GuessPluginTypeFromLibPath(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), SCH_IO_MGR::GuessPluginTypeFromSchPath(), PCB_EDIT_FRAME::OnFileHistory(), BOARD_EDITOR_CONTROL::Open(), and SCH_EDIT_FRAME::OpenProjectFiles().

KICTL_NONKICAD_ONLY

#define KICTL_NONKICAD_ONLY   (1<<0)

chosen file is non-KiCad according to user

Definition at line 74 of file kiway_player.h.

Referenced by AskLoadBoardFileName(), PCB_IO_MGR::FindPluginTypeFromBoardPath(), DESIGN_BLOCK_IO_MGR::GuessPluginTypeFromLibPath(), PCB_IO_MGR::GuessPluginTypeFromLibPath(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), SCH_IO_MGR::GuessPluginTypeFromSchPath(), PCB_EDIT_FRAME::importFile(), BOARD_EDITOR_CONTROL::OpenNonKicadBoard(), and PCB_EDIT_FRAME::OpenProjectFiles().

KICTL_REVERT

#define KICTL_REVERT   (1<<4)

reverting to a previously-saved (KiCad) file.

Definition at line 78 of file kiway_player.h.

Referenced by API_HANDLER_PCB::handleRevertDocument(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), BOARD_EDITOR_CONTROL::Revert(), and SCH_EDITOR_CONTROL::Revert().