CharButton.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2009-2015 Andrej Vodopivec <andrej.vodopivec@gmail.com>
//            (C) 2014-2015 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 CHARBUTTON_H
#define CHARBUTTON_H
 
#include "precomp.h"
#include "StringUtils.h"
#include "Configuration.h"
#include <wx/panel.h>
#include <wx/stattext.h>
 
class CharButton : public wxPanel
{
public:
  struct Definition
  {
    wxString symbol;
    const wxString description = wxm::emptyString;  
    bool matchesMaximaCommand = false;              
  };
 
  CharButton(wxWindow *parent, wxWindow *worksheet, Configuration *config,
             const Definition &def,
             bool forceShow = false);
  wxWindow *GetTextObject() const { return m_buttonText; }
  const wxString &GetSymbol() const { return m_symbol; }
  static CharButton *FromEventObject(wxObject *object);
  static bool EditShortcut(wxWindow *parent, Configuration *configuration,
                           const wxString &symbol);
  static wxString AppendShortcutMenuItem(wxMenu *menu, const wxMouseEvent &event);
  void UpdateToolTip();
  void ActivateButton();
#if wxUSE_ACCESSIBILITY
  wxString GetAccessibleLabel() const {
    return m_description.IsEmpty() ? m_symbol : m_description;
  }
#endif
  void UpdateMinSize();
protected:
  wxString m_symbol;
  Configuration *m_configuration;
  void CharButtonPressed(wxMouseEvent &event);
  void OnSize(wxSizeEvent &event);
  void OnIdleEvent(wxIdleEvent &event);
  void MouseOverPanel(wxMouseEvent &event);
  void MouseOverText(wxMouseEvent &event);
  void MouseLeftPanel(wxMouseEvent &event);
  void MouseLeftText(wxMouseEvent &event);
protected:
  void MouseOverTextIs(bool mouseOver = true);
  void MouseOverPanelIs(bool mouseOver = true);
  wxString m_description;
  wxString m_toolTipBase;
  wxString m_toolTip;
 
private:
  bool m_mouseOverPanel = false;
  bool m_mouseOverText = false;
  bool m_backgroundColorChangeNeeded = false;
  wxStaticText *m_buttonText;
  wxWindow *m_worksheet;
};
 
#endif // CHARBUTTON_H