KIFACE::DOCUMENT_SPEC Struct Reference

#include <kiway.h>

Public Types
enum class	KIND { FILE_KIND , FPID_KIND , CREATE_KIND }

Public Attributes
KIND	kind = KIND::FILE_KIND
wxString	path
	File path (KIND::FILE_KIND) or project path (KIND::FPID_KIND).
LIB_ID	libId
	Library identifier; valid when kind == KIND::FPID_KIND.

Detailed Description

Definition at line 154 of file kiway.h.

Member Enumeration Documentation

KIND

enum class KIFACE::DOCUMENT_SPEC::KIND

strong

Enumerator
FILE_KIND	Open the file at path.
FPID_KIND	Open the library element named by libId.
CREATE_KIND	Create a new document at path and open it (in memory, not persisted)

Definition at line 156 of file kiway.h.

Member Data Documentation

kind

KIND KIFACE::DOCUMENT_SPEC::kind = KIND::FILE_KIND

Definition at line 163 of file kiway.h.

Referenced by CLI::API_SERVER_COMMAND::doPerform(), PCB::IFACE::HandleApiOpenDocument(), and SCH::IFACE::HandleApiOpenDocument().

libId

LIB_ID KIFACE::DOCUMENT_SPEC::libId

Library identifier; valid when kind == KIND::FPID_KIND.

Definition at line 165 of file kiway.h.

Referenced by CLI::API_SERVER_COMMAND::doPerform(), and PCB::IFACE::HandleApiOpenDocument().

path

wxString KIFACE::DOCUMENT_SPEC::path

File path (KIND::FILE_KIND) or project path (KIND::FPID_KIND).

Definition at line 164 of file kiway.h.

Referenced by CLI::API_SERVER_COMMAND::doPerform(), PCB::IFACE::HandleApiOpenDocument(), and SCH::IFACE::HandleApiOpenDocument().

---

The documentation for this struct was generated from the following file:

• kiway.h