209 lines
7.2 KiB
C++
209 lines
7.2 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2018-2021 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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/**
|
|
* @file ui_common.h
|
|
* Functions to provide common constants and other functions to assist
|
|
* in making a consistent UI
|
|
*/
|
|
|
|
#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 wxSize;
|
|
class wxTextCtrl;
|
|
class wxTextEntry;
|
|
class wxWindow;
|
|
class wxMenuItem;
|
|
class wxMenu;
|
|
|
|
/**
|
|
* Used for holding indeterminate values, such as with multiple selections
|
|
* holding different values or controls which do not wish to set a value.
|
|
*/
|
|
#define INDETERMINATE_STATE _( "-- mixed values --" )
|
|
#define INDETERMINATE_ACTION _( "-- leave unchanged --" )
|
|
|
|
namespace KIUI
|
|
{
|
|
|
|
/**
|
|
* Get the standard margin around a widget in the KiCad UI
|
|
* @return margin in pixels
|
|
*/
|
|
KICOMMON_API int GetStdMargin();
|
|
|
|
/**
|
|
* Return the size of @a aSingleLine of text when it is rendered in @a aWindow
|
|
* using whatever font is currently set in that window.
|
|
*/
|
|
KICOMMON_API wxSize GetTextSize( const wxString& aSingleLine, wxWindow* aWindow );
|
|
|
|
KICOMMON_API wxFont GetMonospacedUIFont();
|
|
|
|
KICOMMON_API wxFont GetControlFont( wxWindow* aWindow );
|
|
KICOMMON_API wxFont GetInfoFont( wxWindow* aWindow );
|
|
KICOMMON_API wxFont GetDockedPaneFont( wxWindow* aWindow );
|
|
KICOMMON_API wxFont GetStatusFont( wxWindow* aWindow );
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param aCtrl the text control to potentially make wider.
|
|
* @param aString the text that is used in sizing the control's pixel width.
|
|
* If NULL, then
|
|
* the text already within the control is used.
|
|
* @return true if the \a aCtrl had its size changed, else false.
|
|
*/
|
|
KICOMMON_API bool EnsureTextCtrlWidth( wxTextCtrl* aCtrl, const wxString* aString = nullptr );
|
|
|
|
/**
|
|
* Select the number (or "?") in a reference for ease of editing.
|
|
*/
|
|
KICOMMON_API void SelectReferenceNumber( wxTextEntry* aTextEntry );
|
|
|
|
/**
|
|
* Ellipsize text (at the end) to be no more than 1/3 of the window width.
|
|
*
|
|
* @return shortened text ending with an ellipsis.
|
|
*/
|
|
KICOMMON_API wxString EllipsizeStatusText( wxWindow* aWindow, const wxString& aString );
|
|
|
|
/**
|
|
* Ellipsize text (at the end) to be no more than 36 characters.
|
|
*
|
|
* @return shortened text ending with an ellipsis.
|
|
*/
|
|
KICOMMON_API wxString EllipsizeMenuText( const wxString& aString );
|
|
|
|
/**
|
|
* Check if a input control has focus.
|
|
*
|
|
* @param aFocus Control that has focus, if null, wxWidgets will be queried
|
|
*/
|
|
KICOMMON_API bool IsInputControlFocused( wxWindow* aFocus = nullptr );
|
|
|
|
/**
|
|
* Check if a input control has focus.
|
|
*
|
|
* @param aFocus Control that test if editable
|
|
* @return True if control is input and editable OR control is not a input. False if control is
|
|
* input and not editable.
|
|
*/
|
|
KICOMMON_API bool IsInputControlEditable( wxWindow* aControl );
|
|
|
|
KICOMMON_API bool IsModalDialogFocused();
|
|
|
|
/**
|
|
* Makes a window read-only. Does some extra work over wxWindow::Disable() to make sure you
|
|
* can still scroll around in sub-windows.
|
|
*/
|
|
KICOMMON_API void Disable( wxWindow* aWindow );
|
|
|
|
KICOMMON_API extern const wxString s_FocusStealableInputName;
|
|
|
|
|
|
/**
|
|
* Add a bitmap to a menuitem.
|
|
*
|
|
* It is added only if use images in menus config option allows it. For wxITEM_CHECK
|
|
* or wxITEM_RADIO menuitems, the bitmap is added only on Windows, other platforms do
|
|
* not support it
|
|
*
|
|
* @param aMenu is the menuitem.
|
|
* @param aImage is the icon to add to aMenu.
|
|
*/
|
|
KICOMMON_API void AddBitmapToMenuItem( wxMenuItem* aMenu, const wxBitmap& aImage );
|
|
|
|
|
|
/**
|
|
* Create and insert a menu item with an icon into \a aMenu.
|
|
*
|
|
* @param aMenu is the menu to add the new item.
|
|
* @param aId is the command ID for the new menu item.
|
|
* @param aText is the string for the new menu item.
|
|
* @param aImage is the icon to add to the new menu item.
|
|
* @param aType is the type of menu :wxITEM_NORMAL (default), wxITEM_CHECK ...
|
|
* @return a pointer to the new created wxMenuItem.
|
|
*/
|
|
KICOMMON_API wxMenuItem* AddMenuItem( wxMenu* aMenu, int aId, const wxString& aText, const wxBitmap& aImage,
|
|
wxItemKind aType = wxITEM_NORMAL );
|
|
|
|
|
|
/**
|
|
* Create and insert a menu item with an icon and a help message string into \a aMenu.
|
|
*
|
|
* @param aMenu is the menu to add the new item.
|
|
* @param aId is the command ID for the new menu item.
|
|
* @param aText is the string for the new menu item.
|
|
* @param aHelpText is the help message string for the new menu item.
|
|
* @param aImage is the icon to add to the new menu item.
|
|
* @param aType is the type of menu :wxITEM_NORMAL (default), wxITEM_CHECK ...
|
|
* @return a pointer to the new created wxMenuItem.
|
|
*/
|
|
KICOMMON_API wxMenuItem* AddMenuItem( wxMenu* aMenu, int aId, const wxString& aText, const wxString& aHelpText,
|
|
const wxBitmap& aImage, wxItemKind aType = wxITEM_NORMAL );
|
|
|
|
|
|
/**
|
|
* Create and insert a menu item with an icon into \a aSubMenu in \a aMenu.
|
|
*
|
|
* @param aMenu is the menu to add the new submenu item.
|
|
* @param aSubMenu is the submenu to add the new menu.
|
|
* @param aId is the command ID for the new menu item.
|
|
* @param aText is the string for the new menu item.
|
|
* @param aImage is the icon to add to the new menu item.
|
|
* @return a pointer to the new created wxMenuItem,
|
|
*/
|
|
KICOMMON_API wxMenuItem* AddMenuItem( wxMenu* aMenu, wxMenu* aSubMenu, int aId, const wxString& aText,
|
|
const wxBitmap& aImage );
|
|
|
|
|
|
/**
|
|
* Create and insert a menu item with an icon and a help message string into
|
|
* \a aSubMenu in \a aMenu.
|
|
*
|
|
* @param aMenu is the menu to add the new submenu item.
|
|
* @param aSubMenu is the submenu to add the new menu.
|
|
* @param aId is the command ID for the new menu item.
|
|
* @param aText is the string for the new menu item.
|
|
* @param aHelpText is the help message string for the new menu item.
|
|
* @param aImage is the icon to add to the new menu item.
|
|
* @return a pointer to the new created wxMenuItem.
|
|
*/
|
|
KICOMMON_API wxMenuItem* AddMenuItem( wxMenu* aMenu, wxMenu* aSubMenu, int aId, const wxString& aText,
|
|
const wxString& aHelpText, const wxBitmap& aImage );
|
|
}
|
|
|
|
KICOMMON_API SEVERITY SeverityFromString( const wxString& aSeverity );
|
|
|
|
KICOMMON_API wxString SeverityToString( const SEVERITY& aSeverity );
|
|
|
|
#endif // UI_COMMON_H
|