DIALOG_PRINT_GENERIC Class Reference

#include <dialog_print_generic.h>

Inheritance diagram for DIALOG_PRINT_GENERIC:

Public Types
enum	HOLDER_TYPE { DIALOG, FRAME, PANEL }

Public Member Functions
	DIALOG_PRINT_GENERIC (EDA_DRAW_FRAME *aParent, PRINTOUT_SETTINGS *aSettings)
virtual	~DIALOG_PRINT_GENERIC ()
void	ForcePrintBorder (bool aValue)
	Set 'print border and title block' to a requested value and hides the corresponding checkbox. More...
void	SetInitialFocus (wxWindow *aWindow)
	Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
int	ShowQuasiModal ()
void	EndQuasiModal (int retCode)
bool	IsQuasiModal () const
bool	Show (bool show) override
bool	Enable (bool enable) override
void	OnPaint (wxPaintEvent &event)
void	SetPosition (const wxPoint &aNewPosition)
	Force the position of the dialog to a new position. More...
EDA_UNITS	GetUserUnits () const
HOLDER_TYPE	GetType () const
KIWAY &	Kiway () const
	Return a reference to the KIWAY that this object has an opportunity to participate in. More...
PROJECT &	Prj () const
	Return a reference to the PROJECT associated with this KIWAY. More...
void	SetKiway (wxWindow *aDest, KIWAY *aKiway)
	It is only used for debugging, since "this" is not a wxWindow*. More...

Static Public Member Functions
static bool	IsCtrl (int aChar, const wxKeyEvent &e)
static bool	IsShiftCtrl (int aChar, const wxKeyEvent &e)

Protected Types
enum	{ wxID_FRAME_SEL = 1000, wxID_PRINT_OPTIONS }

Protected Member Functions
virtual wxPrintout *	createPrintout (const wxString &aTitle)=0
	Create a printout with a requested title. More...
virtual void	saveSettings ()
wxSizer *	getMainSizer ()
wxGridBagSizer *	getOptionsSizer ()
wxStaticBox *	getOptionsBox ()
double	getScaleValue ()
	Return scale value selected in the dialog. More...
void	setScaleValue (double aValue)
	Select a corresponding scale radio button and update custom scale value if needed. More...
bool	TransferDataToWindow () override
void	finishDialogSettings ()
	In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
void	setSizeInDU (int x, int y)
	Set the dialog to the given dimensions in "dialog units". More...
int	horizPixelsFromDU (int x) const
	Convert an integer number of dialog units to pixels, horizontally. More...
int	vertPixelsFromDU (int y) const
	Convert an integer number of dialog units to pixels, vertically. More...
void	resetSize ()
	Clear the existing dialog size and position. More...
virtual void	OnCharHook (wxKeyEvent &aEvt)

Protected Attributes
APP_SETTINGS_BASE *	m_config
PRINTOUT_SETTINGS *	m_settings
wxBoxSizer *	m_bUpperSizer
wxStaticBoxSizer *	m_sbOptionsSizer
wxGridBagSizer *	m_gbOptionsSizer
wxStaticText *	m_outputModeLabel
wxChoice *	m_outputMode
wxCheckBox *	m_titleBlock
wxRadioButton *	m_scale1
wxRadioButton *	m_scaleFit
wxRadioButton *	m_scaleCustom
wxTextCtrl *	m_scaleCustomText
wxStaticLine *	m_staticline1
wxButton *	m_buttonOption
wxStdDialogButtonSizer *	m_sdbSizer1
wxButton *	m_sdbSizer1OK
wxButton *	m_sdbSizer1Apply
wxButton *	m_sdbSizer1Cancel
EDA_UNITS	m_units
std::string	m_hash_key
bool	m_useCalculatedSize
bool	m_firstPaintEvent
wxWindow *	m_initialFocusTarget
WX_EVENT_LOOP *	m_qmodal_loop
bool	m_qmodal_showing
WDO_ENABLE_DISABLE *	m_qmodal_parent_disabler
EDA_BASE_FRAME *	m_parentFrame
std::vector< wxWindow * >	m_tabOrder
wxSize	m_initialSize

Private Member Functions
void	onPageSetup (wxCommandEvent &event) override
void	onPrintPreview (wxCommandEvent &event) override
void	onPrintButtonClick (wxCommandEvent &event) override
void	onCancelButtonClick (wxCommandEvent &aEvent) override
void	onClose (wxCloseEvent &event) override
void	onSetCustomScale (wxCommandEvent &event) override
void	initPrintData ()

Private Attributes
wxFloatingPointValidator< double >	m_scaleValidator

Static Private Attributes
static wxPrintData *	s_PrintData = nullptr
static wxPageSetupDialogData *	s_pageSetupData = nullptr

Detailed Description

Definition at line 33 of file dialog_print_generic.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
wxID_FRAME_SEL
wxID_PRINT_OPTIONS

Definition at line 44 of file dialog_print_generic_base.h.

        {
            wxID_FRAME_SEL = 1000,
            wxID_PRINT_OPTIONS
        };

HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

{ DIALOG, FRAME, PANEL };

Constructor & Destructor Documentation

DIALOG_PRINT_GENERIC()

DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC	(	EDA_DRAW_FRAME *	aParent,
		PRINTOUT_SETTINGS *	aSettings
	)

