NormalizedKeyString Struct Reference

#include <Keyboard.h>

Inheritance diagram for NormalizedKeyString:

Collaboration diagram for NormalizedKeyString:

Public Member Functions
	NormalizedKeyString ()=default
	NormalizedKeyString (const wxString &key)
wxString	Display (bool usesSpecialChars=false) const
Public Member Functions inherited from TaggedIdentifier< Tag, CaseSensitive >
	TaggedIdentifier ()=default
	TaggedIdentifier (const TaggedIdentifier &)=default
	Copy allowed only for the same Tag class and case sensitivity. More...
	TaggedIdentifier (TaggedIdentifier &&)=default
	Move allowed only for the same Tag class and case sensitivity. More...
TaggedIdentifier &	operator= (const TaggedIdentifier &)=default
	Copy allowed only for the same Tag class and case sensitivity. More...
TaggedIdentifier &	operator= (TaggedIdentifier &&)=default
	Move allowed only for the same Tag class and case sensitivity. More...
template<typename Tag2 , bool b>
	TaggedIdentifier (const TaggedIdentifier< Tag2, b > &)=delete
	Copy prohibited for other Tag classes or case sensitivity. More...
template<typename Tag2 , bool b>
	TaggedIdentifier (TaggedIdentifier< Tag2, b > &&)=delete
	Move prohibited for other Tag classes or case sensitivity. More...
template<typename Tag2 , bool b>
TaggedIdentifier &	operator= (const TaggedIdentifier< Tag2, b > &)=delete
	Copy prohibited for other Tag classes or case sensitivity. More...
template<typename Tag2 , bool b>
TaggedIdentifier &	operator= (TaggedIdentifier< Tag2, b > &&)=delete
	Move prohibited for other Tag classes or case sensitivity. More...
	TaggedIdentifier (const Identifier &str)
template<typename String , typename = typename String::TagType>
String	CONVERT () const
	Explicit conversion to another kind of TaggedIdentifier. More...
	Identifier ()=default
	Identifier (const wxString &str)
	Allow implicit conversion to this class, but not from. More...
	Identifier (const wxChar *str)
	Allow implicit conversion to this class, but not from. More...
	Identifier (const char *str)
	Allow implicit conversion to this class, but not from. More...
	Identifier (const Identifier &)=default
	Identifier (wxString &&str)
	Identifier (Identifier &&id)
	Identifier (std::initializer_list< Identifier > components, wxChar separator)
	Convenience for building concatenated identifiers. More...
Public Member Functions inherited from Identifier
	Identifier ()=default
	Identifier (const wxString &str)
	Allow implicit conversion to this class, but not from. More...
	Identifier (const wxChar *str)
	Allow implicit conversion to this class, but not from. More...
	Identifier (const char *str)
	Allow implicit conversion to this class, but not from. More...
	Identifier (const Identifier &)=default
Identifier &	operator= (const Identifier &)=default
	Identifier (wxString &&str)
	Identifier (Identifier &&id)
Identifier &	operator= (Identifier &&id)
void	swap (Identifier &id)
	Identifier (std::initializer_list< Identifier > components, wxChar separator)
	Convenience for building concatenated identifiers. More...
bool	empty () const
size_t	size () const
size_t	length () const
const wxString &	GET () const
	Explicit conversion to wxString, meant to be ugly-looking and demanding of a comment why it's correct. More...
std::vector< Identifier >	split (wxChar separator) const

Additional Inherited Members
Public Types inherited from TaggedIdentifier< Tag, CaseSensitive >
using	TagType = Tag

Detailed Description

Definition at line 23 of file Keyboard.h.

Constructor & Destructor Documentation

NormalizedKeyString() [1/2]

NormalizedKeyString::NormalizedKeyString ( )

default

NormalizedKeyString() [2/2]

NormalizedKeyString::NormalizedKeyString ( const wxString &  key )

explicit

Definition at line 17 of file Keyboard.cpp.

   : NormalizedKeyStringBase( key )
{
#if defined(__WXMAC__)
   wxString newkey;
   wxString temp = key;
 
   // PRL:  This is needed to parse older preference files.
   temp.Replace(wxT("XCtrl+"), wxT("Control+"));
 
   // PRL:  RawCtrl is the proper replacement for Control, when formatting
   // wxMenuItem, so that wxWidgets shows ^ in the menu.  It is written into
   // NEW preference files (2.2.0 and later).
   temp.Replace(wxT("RawCtrl+"), wxT("Control+"));
   temp.Replace(wxT("Ctrl+"), wxT("Command+"));
 
   if (temp.Contains(wxT("Control+"))) {
      newkey += wxT("RawCtrl+");
   }
 
   if (temp.Contains(wxT("Alt+")) || temp.Contains(wxT("Option+"))) {
      newkey += wxT("Alt+");
   }
 
   if (temp.Contains(wxT("Shift+"))) {
      newkey += wxT("Shift+");
   }
 
   if (temp.Contains(wxT("Command+"))) {
      newkey += wxT("Ctrl+");
   }
 
   (NormalizedKeyStringBase&)*this =
      newkey + temp.AfterLast(wxT('+'));
#else
   (NormalizedKeyStringBase&)*this = key;
#endif
}

References key, and wxT().

Here is the call graph for this function:

Member Function Documentation

Display()

wxString NormalizedKeyString::Display

(

bool

usesSpecialChars = false

)

const

Definition at line 56 of file Keyboard.cpp.

{
   (void)usesSpecialChars;//compiler food
   // using GET to manipulate key string as needed for macOS differences
   // in displaying of it
   auto newkey = this->GET();
#if defined(__WXMAC__)
 
   if (!usesSpecialChars) {
      // Compose user-visible keystroke names, all ASCII
      newkey.Replace(wxT("RawCtrl+"), wxT("Control+"));
      newkey.Replace(wxT("Alt+"), wxT("Option+"));
      newkey.Replace(wxT("Ctrl+"), wxT("Command+"));
   }
   else {
      // Compose user-visible keystroke names, with special characters
      newkey.Replace(wxT("Shift+"), wxT("\u21e7"));
      newkey.Replace(wxT("RawCtrl+"), '^');
      newkey.Replace(wxT("Alt+"), wxT("\u2325"));
      newkey.Replace(wxT("Ctrl+"), wxT("\u2318"));
   }
 
#endif
 
   return newkey;
}

References Identifier::GET(), and wxT().

Referenced by KeyView::CmpKeyNodeByKey(), KeyView::OnDrawItem(), KeyConfigPrefs::OnFilterKeyDown(), KeyConfigPrefs::OnHotkeyKeyDown(), KeyConfigPrefs::OnHotkeyKillFocus(), KeyView::OnKeyDown(), KeyConfigPrefs::OnSelected(), SelectHandle::Preview(), KeyView::RecalcExtents(), KeyView::RefreshBindings(), KeyView::RefreshLines(), and KeyView::SetKey().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this struct was generated from the following files:

• Keyboard.h
• Keyboard.cpp