Handle the graphic items list to draw/plot the frame and title block. More...

#include <ds_data_model.h>

Public Member Functions
	DS_DATA_MODEL ()

	~DS_DATA_MODEL ()

int	GetFileFormatVersionAtLoad ()

void	SetFileFormatVersionAtLoad (int aVersion)

double	GetLeftMargin ()

void	SetLeftMargin (double aMargin)

double	GetRightMargin ()

void	SetRightMargin (double aMargin)

double	GetTopMargin ()

void	SetTopMargin (double aMargin)

double	GetBottomMargin ()

void	SetBottomMargin (double aMargin)

void	SetupDrawEnvironment (const PAGE_INFO &aPageInfo, double aMilsToIU)

void	AllowVoidList (bool Allow)
	In KiCad applications, a drawing sheet is needed So if the list is empty, a default drawing sheet is loaded, the first time it is drawn. More...

bool	VoidListAllowed ()

void	ClearList ()
	Erase the list of items. More...

void	Save (const wxString &aFullFileName)
	Save the description in a file. More...

void	SaveInString (wxString *aOutputString)
	Save the description in a buffer. More...

void	SaveInString (std::vector< DS_DATA_ITEM * > &aItemsList, wxString *aOutputString)
	Fill the given string with an S-expr serialization of the WS_DATA_ITEMs. More...

void	Append (DS_DATA_ITEM *aItem)

void	Remove (DS_DATA_ITEM *aItem)

DS_DATA_ITEM *	GetItem (unsigned aIdx) const

std::vector< DS_DATA_ITEM * > &	GetItems ()

unsigned	GetCount () const

void	SetDefaultLayout ()

void	SetEmptyLayout ()

bool	LoadDrawingSheet (const wxString &aFullFileName=wxEmptyString, bool Append=false)
	Populates the list with a custom layout or the default layout if no custom layout is available. More...

void	SetPageLayout (const char *aPageLayout, bool aAppend=false, const wxString &aSource=wxT("Sexpr_string"))
	Populate the list from a S expr description stored in a string. More...

Static Public Member Functions
static DS_DATA_MODEL &	GetTheInstance ()
	static function: returns the instance of DS_DATA_MODEL used in the application More...

static void	SetAltInstance (DS_DATA_MODEL *aLayout=nullptr)
	Set an alternate instance of DS_DATA_MODEL. More...

static wxString	EmptyLayout ()
	Return a string containing the empty layout shape. More...

static wxString	DefaultLayout ()
	Return a string containing the empty layout shape. More...

static const wxString	ResolvePath (const wxString &aPath, const wxString &aProjectPath)
	Resolve a path which might be project-relative or contain env variable references. More...

Public Attributes
double	m_WSunits2Iu

VECTOR2D	m_RB_Corner

VECTOR2D	m_LT_Corner

double	m_DefaultLineWidth

VECTOR2D	m_DefaultTextSize

double	m_DefaultTextThickness

bool	m_EditMode

Private Attributes
std::vector< DS_DATA_ITEM * >	m_list

bool	m_allowVoidList

int	m_fileFormatVersionAtLoad

double	m_leftMargin

double	m_rightMargin

double	m_topMargin

double	m_bottomMargin

Detailed Description

Handle the graphic items list to draw/plot the frame and title block.

Definition at line 38 of file ds_data_model.h.

Constructor & Destructor Documentation

◆ DS_DATA_MODEL()

DS_DATA_MODEL::DS_DATA_MODEL ( )

Definition at line 60 of file ds_data_model.cpp.

References m_allowVoidList, m_bottomMargin, m_fileFormatVersionAtLoad, m_leftMargin, m_rightMargin, and m_topMargin.

◆ ~DS_DATA_MODEL()

DS_DATA_MODEL::~DS_DATA_MODEL ( )

inline

Definition at line 43 of file ds_data_model.h.

References ClearList().

Member Function Documentation

◆ AllowVoidList()

void DS_DATA_MODEL::AllowVoidList ( bool Allow )

inline

In KiCad applications, a drawing sheet is needed So if the list is empty, a default drawing sheet is loaded, the first time it is drawn.

However, in drawing sheet editor an empty list is acceptable. AllowVoidList allows or not the empty list

Definition at line 83 of file ds_data_model.h.

References m_allowVoidList.

Referenced by PL_EDITOR_FRAME::Files_io(), DRAWING_SHEET_PARSER::parseSetup(), and PL_EDITOR_FRAME::PL_EDITOR_FRAME().

◆ Append()

void DS_DATA_MODEL::Append ( DS_DATA_ITEM * aItem )

Definition at line 127 of file ds_data_model.cpp.

References m_list.

Referenced by PL_EDITOR_FRAME::AddDrawingSheetItem(), LoadDrawingSheet(), DRAWING_SHEET_PARSER::Parse(), and SetPageLayout().