Definition at line 35 of file dialog_print_generic.cpp.

    : DIALOG_PRINT_GENERIC_BASE( aParent ),
      m_config( nullptr ),
      m_settings( aSettings )
{
    // Note: for the validator, min value is 0.0, to allow typing values like 0.5
    // that start by 0
    m_scaleValidator.SetRange( 0.0, MAX_SCALE );
    m_scaleCustomText->SetValidator( m_scaleValidator );

    // We use a sdbSizer to get platform-dependent ordering of the action buttons, but
    // that requires us to correct the button labels here.
    m_sdbSizer1OK->SetLabel( _( "Print" ) );
    m_sdbSizer1Apply->SetLabel( _( "Print Preview" ) );
    m_sdbSizer1Cancel->SetLabel( _( "Close" ) );
    m_sdbSizer1->Layout();

    m_sdbSizer1OK->SetDefault();

#if defined(__WXMAC__) or defined(__WXGTK__)
    // Preview does not work well on GTK or Mac,
    // but these platforms provide native print preview
    m_sdbSizer1Apply->Hide();
#endif

    finishDialogSettings();
    Layout();
    initPrintData();
}

References _, DIALOG_SHIM::finishDialogSettings(), initPrintData(), DIALOG_PRINT_GENERIC_BASE::m_scaleCustomText, m_scaleValidator, DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1, DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1Apply, DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1Cancel, DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1OK, and MAX_SCALE.

~DIALOG_PRINT_GENERIC()

DIALOG_PRINT_GENERIC::~DIALOG_PRINT_GENERIC ( )

virtual

Definition at line 66 of file dialog_print_generic.cpp.

{
}

Member Function Documentation

createPrintout()

virtual wxPrintout* DIALOG_PRINT_GENERIC::createPrintout ( const wxString &  aTitle )

protectedpure virtual

Create a printout with a requested title.

Implemented in DIALOG_PRINT_PCBNEW, and DIALOG_PRINT_GERBVIEW.

Referenced by onPrintButtonClick(), and onPrintPreview().

Enable()

bool DIALOG_SHIM::Enable ( bool  enable )

overrideinherited

Definition at line 312 of file dialog_shim.cpp.

{
    // so we can do logging of this state change:
    return wxDialog::Enable( enable );
}

EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode )

inherited

Definition at line 473 of file dialog_shim.cpp.

{
    // Hook up validator and transfer data from controls handling so quasi-modal dialogs
    // handle validation in the same way as other dialogs.
    if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
        return;

    SetReturnCode( retCode );

    if( !IsQuasiModal() )
    {
        wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
                    "wasn't called" );
        return;
    }

    if( m_qmodal_loop )
    {
        if( m_qmodal_loop->IsRunning() )
            m_qmodal_loop->Exit( 0 );
        else
            m_qmodal_loop->ScheduleExit( 0 );

        m_qmodal_loop = nullptr;
    }

    delete m_qmodal_parent_disabler;
    m_qmodal_parent_disabler = nullptr;

    Show( false );
}

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, and DIALOG_SHIM::Show().

Referenced by NETLIST_DIALOG::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), NETLIST_DIALOG::OnDelGenerator(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), and DIALOG_SHIM::~DIALOG_SHIM().

finishDialogSettings()

void DIALOG_SHIM::finishDialogSettings ( )

protectedinherited

In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

finishDialogSettings must be called from derived classes after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 151 of file dialog_shim.cpp.

{
    // must be called from the constructor of derived classes,
    // when all widgets are initialized, and therefore their size fixed

    // SetSizeHints fixes the minimal size of sizers in the dialog
    // (SetSizeHints calls Fit(), so no need to call it)
    GetSizer()->SetSizeHints( this );
}

