ui_common.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

 
#ifndef UI_COMMON_H
#define UI_COMMON_H
 
#include <kicommon.h>
#include "report_severity.h"      // enum SEVERITY
#include <wx/string.h>
#include <wx/font.h>
 
class wxBitmapBundle;
class wxSize;
class wxTextCtrl;
class wxTextEntry;
class wxWindow;
class wxMenuItem;
class wxMenu;
class wxNotebook;

#define INDETERMINATE_STATE _( "-- mixed values --" )
#define INDETERMINATE_ACTION _( "-- leave unchanged --" )
 
namespace KIUI
{
 
const int c_IndicatorSizeDIP = 10;
 

KICOMMON_API int GetStdMargin();

KICOMMON_API wxSize GetTextSize( const wxString& aSingleLine, wxWindow* aWindow );
 
KICOMMON_API wxFont GetMonospacedUIFont( int aRelativeSize = 0 );
 
KICOMMON_API wxFont GetControlFont( wxWindow* aWindow );
KICOMMON_API wxFont GetInfoFont( wxWindow* aWindow );
KICOMMON_API wxFont GetSmallInfoFont( wxWindow* aWindow );
KICOMMON_API wxFont GetDockedPaneFont( wxWindow* aWindow );
KICOMMON_API wxFont GetStatusFont( wxWindow* aWindow );

KICOMMON_API bool EnsureTextCtrlWidth( wxTextCtrl* aCtrl, const wxString* aString = nullptr );

KICOMMON_API void SelectReferenceNumber( wxTextEntry* aTextEntry );

KICOMMON_API wxString EllipsizeStatusText( wxWindow* aWindow, const wxString& aString );

KICOMMON_API wxString EllipsizeMenuText( const wxString& aString );

KICOMMON_API wxString WrapText( wxWindow* aWindow, const wxString& aText, int aWidth );

KICOMMON_API bool IsInputControlFocused( wxWindow* aFocus = nullptr );

KICOMMON_API bool IsInputControlEditable( wxWindow* aControl );
 
KICOMMON_API bool IsModalDialogFocused();

KICOMMON_API void Disable( wxWindow* aWindow );
 
KICOMMON_API extern const wxString s_FocusStealableInputName;
 

KICOMMON_API void AddBitmapToMenuItem( wxMenuItem* aMenu, const wxBitmapBundle& aImage );
 

KICOMMON_API wxMenuItem* AddMenuItem( wxMenu* aMenu, int aId, const wxString& aText,
                                      const wxBitmapBundle& aImage,
                                      wxItemKind            aType = wxITEM_NORMAL );
 

KICOMMON_API wxMenuItem* AddMenuItem( wxMenu* aMenu, int aId, const wxString& aText,
                                      const wxString& aHelpText, const wxBitmapBundle& aImage,
                                      wxItemKind aType = wxITEM_NORMAL );
 

KICOMMON_API wxMenuItem* AddMenuItem( wxMenu* aMenu, wxMenu* aSubMenu, int aId,
                                      const wxString& aText, const wxBitmapBundle& aImage );
 

KICOMMON_API wxMenuItem* AddMenuItem( wxMenu* aMenu, wxMenu* aSubMenu, int aId,
                                      const wxString& aText, const wxString& aHelpText,
                                      const wxBitmapBundle& aImage );
}
 
KICOMMON_API SEVERITY SeverityFromString( const wxString& aSeverity );
 
KICOMMON_API wxString SeverityToString( const SEVERITY& aSeverity );
 
KICOMMON_API int FindNotebookPage( wxNotebook* aNotebook, wxWindow* aChildWindow );
 
#endif // UI_COMMON_H