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.

bool	VoidListAllowed ()

void	ClearList ()
	Erase the list of items.

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

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

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

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, wxString *aMsg, bool aAppend=false)
	Populate the list with a custom layout or the default layout if no custom layout is available.

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.

Static Public Member Functions
static DS_DATA_MODEL &	GetTheInstance ()
	Return the instance of DS_DATA_MODEL used in the application.

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

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

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

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

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 34 of file ds_data_model.h.

Constructor & Destructor Documentation

◆ DS_DATA_MODEL()

DS_DATA_MODEL::DS_DATA_MODEL ( )

Definition at line 56 of file ds_data_model.cpp.

References m_allowVoidList, m_bottomMargin, m_DefaultLineWidth, m_DefaultTextSize, m_DefaultTextThickness, m_EditMode, m_fileFormatVersionAtLoad, m_leftMargin, m_rightMargin, m_topMargin, m_WSunits2Iu, and TB_DEFAULT_TEXTSIZE.

Referenced by GetTheInstance(), and SetAltInstance().

◆ ~DS_DATA_MODEL()

DS_DATA_MODEL::~DS_DATA_MODEL ( )

inline

Definition at line 39 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 79 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 116 of file ds_data_model.cpp.

References m_list.

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

◆ ClearList()

void DS_DATA_MODEL::ClearList ( )

Erase the list of items.

Definition at line 107 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 926 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 943 of file drawing_sheet_parser.cpp.

References emptyDrawingSheet.

◆ GetBottomMargin()

double DS_DATA_MODEL::GetBottomMargin ( )

inline

Definition at line 68 of file ds_data_model.h.

References m_bottomMargin.

Referenced by DS_DATA_MODEL_IO::Format(), AUTOPLACER::getDrawableArea(), and SetupDrawEnvironment().

◆ GetCount()

unsigned DS_DATA_MODEL::GetCount ( ) const

inline

Returns: the item count.

Definition at line 126 of file ds_data_model.h.

References m_list.

Referenced by DS_DATA_MODEL_IO::Format().

◆ GetFileFormatVersionAtLoad()

int DS_DATA_MODEL::GetFileFormatVersionAtLoad ( )

inline

Definition at line 56 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 129 of file ds_data_model.cpp.

References m_list.

Referenced by 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 121 of file ds_data_model.h.

References m_list.

Referenced by DIALOG_INSPECTOR::ReCreateDesignList(), and DS_PROXY_UNDO_ITEM::Restore().

◆ GetLeftMargin()

double DS_DATA_MODEL::GetLeftMargin ( )

inline

Definition at line 59 of file ds_data_model.h.

References m_leftMargin.

Referenced by DS_DATA_MODEL_IO::Format(), AUTOPLACER::getDrawableArea(), and SetupDrawEnvironment().

◆ GetRightMargin()

double DS_DATA_MODEL::GetRightMargin ( )

inline

Definition at line 62 of file ds_data_model.h.

References m_rightMargin.

Referenced by DS_DATA_MODEL_IO::Format(), AUTOPLACER::getDrawableArea(), and SetupDrawEnvironment().

◆ GetTheInstance()

DS_DATA_MODEL & DS_DATA_MODEL::GetTheInstance ( )

static

Return the instance of DS_DATA_MODEL used in the application.

Definition at line 72 of file ds_data_model.cpp.

References DS_DATA_MODEL(), wksAltInstance, and wksTheInstance.