Referenced by DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BUS_MANAGER::DIALOG_BUS_MANAGER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_SYMBOLS_LIBID::DIALOG_EDIT_SYMBOLS_LIBID(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_3DMODEL::DIALOG_SELECT_3DMODEL(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

ForcePrintBorder()

void DIALOG_PRINT_GENERIC::ForcePrintBorder

(

bool

aValue

)

Set 'print border and title block' to a requested value and hides the corresponding checkbox.

Definition at line 71 of file dialog_print_generic.cpp.

{
    m_titleBlock->SetValue( aValue );
    m_titleBlock->Hide();

    if( m_config )
    {
        m_settings->Load( m_config );
        m_settings->m_titleBlock = aValue;
        m_settings->Save( m_config );
    }
}

References PRINTOUT_SETTINGS::Load(), m_config, m_settings, DIALOG_PRINT_GENERIC_BASE::m_titleBlock, PRINTOUT_SETTINGS::m_titleBlock, and PRINTOUT_SETTINGS::Save().

Referenced by GERBVIEW_CONTROL::Print().

getMainSizer()

wxSizer* DIALOG_PRINT_GENERIC::getMainSizer ( )

inlineprotected

Definition at line 53 of file dialog_print_generic.h.

    {
        return m_bUpperSizer;
    }

References DIALOG_PRINT_GENERIC_BASE::m_bUpperSizer.

Referenced by DIALOG_PRINT_GERBVIEW::createLeftPanel(), and DIALOG_PRINT_PCBNEW::createLeftPanel().

getOptionsBox()

wxStaticBox* DIALOG_PRINT_GENERIC::getOptionsBox ( )

inlineprotected

Definition at line 63 of file dialog_print_generic.h.

    {
        return m_sbOptionsSizer->GetStaticBox();
    }

References DIALOG_PRINT_GENERIC_BASE::m_sbOptionsSizer.

Referenced by DIALOG_PRINT_GERBVIEW::createExtraOptions(), and DIALOG_PRINT_PCBNEW::createExtraOptions().

getOptionsSizer()

wxGridBagSizer* DIALOG_PRINT_GENERIC::getOptionsSizer ( )

inlineprotected

Definition at line 58 of file dialog_print_generic.h.

    {
        return m_gbOptionsSizer;
    }

References DIALOG_PRINT_GENERIC_BASE::m_gbOptionsSizer.

Referenced by DIALOG_PRINT_GERBVIEW::createExtraOptions(), and DIALOG_PRINT_PCBNEW::createExtraOptions().

getScaleValue()

double DIALOG_PRINT_GENERIC::getScaleValue ( )

protected

Return scale value selected in the dialog.

If this value is outside limits, it will be clamped.

Definition at line 96 of file dialog_print_generic.cpp.

{
    if( m_scale1->GetValue() )
        return 1.0;

    if( m_scaleFit->GetValue() )
        return 0.0;

    if( m_scaleCustom->GetValue() )
    {
        double scale = 1.0;;

        if( !m_scaleCustomText->GetValue().ToDouble( &scale ) )
        {
            DisplayInfoMessage( nullptr, _( "Warning: Bad scale number" ) );
            scale = 1.0;
        }

        if( scale > MAX_SCALE )
        {
            scale = MAX_SCALE;
            setScaleValue( scale );
            DisplayInfoMessage( nullptr,
                wxString::Format( _( "Warning: Scale option set to a very large value.\n"
                                     " Clamped to %f" ), scale ) );
        }
        else if( scale < MIN_SCALE )
        {
            scale = MIN_SCALE;
            setScaleValue( scale );
            DisplayInfoMessage( nullptr,
                wxString::Format( _( "Warning: Scale option set to a very small value.\n"
                                     " Clamped to %f" ), scale ) );
        }

        return scale;
    }

    wxCHECK( false, 1.0 );
}

References _, DisplayInfoMessage(), Format(), DIALOG_PRINT_GENERIC_BASE::m_scale1, DIALOG_PRINT_GENERIC_BASE::m_scaleCustom, DIALOG_PRINT_GENERIC_BASE::m_scaleCustomText, DIALOG_PRINT_GENERIC_BASE::m_scaleFit, MAX_SCALE, MIN_SCALE, scale, and setScaleValue().

Referenced by saveSettings().

GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

{ return m_type; }

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

GetUserUnits()

EDA_UNITS DIALOG_SHIM::GetUserUnits ( ) const

inlineinherited

Definition at line 119 of file dialog_shim.h.

    {
        return m_units;
    }

References DIALOG_SHIM::m_units.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_NET_INSPECTOR::formatLength(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::onCellChanging(), POSITION_RELATIVE_TOOL::PositionRelative(), DIALOG_BOARD_STATISTICS::saveReportClicked(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), DIALOG_POSITION_RELATIVE::updateDialogControls(), DIALOG_MOVE_EXACT::updateDialogControls(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), DIALOG_BOARD_STATISTICS::updateWidets(), DIALOG_ERC::writeReport(), and DIALOG_DRC::writeReport().

horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x ) const

protectedinherited

Convert an integer number of dialog units to pixels, horizontally.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 169 of file dialog_shim.cpp.

{
    wxSize sz( x, 0 );
    return ConvertDialogToPixels( sz ).x;
}

Referenced by DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), and DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

initPrintData()

void DIALOG_PRINT_GENERIC::initPrintData ( )

private

Definition at line 295 of file dialog_print_generic.cpp.

{
    if( !s_PrintData )  // First print
    {
        s_PrintData = new wxPrintData();

        if( !s_PrintData->Ok() )
            DisplayError( this, _( "An error occurred initializing the printer information." ) );

        s_PrintData->SetQuality( wxPRINT_QUALITY_HIGH );      // Default resolution = HIGH;
    }

    if( !s_pageSetupData )
    {
        const PAGE_INFO& pageInfo = m_settings->m_pageInfo;

        s_pageSetupData = new wxPageSetupDialogData( *s_PrintData );
        s_pageSetupData->SetPaperId( pageInfo.GetPaperId() );
        s_pageSetupData->GetPrintData().SetOrientation( pageInfo.GetWxOrientation() );

        if( pageInfo.IsCustom() )
        {
            if( pageInfo.IsPortrait() )
                s_pageSetupData->SetPaperSize( wxSize( Mils2mm( pageInfo.GetWidthMils() ),
                                                       Mils2mm( pageInfo.GetHeightMils() ) ) );
            else
                s_pageSetupData->SetPaperSize( wxSize( Mils2mm( pageInfo.GetHeightMils() ),
                                                       Mils2mm( pageInfo.GetWidthMils() ) ) );
        }

        *s_PrintData = s_pageSetupData->GetPrintData();
    }
}

References _, DisplayError(), PAGE_INFO::GetHeightMils(), PAGE_INFO::GetPaperId(), PAGE_INFO::GetWidthMils(), PAGE_INFO::GetWxOrientation(), PAGE_INFO::IsCustom(), PAGE_INFO::IsPortrait(), PRINTOUT_SETTINGS::m_pageInfo, m_settings, Mils2mm(), s_pageSetupData, and s_PrintData.

Referenced by DIALOG_PRINT_GENERIC().

IsCtrl()

static bool DIALOG_SHIM::IsCtrl ( int  aChar, const wxKeyEvent &  e  )

inlinestaticinherited

Definition at line 124 of file dialog_shim.h.

    {
        return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
                !e.ShiftDown() && !e.MetaDown();
    }

IsQuasiModal()

bool DIALOG_SHIM::IsQuasiModal ( ) const

inlineinherited

Definition at line 106 of file dialog_shim.h.

{ return m_qmodal_showing; }

References DIALOG_SHIM::m_qmodal_showing.

Referenced by DIALOG_SHIM::EndQuasiModal(), EDA_BASE_FRAME::findQuasiModalDialog(), NETLIST_DIALOG::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_SHIM::OnCloseWindow(), NETLIST_DIALOG::OnDelGenerator(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), and DIALOG_SHIM::~DIALOG_SHIM().

IsShiftCtrl()

static bool DIALOG_SHIM::IsShiftCtrl ( int  aChar, const wxKeyEvent &  e  )

inlinestaticinherited

Definition at line 130 of file dialog_shim.h.

    {
        return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
                e.ShiftDown() && !e.MetaDown();
    }

Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

    {
        wxASSERT( m_kiway );    // smoke out bugs in Debug build, then Release runs fine.
        return *m_kiway;
    }

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

onCancelButtonClick()

void DIALOG_PRINT_GENERIC::onCancelButtonClick ( wxCommandEvent &  aEvent )

overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 272 of file dialog_print_generic.cpp.

{
    saveSettings();

    wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL ) );
}

