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(650, 402), long style=wxDEFAULT_DIALOG_STYLE\|wxRESIZE_BORDER\|wxFULL_REPAINT_ON_RESIZE\|wxSUNKEN_BORDER)

	~DIALOG_KEEPOUT_AREA_PROPERTIES_BASE ()

int	ShowQuasiModal ()

void	EndQuasiModal (int retCode)

bool	IsQuasiModal ()

bool	Show (bool show) override

bool	Enable (bool enable) 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)

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	FixOSXCancelButtonIssue ()
	A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms. More...

Protected Attributes
wxStaticText *	m_staticTextLayerSelection

wxDataViewListCtrl *	m_layers

wxStaticText *	m_staticTextprops

wxRadioBox *	m_OrientEdgesOpt

wxRadioBox *	m_OutlineAppearanceCtrl

wxCheckBox *	m_cbTracksCtrl

wxCheckBox *	m_cbViasCtrl

wxCheckBox *	m_cbCopperPourCtrl

wxStaticLine *	m_staticline1

wxStdDialogButtonSizer *	m_sdbSizerButtons

wxButton *	m_sdbSizerButtonsOK

wxButton *	m_sdbSizerButtonsCancel

std::string	m_hash_key

EVENT_LOOP *	m_qmodal_loop

bool	m_qmodal_showing

WDO_ENABLE_DISABLE *	m_qmodal_parent_disabler

Private Member Functions
void	_wxFB_OnLayerSelection (wxDataViewEvent &event)

Detailed Description

Class DIALOG_KEEPOUT_AREA_PROPERTIES_BASE.

Definition at line 38 of file dialog_keepout_area_properties_base.h.