◆ ClearList()

void DS_DATA_MODEL::ClearList ( )

Erase the list of items.

Definition at line 118 of file ds_data_model.cpp.

References m_list.

Referenced by PL_EDITOR_FRAME::doCloseWindow(), PL_EDITOR_FRAME::Files_io(), LoadDrawingSheet(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), SetPageLayout(), and ~DS_DATA_MODEL().

◆ DefaultLayout()

wxString DS_DATA_MODEL::DefaultLayout ( )

static

Return a string containing the empty layout shape.

Definition at line 904 of file drawing_sheet_parser.cpp.

References defaultDrawingSheet.

◆ EmptyLayout()

wxString DS_DATA_MODEL::EmptyLayout ( )

static

Return a string containing the empty layout shape.

Definition at line 919 of file drawing_sheet_parser.cpp.

References emptyDrawingSheet.

◆ GetBottomMargin()

double DS_DATA_MODEL::GetBottomMargin ( )

inline

Definition at line 72 of file ds_data_model.h.

References m_bottomMargin.

Referenced by PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), DS_DATA_MODEL_IO::Format(), and SetupDrawEnvironment().

◆ GetCount()

unsigned DS_DATA_MODEL::GetCount ( ) const

inline

Returns: the item count.

Definition at line 130 of file ds_data_model.h.

References m_list.

Referenced by DS_DRAW_ITEM_LIST::BuildDrawItemsList(), and DS_DATA_MODEL_IO::Format().

◆ GetFileFormatVersionAtLoad()

int DS_DATA_MODEL::GetFileFormatVersionAtLoad ( )

inline

Definition at line 60 of file ds_data_model.h.

References m_fileFormatVersionAtLoad.

◆ GetItem()

DS_DATA_ITEM * DS_DATA_MODEL::GetItem ( unsigned aIdx ) const

Returns: is the item from its index aIdx, or NULL if does not exist.

Definition at line 140 of file ds_data_model.cpp.

References m_list.

Referenced by DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), DS_DATA_MODEL_IO::Format(), and DS_PROXY_UNDO_ITEM::Restore().

◆ GetItems()

std::vector< DS_DATA_ITEM * > & DS_DATA_MODEL::GetItems ( )

inline

Returns: a reference to the items.

Definition at line 125 of file ds_data_model.h.

References m_list.

Referenced by DS_DRAW_ITEM_LIST::BuildDrawItemsList(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), PL_EDIT_TOOL::Paste(), PL_EDITOR_FRAME::PrintPage(), PLEDITOR_PRINTOUT::PrintPage(), DIALOG_INSPECTOR::ReCreateDesignList(), and DS_PROXY_UNDO_ITEM::Restore().

◆ GetLeftMargin()

double DS_DATA_MODEL::GetLeftMargin ( )

inline

Definition at line 63 of file ds_data_model.h.

References m_leftMargin.

Referenced by PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), DS_DATA_MODEL_IO::Format(), and SetupDrawEnvironment().

◆ GetRightMargin()

double DS_DATA_MODEL::GetRightMargin ( )

inline

Definition at line 66 of file ds_data_model.h.

References m_rightMargin.

Referenced by PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), DS_DATA_MODEL_IO::Format(), and SetupDrawEnvironment().

◆ GetTheInstance()

DS_DATA_MODEL & DS_DATA_MODEL::GetTheInstance ( )

static

static function: returns the instance of DS_DATA_MODEL used in the application

Definition at line 78 of file ds_data_model.cpp.

References wksAltInstance, and wksTheInstance.

◆ GetTopMargin()

double DS_DATA_MODEL::GetTopMargin ( )

inline

Definition at line 69 of file ds_data_model.h.

References m_topMargin.

Referenced by PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), DS_DATA_MODEL_IO::Format(), and SetupDrawEnvironment().

◆ LoadDrawingSheet()

bool DS_DATA_MODEL::LoadDrawingSheet	(	const wxString &	aFullFileName = `wxEmptyString`,
		bool	Append = `false`
	)

Populates the list with a custom layout or the default layout if no custom layout is available.

Parameters

aFullFileName	is the custom drawing sheet file. If empty, load the file defined by KICAD_WKSFILE and if its not defined, the default internal drawing sheet.
Append	if true: do not delete old layout, and load only aFullFileName.

Definition at line 947 of file drawing_sheet_parser.cpp.

References _, Append(), ClearList(), DRAWING_SHEET_PARSER::Parse(), SetDefaultLayout(), and IO_ERROR::What().