References saveSettings().

OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt )

protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_SYMBOL, HK_PROMPT_DIALOG, and HTML_MESSAGE_BOX.

Definition at line 563 of file dialog_shim.cpp.

{
    if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
    {
        if( m_parentFrame )
        {
            m_parentFrame->ToggleUserUnits();
            return;
        }
    }
    // shift-return (Mac default) or Ctrl-Return (GTK) for OK
    else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
    {
        wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
        return;
    }
    else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
    {
        wxWindow* currentWindow = wxWindow::FindFocus();
        int       currentIdx = -1;
        int       delta = aEvt.ShiftDown() ? -1 : 1;

        auto advance = [&]( int& idx )
        {
            // Wrap-around modulus
            int size = m_tabOrder.size();
            idx = ( ( idx + delta ) % size + size ) % size;
        };

        for( size_t i = 0; i < m_tabOrder.size(); ++i )
        {
            if( m_tabOrder[i] == currentWindow )
            {
                currentIdx = (int) i;
                break;
            }
        }

        if( currentIdx >= 0 )
        {
            advance( currentIdx );

            //todo: We don't currently have non-textentry dialog boxes but this will break if
            // we add them.
#ifdef __APPLE__
            while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
                advance( currentIdx );
#endif

            m_tabOrder[ currentIdx ]->SetFocus();
            return;
        }
    }

    aEvt.Skip();
}

References delta, DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

Referenced by DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), and DIALOG_TEXT_PROPERTIES::~DIALOG_TEXT_PROPERTIES().

onClose()

void DIALOG_PRINT_GENERIC::onClose ( wxCloseEvent &  event )

overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 280 of file dialog_print_generic.cpp.

{
    saveSettings();
    event.Skip();
}

References saveSettings().

onPageSetup()

void DIALOG_PRINT_GENERIC::onPageSetup ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 180 of file dialog_print_generic.cpp.

{
    wxPageSetupDialog pageSetupDialog( this, s_pageSetupData );
    pageSetupDialog.ShowModal();

    (*s_PrintData) = pageSetupDialog.GetPageSetupDialogData().GetPrintData();
    (*s_pageSetupData) = pageSetupDialog.GetPageSetupDialogData();
}

References s_pageSetupData.

OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event )

inherited

Definition at line 380 of file dialog_shim.cpp.

{
    if( m_firstPaintEvent )
    {
        KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision( this );

        selectAllInTextCtrls( GetChildren() );

        if( m_initialFocusTarget )
            KIPLATFORM::UI::ForceFocus( m_initialFocusTarget );
        else
            KIPLATFORM::UI::ForceFocus( this );     // Focus the dialog itself

        m_firstPaintEvent = false;
    }

    event.Skip();
}

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), KIPLATFORM::UI::ForceFocus(), DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

onPrintButtonClick()

void DIALOG_PRINT_GENERIC::onPrintButtonClick ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 231 of file dialog_print_generic.cpp.

{
    if( Pgm().m_Printing )
    {
        DisplayError( this, _( "Previous print job not yet complete." ) );
        return;
    }

    m_settings->m_pageCount = 0;    // it needs to be set by a derived dialog
    saveSettings();

    if( m_settings->m_pageCount == 0 )
    {
        DisplayError( this, _( "Nothing to print" ) );
        return;
    }

    wxPrintDialogData printDialogData( *s_PrintData );
    printDialogData.SetMaxPage( m_settings->m_pageCount );

    wxPrinter printer( &printDialogData );
    auto printout = std::unique_ptr<wxPrintout>( createPrintout( _( "Print" ) ) );

    Pgm().m_Printing = true;

    {
        if( !printer.Print( this, printout.get(), true ) )
        {
            if( wxPrinter::GetLastError() == wxPRINTER_ERROR )
                DisplayError( this, _( "There was a problem printing." ) );
        }
        else
        {
            *s_PrintData = printer.GetPrintDialogData().GetPrintData();
        }
    }

    Pgm().m_Printing = false;
}

