ui_common.h File Reference

Functions to provide common constants and other functions to assist in making a consistent UI. More...

#include "report_severity.h"
#include <wx/string.h>
#include <wx/font.h>

Go to the source code of this file.

Namespaces
	KIUI

Functions
int	KIUI::GetStdMargin ()
	Get the standard margin around a widget in the KiCad UI. More...
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. More...
wxFont	KIUI::GetMonospacedUIFont ()
wxFont	KIUI::GetControlFont (wxWindow *aWindow)
wxFont	KIUI::GetInfoFont (wxWindow *aWindow)
wxFont	KIUI::GetStatusFont (wxWindow *aWindow)
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. More...
void	KIUI::SelectReferenceNumber (wxTextEntry *aTextEntry)
	Select the number (or "?") in a reference for ease of editing. More...
bool	KIUI::IsInputControlFocused (wxWindow *aFocus=nullptr)
	Check if a input control has focus. More...
bool	KIUI::IsInputControlEditable (wxWindow *aControl)
	Check if a input control has focus. More...
bool	KIUI::IsModalDialogFocused ()
SEVERITY	SeverityFromString (const wxString &aSeverity)
wxString	SeverityToString (const SEVERITY &aSeverity)

Detailed Description

Functions to provide common constants and other functions to assist in making a consistent UI.

Definition in file ui_common.h.

Function Documentation

SeverityFromString()

SEVERITY SeverityFromString

(

const wxString &

aSeverity

)

Definition at line 45 of file ui_common.cpp.

{
    if( aSeverity == wxT( "warning" ) )
        return RPT_SEVERITY_WARNING;
    else if( aSeverity == wxT( "ignore" ) )
        return RPT_SEVERITY_IGNORE;
    else
        return RPT_SEVERITY_ERROR;
}

References RPT_SEVERITY_ERROR, RPT_SEVERITY_IGNORE, and RPT_SEVERITY_WARNING.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and ERC_SETTINGS::ERC_SETTINGS().

SeverityToString()

wxString SeverityToString

(

const SEVERITY &

aSeverity

)

Definition at line 56 of file ui_common.cpp.

{
    if( aSeverity == RPT_SEVERITY_IGNORE )
        return wxT( "ignore" );
    else if( aSeverity == RPT_SEVERITY_WARNING )
        return wxT( "warning" );
    else
        return wxT( "error" );
}

References RPT_SEVERITY_IGNORE, and RPT_SEVERITY_WARNING.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and ERC_SETTINGS::ERC_SETTINGS().