SymbolShortcuts.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2026 Gunter Königsmann <wxMaxima@physikbuch.de>
//
//  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 2 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, write to the Free Software
//  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
//  SPDX-License-Identifier: GPL-2.0+
 
#ifndef SYMBOLSHORTCUTS_H
#define SYMBOLSHORTCUTS_H
 
#include <wx/string.h>
#include <vector>
 
class wxKeyEvent;
 
namespace wxm {
 
std::vector<wxString> SplitIntoSymbols(const wxString &text);
 
wxString JoinSymbols(const std::vector<wxString> &symbols);
 
struct SymbolShortcut
{
  wxString symbol;
  wxString shortcut;
  bool operator==(const SymbolShortcut &) const = default;
};
 
std::vector<SymbolShortcut> ParseSymbolShortcuts(const wxString &stored);
wxString SerializeSymbolShortcuts(const std::vector<SymbolShortcut> &shortcuts);
 
wxString NormalizeShortcut(const wxString &shortcut);
 
bool IsUsableShortcut(int flags, int keyCode);
 
wxString ShortcutFromKeyEvent(const wxKeyEvent &event);
 
bool SameShortcut(const wxString &a, const wxString &b);
 
wxString ShortcutForDisplay(const wxString &rawShortcut);
 
wxString SymbolForKeyEvent(const std::vector<SymbolShortcut> &shortcuts,
                           const wxKeyEvent &event);
 
} // namespace wxm
 
#endif // SYMBOLSHORTCUTS_H