Referenced by PL_EDITOR_FRAME::AddDrawingSheetItem(), BOOST_AUTO_TEST_CASE(), DS_DRAW_ITEM_LIST::BuildDrawItemsList(), DS_PROXY_VIEW_ITEM::CollectTextVarKeys(), PL_EDIT_TOOL::Copy(), PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), PROPERTIES_FRAME::CopyPrmsFromPanelToGeneral(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), PL_EDITOR_FRAME::doCloseWindow(), PL_EDIT_TOOL::DoDelete(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), PL_EDITOR_FRAME::Files_io(), DS_DATA_ITEM_POLYGONS::GetCornerPositionIU(), AUTOPLACER::getDrawableArea(), DS_DATA_ITEM::GetEndPos(), DS_DATA_ITEM::GetEndPosIU(), DS_DATA_ITEM::GetPenSizeIU(), DS_DATA_ITEM_POLYGONS::GetPenSizeIU(), DS_DATA_ITEM_TEXT::GetPenSizeIU(), DS_DATA_ITEM::GetStartPos(), DS_DATA_ITEM::GetStartPosIU(), SCH_EDIT_FRAME::importFile(), BOARD_LOADER::initializeLoadedBoard(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), PL_EDITOR_FRAME::InsertDrawingSheetFile(), PL_EDIT_TOOL::InteractiveDelete(), DS_DATA_ITEM::IsInsidePage(), DS_DATA_ITEM_POLYGONS::IsInsidePage(), PCB_EDIT_FRAME::LoadDrawingSheet(), SCH_EDIT_FRAME::LoadDrawingSheet(), PL_EDITOR_FRAME::LoadDrawingSheetFile(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), DS_DATA_ITEM::MoveEndPointTo(), DS_DATA_ITEM::MoveEndPointToIU(), DS_DATA_ITEM::MoveStartPointTo(), DS_DATA_ITEM::MoveStartPointToIU(), DS_DATA_ITEM::MoveToIU(), PROPERTIES_FRAME::OnSetDefaultValues(), PL_EDIT_TOOL::Paste(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PLEDITOR_PRINTOUT::PrintPage(), PL_SELECTION_TOOL::RebuildSelection(), DIALOG_INSPECTOR::ReCreateDesignList(), DS_PROXY_UNDO_ITEM::Restore(), PL_EDITOR_FRAME::SaveDrawingSheetFile(), DIALOG_PAGES_SETTINGS::SavePageSettings(), SCH_EDIT_FRAME::saveProjectSettings(), PL_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), DS_DATA_ITEM_TEXT::SetConstrainedTextSize(), PL_EDITOR_FRAME::setupUIConditions(), DS_DATA_ITEM_TEXT::SyncDrawItems(), and PL_EDITOR_CONTROL::TitleBlockDisplayMode().

◆ GetTopMargin()

double DS_DATA_MODEL::GetTopMargin ( )

inline

Definition at line 65 of file ds_data_model.h.

References m_topMargin.

Referenced by DS_DATA_MODEL_IO::Format(), AUTOPLACER::getDrawableArea(), and SetupDrawEnvironment().

◆ LoadDrawingSheet()

bool DS_DATA_MODEL::LoadDrawingSheet	(	const wxString &	aFullFileName,
		wxString *	aMsg,
		bool	aAppend = false )

Populate 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.
aMsg	[optional] if non-null, will be filled with any error messages.
aAppend	if true: do not delete old layout, and load only aFullFileName.

Definition at line 967 of file drawing_sheet_parser.cpp.

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

Referenced by PL_EDITOR_FRAME::InsertDrawingSheetFile(), and PL_EDITOR_FRAME::PL_EDITOR_FRAME().

◆ Remove()

void DS_DATA_MODEL::Remove ( DS_DATA_ITEM * aItem )

Definition at line 122 of file ds_data_model.cpp.

References m_list.

Referenced by PL_EDIT_TOOL::DoDelete().

◆ ResolvePath()

static 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.

◆ 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_FILEIO::Finish(), and 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 153 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 146 of file ds_data_model_io.cpp.

References DS_DATA_MODEL_IO::Format().

Referenced by DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS().

◆ SetAltInstance()

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

static

Set an alternate instance of DS_DATA_MODEL.

Parameters

aLayout the alternate drawing sheet; if null restore the default drawing sheet.

Definition at line 81 of file ds_data_model.cpp.

