page_info.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2007-2013 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2008-2013 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2007-2022 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef PAGE_INFO_H
#define PAGE_INFO_H
 
#include <wx/string.h>
#include <math/vector2d.h>
 
#include <richio.h> // for OUTPUTFORMATTER and IO_ERROR
 
#define MIN_PAGE_SIZE_MILS 1000
#define MAX_PAGE_SIZE_PCBNEW_MILS 48000
#define MAX_PAGE_SIZE_EESCHEMA_MILS 120000
 
 
class PAGE_INFO
{
public:
 PAGE_INFO( const wxString& aType = PAGE_INFO::A3, bool IsPortrait = false );
 
 // paper size names which are part of the public API, pass to SetType() or
 // above constructor.
 
 // these were once wxStrings, but it caused static construction sequence problems:
 static const wxChar A5[];
 static const wxChar A4[];
 static const wxChar A3[];
 static const wxChar A2[];
 static const wxChar A1[];
 static const wxChar A0[];
 static const wxChar A[];
 static const wxChar B[];
 static const wxChar C[];
 static const wxChar D[];
 static const wxChar E[];
 static const wxChar GERBER[];
 static const wxChar USLetter[];
 static const wxChar USLegal[];
 static const wxChar USLedger[];
 static const wxChar Custom[]; 
 
 
 bool SetType( const wxString& aStandardPageDescriptionName, bool aIsPortrait = false );
 const wxString& GetType() const { return m_type; }
 
 bool IsDefault() const { return m_type == PAGE_INFO::A3 && !m_portrait; }
 
 bool IsCustom() const;
 
 void SetPortrait( bool aIsPortrait );
 bool IsPortrait() const { return m_portrait; }
 
 wxPrintOrientation GetWxOrientation() const { return IsPortrait() ? wxPORTRAIT : wxLANDSCAPE; }
 
 wxPaperSize GetPaperId() const { return m_paper_id; }
 
 void SetWidthMils( int aWidthInMils );
 int GetWidthMils() const { return m_size.x; }
 
 void SetHeightMils( int aHeightInMils );
 int GetHeightMils() const { return m_size.y; }
 
 const VECTOR2I& GetSizeMils() const { return m_size; }
 
 int GetWidthIU( double aIUScale ) const { return aIUScale * GetWidthMils(); }
 
 int GetHeightIU( double aIUScale ) const { return aIUScale * GetHeightMils(); }
 
 const VECTOR2I GetSizeIU( double aIUScale ) const
 {
 return VECTOR2I( GetWidthIU( aIUScale ), GetHeightIU( aIUScale ) );
 }
 
 static void SetCustomWidthMils( int aWidthInMils );
 
 static void SetCustomHeightMils( int aHeightInMils );
 
 static int GetCustomWidthMils() { return s_user_width; }
 
 static int GetCustomHeightMils() { return s_user_height; }
 
 void Format( OUTPUTFORMATTER* aFormatter, int aNestLevel, int aControlBits ) const;
 
protected:
 // only the class implementation(s) may use this constructor
 PAGE_INFO( const VECTOR2I& aSizeMils, const wxString& aName, wxPaperSize aPaperId );
 
private:
 // standard pre-defined sizes
 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;
 
 // all dimensions here are in mils
 
 wxString m_type; 
 VECTOR2I m_size; 
 
 bool m_portrait; 
 
 wxPaperSize m_paper_id; 
 
 static int s_user_height;
 static int s_user_width;
 
 void updatePortrait();
 
 void setMargins();
};
 
#endif // PAGE_INFO_H