base_screen.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Jean-Pierre Charras, [email protected]
 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
 * Copyright (C) 1992-2020 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 BASE_SCREEN_H
#define BASE_SCREEN_H

#include <eda_item.h>


class BASE_SCREEN : public EDA_ITEM
{
public:
 BASE_SCREEN( EDA_ITEM* aParent, KICAD_T aType = SCREEN_T );

 BASE_SCREEN( const wxSize& aPageSizeIU, KICAD_T aType = SCREEN_T ) :
 BASE_SCREEN( nullptr, aType )
 {
 InitDataPoints( aPageSizeIU );
 }

 BASE_SCREEN( KICAD_T aType = SCREEN_T ) :
 BASE_SCREEN( nullptr, aType )
 {}

 ~BASE_SCREEN() override { }

 void InitDataPoints( const wxSize& aPageSizeInternalUnits );

 void SetContentModified( bool aModified = true ) { m_flagModified = aModified; }
 bool IsContentModified() const { return m_flagModified; }

 virtual wxString GetClass() const override
 {
 return wxT( "BASE_SCREEN" );
 }

 int GetPageCount() const { return m_pageCount; }
 void SetPageCount( int aPageCount );

 int GetVirtualPageNumber() const { return m_virtualPageNumber; }
 void SetVirtualPageNumber( int aPageNumber ) { m_virtualPageNumber = aPageNumber; }

 const wxString& GetPageNumber() const;
 void SetPageNumber( const wxString& aPageNumber ) { m_pageNumber = aPageNumber; }

#if defined(DEBUG)
 void Show( int nestLevel, std::ostream& os ) const override;
#endif

 static wxString m_DrawingSheetFileName; 

 wxPoint m_DrawOrg; 

 VECTOR2D m_LocalOrigin; 

 wxPoint m_StartVisu; 

 bool m_Center; 

 VECTOR2D m_ScrollCenter; 

protected:
 int m_pageCount;

 int m_virtualPageNumber;

 wxString m_pageNumber;

private:
 bool m_flagModified; 
};

#endif // BASE_SCREEN_H