EMBEDDED_FILES::EMBEDDED_FILE Struct Reference

#include <embedded_files.h>

Public Types
enum class	FILE_TYPE {   FONT , MODEL , WORKSHEET , DATASHEET ,   OTHER }

Public Member Functions
	EMBEDDED_FILE ()
bool	Validate ()
wxString	GetLink () const

Public Attributes
wxString	name
FILE_TYPE	type
bool	is_valid
std::string	compressedEncodedData
std::vector< char >	decompressedData
std::string	data_sha

Detailed Description

Definition at line 36 of file embedded_files.h.

Member Enumeration Documentation

FILE_TYPE

enum class EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE

strong

Enumerator
FONT
MODEL
WORKSHEET
DATASHEET
OTHER

Definition at line 38 of file embedded_files.h.

Constructor & Destructor Documentation

EMBEDDED_FILE()

EMBEDDED_FILES::EMBEDDED_FILE::EMBEDDED_FILE ( )

inline

Definition at line 47 of file embedded_files.h.

Member Function Documentation

GetLink()

wxString EMBEDDED_FILES::EMBEDDED_FILE::GetLink ( ) const

inline

Definition at line 61 of file embedded_files.h.

References FILEEXT::KiCadUriPrefix, and name.

Referenced by EMBEDDED_FILES::GetEmbeddedFileLink(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), PANEL_EMBEDDED_FILES::onAddEmbeddedFile(), TEXT_BUTTON_URL::OnButtonClick(), and DIALOG_PAGES_SETTINGS::OnWksFileSelection().

Validate()

bool EMBEDDED_FILES::EMBEDDED_FILE::Validate ( )

inline

Definition at line 52 of file embedded_files.h.

References data_sha, decompressedData, and is_valid.

Member Data Documentation

compressedEncodedData

std::string EMBEDDED_FILES::EMBEDDED_FILE::compressedEncodedData

Definition at line 69 of file embedded_files.h.

Referenced by EMBEDDED_FILES::CompressAndEncode(), EMBEDDED_FILES::DecompressAndDecode(), SCH_SCREEN::FixupEmbeddedData(), BOARD::FixupEmbeddedData(), and EMBEDDED_FILES::WriteEmbeddedFiles().

data_sha

std::string EMBEDDED_FILES::EMBEDDED_FILE::data_sha

Definition at line 71 of file embedded_files.h.

Referenced by BOOST_AUTO_TEST_CASE(), EMBEDDED_FILES::CompressAndEncode(), EMBEDDED_FILES::DecompressAndDecode(), SCH_SCREEN::FixupEmbeddedData(), BOARD::FixupEmbeddedData(), Validate(), and EMBEDDED_FILES::WriteEmbeddedFiles().

decompressedData

std::vector<char> EMBEDDED_FILES::EMBEDDED_FILE::decompressedData

Definition at line 70 of file embedded_files.h.

Referenced by BOOST_AUTO_TEST_CASE(), EMBEDDED_FILES::CompressAndEncode(), ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), EMBEDDED_FILES::DecompressAndDecode(), SCH_SCREEN::FixupEmbeddedData(), BOARD::FixupEmbeddedData(), ALTIUM_PCB::ParseComponentsBodies6Data(), and Validate().

is_valid

bool EMBEDDED_FILES::EMBEDDED_FILE::is_valid

Definition at line 68 of file embedded_files.h.

Referenced by SCH_SCREEN::FixupEmbeddedData(), BOARD::FixupEmbeddedData(), and Validate().

name

wxString EMBEDDED_FILES::EMBEDDED_FILE::name

Definition at line 66 of file embedded_files.h.

Referenced by EMBEDDED_FILES::AddFile(), BOOST_AUTO_TEST_CASE(), ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), EMBEDDED_FILES::DecompressAndDecode(), GetLink(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), ALTIUM_PCB::ParseComponentsBodies6Data(), and EMBEDDED_FILES::WriteEmbeddedFiles().

type

FILE_TYPE EMBEDDED_FILES::EMBEDDED_FILE::type

Definition at line 67 of file embedded_files.h.

Referenced by ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), LIB_SYMBOL::EmbedFonts(), BOARD::EmbedFonts(), FOOTPRINT::EmbedFonts(), and EMBEDDED_FILES::WriteEmbeddedFiles().

---

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

• embedded_files.h