HISTORY_FILE_DATA Struct Reference

Data produced by a registered saver on the UI thread, consumed by either the background local-history commit thread or the foreground autosave-file writer. More...

#include <local_history.h>

Public Attributes
wxString	relativePath
	Destination path relative to the project root.
std::string	content
	Serialized content (mutually exclusive with sourcePath)
wxString	sourcePath
	For file-copy savers (small files like .kicad_pro)
bool	prettify = false
KICAD_FORMAT::FORMAT_MODE	formatMode = KICAD_FORMAT::FORMAT_MODE::NORMAL

Detailed Description

Data produced by a registered saver on the UI thread, consumed by either the background local-history commit thread or the foreground autosave-file writer.

Each entry represents one file to write. The dispatcher joins relativePath to a destination root chosen by the active backup format and location preferences.

Definition at line 50 of file local_history.h.

Member Data Documentation

content

std::string HISTORY_FILE_DATA::content

Serialized content (mutually exclusive with sourcePath)

Definition at line 53 of file local_history.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOARD::SaveToHistory(), and SCHEMATIC::SaveToHistory().

formatMode

KICAD_FORMAT::FORMAT_MODE HISTORY_FILE_DATA::formatMode = KICAD_FORMAT::FORMAT_MODE::NORMAL

Definition at line 56 of file local_history.h.

Referenced by BOARD::SaveToHistory(), and SCHEMATIC::SaveToHistory().

prettify

bool HISTORY_FILE_DATA::prettify = false

Definition at line 55 of file local_history.h.

Referenced by BOARD::SaveToHistory(), and SCHEMATIC::SaveToHistory().

relativePath

wxString HISTORY_FILE_DATA::relativePath

Destination path relative to the project root.

Definition at line 52 of file local_history.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOARD::SaveToHistory(), PROJECT::SaveToHistory(), and SCHEMATIC::SaveToHistory().

sourcePath

wxString HISTORY_FILE_DATA::sourcePath

For file-copy savers (small files like .kicad_pro)

Definition at line 54 of file local_history.h.

Referenced by PROJECT::SaveToHistory().

---

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

• local_history.h