KIUI Namespace Reference

Functions
void	ValidatorTransferToWindowWithoutEvents (wxValidator &aValidator)
	Call a text validator's TransferDataToWindow method without firing a text change event. More...
void	SetControlsTabOrder (const std::vector< wxWindow * > &aControlsInTabOrder)
	Set a list of controls to have a defined sequential tab order. More...
int	GetStdMargin ()
	Get the standard margin around a widget in the KiCad UI. More...
wxSize	GetTextSize (const wxString &aSingleLine, wxWindow *aWindow)
	Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currently set in that window. More...
wxFont	GetMonospacedUIFont ()
wxFont	GetControlFont (wxWindow *aWindow)
wxFont	GetInfoFont (wxWindow *aWindow)
wxFont	GetDockedPaneFont (wxWindow *aWindow)
wxFont	GetStatusFont (wxWindow *aWindow)
bool	EnsureTextCtrlWidth (wxTextCtrl *aCtrl, const wxString *aString=nullptr)
	Set the minimum pixel width on a text control in order to make a text string be fully visible within it. More...
void	SelectReferenceNumber (wxTextEntry *aTextEntry)
	Select the number (or "?") in a reference for ease of editing. More...
wxString	EllipsizeStatusText (wxWindow *aWindow, const wxString &aString)
	Ellipsize text (at the end) to be no more than 1/3 of the window width. More...
wxString	EllipsizeMenuText (const wxString &aString)
	Ellipsize text (at the end) to be no more than 36 characters. More...
bool	IsInputControlFocused (wxWindow *aFocus=nullptr)
	Check if a input control has focus. More...
bool	IsInputControlEditable (wxWindow *aControl)
	Check if a input control has focus. More...
bool	IsModalDialogFocused ()
void	Disable (wxWindow *aWindow)
	Makes a window read-only. More...

Function Documentation

Disable()

void KIUI::Disable

(

wxWindow *

aWindow

)

Makes a window read-only.

Does some extra work over wxWindow::Disable() to make sure you can still scroll around in sub-windows.

Definition at line 321 of file ui_common.cpp.

{
 wxScrollBar* scrollBar = dynamic_cast<wxScrollBar*>( aWindow );
 wxGrid* grid = dynamic_cast<wxGrid*>( aWindow );
 wxStyledTextCtrl* scintilla = dynamic_cast<wxStyledTextCtrl*>( aWindow );
 wxControl* control = dynamic_cast<wxControl*>( aWindow );
 
 if( scrollBar )
 {
 // Leave a scroll bar active
 }
 else if( grid )
 {
 for( int row = 0; row < grid->GetNumberRows(); ++row )
 {
 for( int col = 0; col < grid->GetNumberCols(); ++col )
 grid->SetReadOnly( row, col );
 }
 }
 else if( scintilla )
 {
 scintilla->SetReadOnly( true );
 }
 else if( control )
 {
 control->Disable();
 }
 else
 {
 for( wxWindow* child : aWindow->GetChildren() )
 Disable( child );
 }
}

References Disable(), and grid.