References DS_DATA_MODEL(), and wksAltInstance.

Referenced by DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ SetBottomMargin()

void DS_DATA_MODEL::SetBottomMargin ( double aMargin )

inline

Definition at line 69 of file ds_data_model.h.

References m_bottomMargin.

Referenced by DRAWING_SHEET_PARSER::parseSetup().

◆ SetDefaultLayout()

void DS_DATA_MODEL::SetDefaultLayout ( )

Definition at line 920 of file drawing_sheet_parser.cpp.

References defaultDrawingSheet, and SetPageLayout().

Referenced by LoadDrawingSheet().

◆ SetEmptyLayout()

void DS_DATA_MODEL::SetEmptyLayout ( )

Definition at line 937 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 57 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 60 of file ds_data_model.h.

References m_leftMargin.

Referenced by 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 949 of file drawing_sheet_parser.cpp.

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

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

◆ SetRightMargin()

void DS_DATA_MODEL::SetRightMargin ( double aMargin )

inline

Definition at line 63 of file ds_data_model.h.

References m_rightMargin.

Referenced by DRAWING_SHEET_PARSER::parseSetup().

◆ SetTopMargin()

void DS_DATA_MODEL::SetTopMargin ( double aMargin )

inline

Definition at line 66 of file ds_data_model.h.

References m_topMargin.

Referenced by DRAWING_SHEET_PARSER::parseSetup().

◆ SetupDrawEnvironment()

void DS_DATA_MODEL::SetupDrawEnvironment	(	const PAGE_INFO &	aPageInfo,
		double	aMilsToIU )

Definition at line 87 of file ds_data_model.cpp.

References GetBottomMargin(), GetLeftMargin(), GetRightMargin(), PAGE_INFO::GetSizeMils(), GetTopMargin(), m_LT_Corner, m_RB_Corner, m_WSunits2Iu, MILS_TO_MM, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ VoidListAllowed()

bool DS_DATA_MODEL::VoidListAllowed ( )

inline

Returns: true if an empty list is allowed

Definition at line 84 of file ds_data_model.h.

References m_allowVoidList.

Member Data Documentation

◆ m_allowVoidList

bool DS_DATA_MODEL::m_allowVoidList

private

Definition at line 184 of file ds_data_model.h.

Referenced by AllowVoidList(), DS_DATA_MODEL(), and VoidListAllowed().

◆ m_bottomMargin

double DS_DATA_MODEL::m_bottomMargin

private

Definition at line 191 of file ds_data_model.h.

Referenced by DS_DATA_MODEL(), GetBottomMargin(), and SetBottomMargin().

◆ m_DefaultLineWidth

double DS_DATA_MODEL::m_DefaultLineWidth

Definition at line 173 of file ds_data_model.h.

Referenced by DS_DATA_MODEL(), DS_DATA_MODEL_IO::Format(), DS_DATA_MODEL_IO::format(), and DRAWING_SHEET_PARSER::parseSetup().

◆ m_DefaultTextSize

VECTOR2D DS_DATA_MODEL::m_DefaultTextSize

Definition at line 174 of file ds_data_model.h.

Referenced by DS_DATA_MODEL(), DS_DATA_MODEL_IO::Format(), DRAWING_SHEET_PARSER::parseSetup(), and DS_DATA_ITEM_TEXT::SetConstrainedTextSize().

◆ m_DefaultTextThickness

double DS_DATA_MODEL::m_DefaultTextThickness

Definition at line 175 of file ds_data_model.h.

Referenced by DS_DATA_MODEL(), DS_DATA_MODEL_IO::Format(), and DRAWING_SHEET_PARSER::parseSetup().

◆ m_EditMode

bool DS_DATA_MODEL::m_EditMode

Definition at line 176 of file ds_data_model.h.

