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

#include <wx/string.h>

Namespaces
	KIUI

Enumerations
enum	SEVERITY { RPT_SEVERITY_UNDEFINED = 0x00, RPT_SEVERITY_INFO = 0x01, RPT_SEVERITY_EXCLUSION = 0x02, RPT_SEVERITY_ACTION = 0x04, RPT_SEVERITY_WARNING = 0x08, RPT_SEVERITY_ERROR = 0x10, RPT_SEVERITY_IGNORE = 0x20 }

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...

bool	KIUI::EnsureTextCtrlWidth (wxTextCtrl aCtrl, const wxString aString=NULL)
	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 ()
	Checks 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.

Enumeration Type Documentation

◆ SEVERITY

enum SEVERITY

Enumerator
RPT_SEVERITY_UNDEFINED
RPT_SEVERITY_INFO
RPT_SEVERITY_EXCLUSION
RPT_SEVERITY_ACTION
RPT_SEVERITY_WARNING
RPT_SEVERITY_ERROR
RPT_SEVERITY_IGNORE

Definition at line 83 of file ui_common.h.

               {
     RPT_SEVERITY_UNDEFINED = 0x00,
     RPT_SEVERITY_INFO      = 0x01,
     RPT_SEVERITY_EXCLUSION = 0x02,
     RPT_SEVERITY_ACTION    = 0x04,
     RPT_SEVERITY_WARNING   = 0x08,
     RPT_SEVERITY_ERROR     = 0x10,
     RPT_SEVERITY_IGNORE    = 0x20
 };

Function Documentation

◆ SeverityFromString()

SEVERITY SeverityFromString ( const wxString & aSeverity )

Definition at line 36 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 47 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.