Referenced by Disable(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_BOARD_SETUP::onPageChanged(), and PANEL_DATA_COLLECTION::TransferDataToWindow().

EllipsizeMenuText()

wxString KIUI::EllipsizeMenuText

(

const wxString &

aString

)

Ellipsize text (at the end) to be no more than 36 characters.

Returns

shortened text ending with an ellipsis.

Definition at line 215 of file ui_common.cpp.

{
 wxString msg = UnescapeString( aString );
 
 msg.Replace( wxT( "\n" ), wxT( " " ) );
 msg.Replace( wxT( "\r" ), wxT( " " ) );
 msg.Replace( wxT( "\t" ), wxT( " " ) );
 
 if( msg.Length() > 36 )
 msg = msg.Left( 34 ) + wxT( "..." );
 
 return msg;
}

References UnescapeString().

Referenced by LIB_FIELD::GetItemDescription(), LIB_TEXT::GetItemDescription(), SCH_FIELD::GetItemDescription(), SCH_LABEL::GetItemDescription(), SCH_GLOBALLABEL::GetItemDescription(), SCH_HIERLABEL::GetItemDescription(), SCH_SHEET_PIN::GetItemDescription(), SCH_TEXT::GetItemDescription(), FP_TEXT::GetItemDescription(), and PCB_TEXT::GetItemDescription().

EllipsizeStatusText()

wxString KIUI::EllipsizeStatusText	(	wxWindow *	aWindow,
		const wxString &	aString
	)

Ellipsize text (at the end) to be no more than 1/3 of the window width.

Returns

shortened text ending with an ellipsis.

Definition at line 197 of file ui_common.cpp.

{
 wxString msg = UnescapeString( aString );
 
 msg.Replace( wxT( "\n" ), wxT( " " ) );
 msg.Replace( wxT( "\r" ), wxT( " " ) );
 msg.Replace( wxT( "\t" ), wxT( " " ) );
 
 wxClientDC dc( aWindow );
 int statusWidth = aWindow->GetSize().GetWidth();
 
 // 30% of the first 800 pixels plus 60% of the remaining width
 int textWidth = std::min( statusWidth, 800 ) * 0.3 + std::max( statusWidth - 800, 0 ) * 0.6;
 
 return wxControl::Ellipsize( msg, dc, wxELLIPSIZE_END, textWidth );
}

References UnescapeString().

Referenced by LIB_TEXTBOX::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), and PCB_TEXTBOX::GetMsgPanelInfo().

EnsureTextCtrlWidth()

bool KIUI::EnsureTextCtrlWidth	(	wxTextCtrl *	aCtrl,
		const wxString *	aString = nullptr
	)

Set the minimum pixel width on a text control in order to make a text string be fully visible within it.

The current font within the text control is considered. The text can come either from the control or be given as an argument. If the text control is larger than needed, then nothing is done.

Parameters

aCtrl	the text control to potentially make wider.
aString	the text that is used in sizing the control's pixel width. If NULL, then the text already within the control is used.

Returns

true if the aCtrl had its size changed, else false.

Definition at line 168 of file ui_common.cpp.

{
 wxWindow* window = aCtrl->GetParent();
 
 if( !window )
 window = aCtrl;
 
 wxString ctrlText;
 
 if( !aString )
 {
 ctrlText = aCtrl->GetValue();
 aString = &ctrlText;
 }
 
 wxSize textz = GetTextSize( *aString, window );
 wxSize ctrlz = aCtrl->GetSize();
 
 if( ctrlz.GetWidth() < textz.GetWidth() + 10 )
 {
 ctrlz.SetWidth( textz.GetWidth() + 10 );
 aCtrl->SetSizeHints( ctrlz );
 return true;
 }
 
 return false;
}

References GetTextSize().

Referenced by GERBVIEW_FRAME::UpdateTitleAndInfo().

GetControlFont()

wxFont KIUI::GetControlFont

(

wxWindow *

aWindow

)

Definition at line 162 of file ui_common.cpp.

{
 return getGUIFont( aWindow, 0 );
}

References getGUIFont().

Referenced by EDA_MSG_PANEL::GetRequiredHeight(), EDA_MSG_PANEL::OnPaint(), PAGED_DIALOG::PAGED_DIALOG(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), PROJECT_TREE::PROJECT_TREE(), WX_GRID::SetLabelFont(), SIM_NOPLOT_PANEL::SIM_NOPLOT_PANEL(), and WX_GRID::WX_GRID().

GetDockedPaneFont()

wxFont KIUI::GetDockedPaneFont

(

wxWindow *

aWindow

)

Definition at line 144 of file ui_common.cpp.

{
#ifdef __WXMAC__
 int scale = -1;
#else
 int scale = 0;
#endif
 
 return getGUIFont( aWindow, scale );
}

References getGUIFont(), and scale.

Referenced by PCB_SEARCH_PANE::PCB_SEARCH_PANE(), and PROPERTIES_PANEL::PROPERTIES_PANEL().