References _, createPrintout(), DisplayError(), PRINTOUT_SETTINGS::m_pageCount, m_settings, Pgm(), s_PrintData, and saveSettings().

onPrintPreview()

void DIALOG_PRINT_GENERIC::onPrintPreview ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 190 of file dialog_print_generic.cpp.

{
    m_settings->m_pageCount = 0;    // it needs to be set by a derived dialog
    saveSettings();

    if( m_settings->m_pageCount == 0 )
    {
        DisplayError( this, _( "Nothing to print" ) );
        return;
    }

    // Pass two printout objects: for preview, and possible printing.
    wxString title = _( "Print Preview" );
    wxPrintPreview* preview =
            new wxPrintPreview( createPrintout( title ), createPrintout( title ), s_PrintData );

    preview->SetZoom( 100 );

    wxPreviewFrame* frame = new wxPreviewFrame( preview, this, title, m_parent->GetPosition(),
                                                m_parent->GetSize() );
    frame->SetMinSize( wxSize( 550, 350 ) );
    frame->Center();

    // On wxGTK, set the flag wxTOPLEVEL_EX_DIALOG is mandatory, if we want
    // close the frame using the X box in caption, when the preview frame is run
    // from a dialog
    frame->SetExtraStyle( frame->GetExtraStyle() | wxTOPLEVEL_EX_DIALOG );

    // We use here wxPreviewFrame_WindowModal option to make the wxPrintPreview frame
    // modal for its caller only.
    // An other reason is the fact when closing the frame without this option,
    // all top level frames are reenabled.
    // With this option, only the parent is reenabled.
    // Reenabling all top level frames should be made by the parent dialog.
    frame->InitializeWithModality( wxPreviewFrame_WindowModal );

    frame->Raise(); // Needed on Ubuntu/Unity to display the frame
    frame->Show( true );
}

References _, createPrintout(), DisplayError(), PRINTOUT_SETTINGS::m_pageCount, m_settings, s_PrintData, and saveSettings().

onSetCustomScale()

void DIALOG_PRINT_GENERIC::onSetCustomScale ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 287 of file dialog_print_generic.cpp.

{
    // Select 'custom scale' radio button when user types in a value in the
    // custom scale text box
    m_scaleCustom->SetValue( true );
}

References DIALOG_PRINT_GENERIC_BASE::m_scaleCustom.

Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

{
    return Kiway().Prj();
}

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SIM_PLOT_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SIM_PLOT_FRAME::getDefaultFilename(), SIM_PLOT_FRAME::getDefaultPath(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), SIM_PLOT_FRAME::loadWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbookAs(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_SCHEMATIC_SETUP::OnPageChange(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_EDIT_FRAME::saveSchematicFile(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::saveSymbolAs(), SCH_BASE_FRAME::saveSymbolLibTables(), SIM_PLOT_FRAME::saveWorkbook(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurSymbol(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER_FRAME::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SCH_EDIT_FRAME::updateAutoSaveFile(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), SIM_PLOT_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

resetSize()

void DIALOG_SHIM::resetSize ( )

protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 287 of file dialog_shim.cpp.

{
    const char* hash_key;

    if( m_hash_key.size() )
    {
        // a special case like EDA_LIST_DIALOG, which has multiple uses.
        hash_key = m_hash_key.c_str();
    }
    else
    {
        hash_key = typeid(*this).name();
    }

    std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );

    if( it == class_map.end() )
        return;

    wxRect rect = it->second;
    rect.SetSize( wxSize( 0, 0 ) );
    class_map[ hash_key ] = rect;
}

References class_map, and DIALOG_SHIM::m_hash_key.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

saveSettings()

void DIALOG_PRINT_GENERIC::saveSettings ( )

protectedvirtual

Reimplemented in DIALOG_PRINT_PCBNEW, and DIALOG_PRINT_GERBVIEW.

Definition at line 85 of file dialog_print_generic.cpp.

{
    m_settings->m_scale = getScaleValue();
    m_settings->m_titleBlock = m_titleBlock->GetValue();
    m_settings->m_blackWhite = m_outputMode->GetSelection();

    if( m_config )
        m_settings->Save( m_config );
}

References getScaleValue(), PRINTOUT_SETTINGS::m_blackWhite, m_config, DIALOG_PRINT_GENERIC_BASE::m_outputMode, PRINTOUT_SETTINGS::m_scale, m_settings, DIALOG_PRINT_GENERIC_BASE::m_titleBlock, PRINTOUT_SETTINGS::m_titleBlock, and PRINTOUT_SETTINGS::Save().

Referenced by onCancelButtonClick(), onClose(), onPrintButtonClick(), onPrintPreview(), DIALOG_PRINT_GERBVIEW::saveSettings(), and DIALOG_PRINT_PCBNEW::saveSettings().

SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow )

inlineinherited

Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

Definition at line 97 of file dialog_shim.h.

    {
        m_initialFocusTarget = aWindow;
    }

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::saveSymbolAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

SetKiway()

void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest, KIWAY *  aKiway  )

inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters

aDest	is the recipient of aKiway pointer.
aKiway	is often from a parent window or from KIFACE::CreateWindow().

Definition at line 43 of file kiway_holder.cpp.

{
#if defined(DEBUG)
    // offer a trap point for debugging most any window
    wxASSERT( aDest );
    if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
    {
        int breakhere=1;
        ignore_unused( breakhere );
    }
#endif

    ignore_unused( aDest );

    m_kiway = aKiway;
}

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition )

inherited

Force the position of the dialog to a new position.

Parameters

aNewPosition

is the new forced position

Definition at line 190 of file dialog_shim.cpp.

{
    wxDialog::SetPosition( aNewPosition );

    // Now update the stored position:
    const char* hash_key;

    if( m_hash_key.size() )
    {
        // a special case like EDA_LIST_DIALOG, which has multiple uses.
        hash_key = m_hash_key.c_str();
    }
    else
    {
        hash_key = typeid(*this).name();
    }

    std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );

    if( it == class_map.end() )
        return;

    wxRect rect = it->second;
    rect.SetPosition( aNewPosition );

    class_map[ hash_key ] = rect;
}

