Describe the page size and margins of a paper page on which to eventually print or plot. More...

#include <page_info.h>

Public Member Functions
	PAGE_INFO (const wxString &aType=PAGE_INFO::A3, bool IsPortrait=false)

bool	SetType (const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
	Set the name of the page type and also the sizes and margins commonly associated with that type name. More...

const wxString &	GetType () const

bool	IsDefault () const

bool	IsCustom () const

void	SetPortrait (bool aIsPortrait)
	Rotate the paper page 90 degrees. More...

bool	IsPortrait () const

wxPrintOrientation	GetWxOrientation () const

wxPaperSize	GetPaperId () const

void	SetWidthMils (int aWidthInMils)

int	GetWidthMils () const

void	SetHeightMils (int aHeightInMils)

int	GetHeightMils () const

const VECTOR2I &	GetSizeMils () const

int	GetWidthIU (double aIUScale) const
	Gets the page width in IU. More...

int	GetHeightIU (double aIUScale) const
	Gets the page height in IU. More...

const VECTOR2I	GetSizeIU (double aIUScale) const
	Gets the page size in internal units. More...

void	Format (OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
	Output the page class to aFormatter in s-expression form. More...

Static Public Member Functions
static void	SetCustomWidthMils (int aWidthInMils)
	Set the width of Custom page in mils for any custom page constructed or made via SetType() after making this call. More...

static void	SetCustomHeightMils (int aHeightInMils)
	Set the height of Custom page in mils for any custom page constructed or made via SetType() after making this call. More...

static int	GetCustomWidthMils ()

static int	GetCustomHeightMils ()

Static Public Attributes
static const wxChar	A5 [] = wxT( "A5" )

static const wxChar	A4 [] = wxT( "A4" )

static const wxChar	A3 [] = wxT( "A3" )

static const wxChar	A2 [] = wxT( "A2" )

static const wxChar	A1 [] = wxT( "A1" )

static const wxChar	A0 [] = wxT( "A0" )

static const wxChar	A [] = wxT( "A" )

static const wxChar	B [] = wxT( "B" )

static const wxChar	C [] = wxT( "C" )

static const wxChar	D [] = wxT( "D" )

static const wxChar	E [] = wxT( "E" )

static const wxChar	GERBER [] = wxT( "GERBER" )

static const wxChar	USLetter [] = wxT( "USLetter" )

static const wxChar	USLegal [] = wxT( "USLegal" )

static const wxChar	USLedger [] = wxT( "USLedger" )

static const wxChar	Custom [] = wxT( "User" )
	"User" defined page type More...

Protected Member Functions
	PAGE_INFO (const VECTOR2I &aSizeMils, const wxString &aName, wxPaperSize aPaperId)

Private Member Functions
void	updatePortrait ()

void	setMargins ()

Private Attributes
wxString	m_type
	paper type: A4, A3, etc. More...

VECTOR2I	m_size
	mils More...

bool	m_portrait
	true if portrait, false if landscape More...

wxPaperSize	m_paper_id
	wx' style paper id. More...

Static Private Attributes
static const PAGE_INFO	pageA5

static const PAGE_INFO	pageA4

static const PAGE_INFO	pageA3

static const PAGE_INFO	pageA2

static const PAGE_INFO	pageA1

static const PAGE_INFO	pageA0

static const PAGE_INFO	pageA

static const PAGE_INFO	pageB

static const PAGE_INFO	pageC

static const PAGE_INFO	pageD

static const PAGE_INFO	pageE

static const PAGE_INFO	pageGERBER

static const PAGE_INFO	pageUSLetter

static const PAGE_INFO	pageUSLegal

static const PAGE_INFO	pageUSLedger

static const PAGE_INFO	pageUser

static int	s_user_height = 11000

static int	s_user_width = 17000

Detailed Description

Describe the page size and margins of a paper page on which to eventually print or plot.

Paper sizes are often described in inches. Here paper is described in 1/1000th of an inch (mils). For convenience there are some read only accessors for internal units which is a compile time calculation, not runtime.

Author: Dick Hollenbeck

Definition at line 53 of file page_info.h.

Constructor & Destructor Documentation

◆ PAGE_INFO() [1/2]

PAGE_INFO::PAGE_INFO	(	const wxString &	aType = `PAGE_INFO::A3`,
		bool	IsPortrait = `false`
	)

Definition at line 115 of file page_info.cpp.

{
 SetType( aType, aIsPortrait );
}

References SetType().

◆ PAGE_INFO() [2/2]

PAGE_INFO::PAGE_INFO	(	const VECTOR2I &	aSizeMils,
		const wxString &	aName,
		wxPaperSize	aPaperId
	)

protected

Definition at line 104 of file page_info.cpp.

 :
 m_type( aType ), m_size( aSizeMils ), m_paper_id( aPaperId )
{
 updatePortrait();
 
 // This constructor is protected, and only used by const PAGE_INFO's known
 // only to class implementation, so no further changes to "this" object are
 // expected.
}

References updatePortrait().

Member Function Documentation

◆ Format()

void PAGE_INFO::Format	(	OUTPUTFORMATTER *	aFormatter,
		int	aNestLevel,
		int	aControlBits
	)		const

Output the page class to aFormatter in s-expression form.

Parameters

aFormatter	The OUTPUTFORMATTER object to write to.
aNestLevel	The indentation next level.
aControlBits	The control bit definition for object specific formatting.

Exceptions

IO_ERROR on write error.

Definition at line 273 of file page_info.cpp.

{
 aFormatter->Print( aNestLevel, "(paper %s", aFormatter->Quotew( GetType() ).c_str() );
 
 // The page dimensions are only required for user defined page sizes.
 // Internally, the page size is in mils
 if( GetType() == PAGE_INFO::Custom )
 aFormatter->Print( 0, " %g %g",
 GetWidthMils() * 25.4 / 1000.0,
 GetHeightMils() * 25.4 / 1000.0 );
 
 if( !IsCustom() && IsPortrait() )
 aFormatter->Print( 0, " portrait" );
 
 aFormatter->Print( 0, ")\n" );
}

References Custom, GetHeightMils(), GetType(), GetWidthMils(), IsCustom(), IsPortrait(), OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by SCH_SEXPR_PLUGIN::Format(), and PCB_PLUGIN::formatGeneral().

◆ GetCustomHeightMils()

static int PAGE_INFO::GetCustomHeightMils ( )

inlinestatic

Returns: custom paper height in mils.

Definition at line 187 of file page_info.h.

187{ return s_user_height; }

PAGE_INFO::s_user_height

static int s_user_height

Definition: page_info.h:233

References s_user_height.

Referenced by PL_EDITOR_FRAME::SaveSettings(), and DIALOG_PAGES_SETTINGS::TransferDataToWindow().

◆ GetCustomWidthMils()

static int PAGE_INFO::GetCustomWidthMils ( )

inlinestatic

Returns: custom paper width in mils.

Definition at line 182 of file page_info.h.

182{ return s_user_width; }

PAGE_INFO::s_user_width

static int s_user_width

Definition: page_info.h:234

References s_user_width.

Referenced by PL_EDITOR_FRAME::SaveSettings(), and DIALOG_PAGES_SETTINGS::TransferDataToWindow().

◆ GetHeightIU()

int PAGE_INFO::GetHeightIU ( double aIUScale ) const

inline

Gets the page height in IU.

Parameters

aIUScale The IU scale, this is most likely always going to be IU_PER_MILS variable being passed. Note, this constexpr variable changes depending on application, hence why it is passed.

Definition at line 153 of file page_info.h.

153{ return aIUScale * GetHeightMils(); }

References GetHeightMils().

Referenced by SCH_PLOTTER::createHPGLFiles(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), SCH_EDIT_FRAME::GetDocumentExtents(), GetSizeIU(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseSheet(), SCH_PLOTTER::plotOneSheetPDF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), KIGFX::SCH_VIEW::ResizeSheetWorkingArea(), and PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview().

◆ GetHeightMils()

int PAGE_INFO::GetHeightMils ( ) const

inline

Definition at line 133 of file page_info.h.

133{ return m_size.y; }

VECTOR2::y

T y

Definition: vector2d.h:78

References m_size, and VECTOR2< T >::y.

Referenced by SCH_PLOTTER::createPSFiles(), KIGFX::DS_PAINTER::DrawBorder(), Format(), SCH_LEGACY_PLUGIN::Format(), GetHeightIU(), DIALOG_PRINT_GENERIC::initPrintData(), SCH_PLOTTER::plotOneSheetSVG(), SCH_PLOTTER::setupPlotPagePDF(), PS_PLOTTER::StartPlot(), PL_EDITOR_FRAME::ToPrinter(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::TransferDataToWindow(), and DS_PROXY_VIEW_ITEM::ViewBBox().

◆ GetPaperId()

wxPaperSize PAGE_INFO::GetPaperId ( ) const

inline

Returns: wxPrintData's style paper id associated with page type name.

Definition at line 127 of file page_info.h.

127{ return m_paper_id; }

References m_paper_id.

Referenced by DIALOG_PRINT_GENERIC::initPrintData(), PL_EDITOR_FRAME::ToPrinter(), and DIALOG_PRINT_USING_PRINTER::TransferDataToWindow().

◆ GetSizeIU()

const VECTOR2I PAGE_INFO::GetSizeIU ( double aIUScale ) const

inline

Gets the page size in internal units.

Parameters

aIUScale The IU scale, this is most likely always going to be IU_PER_MILS variable being passed. Note, this constexpr variable changes depending on application, hence why it is passed.

Definition at line 162 of file page_info.h.

 {
 return VECTOR2I( GetWidthIU( aIUScale ), GetHeightIU( aIUScale ) );
 }

References GetHeightIU(), and GetWidthIU().

Referenced by BOARD_NETLIST_UPDATER::estimateFootprintInsertionPosition(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_BASE_FRAME::GetPageSizeIU(), GERBVIEW_FRAME::GetPageSizeIU(), PCB_BASE_FRAME::GetPageSizeIU(), PL_EDITOR_FRAME::GetPageSizeIU(), initializePlotter(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), SCH_EAGLE_PLUGIN::loadSchematic(), SCH_EAGLE_PLUGIN::loadSheet(), SYMBOL_EDIT_FRAME::PrintPage(), PLEDITOR_PRINTOUT::PrintPage(), SCH_PRINTOUT::PrintPage(), SCH_SCREEN::SCH_SCREEN(), PL_EDITOR_FRAME::SetPageSettings(), GERBVIEW_FRAME::SetPageSettings(), PCB_BASE_FRAME::SetPageSettings(), and PL_EDITOR_FRAME::UpdateMsgPanelInfo().

◆ GetSizeMils()

const VECTOR2I & PAGE_INFO::GetSizeMils ( ) const

inline

Definition at line 135 of file page_info.h.

135{ return m_size; }

References m_size.

Referenced by PDF_PLOTTER::ClosePage(), BOARD_PRINTOUT::DrawPage(), DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), DS_DATA_MODEL::SetupDrawEnvironment(), HPGL_PLOTTER::SetViewport(), PS_PLOTTER::SetViewport(), SVG_PLOTTER::SetViewport(), PDF_PLOTTER::StartPage(), and PS_PLOTTER::StartPlot().

◆ GetType()

const wxString & PAGE_INFO::GetType ( ) const

inline

Definition at line 94 of file page_info.h.

94{ return m_type; }

References m_type.

Referenced by DS_DRAW_ITEM_LIST::BuildDrawItemsList(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), Format(), SCH_LEGACY_PLUGIN::Format(), DIALOG_INSPECTOR::ReCreateDesignList(), GERBVIEW_FRAME::SaveSettings(), PL_EDITOR_FRAME::SaveSettings(), SetType(), PS_PLOTTER::StartPlot(), and DIALOG_PAGES_SETTINGS::TransferDataToWindow().

◆ GetWidthIU()

int PAGE_INFO::GetWidthIU ( double aIUScale ) const

inline

Gets the page width in IU.

Parameters

aIUScale The IU scale, this is most likely always going to be IU_PER_MILS variable being passed. Note, this constexpr variable changes depending on application, hence why it is passed.

Definition at line 144 of file page_info.h.

144{ return aIUScale * GetWidthMils(); }

References GetWidthMils().

Referenced by SCH_PLOTTER::createHPGLFiles(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), SCH_EDIT_FRAME::GetDocumentExtents(), GetSizeIU(), ALTIUM_PCB::Parse(), SCH_PLOTTER::plotOneSheetPDF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), KIGFX::SCH_VIEW::ResizeSheetWorkingArea(), and PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview().

◆ GetWidthMils()

int PAGE_INFO::GetWidthMils ( ) const

inline

Definition at line 130 of file page_info.h.

130{ return m_size.x; }

VECTOR2::x

T x

Definition: vector2d.h:78

References m_size, and VECTOR2< T >::x.

Referenced by SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPSFiles(), KIGFX::DS_PAINTER::DrawBorder(), Format(), SCH_LEGACY_PLUGIN::Format(), GetWidthIU(), DIALOG_PRINT_GENERIC::initPrintData(), SCH_PLOTTER::plotOneSheetSVG(), SCH_PLOTTER::setupPlotPagePDF(), PS_PLOTTER::StartPlot(), PL_EDITOR_FRAME::ToPrinter(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::TransferDataToWindow(), DS_PROXY_VIEW_ITEM::ViewBBox(), and DS_PROXY_VIEW_ITEM::ViewDraw().

◆ GetWxOrientation()

wxPrintOrientation PAGE_INFO::GetWxOrientation ( ) const

inline

Returns: ws' style printing orientation (wxPORTRAIT or wxLANDSCAPE).

Definition at line 122 of file page_info.h.

122{ return IsPortrait() ? wxPORTRAIT : wxLANDSCAPE; }

References IsPortrait().

Referenced by DIALOG_PRINT_GENERIC::initPrintData(), PL_EDITOR_FRAME::ToPrinter(), and DIALOG_PRINT_USING_PRINTER::TransferDataToWindow().

◆ IsCustom()

bool PAGE_INFO::IsCustom ( ) const

Returns: true if the type is Custom.

Definition at line 182 of file page_info.cpp.

{
 return m_type == Custom;
}

References Custom, and m_type.

Referenced by Format(), SCH_LEGACY_PLUGIN::Format(), DIALOG_PRINT_GENERIC::initPrintData(), PS_PLOTTER::StartPlot(), PL_EDITOR_FRAME::ToPrinter(), and DIALOG_PRINT_USING_PRINTER::TransferDataToWindow().

◆ IsDefault()

bool PAGE_INFO::IsDefault ( ) const

inline

Returns: True if the object has the default page settings which are A3, landscape.

Definition at line 99 of file page_info.h.

99{ return m_type == PAGE_INFO::A3 && !m_portrait; }

PAGE_INFO::A3

static const wxChar A3[]

Definition: page_info.h:64

PAGE_INFO::m_portrait

bool m_portrait

true if portrait, false if landscape

Definition: page_info.h:229

References A3, m_portrait, and m_type.

◆ IsPortrait()

bool PAGE_INFO::IsPortrait ( ) const

inline

Definition at line 117 of file page_info.h.

117{ return m_portrait; }

References m_portrait.

Referenced by SCH_PLOTTER::createPSFiles(), Format(), SCH_LEGACY_PLUGIN::Format(), GetWxOrientation(), DIALOG_PRINT_GENERIC::initPrintData(), SCH_PLOTTER::plotOneSheetSVG(), PL_EDITOR_FRAME::SaveSettings(), SCH_PLOTTER::setupPlotPagePDF(), PS_PLOTTER::StartPlot(), PL_EDITOR_FRAME::ToPrinter(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), and DIALOG_PAGES_SETTINGS::TransferDataToWindow().

◆ SetCustomHeightMils()

void PAGE_INFO::SetCustomHeightMils ( int aHeightInMils )

static

Set the height of Custom page in mils for any custom page constructed or made via SetType() after making this call.

Definition at line 239 of file page_info.cpp.

{
 s_user_height = clampHeight( aHeightInMils );
}

References clampHeight(), and s_user_height.

Referenced by PL_EDITOR_FRAME::LoadSettings(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ SetCustomWidthMils()

void PAGE_INFO::SetCustomWidthMils ( int aWidthInMils )

static

Set the width of Custom page in mils for any custom page constructed or made via SetType() after making this call.

Definition at line 233 of file page_info.cpp.

{
 s_user_width = clampWidth( aWidthInMils );
}

References clampWidth(), and s_user_width.

Referenced by PL_EDITOR_FRAME::LoadSettings(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ SetHeightMils()

void PAGE_INFO::SetHeightMils ( int aHeightInMils )

Definition at line 259 of file page_info.cpp.

{
 if( m_size.y != aHeightInMils )
 {
 m_size.y = clampHeight( aHeightInMils );
 
 m_type = Custom;
 m_paper_id = wxPAPER_NONE;
 
 updatePortrait();
 }
}

References clampHeight(), Custom, m_paper_id, m_size, m_type, updatePortrait(), and VECTOR2< T >::y.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), SCH_LEGACY_PLUGIN::loadPageSettings(), LEGACY_PLUGIN::loadSHEET(), SCH_EAGLE_PLUGIN::loadSheet(), PCB_PARSER::parsePAGE_INFO(), SCH_SEXPR_PARSER::parsePAGE_INFO(), PCB_PLOT_SVG::Plot(), DIALOG_PAGES_SETTINGS::SavePageSettings(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ setMargins()

void PAGE_INFO::setMargins ( )

private

◆ SetPortrait()

void PAGE_INFO::SetPortrait ( bool aIsPortrait )

Rotate the paper page 90 degrees.

This PAGE_INFO may either be in portrait or landscape mode. Use this function to change from one mode to the other mode.

Parameters

aIsPortrait if true and not already in portrait mode, will change this PAGE_INFO to portrait mode. Or if false and not already in landscape mode, will change this PAGE_INFO to landscape mode.

Definition at line 188 of file page_info.cpp.

{
 if( m_portrait != aIsPortrait )
 {
 // swap x and y in m_size
 std::swap( m_size.y, m_size.x );
 
 m_portrait = aIsPortrait;
 
 // margins are not touched, do that if you want
 }
}

References m_portrait, m_size, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_PLOTTER::createPSFiles(), SCH_LEGACY_PLUGIN::loadPageSettings(), LEGACY_PLUGIN::loadSHEET(), PCB_PARSER::parsePAGE_INFO(), SCH_SEXPR_PARSER::parsePAGE_INFO(), SCH_PLOTTER::plotOneSheetSVG(), DIALOG_PAGES_SETTINGS::SavePageSettings(), and SCH_PLOTTER::setupPlotPagePDF().

◆ SetType()

bool PAGE_INFO::SetType	(	const wxString &	aStandardPageDescriptionName,
		bool	aIsPortrait = `false`
	)

Set the name of the page type and also the sizes and margins commonly associated with that type name.

Parameters

aStandardPageDescriptionName	is a wxString constant giving one of: "A5" "A4" "A3" "A2" "A1" "A0" "A" "B" "C" "D" "E" "GERBER", "USLetter", "USLegal", "USLedger", or "User". If "User" then the width and height are custom, and will be set according to previous calls to static PAGE_INFO::SetUserWidthMils() and static PAGE_INFO::SetUserHeightMils();
aIsPortrait	Set to true to set page orientation to portrait mode.

Returns: true if aStandarePageDescription was a recognized type.

Definition at line 121 of file page_info.cpp.

{
 bool rc = true;
 
 // all are landscape initially
 if( aType == pageA5.GetType() )
 *this = pageA5;
 else if( aType == pageA4.GetType() )
 *this = pageA4;
 else if( aType == pageA3.GetType() )
 *this = pageA3;
 else if( aType == pageA2.GetType() )
 *this = pageA2;
 else if( aType == pageA1.GetType() )
 *this = pageA1;
 else if( aType == pageA0.GetType() )
 *this = pageA0;
 else if( aType == pageA.GetType() )
 *this = pageA;
 else if( aType == pageB.GetType() )
 *this = pageB;
 else if( aType == pageC.GetType() )
 *this = pageC;
 else if( aType == pageD.GetType() )
 *this = pageD;
 else if( aType == pageE.GetType() )
 *this = pageE;
 else if( aType == pageGERBER.GetType() )
 *this = pageGERBER;
 else if( aType == pageUSLetter.GetType() )
 *this = pageUSLetter;
 else if( aType == pageUSLegal.GetType() )
 *this = pageUSLegal;
 else if( aType == pageUSLedger.GetType() )
 *this = pageUSLedger;
 else if( aType == pageUser.GetType() )
 {
 // pageUser is const, and may not and does not hold the custom size,
 // so customize *this later
 *this = pageUser;
 
 // customize:
 m_size.x = s_user_width;
 m_size.y = s_user_height;
 
 updatePortrait();
 }
 else
 rc = false;
 
 if( aIsPortrait )
 {
 // all private PAGE_INFOs are landscape, must swap x and y
 std::swap( m_size.y, m_size.x );
 updatePortrait();
 }
 
 return rc;
}

References GetType(), m_size, pageA, pageA0, pageA1, pageA2, pageA3, pageA4, pageA5, pageB, pageC, pageD, pageE, pageGERBER, pageUser, pageUSLedger, pageUSLegal, pageUSLetter, s_user_height, s_user_width, updatePortrait(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPSFiles(), DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), SCH_LEGACY_PLUGIN::loadPageSettings(), GERBVIEW_FRAME::LoadSettings(), PL_EDITOR_FRAME::LoadSettings(), LEGACY_PLUGIN::loadSHEET(), PAGE_INFO(), PCB_PARSER::parsePAGE_INFO(), SCH_SEXPR_PARSER::parsePAGE_INFO(), SCH_ALTIUM_PLUGIN::ParseSheet(), SCH_PLOTTER::plotOneSheetSVG(), DIALOG_PAGES_SETTINGS::SavePageSettings(), SCH_PLOTTER::setupPlotPagePDF(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ SetWidthMils()

void PAGE_INFO::SetWidthMils ( int aWidthInMils )

Definition at line 245 of file page_info.cpp.

{
 if( m_size.x != aWidthInMils )
 {
 m_size.x = clampWidth( aWidthInMils );
 
 m_type = Custom;
 m_paper_id = wxPAPER_NONE;
 
 updatePortrait();
 }
}

References clampWidth(), Custom, m_paper_id, m_size, m_type, updatePortrait(), and VECTOR2< T >::x.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), SCH_LEGACY_PLUGIN::loadPageSettings(), LEGACY_PLUGIN::loadSHEET(), SCH_EAGLE_PLUGIN::loadSheet(), PCB_PARSER::parsePAGE_INFO(), SCH_SEXPR_PARSER::parsePAGE_INFO(), PCB_PLOT_SVG::Plot(), DIALOG_PAGES_SETTINGS::SavePageSettings(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ updatePortrait()

void PAGE_INFO::updatePortrait ( )

inlineprivate

Definition at line 97 of file page_info.cpp.

{
 // update m_portrait based on orientation of m_size.x and m_size.y
 m_portrait = ( m_size.y > m_size.x );
}

References m_portrait, m_size, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PAGE_INFO(), SetHeightMils(), SetType(), and SetWidthMils().

Member Data Documentation

◆ A

const wxChar PAGE_INFO::A = wxT( "A" )

static

Definition at line 68 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ A0

const wxChar PAGE_INFO::A0 = wxT( "A0" )

static

Definition at line 67 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ A1

const wxChar PAGE_INFO::A1 = wxT( "A1" )

static

Definition at line 66 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ A2

const wxChar PAGE_INFO::A2 = wxT( "A2" )

static

Definition at line 65 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ A3

const wxChar PAGE_INFO::A3 = wxT( "A3" )

static

Definition at line 64 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), IsDefault(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ A4

const wxChar PAGE_INFO::A4 = wxT( "A4" )

static

Definition at line 63 of file page_info.h.

Referenced by FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), GENDRILL_WRITER_BASE::genDrillMapFile(), DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ A5

const wxChar PAGE_INFO::A5 = wxT( "A5" )

static

Definition at line 62 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ B

const wxChar PAGE_INFO::B = wxT( "B" )

static

Definition at line 69 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ C

const wxChar PAGE_INFO::C = wxT( "C" )

static

Definition at line 70 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ Custom

const wxChar PAGE_INFO::Custom = wxT( "User" )

static

"User" defined page type

Definition at line 77 of file page_info.h.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), Format(), DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), IsCustom(), SCH_LEGACY_PLUGIN::loadPageSettings(), LEGACY_PLUGIN::loadSHEET(), DIALOG_PAGES_SETTINGS::OnPaperSizeChoice(), PCB_PARSER::parsePAGE_INFO(), SCH_SEXPR_PARSER::parsePAGE_INFO(), DIALOG_PAGES_SETTINGS::SavePageSettings(), SetHeightMils(), SetWidthMils(), and DIALOG_PAGES_SETTINGS::TransferDataFromWindow().

◆ D

const wxChar PAGE_INFO::D = wxT( "D" )

static

Definition at line 71 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ E

const wxChar PAGE_INFO::E = wxT( "E" )

static

Definition at line 72 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ GERBER

const wxChar PAGE_INFO::GERBER = wxT( "GERBER" )

static

Definition at line 73 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ m_paper_id

wxPaperSize PAGE_INFO::m_paper_id

private

wx' style paper id.

Definition at line 231 of file page_info.h.

Referenced by GetPaperId(), SetHeightMils(), and SetWidthMils().

◆ m_portrait

bool PAGE_INFO::m_portrait

private

true if portrait, false if landscape

Definition at line 229 of file page_info.h.

Referenced by IsDefault(), IsPortrait(), SetPortrait(), and updatePortrait().

◆ m_size

VECTOR2I PAGE_INFO::m_size

private

mils

Definition at line 227 of file page_info.h.

Referenced by GetHeightMils(), GetSizeMils(), GetWidthMils(), SetHeightMils(), SetPortrait(), SetType(), SetWidthMils(), and updatePortrait().

◆ m_type

wxString PAGE_INFO::m_type

private

paper type: A4, A3, etc.

Definition at line 226 of file page_info.h.

Referenced by GetType(), IsCustom(), IsDefault(), SetHeightMils(), and SetWidthMils().

◆ pageA

const PAGE_INFO PAGE_INFO::pageA

staticprivate

Definition at line 211 of file page_info.h.

Referenced by SetType().

◆ pageA0

const PAGE_INFO PAGE_INFO::pageA0

staticprivate

Definition at line 210 of file page_info.h.

Referenced by SetType().

◆ pageA1

const PAGE_INFO PAGE_INFO::pageA1

staticprivate

Definition at line 209 of file page_info.h.

Referenced by SetType().

◆ pageA2

const PAGE_INFO PAGE_INFO::pageA2

staticprivate

Definition at line 208 of file page_info.h.

Referenced by SetType().

◆ pageA3

const PAGE_INFO PAGE_INFO::pageA3

staticprivate

Definition at line 207 of file page_info.h.

Referenced by SetType().

◆ pageA4

const PAGE_INFO PAGE_INFO::pageA4

staticprivate

Definition at line 206 of file page_info.h.

Referenced by SetType().

◆ pageA5

const PAGE_INFO PAGE_INFO::pageA5

staticprivate

Definition at line 205 of file page_info.h.

Referenced by SetType().

◆ pageB

const PAGE_INFO PAGE_INFO::pageB

staticprivate

Definition at line 212 of file page_info.h.

Referenced by SetType().

◆ pageC

const PAGE_INFO PAGE_INFO::pageC

staticprivate

Definition at line 213 of file page_info.h.

Referenced by SetType().

◆ pageD

const PAGE_INFO PAGE_INFO::pageD

staticprivate

Definition at line 214 of file page_info.h.

Referenced by SetType().

◆ pageE

const PAGE_INFO PAGE_INFO::pageE

staticprivate

Definition at line 215 of file page_info.h.

Referenced by SetType().

◆ pageGERBER

const PAGE_INFO PAGE_INFO::pageGERBER

staticprivate

Definition at line 216 of file page_info.h.

Referenced by SetType().

◆ pageUser

const PAGE_INFO PAGE_INFO::pageUser

staticprivate

Definition at line 222 of file page_info.h.

Referenced by SetType().

◆ pageUSLedger

const PAGE_INFO PAGE_INFO::pageUSLedger

staticprivate

Definition at line 220 of file page_info.h.

Referenced by SetType().

◆ pageUSLegal

const PAGE_INFO PAGE_INFO::pageUSLegal

staticprivate

Definition at line 219 of file page_info.h.

Referenced by SetType().

◆ pageUSLetter

const PAGE_INFO PAGE_INFO::pageUSLetter

staticprivate

Definition at line 218 of file page_info.h.

Referenced by SetType().

◆ s_user_height

int PAGE_INFO::s_user_height = 11000

staticprivate

Definition at line 233 of file page_info.h.

Referenced by GetCustomHeightMils(), SetCustomHeightMils(), and SetType().

◆ s_user_width

int PAGE_INFO::s_user_width = 17000

staticprivate

Definition at line 234 of file page_info.h.

Referenced by GetCustomWidthMils(), SetCustomWidthMils(), and SetType().

◆ USLedger

const wxChar PAGE_INFO::USLedger = wxT( "USLedger" )

static

Definition at line 76 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ USLegal

const wxChar PAGE_INFO::USLegal = wxT( "USLegal" )

static

Definition at line 75 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

◆ USLetter

const wxChar PAGE_INFO::USLetter = wxT( "USLetter" )

static

Definition at line 74 of file page_info.h.

Referenced by DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog(), and DIALOG_PAGES_SETTINGS::SavePageSettings().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PAGE_INFO() [1/2]

◆ PAGE_INFO() [2/2]

Member Function Documentation

◆ Format()

◆ GetCustomHeightMils()

◆ GetCustomWidthMils()

◆ GetHeightIU()

◆ GetHeightMils()

◆ GetPaperId()

◆ GetSizeIU()

◆ GetSizeMils()

◆ GetType()

◆ GetWidthIU()

◆ GetWidthMils()

◆ GetWxOrientation()

◆ IsCustom()

◆ IsDefault()

◆ IsPortrait()

◆ SetCustomHeightMils()

◆ SetCustomWidthMils()

◆ SetHeightMils()

◆ setMargins()

◆ SetPortrait()

◆ SetType()

◆ SetWidthMils()

◆ updatePortrait()

Member Data Documentation

◆ A

◆ A0

◆ A1

◆ A2

◆ A3

◆ A4

◆ A5

◆ B

◆ C

◆ Custom

◆ D

◆ E

◆ GERBER

◆ m_paper_id

◆ m_portrait

◆ m_size

◆ m_type

◆ pageA

◆ pageA0

◆ pageA1

◆ pageA2

◆ pageA3

◆ pageA4

◆ pageA5

◆ pageB

◆ pageC

◆ pageD

◆ pageE

◆ pageGERBER

◆ pageUser

◆ pageUSLedger

◆ pageUSLegal

◆ pageUSLetter

◆ s_user_height

◆ s_user_width

◆ USLedger

◆ USLegal

◆ USLetter