Referenced by DS_DATA_MODEL(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PL_EDITOR_FRAME::setupUIConditions(), and PL_EDITOR_CONTROL::TitleBlockDisplayMode().

◆ m_fileFormatVersionAtLoad

int DS_DATA_MODEL::m_fileFormatVersionAtLoad

private

Definition at line 187 of file ds_data_model.h.

Referenced by DS_DATA_MODEL(), GetFileFormatVersionAtLoad(), and SetFileFormatVersionAtLoad().

◆ m_leftMargin

double DS_DATA_MODEL::m_leftMargin

private

Definition at line 188 of file ds_data_model.h.

Referenced by DS_DATA_MODEL(), GetLeftMargin(), and SetLeftMargin().

◆ m_list

std::vector<DS_DATA_ITEM*> DS_DATA_MODEL::m_list

private

Definition at line 183 of file ds_data_model.h.

Referenced by Append(), ClearList(), GetCount(), GetItem(), GetItems(), and Remove().

◆ m_LT_Corner

VECTOR2D DS_DATA_MODEL::m_LT_Corner

Definition at line 172 of file ds_data_model.h.

Referenced by DS_DATA_ITEM::GetEndPos(), and SetupDrawEnvironment().

◆ m_RB_Corner

VECTOR2D DS_DATA_MODEL::m_RB_Corner

Definition at line 171 of file ds_data_model.h.

Referenced by DS_DATA_ITEM::GetEndPos(), and SetupDrawEnvironment().

◆ m_rightMargin

double DS_DATA_MODEL::m_rightMargin

private

Definition at line 189 of file ds_data_model.h.

Referenced by DS_DATA_MODEL(), GetRightMargin(), and SetRightMargin().

◆ m_topMargin

double DS_DATA_MODEL::m_topMargin

private

Definition at line 190 of file ds_data_model.h.

Referenced by DS_DATA_MODEL(), GetTopMargin(), and SetTopMargin().

◆ m_WSunits2Iu

double DS_DATA_MODEL::m_WSunits2Iu

Definition at line 169 of file ds_data_model.h.

Referenced by DS_DATA_MODEL(), DS_DATA_ITEM_POLYGONS::GetCornerPositionIU(), DS_DATA_ITEM::GetEndPosIU(), DS_DATA_ITEM::MoveEndPointToIU(), DS_DATA_ITEM::MoveToIU(), SetupDrawEnvironment(), and DS_DATA_ITEM_TEXT::SyncDrawItems().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DS_DATA_MODEL()

◆ ~DS_DATA_MODEL()

Member Function Documentation

◆ AllowVoidList()

◆ Append()

◆ ClearList()

◆ DefaultLayout()

◆ EmptyLayout()

◆ GetBottomMargin()

◆ GetCount()

◆ GetFileFormatVersionAtLoad()

◆ GetItem()

◆ GetItems()

◆ GetLeftMargin()

◆ GetRightMargin()

◆ GetTheInstance()

◆ GetTopMargin()

◆ LoadDrawingSheet()

◆ Remove()

◆ ResolvePath()

◆ Save()

◆ SaveInString() [1/2]

◆ SaveInString() [2/2]

◆ SetAltInstance()

◆ SetBottomMargin()

◆ SetDefaultLayout()

◆ SetEmptyLayout()

◆ SetFileFormatVersionAtLoad()

◆ SetLeftMargin()

◆ SetPageLayout()

◆ SetRightMargin()

◆ SetTopMargin()

◆ SetupDrawEnvironment()

◆ VoidListAllowed()

Member Data Documentation

◆ m_allowVoidList

◆ m_bottomMargin

◆ m_DefaultLineWidth

◆ m_DefaultTextSize

◆ m_DefaultTextThickness

◆ m_EditMode

◆ m_fileFormatVersionAtLoad

◆ m_leftMargin

◆ m_list

◆ m_LT_Corner

◆ m_RB_Corner

◆ m_rightMargin

◆ m_topMargin

◆ m_WSunits2Iu