References class_map, DIALOG_SHIM::m_hash_key, and PCAD2KICAD::SetPosition().

Referenced by PCB_BASE_FRAME::SelectOneLayer().

setScaleValue()

void DIALOG_PRINT_GENERIC::setScaleValue ( double  aValue )

protected

Select a corresponding scale radio button and update custom scale value if needed.

Parameters

aValue

is the scale value to be selected (0 stands for fit-to-page).

Definition at line 138 of file dialog_print_generic.cpp.

{
    wxASSERT( aValue >= 0.0 );

    if( aValue == 0.0 )     // fit to page
    {
        m_scaleFit->SetValue( true );
    }
    else if( aValue == 1.0 )
    {
        m_scale1->SetValue( true );
    }
    else
    {
        // Silently clamp the value (it comes from the config file).
        if( aValue > MAX_SCALE )
            aValue = MAX_SCALE;
        else if( aValue < MIN_SCALE )
            aValue = MIN_SCALE;

        m_scaleCustom->SetValue( true );
        m_scaleCustomText->SetValue( wxString::Format( wxT( "%f" ), aValue ) );
    }
}

References Format(), DIALOG_PRINT_GENERIC_BASE::m_scale1, DIALOG_PRINT_GENERIC_BASE::m_scaleCustom, DIALOG_PRINT_GENERIC_BASE::m_scaleCustomText, DIALOG_PRINT_GENERIC_BASE::m_scaleFit, MAX_SCALE, and MIN_SCALE.

Referenced by getScaleValue(), and TransferDataToWindow().

setSizeInDU()

void DIALOG_SHIM::setSizeInDU ( int  x, int  y  )

protectedinherited

Set the dialog to the given dimensions in "dialog units".

These are units equivalent to 4* the average character width and 8* the average character height, allowing a dialog to be sized in a way that scales it with the system font.

Definition at line 162 of file dialog_shim.cpp.

{
    wxSize sz( x, y );
    SetSize( ConvertDialogToPixels( sz ) );
}

Referenced by DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

Show()

bool DIALOG_SHIM::Show ( bool  show )

overrideinherited

Definition at line 219 of file dialog_shim.cpp.

{
    bool        ret;
    const char* hash_key;

    if( m_hash_key.size() )
    {
        // a special case like EDA_LIST_DIALOG, which has multiple uses.
        hash_key = m_hash_key.c_str();
    }
    else
    {
        hash_key = typeid(*this).name();
    }

    // Show or hide the window.  If hiding, save current position and size.
    // If showing, use previous position and size.
    if( show )
    {
#ifndef __WINDOWS__
        wxDialog::Raise();  // Needed on OS X and some other window managers (i.e. Unity)
#endif
        ret = wxDialog::Show( show );

        // classname is key, returns a zeroed out default EDA_RECT if none existed before.
        wxRect savedDialogRect = class_map[ hash_key ];

        if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
        {
            if( m_useCalculatedSize )
            {
                SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
                         wxDialog::GetSize().x, wxDialog::GetSize().y, 0 );
            }
            else
            {
                SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
                         std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
                         std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
                         0 );
            }
        }
        else if( m_initialSize != wxDefaultSize )
            SetSize( m_initialSize );

        // Be sure that the dialog appears in a visible area
        // (the dialog position might have been stored at the time when it was
        // shown on another display)
        if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
            Centre();
    }
    else
    {
        // Save the dialog's position & size before hiding, using classname as key
        class_map[ hash_key ] = wxRect( wxDialog::GetPosition(), wxDialog::GetSize() );

#ifdef __WXMAC__
        if ( m_eventLoop )
            m_eventLoop->Exit( GetReturnCode() );   // Needed for APP-MODAL dlgs on OSX
#endif

        ret = wxDialog::Show( show );
    }

    return ret;
}

References class_map, DIALOG_SHIM::m_hash_key, DIALOG_SHIM::m_initialSize, and DIALOG_SHIM::m_useCalculatedSize.

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), DRC_TOOL::CrossProbe(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), EE_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 423 of file dialog_shim.cpp.

