dialog_page_settings.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020-2023 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef _DIALOG_PAGES_SETTINGS_H_
#define _DIALOG_PAGES_SETTINGS_H_
 
#include <page_info.h>
#include <title_block.h>
#include <widgets/unit_binder.h>
#include <widgets/std_bitmap_button.h>
#include <dialog_page_settings_base.h>
 
class DS_DATA_MODEL;
class EDA_DRAW_FRAME;
class BASE_SCREEN;
class EMBEDDED_FILES;
class FILENAME_RESOLVER;
 
class DIALOG_PAGES_SETTINGS: public DIALOG_PAGES_SETTINGS_BASE
{
public:
 DIALOG_PAGES_SETTINGS( EDA_DRAW_FRAME* aParent, EMBEDDED_FILES* aEmbeddedFiles,
 double aIuPerMils, const VECTOR2D& aMaxUserSizeMils );
 virtual ~DIALOG_PAGES_SETTINGS();
 
 const wxString GetWksFileName()
 {
 return m_textCtrlFilePicker->GetValue();
 }
 
 void SetWksFileName(const wxString& aFilename )
 {
 m_textCtrlFilePicker->SetValue( aFilename );
 }
 
 void EnableWksFileNamePicker( bool aEnable )
 {
 m_textCtrlFilePicker->Enable( aEnable );
 m_browseButton->Enable( aEnable );
 }
 
private:
 virtual void onTransferDataToWindow() {}
 
 virtual bool onSavePageSettings()
 {
 // default just return true savepagesettings to succeed
 return true;
 }
 
 virtual bool TransferDataToWindow() override;
 virtual bool TransferDataFromWindow() override;
 
 // event handlers for page size choice
 void OnPaperSizeChoice( wxCommandEvent& event ) override;
 void OnUserPageSizeXTextUpdated( wxCommandEvent& event ) override;
 void OnUserPageSizeYTextUpdated( wxCommandEvent& event ) override;
 void OnPageOrientationChoice( wxCommandEvent& event ) override;
 
 // event handler for texts in title block
 void OnRevisionTextUpdated( wxCommandEvent& event ) override;
 void OnDateTextUpdated( wxCommandEvent& event ) override;
 void OnTitleTextUpdated( wxCommandEvent& event ) override;
 void OnCompanyTextUpdated( wxCommandEvent& event ) override;
 void OnComment1TextUpdated( wxCommandEvent& event ) override;
 void OnComment2TextUpdated( wxCommandEvent& event ) override;
 void OnComment3TextUpdated( wxCommandEvent& event ) override;
 void OnComment4TextUpdated( wxCommandEvent& event ) override;
 void OnComment5TextUpdated( wxCommandEvent& event ) override;
 void OnComment6TextUpdated( wxCommandEvent& event ) override;
 void OnComment7TextUpdated( wxCommandEvent& event ) override;
 void OnComment8TextUpdated( wxCommandEvent& event ) override;
 void OnComment9TextUpdated( wxCommandEvent& event ) override;
 
 // Handle button click for setting the date from the picker
 void OnDateApplyClick( wxCommandEvent& event ) override;
 
 // .kicad_wks file description selection
 void OnWksFileSelection( wxCommandEvent& event ) override;
 
 // Save in the current title block the new page settings
 // return true if changes are made, or false if not
 bool SavePageSettings();
 
 void SetCurrentPageSizeSelection( const wxString& aPaperSize );
 
 // Update drawing sheet example
 void UpdateDrawingSheetExample();
 
 // Get page layout info from selected dialog items
 void GetPageLayoutInfoFromDialog();
 
 // Get custom page size in mils from dialog
 void GetCustomSizeMilsFromDialog();
 
 bool LocalPrjConfigChanged() { return m_localPrjConfigChanged; }
 
protected:
 EDA_DRAW_FRAME* m_parent;
 BASE_SCREEN* m_screen;
 wxString m_projectPath; // the curr project path
 wxArrayString m_pageFmt; 
 bool m_initialized;
 bool m_localPrjConfigChanged; 
 wxBitmap* m_pageBitmap; 
 VECTOR2D m_layout_size; 
 VECTOR2D m_maxPageSizeMils; 
 PAGE_INFO m_pageInfo; 
 bool m_customFmt; 
 TITLE_BLOCK m_tb; 
 DS_DATA_MODEL* m_drawingSheet; // the alternate and temporary drawing sheet shown by the
 // dialog when the initial one is replaced by a new one
 double m_iuPerMils;
 EMBEDDED_FILES* m_embeddedFiles; // the embedded files reference from the parent
 FILENAME_RESOLVER* m_filenameResolver;
 
private:
 UNIT_BINDER m_customSizeX;
 UNIT_BINDER m_customSizeY;
};
 
#endif // _DIALOG_PAGES_SETTINGS_H_