GetInfoFont()

wxFont KIUI::GetInfoFont

(

wxWindow *

aWindow

)

Definition at line 156 of file ui_common.cpp.

{
 return getGUIFont( aWindow, -1 );
}

References getGUIFont().

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), APPEARANCE_CONTROLS::createControls(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_CLEANUP_GRAPHICS::DIALOG_CLEANUP_GRAPHICS(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GET_FOOTPRINT_BY_NAME::DIALOG_GET_FOOTPRINT_BY_NAME(), 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_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PRINT_PCBNEW::DIALOG_PRINT_PCBNEW(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SIM_MODEL< T_symbol, T_field >::DIALOG_SIM_MODEL(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), PANEL_COMMON_SETTINGS::PANEL_COMMON_SETTINGS(), PANEL_EESCHEMA_DISPLAY_OPTIONS::PANEL_EESCHEMA_DISPLAY_OPTIONS(), PANEL_EESCHEMA_EDITING_OPTIONS::PANEL_EESCHEMA_EDITING_OPTIONS(), PANEL_FP_EDITOR_DEFAULTS::PANEL_FP_EDITOR_DEFAULTS(), PANEL_GERBVIEW_EXCELLON_SETTINGS::PANEL_GERBVIEW_EXCELLON_SETTINGS(), PANEL_RF_ATTENUATORS::PANEL_RF_ATTENUATORS(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), PANEL_SETUP_BUSES::PANEL_SETUP_BUSES(), PANEL_SETUP_CONSTRAINTS::PANEL_SETUP_CONSTRAINTS(), PANEL_SETUP_FORMATTING::PANEL_SETUP_FORMATTING(), PANEL_SETUP_MASK_AND_PASTE::PANEL_SETUP_MASK_AND_PASTE(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SYM_EDITING_OPTIONS::PANEL_SYM_EDITING_OPTIONS(), PROPERTIES_FRAME::PROPERTIES_FRAME(), TEMPLATE_WIDGET::SetTemplate(), PANEL_RF_ATTENUATORS::ThemeChanged(), and WX_HTML_REPORT_PANEL::WX_HTML_REPORT_PANEL().

GetMonospacedUIFont()

wxFont KIUI::GetMonospacedUIFont

(

)

Definition at line 85 of file ui_common.cpp.

{
 static int guiFontSize = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT ).GetPointSize();
 
 wxFont font( guiFontSize, wxFONTFAMILY_MODERN, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL );
 
#ifdef __WXMAC__
 // https://trac.wxwidgets.org/ticket/19210
 if( font.GetFaceName().IsEmpty() )
 font.SetFaceName( wxS( "Menlo" ) );
#endif
 
 return font;
}

Referenced by CVPCB_MAINFRAME::BuildFootprintsListBox(), CVPCB_MAINFRAME::BuildSymbolsListBox(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), NETLIST_VIEW_DIALOG::NETLIST_VIEW_DIALOG(), and SCINTILLA_TRICKS::setupStyles().

GetStatusFont()

wxFont KIUI::GetStatusFont

(

wxWindow *

aWindow

)

Definition at line 132 of file ui_common.cpp.

{
#ifdef __WXMAC__
 int scale = -2;
#else
 int scale = 0;
#endif
 
 return getGUIFont( aWindow, scale );
}

References getGUIFont(), and scale.

Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), EDA_MSG_PANEL::EDA_MSG_PANEL(), EVT_MENU_RANGE(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), and SIMULATOR_FRAME::SIMULATOR_FRAME().

GetStdMargin()

int KIUI::GetStdMargin

(

)

Get the standard margin around a widget in the KiCad UI.

Returns

margin in pixels

Definition at line 41 of file ui_common.cpp.

{
 // This is the value used in (most) wxFB dialogs
 return 5;
}

Referenced by BUTTON_ROW_PANEL::addButtons(), BUTTON_ROW_PANEL::BUTTON_ROW_PANEL(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), and PANEL_HOTKEYS_EDITOR::installButtons().

GetTextSize()

wxSize KIUI::GetTextSize	(	const wxString &	aSingleLine,
		wxWindow *	aWindow
	)

Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currently set in that window.

Definition at line 70 of file ui_common.cpp.

{
 wxCoord width;
 wxCoord height;
 
 {
 wxClientDC dc( aWindow );
 dc.SetFont( aWindow->GetFont() );
 dc.GetTextExtent( aSingleLine, &width, &height );
 }
 
 return wxSize( width, height );
}

Referenced by DIALOG_EDIT_SYMBOLS_LIBID::AdjustGridColumns(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), LIB_TREE_MODEL_ADAPTER::doAddColumn(), WX_ELLIPSIZED_STATIC_TEXT::DoGetBestSize(), EDA_DRAW_FRAME::EDA_DRAW_FRAME(), EnsureTextCtrlWidth(), FIELDS_EDITOR_GRID_DATA_MODEL::GetDataWidth(), PANEL_SETUP_CONSTRAINTS::PANEL_SETUP_CONSTRAINTS(), PL_EDITOR_FRAME::PL_EDITOR_FRAME(), PANEL_SETUP_PINMAP::reBuildMatrixPanel(), DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR::recalculateColumns(), PL_EDITOR_FRAME::ReCreateHToolbar(), ZONE_SETTINGS::SetupLayersList(), and NET_SELECTOR_COMBOPOPUP::updateSize().

IsInputControlEditable()

bool KIUI::IsInputControlEditable

(

wxWindow *

aControl

)

Check if a input control has focus.

Parameters

aFocus

Control that test if editable

Returns

True if control is input and editable OR control is not a input. False if control is input and not editable.

Definition at line 298 of file ui_common.cpp.

{
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( aFocus );
 wxStyledTextCtrl* styledText = dynamic_cast<wxStyledTextCtrl*>( aFocus );
 wxSearchCtrl* searchCtrl = dynamic_cast<wxSearchCtrl*>( aFocus );
 
 if( textEntry )
 return textEntry->IsEditable();
 else if( styledText )
 return styledText->IsEditable();
 else if( searchCtrl )
 return searchCtrl->IsEditable();
 
 return true; // Must return true if we can't determine the state, intentionally true for non inputs as well
}

Referenced by TOOL_DISPATCHER::DispatchWxEvent().

IsInputControlFocused()

bool KIUI::IsInputControlFocused

(

wxWindow *

aFocus = nullptr

)

Check if a input control has focus.

Parameters

aFocus

Control that has focus, if null, wxWidgets will be queried

Definition at line 265 of file ui_common.cpp.

{
 if( aFocus == nullptr )
 aFocus = wxWindow::FindFocus();
 
 if( !aFocus )
 return false;
 
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( aFocus );
 wxStyledTextCtrl* styledText = dynamic_cast<wxStyledTextCtrl*>( aFocus );
 wxListBox* listBox = dynamic_cast<wxListBox*>( aFocus );
 wxSearchCtrl* searchCtrl = dynamic_cast<wxSearchCtrl*>( aFocus );
 wxCheckBox* checkboxCtrl = dynamic_cast<wxCheckBox*>( aFocus );
 wxChoice* choiceCtrl = dynamic_cast<wxChoice*>( aFocus );
 wxRadioButton* radioBtn = dynamic_cast<wxRadioButton*>( aFocus );
 wxSpinCtrl* spinCtrl = dynamic_cast<wxSpinCtrl*>( aFocus );
 wxSpinCtrlDouble* spinDblCtrl = dynamic_cast<wxSpinCtrlDouble*>( aFocus );
 wxSlider* sliderCtl = dynamic_cast<wxSlider*>( aFocus );
 
 // Data view control is annoying, the focus is on a "wxDataViewCtrlMainWindow" class that
 // is not formally exported via the header.
 wxDataViewCtrl* dataViewCtrl = nullptr;
 
 wxWindow* parent = aFocus->GetParent();
 
 if( parent )
 dataViewCtrl = dynamic_cast<wxDataViewCtrl*>( parent );
 
 return ( textEntry || styledText || listBox || searchCtrl || checkboxCtrl || choiceCtrl
 || radioBtn || spinCtrl || spinDblCtrl || sliderCtl || dataViewCtrl );
}

Referenced by TOOL_DISPATCHER::DispatchWxEvent(), EDA_DRAW_PANEL_GAL::onEnter(), KIGFX::WX_VIEW_CONTROLS::onEnter(), and EDA_DRAW_PANEL_GAL::OnEvent().

IsModalDialogFocused()

bool KIUI::IsModalDialogFocused

(

)

Definition at line 315 of file ui_common.cpp.

{
 return !Pgm().m_ModalDialogs.empty();
}

References Pgm().

Referenced by EDA_DRAW_PANEL_GAL::onEnter(), and EDA_DRAW_PANEL_GAL::OnEvent().

SelectReferenceNumber()

void KIUI::SelectReferenceNumber

(

wxTextEntry *

aTextEntry

)

Select the number (or "?") in a reference for ease of editing.

Definition at line 230 of file ui_common.cpp.

{
 wxString ref = aTextEntry->GetValue();
 
 if( ref.find_first_of( '?' ) != ref.npos )
 {
 aTextEntry->SetSelection( ref.find_first_of( '?' ), ref.find_last_of( '?' ) + 1 );
 }
 else if( ref.find_first_of( '*' ) != ref.npos )
 {
 aTextEntry->SetSelection( ref.find_first_of( '*' ), ref.find_last_of( '*' ) + 1 );
 }
 else
 {
 wxString num = ref;
 
 while( !num.IsEmpty() && ( !isdigit( num.Last() ) || !isdigit( num.GetChar( 0 ) ) ) )
 {
 // Trim non-digit from end
 if( !isdigit( num.Last() ) )
 num.RemoveLast();
 
 // Trim non-digit from the start
 if( !num.IsEmpty() && !isdigit( num.GetChar( 0 ) ) )
 num = num.Right( num.Length() - 1 );
 }
 
 aTextEntry->SetSelection( ref.Find( num ), ref.Find( num ) + num.Length() );
 
 if( num.IsEmpty() )
 aTextEntry->SetSelection( -1, -1 );
 }
}

Referenced by DIALOG_SYMBOL_PROPERTIES::HandleDelayedSelection(), DIALOG_FIELD_PROPERTIES::OnSetFocusText(), DIALOG_TEXT_PROPERTIES::OnSetFocusText(), and DIALOG_FOOTPRINT_PROPERTIES::OnUpdateUI().

SetControlsTabOrder()

void KIUI::SetControlsTabOrder

(

const std::vector< wxWindow * > &

aControlsInTabOrder

)

Set a list of controls to have a defined sequential tab order.

Each control in the list will come after the previous one. The first control will keep its current position. The end result will be that the given control will be sequential when tabbed though.

This can be slightly clearer than manually calling MoveAfterInTabOrder on each control in turn.

Parameters

aControlsInTabOrder

list of controls (wxWindows) in desired tab order

ValidatorTransferToWindowWithoutEvents()

void KIUI::ValidatorTransferToWindowWithoutEvents

(

wxValidator &

aValidator

)

Call a text validator's TransferDataToWindow method without firing a text change event.

This is useful when you want to keep a validator in sync with other data, but the act of changing it should not trigger other updates. It is the validator equivalent of ChangeValue() compared to SetValue().

This function blocks all events, but the same technique can be used to selectively block events.

Parameters

aValidator

the validator to update the control of

Definition at line 376 of file validators.cpp.

{
 wxWindow* ctrl = aValidator.GetWindow();
 
 wxCHECK_RET( ctrl != nullptr, wxS( "Transferring validator data without a control" ) );
 
 wxEventBlocker orient_update_blocker( ctrl, wxEVT_ANY );
 aValidator.TransferToWindow();
}