KiCad PCB EDA Suite
Loading...
Searching...
No Matches
HISTORY_FILE_DATA Struct Reference

Data produced by a registered saver on the UI thread, consumed by the background commit thread. More...

#include <local_history.h>

Public Attributes

wxString path
 Destination inside .history/.
 
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 the background commit thread.

Each entry represents one file to write into the .history mirror.

Definition at line 46 of file local_history.h.

Member Data Documentation

◆ content

std::string HISTORY_FILE_DATA::content

Serialized content (mutually exclusive with sourcePath)

Definition at line 49 of file local_history.h.

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

◆ formatMode

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

Definition at line 52 of file local_history.h.

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

◆ path

wxString HISTORY_FILE_DATA::path

Destination inside .history/.

Definition at line 48 of file local_history.h.

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

◆ prettify

bool HISTORY_FILE_DATA::prettify = false

Definition at line 51 of file local_history.h.

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

◆ sourcePath

wxString HISTORY_FILE_DATA::sourcePath

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

Definition at line 50 of file local_history.h.

Referenced by PROJECT::SaveToHistory().


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