Constructor & Destructor Documentation

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( 650,402 )`,
		long	style = `wxDEFAULT_DIALOG_STYLE\|wxRESIZE_BORDER\|wxFULL_REPAINT_ON_RESIZE\|wxSUNKEN_BORDER`
	)

Definition at line 16 of file dialog_keepout_area_properties_base.cpp.

                                                                                                                                                                                      : DIALOG_SHIM( parent, id, title, pos, size, style )
 {
     this->SetSizeHints( wxSize( 500,-1 ), wxDefaultSize );
     
     wxBoxSizer* m_MainSizer;
     m_MainSizer = new wxBoxSizer( wxVERTICAL );
     
     wxBoxSizer* m_UpperSizer;
     m_UpperSizer = new wxBoxSizer( wxHORIZONTAL );
     
     wxBoxSizer* m_layersListSizer;
     m_layersListSizer = new wxBoxSizer( wxVERTICAL );
     
     m_staticTextLayerSelection = new wxStaticText( this, wxID_ANY, _("Keepout Area Layers:"), wxDefaultPosition, wxDefaultSize, 0 );
     m_staticTextLayerSelection->Wrap( -1 );
     m_layersListSizer->Add( m_staticTextLayerSelection, 0, wxTOP|wxRIGHT|wxLEFT, 5 );
     
     m_layers = new wxDataViewListCtrl( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxDV_HORIZ_RULES|wxDV_NO_HEADER );
     m_layersListSizer->Add( m_layers, 1, wxALL|wxEXPAND, 5 );
     
     
     m_UpperSizer->Add( m_layersListSizer, 1, wxEXPAND, 5 );
     
     wxBoxSizer* bSizerRight;
     bSizerRight = new wxBoxSizer( wxVERTICAL );
     
     m_staticTextprops = new wxStaticText( this, wxID_ANY, _("Properties:"), wxDefaultPosition, wxDefaultSize, 0 );
     m_staticTextprops->Wrap( -1 );
     bSizerRight->Add( m_staticTextprops, 0, wxTOP|wxRIGHT|wxLEFT, 5 );
     
     wxString m_OrientEdgesOptChoices[] = { _("Any orientation"), _("180, 90, and 45 degrees") };
     int m_OrientEdgesOptNChoices = sizeof( m_OrientEdgesOptChoices ) / sizeof( wxString );
     m_OrientEdgesOpt = new wxRadioBox( this, wxID_ANY, _("Zone Edge Orientation:"), wxDefaultPosition, wxDefaultSize, m_OrientEdgesOptNChoices, m_OrientEdgesOptChoices, 1, wxRA_SPECIFY_COLS );
     m_OrientEdgesOpt->SetSelection( 1 );
     bSizerRight->Add( m_OrientEdgesOpt, 0, wxEXPAND|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
     
     wxString m_OutlineAppearanceCtrlChoices[] = { _("Line"), _("Hatched Outline"), _("Full Hatched") };
     int m_OutlineAppearanceCtrlNChoices = sizeof( m_OutlineAppearanceCtrlChoices ) / sizeof( wxString );
     m_OutlineAppearanceCtrl = new wxRadioBox( this, wxID_ANY, _("Outline Appearence:"), wxDefaultPosition, wxDefaultSize, m_OutlineAppearanceCtrlNChoices, m_OutlineAppearanceCtrlChoices, 1, wxRA_SPECIFY_COLS );
     m_OutlineAppearanceCtrl->SetSelection( 1 );
     bSizerRight->Add( m_OutlineAppearanceCtrl, 0, wxALL|wxEXPAND, 5 );
     
     wxStaticBoxSizer* sbSizerCutoutOpts;
     sbSizerCutoutOpts = new wxStaticBoxSizer( new wxStaticBox( this, wxID_ANY, _("Keepout Options:") ), wxVERTICAL );
     
     m_cbTracksCtrl = new wxCheckBox( sbSizerCutoutOpts->GetStaticBox(), wxID_ANY, _("No tracks"), wxDefaultPosition, wxDefaultSize, 0 );
     sbSizerCutoutOpts->Add( m_cbTracksCtrl, 0, wxTOP|wxRIGHT|wxLEFT|wxEXPAND, 5 );
     
     m_cbViasCtrl = new wxCheckBox( sbSizerCutoutOpts->GetStaticBox(), wxID_ANY, _("No vias"), wxDefaultPosition, wxDefaultSize, 0 );
     sbSizerCutoutOpts->Add( m_cbViasCtrl, 0, wxTOP|wxRIGHT|wxLEFT|wxEXPAND, 5 );
     
     m_cbCopperPourCtrl = new wxCheckBox( sbSizerCutoutOpts->GetStaticBox(), wxID_ANY, _("No copper pour"), wxDefaultPosition, wxDefaultSize, 0 );
     sbSizerCutoutOpts->Add( m_cbCopperPourCtrl, 0, wxALL|wxEXPAND, 5 );
     
     
     bSizerRight->Add( sbSizerCutoutOpts, 0, wxEXPAND|wxALL, 5 );
     
     
     m_UpperSizer->Add( bSizerRight, 0, wxEXPAND, 5 );
     
     
     m_MainSizer->Add( m_UpperSizer, 1, wxEXPAND, 5 );
     
     m_staticline1 = new wxStaticLine( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLI_HORIZONTAL );
     m_MainSizer->Add( m_staticline1, 0, wxEXPAND | wxALL, 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();
     
     m_MainSizer->Add( m_sdbSizerButtons, 0, wxEXPAND|wxALL, 5 );
     
     
     this->SetSizer( m_MainSizer );
     this->Layout();
     
     this->Centre( wxBOTH );
 }

DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::~DIALOG_KEEPOUT_AREA_PROPERTIES_BASE ( )

Definition at line 98 of file dialog_keepout_area_properties_base.cpp.

99 {

100 }

Member Function Documentation

void DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::_wxFB_OnLayerSelection ( wxDataViewEvent & event )

inlineprivate

Definition at line 44 of file dialog_keepout_area_properties_base.h.

References OnLayerSelection().

44 { OnLayerSelection( event ); }

DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::OnLayerSelection

virtual void OnLayerSelection(wxDataViewEvent &event)

Definition: dialog_keepout_area_properties_base.h:62

bool DIALOG_SHIM::Enable ( bool enable )

overrideinherited

Definition at line 182 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues().

 {
     // 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" );
 #endif
 
     return wxDialog::Enable( enable );
 }

void DIALOG_SHIM::EndQuasiModal ( int retCode )

inherited

Definition at line 540 of file dialog_shim.cpp.

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_ONE_FIELD::OnCancelClick(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCloseDialog(), DIALOG_EDIT_ONE_FIELD::OnCloseDialog(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCloseDialog(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), DIALOG_EDIT_ONE_FIELD::OnOkClick(), DIALOG_EXCHANGE_MODULE::OnQuit(), DIALOG_CHOOSE_COMPONENT::OnSchViewDClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), and DIALOG_SHIM::~DIALOG_SHIM().

 {
     // 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;
     }
 
     m_qmodal_showing = false;
 
     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 );
 }

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

References PCAD2KICAD::Center.

 {
     // 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();
 }

void DIALOG_SHIM::FixOSXCancelButtonIssue ( )

protectedinherited

A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms.

Definition at line 117 of file dialog_shim.cpp.

Referenced by DIALOG_SHIM::Show().

 {
 #ifdef  __WXMAC__
     // A ugly hack to fix an issue on OSX: ctrl+c closes the dialog instead of
     // copying a text if a  button with wxID_CANCEL is used in a wxStdDialogButtonSizer
     // created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority
     // to copy text standard accelerator, and the dlg is closed when trying to copy text
     wxButton* button = dynamic_cast< wxButton* > ( wxWindow::FindWindowById( wxID_CANCEL, this ) );
 
     if( button )
         button->SetLabel( _( "Cancel" ) );
 #endif
 }

bool DIALOG_SHIM::IsQuasiModal ( )

inlineinherited

Definition at line 93 of file dialog_shim.h.

References DIALOG_SHIM::m_qmodal_showing.

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::EndQuasiModal(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_ONE_FIELD::OnCancelClick(), DIALOG_EDIT_ONE_FIELD::OnCloseDialog(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EDIT_ONE_FIELD::OnOkClick(), FOOTPRINT_SELECT_WIDGET::ShowPicker(), EDA_BASE_FRAME::windowClosing(), and DIALOG_SHIM::~DIALOG_SHIM().

93 { return m_qmodal_showing; }

DIALOG_SHIM::m_qmodal_showing

bool m_qmodal_showing

Definition: dialog_shim.h:132

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.

References KIWAY_HOLDER::m_kiway.

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

virtual void DIALOG_KEEPOUT_AREA_PROPERTIES_BASE::OnLayerSelection ( wxDataViewEvent & event )

inlineprotectedvirtual

Reimplemented in DIALOG_KEEPOUT_AREA_PROPERTIES.

Definition at line 62 of file dialog_keepout_area_properties_base.h.

Referenced by _wxFB_OnLayerSelection().

62 { event.Skip(); }

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.

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

 {
     return Kiway().Prj();
 }

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 41 of file kiway_holder.cpp.

References KIWAY_HOLDER::m_kiway, and name.

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

 {
 #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;
 }

bool DIALOG_SHIM::Show ( bool show )

overrideinherited

Definition at line 139 of file dialog_shim.cpp.

References class_map, DIALOG_SHIM::FixOSXCancelButtonIssue(), EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, wxPoint::x, and wxPoint::y.

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_ANNOTATE::OnApplyClick(), DIALOG_SCH_FIND::OnCancel(), DIALOG_ANNOTATE::OnCancelClick(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_MODULE::OnQuit(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), and DIALOG_SHIM::ShowQuasiModal().

 {
     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 )
     {
         wxDialog::Raise();  // Needed on OS X and some other window managers (i.e. Unity)
         ret = wxDialog::Show( show );
 
         // classname is key, returns a zeroed out default EDA_RECT if none existed before.
         EDA_RECT r = class_map[ hash_key ];
 
         if( r.GetSize().x != 0 && r.GetSize().y != 0 )
             SetSize( r.GetPosition().x, r.GetPosition().y, r.GetSize().x, r.GetSize().y, 0 );
     }
     else
     {
         // Save the dialog's position & size before hiding, using classname as key
         EDA_RECT  r( wxDialog::GetPosition(), wxDialog::GetSize() );
         class_map[ hash_key ] = r;
 
         ret = wxDialog::Show( show );
     }
 
     FixOSXCancelButtonIssue();
 
     return ret;
 }

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 495 of file dialog_shim.cpp.

References DBG, DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, and DIALOG_SHIM::Show().

Referenced by LIB_EDIT_FRAME::DeleteOnePart(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), SCH_EDIT_FRAME::InstallHierarchyFrame(), InvokeDialogCreateBOMEditor(), InvokeDialogUpdateFields(), LIB_VIEW_FRAME::OnSelectSymbol(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

 {
     // 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 );
 
     Show( true );
 
     m_qmodal_showing = true;
 
     EVENT_LOOP event_loop;
 
     m_qmodal_loop = &event_loop;
 
     event_loop.Run();
 
     return GetReturnCode();
 }