{
    // This is an exception safe way to zero a pointer before returning.
    // Yes, even though DismissModal() clears this first normally, this is
    // here in case there's an exception before the dialog is dismissed.
    struct NULLER
    {
        void*&  m_what;
        NULLER( void*& aPtr ) : m_what( aPtr ) {}
        ~NULLER() { m_what = nullptr; }   // indeed, set it to NULL on destruction
    } clear_this( (void*&) m_qmodal_loop );

    // release the mouse if it's currently captured as the window having it
    // will be disabled when this dialog is shown -- but will still keep the
    // capture making it impossible to do anything in the modal dialog itself
    wxWindow* win = wxWindow::GetCapture();
    if( win )
        win->ReleaseMouse();

    // Get the optimal parent
    wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );

    wxASSERT_MSG( !m_qmodal_parent_disabler,
            wxT( "Caller using ShowQuasiModal() twice on same window?" ) );

    // quasi-modal: disable only my "optimal" parent
    m_qmodal_parent_disabler = new WDO_ENABLE_DISABLE( parent );

    // Apple in its infinite wisdom will raise a disabled window before even passing
    // us the event, so we have no way to stop it.  Instead, we must set an order on
    // the windows so that the quasi-modal will be pushed in front of the disabled
    // window when it is raised.
    KIPLATFORM::UI::ReparentQuasiModal( this );

    Show( true );

    m_qmodal_showing = true;

    WX_EVENT_LOOP event_loop;

    m_qmodal_loop = &event_loop;

    event_loop.Run();

    m_qmodal_showing = false;

    return GetReturnCode();
}

References DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, KIPLATFORM::UI::ReparentQuasiModal(), DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowDimensionPropertiesDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog().

TransferDataToWindow()

bool DIALOG_PRINT_GENERIC::TransferDataToWindow ( )

overrideprotected

Definition at line 164 of file dialog_print_generic.cpp.

{
    if( !wxDialog::TransferDataToWindow() )
        return false;

    if( m_config )
        m_settings->Load( m_config );

    setScaleValue( m_settings->m_scale );
    m_titleBlock->SetValue( m_settings->m_titleBlock );
    m_outputMode->SetSelection( m_settings->m_blackWhite ? 1 : 0 );

    return true;
}

References PRINTOUT_SETTINGS::Load(), PRINTOUT_SETTINGS::m_blackWhite, m_config, DIALOG_PRINT_GENERIC_BASE::m_outputMode, PRINTOUT_SETTINGS::m_scale, m_settings, DIALOG_PRINT_GENERIC_BASE::m_titleBlock, PRINTOUT_SETTINGS::m_titleBlock, and setScaleValue().

Referenced by DIALOG_PRINT_GERBVIEW::TransferDataToWindow(), and DIALOG_PRINT_PCBNEW::TransferDataToWindow().

vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y ) const

protectedinherited

Convert an integer number of dialog units to pixels, vertically.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 176 of file dialog_shim.cpp.

{
    wxSize sz( 0, y );
    return ConvertDialogToPixels( sz ).y;
}

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

m_bUpperSizer

wxBoxSizer* DIALOG_PRINT_GENERIC_BASE::m_bUpperSizer

protectedinherited

Definition at line 50 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), and getMainSizer().

m_buttonOption

wxButton* DIALOG_PRINT_GENERIC_BASE::m_buttonOption

protectedinherited

Definition at line 61 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), and DIALOG_PRINT_GENERIC_BASE::~DIALOG_PRINT_GENERIC_BASE().

m_config

APP_SETTINGS_BASE* DIALOG_PRINT_GENERIC::m_config

protected

Definition at line 101 of file dialog_print_generic.h.

Referenced by DIALOG_PRINT_GERBVIEW::DIALOG_PRINT_GERBVIEW(), DIALOG_PRINT_PCBNEW::DIALOG_PRINT_PCBNEW(), ForcePrintBorder(), saveSettings(), and TransferDataToWindow().

m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent

protectedinherited

Definition at line 208 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

m_gbOptionsSizer

wxGridBagSizer* DIALOG_PRINT_GENERIC_BASE::m_gbOptionsSizer

protectedinherited

Definition at line 52 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), and getOptionsSizer().

m_hash_key

std::string DIALOG_SHIM::m_hash_key

protectedinherited

Definition at line 199 of file dialog_shim.h.

Referenced by DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), PAGED_DIALOG::PAGED_DIALOG(), DIALOG_SHIM::resetSize(), DIALOG_SHIM::SetPosition(), DIALOG_TEXT_AND_LABEL_PROPERTIES::SetTitle(), and DIALOG_SHIM::Show().

m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget

protectedinherited

Definition at line 209 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint(), and DIALOG_SHIM::SetInitialFocus().

m_initialSize

wxSize DIALOG_SHIM::m_initialSize

protectedinherited

Definition at line 221 of file dialog_shim.h.

Referenced by DIALOG_SHIM::Show().

m_outputMode

wxChoice* DIALOG_PRINT_GENERIC_BASE::m_outputMode

protectedinherited

Definition at line 54 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), DIALOG_PRINT_PCBNEW::DIALOG_PRINT_PCBNEW(), DIALOG_PRINT_PCBNEW::onColorModeClicked(), saveSettings(), and TransferDataToWindow().

m_outputModeLabel

wxStaticText* DIALOG_PRINT_GENERIC_BASE::m_outputModeLabel

protectedinherited

Definition at line 53 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE().

m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame

protectedinherited

Definition at line 216 of file dialog_shim.h.

Referenced by DIALOG_ANNOTATE::InitValues(), DIALOG_SHIM::OnCharHook(), and DIALOG_ANNOTATE::~DIALOG_ANNOTATE().

m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop

protectedinherited

Definition at line 211 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

m_qmodal_parent_disabler

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler

protectedinherited

Definition at line 214 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_SHIM::~DIALOG_SHIM().

m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing

protectedinherited

Definition at line 213 of file dialog_shim.h.

Referenced by DIALOG_SHIM::IsQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

m_sbOptionsSizer

wxStaticBoxSizer* DIALOG_PRINT_GENERIC_BASE::m_sbOptionsSizer

protectedinherited

Definition at line 51 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), and getOptionsBox().

m_scale1

wxRadioButton* DIALOG_PRINT_GENERIC_BASE::m_scale1

protectedinherited

Definition at line 56 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), getScaleValue(), and setScaleValue().

m_scaleCustom

wxRadioButton* DIALOG_PRINT_GENERIC_BASE::m_scaleCustom

protectedinherited

Definition at line 58 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), getScaleValue(), onSetCustomScale(), and setScaleValue().

m_scaleCustomText

wxTextCtrl* DIALOG_PRINT_GENERIC_BASE::m_scaleCustomText

protectedinherited

Definition at line 59 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC(), DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), getScaleValue(), setScaleValue(), and DIALOG_PRINT_GENERIC_BASE::~DIALOG_PRINT_GENERIC_BASE().

m_scaleFit

wxRadioButton* DIALOG_PRINT_GENERIC_BASE::m_scaleFit

protectedinherited

Definition at line 57 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), getScaleValue(), and setScaleValue().

m_scaleValidator

wxFloatingPointValidator<double> DIALOG_PRINT_GENERIC::m_scaleValidator

private

Definition at line 106 of file dialog_print_generic.h.

Referenced by DIALOG_PRINT_GENERIC().

m_sdbSizer1

wxStdDialogButtonSizer* DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1

protectedinherited

Definition at line 62 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC(), and DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE().

m_sdbSizer1Apply

wxButton* DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1Apply

protectedinherited

Definition at line 64 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC(), DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), and DIALOG_PRINT_GENERIC_BASE::~DIALOG_PRINT_GENERIC_BASE().

m_sdbSizer1Cancel

wxButton* DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1Cancel

protectedinherited

Definition at line 65 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC(), DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), and DIALOG_PRINT_GENERIC_BASE::~DIALOG_PRINT_GENERIC_BASE().

m_sdbSizer1OK

wxButton* DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1OK

protectedinherited

Definition at line 63 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC(), DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), and DIALOG_PRINT_GENERIC_BASE::~DIALOG_PRINT_GENERIC_BASE().

m_settings

PRINTOUT_SETTINGS* DIALOG_PRINT_GENERIC::m_settings

protected

Definition at line 103 of file dialog_print_generic.h.

Referenced by ForcePrintBorder(), initPrintData(), DIALOG_PRINT_PCBNEW::onColorModeClicked(), onPrintButtonClick(), onPrintPreview(), saveSettings(), DIALOG_PRINT_PCBNEW::settings(), DIALOG_PRINT_GERBVIEW::settings(), and TransferDataToWindow().

m_staticline1

wxStaticLine* DIALOG_PRINT_GENERIC_BASE::m_staticline1

protectedinherited

Definition at line 60 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE().

m_tabOrder

std::vector<wxWindow*> DIALOG_SHIM::m_tabOrder

protectedinherited

Definition at line 218 of file dialog_shim.h.

Referenced by DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), and DIALOG_SHIM::OnCharHook().

m_titleBlock

wxCheckBox* DIALOG_PRINT_GENERIC_BASE::m_titleBlock

protectedinherited

Definition at line 55 of file dialog_print_generic_base.h.

Referenced by DIALOG_PRINT_GENERIC_BASE::DIALOG_PRINT_GENERIC_BASE(), ForcePrintBorder(), saveSettings(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and TransferDataToWindow().

m_units

EDA_UNITS DIALOG_SHIM::m_units

protectedinherited

Definition at line 198 of file dialog_shim.h.

Referenced by DIALOG_BOARD_REANNOTATE::CoordTowxString(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_PAD_PROPERTIES::displayPrimitivesList(), DIALOG_SHIM::GetUserUnits(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_BOARD_REANNOTATE::MakeSampleText(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), and DIALOG_NET_INSPECTOR::onUnitsChanged().

m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize

protectedinherited

Definition at line 203 of file dialog_shim.h.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_ONE_LAYER_SELECTOR::PCB_ONE_LAYER_SELECTOR(), and DIALOG_SHIM::Show().

s_pageSetupData

wxPageSetupDialogData * DIALOG_PRINT_GENERIC::s_pageSetupData = nullptr

staticprivate

Definition at line 109 of file dialog_print_generic.h.

Referenced by initPrintData(), and onPageSetup().

s_PrintData

wxPrintData * DIALOG_PRINT_GENERIC::s_PrintData = nullptr

staticprivate

Definition at line 108 of file dialog_print_generic.h.

Referenced by initPrintData(), onPrintButtonClick(), and onPrintPreview().

---

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

• dialog_print_generic.h
• dialog_print_generic.cpp