Class DIALOG_KEEPOUT_AREA_PROPERTIES_BASE. More...

#include <dialog_keepout_area_properties_base.h>

Inheritance diagram for DIALOG_KEEPOUT_AREA_PROPERTIES_BASE:

Public Member Functions
	DIALOG_KEEPOUT_AREA_PROPERTIES_BASE (wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Keepout Area Properties"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE\|wxRESIZE_BORDER\|wxFULL_REPAINT_ON_RESIZE\|wxBORDER_SUNKEN)

	~DIALOG_KEEPOUT_AREA_PROPERTIES_BASE ()

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 ()

bool	Show (bool show) override

bool	Enable (bool enable) override

void	OnPaint (wxPaintEvent &event)

EDA_UNITS_T	GetUserUnits () const override

KIWAY &	Kiway () const
	Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...

PROJECT &	Prj () const
	Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...

void	SetKiway (wxWindow aDest, KIWAY aKiway)
	Function SetKiway. More...

Protected Member Functions
virtual void	OnLayerSelection (wxDataViewEvent &event)

virtual void	OnSizeLayersList (wxSizeEvent &event)

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)
	Convert an integer number of dialog units to pixels, horizontally. More...

int	VertPixelsFromDU (int y)
	Convert an integer number of dialog units to pixels, vertically. More...

Protected Attributes
wxStaticText *	m_staticTextLayerSelection

wxDataViewListCtrl *	m_layers

wxCheckBox *	m_cbTracksCtrl

wxCheckBox *	m_cbViasCtrl

wxCheckBox *	m_cbCopperPourCtrl

wxCheckBox *	m_cbConstrainCtrl

wxStaticText *	m_staticTextStyle

wxChoice *	m_OutlineAppearanceCtrl

wxStaticLine *	m_staticline1

wxStdDialogButtonSizer *	m_sdbSizerButtons

wxButton *	m_sdbSizerButtonsOK

wxButton *	m_sdbSizerButtonsCancel

EDA_UNITS_T	m_units

std::string	m_hash_key

bool	m_firstPaintEvent

wxWindow *	m_initialFocusTarget

WX_EVENT_LOOP *	m_qmodal_loop

bool	m_qmodal_showing

WDO_ENABLE_DISABLE *	m_qmodal_parent_disabler

Detailed Description

Class DIALOG_KEEPOUT_AREA_PROPERTIES_BASE.

Definition at line 35 of file dialog_keepout_area_properties_base.h.

Constructor & Destructor Documentation

◆ DIALOG_KEEPOUT_AREA_PROPERTIES_BASE()

DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::DIALOG_KEEPOUT_AREA_PROPERTIES_BASE	(	wxWindow *	parent,
		wxWindowID	id = `wxID_ANY`,
		const wxString &	title = `_("Keepout Area Properties")`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxSize( -1,-1 )`,
		long	style = `wxDEFAULT_DIALOG_STYLE\|wxRESIZE_BORDER\|wxFULL_REPAINT_ON_RESIZE\|wxBORDER_SUNKEN`
	)

Definition at line 12 of file dialog_keepout_area_properties_base.cpp.

                                                                                                                                                                                      : DIALOG_SHIM( parent, id, title, pos, size, style )
 {
     this->SetSizeHints( wxSize( -1,-1 ), wxDefaultSize );
     
     wxBoxSizer* bMainSizer;
     bMainSizer = new wxBoxSizer( wxVERTICAL );
     
     wxBoxSizer* bUpperSizer;
     bUpperSizer = new wxBoxSizer( wxHORIZONTAL );
     
     wxBoxSizer* bLayersListSizer;
     bLayersListSizer = new wxBoxSizer( wxVERTICAL );
     
     m_staticTextLayerSelection = new wxStaticText( this, wxID_ANY, _("Layers:"), wxDefaultPosition, wxDefaultSize, 0 );
     m_staticTextLayerSelection->Wrap( -1 );
     bLayersListSizer->Add( m_staticTextLayerSelection, 0, wxTOP|wxRIGHT|wxLEFT, 5 );
     
     m_layers = new wxDataViewListCtrl( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxDV_NO_HEADER|wxBORDER_SIMPLE );
     bLayersListSizer->Add( m_layers, 1, wxEXPAND|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
     
     
     bUpperSizer->Add( bLayersListSizer, 1, wxEXPAND|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
     
     wxBoxSizer* bSizerRight;
     bSizerRight = new wxBoxSizer( wxVERTICAL );
     
     m_cbTracksCtrl = new wxCheckBox( this, wxID_ANY, _("Keep out tracks"), wxDefaultPosition, wxDefaultSize, 0 );
     bSizerRight->Add( m_cbTracksCtrl, 0, wxTOP|wxRIGHT|wxLEFT|wxEXPAND, 5 );
     
     m_cbViasCtrl = new wxCheckBox( this, wxID_ANY, _("Keep out vias"), wxDefaultPosition, wxDefaultSize, 0 );
     bSizerRight->Add( m_cbViasCtrl, 0, wxTOP|wxRIGHT|wxLEFT|wxEXPAND, 5 );
     
     m_cbCopperPourCtrl = new wxCheckBox( this, wxID_ANY, _("Keep out copper pours"), wxDefaultPosition, wxDefaultSize, 0 );
     bSizerRight->Add( m_cbCopperPourCtrl, 0, wxALL|wxEXPAND, 5 );
     
     
     bSizerRight->Add( 0, 0, 0, wxEXPAND|wxTOP|wxBOTTOM, 5 );
     
     m_cbConstrainCtrl = new wxCheckBox( this, wxID_ANY, _("Constrain outline to H, V and 45 deg"), wxDefaultPosition, wxDefaultSize, 0 );
     bSizerRight->Add( m_cbConstrainCtrl, 0, wxALL, 5 );
     
     wxBoxSizer* bSizerLowerRight;
     bSizerLowerRight = new wxBoxSizer( wxHORIZONTAL );
     
     m_staticTextStyle = new wxStaticText( this, wxID_ANY, _("Outline display:"), wxDefaultPosition, wxDefaultSize, 0 );
     m_staticTextStyle->Wrap( -1 );
     bSizerLowerRight->Add( m_staticTextStyle, 0, wxALIGN_CENTER_VERTICAL|wxRIGHT|wxLEFT, 5 );
     
     wxString m_OutlineAppearanceCtrlChoices[] = { _("Line"), _("Hatched"), _("Fully hatched") };
     int m_OutlineAppearanceCtrlNChoices = sizeof( m_OutlineAppearanceCtrlChoices ) / sizeof( wxString );
     m_OutlineAppearanceCtrl = new wxChoice( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, m_OutlineAppearanceCtrlNChoices, m_OutlineAppearanceCtrlChoices, 0 );
     m_OutlineAppearanceCtrl->SetSelection( 0 );
     bSizerLowerRight->Add( m_OutlineAppearanceCtrl, 0, wxRIGHT|wxLEFT|wxEXPAND, 5 );
     
     
     bSizerRight->Add( bSizerLowerRight, 1, wxEXPAND, 5 );
     
     
     bUpperSizer->Add( bSizerRight, 0, wxEXPAND|wxALL, 10 );
     
     
     bMainSizer->Add( bUpperSizer, 1, wxEXPAND|wxTOP|wxRIGHT|wxLEFT, 5 );
     
     m_staticline1 = new wxStaticLine( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLI_HORIZONTAL );
     bMainSizer->Add( m_staticline1, 0, wxEXPAND|wxTOP|wxRIGHT|wxLEFT, 5 );
     
     m_sdbSizerButtons = new wxStdDialogButtonSizer();
     m_sdbSizerButtonsOK = new wxButton( this, wxID_OK );
     m_sdbSizerButtons->AddButton( m_sdbSizerButtonsOK );
     m_sdbSizerButtonsCancel = new wxButton( this, wxID_CANCEL );
     m_sdbSizerButtons->AddButton( m_sdbSizerButtonsCancel );
     m_sdbSizerButtons->Realize();
     
     bMainSizer->Add( m_sdbSizerButtons, 0, wxEXPAND|wxALL, 5 );
     
     
     this->SetSizer( bMainSizer );
     this->Layout();
     bMainSizer->Fit( this );
     
     this->Centre( wxBOTH );
     
     // Connect Events
     m_layers->Connect( wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED, wxDataViewEventHandler( DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::OnLayerSelection ), NULL, this );
     m_layers->Connect( wxEVT_SIZE, wxSizeEventHandler( DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::OnSizeLayersList ), NULL, this );
 }

References m_cbConstrainCtrl, m_cbCopperPourCtrl, m_cbTracksCtrl, m_cbViasCtrl, m_layers, m_OutlineAppearanceCtrl, m_sdbSizerButtons, m_sdbSizerButtonsCancel, m_sdbSizerButtonsOK, m_staticline1, m_staticTextLayerSelection, m_staticTextStyle, OnLayerSelection(), and OnSizeLayersList().

◆ ~DIALOG_KEEPOUT_AREA_PROPERTIES_BASE()

DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::~DIALOG_KEEPOUT_AREA_PROPERTIES_BASE ( )

Definition at line 99 of file dialog_keepout_area_properties_base.cpp.

 {
     // Disconnect Events
     m_layers->Disconnect( wxEVT_COMMAND_DATAVIEW_ITEM_VALUE_CHANGED, wxDataViewEventHandler( DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::OnLayerSelection ), NULL, this );
     m_layers->Disconnect( wxEVT_SIZE, wxSizeEventHandler( DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::OnSizeLayersList ), NULL, this );
     
 }

References m_layers, OnLayerSelection(), and OnSizeLayersList().

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool enable )

overrideinherited

Definition at line 230 of file dialog_shim.cpp.

 {
     // so we can do logging of this state change:
 
 #if defined(DEBUG)
     const char* type_id = typeid( *this ).name();
     printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
     fflush(0);  //Needed on msys2 to immediately print the message
 #endif
 
     return wxDialog::Enable( enable );
 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int retCode )

inherited

Definition at line 391 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( wxT( "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 = NULL;
     }
 
     delete m_qmodal_parent_disabler;
     m_qmodal_parent_disabler = 0;
 
     Show( false );
 }

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_COMPONENT::OnUseBrowser(), 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, when all widgets are initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at end of TransferDataToWindow, or better at end of a wxInitDialogEvent handler

In any case, the best way is to call it in a wxInitDialogEvent handler after calling TransfertDataToWindow(), which is the default wxInitDialogEvent handler wxDialog

Definition at line 129 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 );
 
     // the default position, when calling the first time the dlg
     Center();
 }

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXIT::DIALOG_EXIT(), 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_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_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_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetUserUnits()

EDA_UNITS_T DIALOG_SHIM::GetUserUnits ( ) const

inlineoverrideinherited

Definition at line 133 of file dialog_shim.h.

133 { return m_units; }

DIALOG_SHIM::m_units

EDA_UNITS_T m_units

Definition: dialog_shim.h:173

References DIALOG_SHIM::m_units.

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_ERC::DisplayERC_MarkersList(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::onCellChanging(), DIALOG_PAD_PROPERTIES::padValuesOK(), DIALOG_ERC::TestErc(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), DIALOG_POSITION_RELATIVE::updateDialogControls(), DIALOG_MOVE_EXACT::updateDialogControls(), and DIALOG_DRC_CONTROL::writeReport().

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int x )

protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 150 of file dialog_shim.cpp.

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

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

◆ IsQuasiModal()

bool DIALOG_SHIM::IsQuasiModal ( )

inlineinherited

Definition at line 125 of file dialog_shim.h.

125 { return m_qmodal_showing; }

DIALOG_SHIM::m_qmodal_showing

bool m_qmodal_showing

Definition: dialog_shim.h:184

References DIALOG_SHIM::m_qmodal_showing.

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::EndQuasiModal(), EDA_BASE_FRAME::findQuasiModalDialog(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_SHIM::OnCloseWindow(), FOOTPRINT_SELECT_WIDGET::ShowPicker(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Function Kiway returns 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 60 of file kiway_player.h.

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

References KIWAY_HOLDER::m_kiway.

◆ OnLayerSelection()

virtual void DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::OnLayerSelection ( wxDataViewEvent & event )

inlineprotectedvirtual

Reimplemented in DIALOG_KEEPOUT_AREA_PROPERTIES.

Definition at line 54 of file dialog_keepout_area_properties_base.h.

54 { event.Skip(); }

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE(), and ~DIALOG_KEEPOUT_AREA_PROPERTIES_BASE().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent & event )

inherited

Definition at line 293 of file dialog_shim.cpp.

 {
     if( m_firstPaintEvent )
     {
 #ifdef __WXMAC__
         fixOSXCancelButtonIssue( this );
         selectAllInTextCtrls( GetChildren() );
 #endif
 
         if( m_initialFocusTarget )
             m_initialFocusTarget->SetFocus();
         else
             SetFocus();     // Focus the dialog itself
 
         m_firstPaintEvent = false;
     }
 
     event.Skip();
 }

References DIALOG_SHIM::m_firstPaintEvent, and DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnSizeLayersList()

virtual void DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::OnSizeLayersList ( wxSizeEvent & event )

inlineprotectedvirtual

Definition at line 55 of file dialog_keepout_area_properties_base.h.

55 { event.Skip(); }

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE(), and ~DIALOG_KEEPOUT_AREA_PROPERTIES_BASE().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Function Prj returns a reference to the PROJECT "associated with" this KIWAY.

Definition at line 34 of file kiway_holder.cpp.

 {
     return Kiway().Prj();
 }

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

◆ 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 116 of file dialog_shim.h.

     {
         m_initialFocusTarget = aWindow;
     }

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_EDIT_ONE_FIELD::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(), LIB_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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

inherited

Function SetKiway.

Parameters

aDest	is the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
aKiway	is often from a parent window, or from KIFACE::CreateWindow().

Definition at line 47 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;
         (void) breakhere;
     }
 #endif
 
     (void) aDest;
 
     m_kiway = aKiway;
 }

References KIWAY_HOLDER::m_kiway, and name.

Referenced by InvokePcbLibTableEditor(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ 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 143 of file dialog_shim.cpp.

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

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), 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 171 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.
         EDA_RECT savedDialogRect = class_map[ hash_key ];
 
         if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
         {
             SetSize( savedDialogRect.GetPosition().x,
                      savedDialogRect.GetPosition().y,
                      std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
                      std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
                      0 );
         }
 
         // 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 ] = EDA_RECT( 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, EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, and max.

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_SCH_FIND::OnCancel(), SCH_EDIT_FRAME::OnFindItems(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 337 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 = 0; }   // 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() );
 
     // Show the optimal parent
     DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
 
     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 );
 
 #ifdef  __WXMAC__
     // 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.
     ReparentQuasiModal();
 #endif
     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 DBG, DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), SCH_EDIT_FRAME::InstallHierarchyFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), LIB_EDIT_FRAME::OnEditComponentProperties(), PCB_EDIT_FRAME::OnEditTracksAndVias(), SCH_EDIT_FRAME::OnLaunchBomManager(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectComponentFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int y )

protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 157 of file dialog_shim.cpp.

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

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

Member Data Documentation

◆ m_cbConstrainCtrl

wxCheckBox* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_cbConstrainCtrl

protected

Definition at line 45 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataFromWindow(), and DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow().

◆ m_cbCopperPourCtrl

wxCheckBox* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_cbCopperPourCtrl

protected

Definition at line 44 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataFromWindow(), and DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow().

◆ m_cbTracksCtrl

wxCheckBox* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_cbTracksCtrl

protected

Definition at line 42 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataFromWindow(), and DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow().

◆ m_cbViasCtrl

wxCheckBox* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_cbViasCtrl

protected

Definition at line 43 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataFromWindow(), and DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent

protectedinherited

Definition at line 179 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

std::string DIALOG_SHIM::m_hash_key

protectedinherited

Definition at line 174 of file dialog_shim.h.

Referenced by DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), PAGED_DIALOG::PAGED_DIALOG(), DIALOG_LABEL_EDITOR::SetTitle(), and DIALOG_SHIM::Show().

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget

protectedinherited

Definition at line 180 of file dialog_shim.h.

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

◆ m_layers

wxDataViewListCtrl* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_layers

protected

Definition at line 41 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_KEEPOUT_AREA_PROPERTIES_BASE(), DIALOG_KEEPOUT_AREA_PROPERTIES::OnLayerSelection(), and ~DIALOG_KEEPOUT_AREA_PROPERTIES_BASE().

◆ m_OutlineAppearanceCtrl

wxChoice* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_OutlineAppearanceCtrl

protected

Definition at line 47 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataFromWindow(), and DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop

protectedinherited

Definition at line 183 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 185 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 184 of file dialog_shim.h.

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

◆ m_sdbSizerButtons

wxStdDialogButtonSizer* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_sdbSizerButtons

protected

Definition at line 49 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE().

◆ m_sdbSizerButtonsCancel

wxButton* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_sdbSizerButtonsCancel

protected

Definition at line 51 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE().

◆ m_sdbSizerButtonsOK

wxButton* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_sdbSizerButtonsOK

protected

Definition at line 50 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), and DIALOG_KEEPOUT_AREA_PROPERTIES_BASE().

◆ m_staticline1

wxStaticLine* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_staticline1

protected

Definition at line 48 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE().

◆ m_staticTextLayerSelection

wxStaticText* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_staticTextLayerSelection

protected

Definition at line 40 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE().

◆ m_staticTextStyle

wxStaticText* DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::m_staticTextStyle

protected

Definition at line 46 of file dialog_keepout_area_properties_base.h.

Referenced by DIALOG_KEEPOUT_AREA_PROPERTIES_BASE().

◆ m_units

EDA_UNITS_T DIALOG_SHIM::m_units

protectedinherited

Definition at line 173 of file dialog_shim.h.

Referenced by DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_PAD_PROPERTIES::displayPrimitivesList(), DIALOG_SHIM::GetUserUnits(), and DIALOG_NETLIST::OnTestFootprintsClick().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DIALOG_KEEPOUT_AREA_PROPERTIES_BASE()

◆ ~DIALOG_KEEPOUT_AREA_PROPERTIES_BASE()

Member Function Documentation

◆ Enable()

◆ EndQuasiModal()

◆ FinishDialogSettings()

◆ GetUserUnits()

◆ HorizPixelsFromDU()

◆ IsQuasiModal()

◆ Kiway()

◆ OnLayerSelection()

◆ OnPaint()

◆ OnSizeLayersList()

◆ Prj()

◆ SetInitialFocus()

◆ SetKiway()

◆ SetSizeInDU()

◆ Show()

◆ ShowQuasiModal()

◆ VertPixelsFromDU()

Member Data Documentation

◆ m_cbConstrainCtrl

◆ m_cbCopperPourCtrl

◆ m_cbTracksCtrl

◆ m_cbViasCtrl

◆ m_firstPaintEvent

◆ m_hash_key

◆ m_initialFocusTarget

◆ m_layers

◆ m_OutlineAppearanceCtrl

◆ m_qmodal_loop

◆ m_qmodal_parent_disabler

◆ m_qmodal_showing

◆ m_sdbSizerButtons

◆ m_sdbSizerButtonsCancel

◆ m_sdbSizerButtonsOK

◆ m_staticline1

◆ m_staticTextLayerSelection

◆ m_staticTextStyle

◆ m_units