Referenced by DS_DRAW_ITEM_LIST::BuildDrawItemsList(), PL_EDITOR_FRAME::InsertDrawingSheetFile(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ Remove()

void DS_DATA_MODEL::Remove ( DS_DATA_ITEM * aItem )

Definition at line 133 of file ds_data_model.cpp.

References m_list.

Referenced by PL_EDIT_TOOL::DoDelete().

◆ ResolvePath()

const wxString DS_DATA_MODEL::ResolvePath	(	const wxString &	aPath,
		const wxString &	aProjectPath
	)

static

Resolve a path which might be project-relative or contain env variable references.

Definition at line 149 of file ds_data_model.cpp.

References ExpandEnvVarSubstitutions(), Kiface(), KIFACE_BASE::KifaceSearch(), and name.

Referenced by EESCHEMA_JOBS_HANDLER::InitRenderSettings(), LoadBoard(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_PAGES_SETTINGS::SavePageSettings(), and SCH_EDIT_FRAME::saveProjectSettings().

◆ Save()

void DS_DATA_MODEL::Save ( const wxString & aFullFileName )

Save the description in a file.

Parameters

aFullFileName the filename of the file to created.

Definition at line 138 of file ds_data_model_io.cpp.

References DS_DATA_MODEL_IO::Format().

Referenced by PL_EDITOR_FRAME::SaveDrawingSheetFile(), and SCH_EDIT_FRAME::saveProjectSettings().

◆ SaveInString() [1/2]

void DS_DATA_MODEL::SaveInString	(	std::vector< DS_DATA_ITEM * > &	aItemsList,
		wxString *	aOutputString
	)

Fill the given string with an S-expr serialization of the WS_DATA_ITEMs.

Definition at line 152 of file ds_data_model_io.cpp.

References DS_DATA_MODEL_IO::Format().

◆ SaveInString() [2/2]

void DS_DATA_MODEL::SaveInString ( wxString * aOutputString )

Save the description in a buffer.

Parameters

aOutputString is a wxString to store the S expr string

Definition at line 145 of file ds_data_model_io.cpp.

References DS_DATA_MODEL_IO::Format().

Referenced by PL_EDIT_TOOL::Copy(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), and DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM().

◆ SetAltInstance()

void DS_DATA_MODEL::SetAltInstance ( DS_DATA_MODEL * aLayout = nullptr )

static

Set an alternate instance of DS_DATA_MODEL.

static function: Set an alternate instance of DS_DATA_MODEL mainly used in page setting dialog

Parameters

aLayout	the alternate drawing sheet; if null restore the default drawing sheet
aLayout	= the alternate drawing sheet. if null, restore the basic drawing sheet

Definition at line 92 of file ds_data_model.cpp.

References wksAltInstance.

Referenced by DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ SetBottomMargin()

void DS_DATA_MODEL::SetBottomMargin ( double aMargin )

inline

Definition at line 73 of file ds_data_model.h.

References m_bottomMargin.

Referenced by PROPERTIES_FRAME::CopyPrmsFromPanelToGeneral(), and DRAWING_SHEET_PARSER::parseSetup().

◆ SetDefaultLayout()

void DS_DATA_MODEL::SetDefaultLayout ( )

Definition at line 898 of file drawing_sheet_parser.cpp.

References defaultDrawingSheet, and SetPageLayout().

Referenced by LoadDrawingSheet().

◆ SetEmptyLayout()

void DS_DATA_MODEL::SetEmptyLayout ( )

Definition at line 913 of file drawing_sheet_parser.cpp.

References emptyDrawingSheet, and SetPageLayout().

Referenced by SCH_EDIT_FRAME::importFile().

◆ SetFileFormatVersionAtLoad()

void DS_DATA_MODEL::SetFileFormatVersionAtLoad ( int aVersion )

inline

Definition at line 61 of file ds_data_model.h.

References m_fileFormatVersionAtLoad.

Referenced by DRAWING_SHEET_PARSER::Parse().

◆ SetLeftMargin()

void DS_DATA_MODEL::SetLeftMargin ( double aMargin )

inline

Definition at line 64 of file ds_data_model.h.

References m_leftMargin.

Referenced by PROPERTIES_FRAME::CopyPrmsFromPanelToGeneral(), and DRAWING_SHEET_PARSER::parseSetup().

◆ SetPageLayout()

void DS_DATA_MODEL::SetPageLayout	(	const char *	aPageLayout,
		bool	aAppend = `false`,
		const wxString &	aSource = `wxT( "Sexpr_string" )`
	)

Populate the list from a S expr description stored in a string.

Parameters

aPageLayout	is the S expr string.
aAppend	Do not delete old layout if true and append aPageLayout the existing one.
aSource	is the layout source description.

Definition at line 925 of file drawing_sheet_parser.cpp.

References Append(), ClearList(), DRAWING_SHEET_PARSER::Parse(), and IO_ERROR::What().

Referenced by DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), PL_EDIT_TOOL::Paste(), DS_PROXY_UNDO_ITEM::Restore(), SetDefaultLayout(), and SetEmptyLayout().