pqMenuEventTranslator.cxx

/*=========================================================================

   Program: ParaView
   Module:    pqMenuEventTranslator.cxx

   Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/

#include "pqMenuEventTranslator.h"

#include <QAction>
#include <QEvent>
#include <QKeyEvent>
#include <QMenu>
#include <QMenuBar>
#include <QMouseEvent>

pqMenuEventTranslator::pqMenuEventTranslator(QObject* p)
  : pqWidgetEventTranslator(p)
{
}

pqMenuEventTranslator::~pqMenuEventTranslator()
{
}

bool pqMenuEventTranslator::translateEvent(QObject* Object, QEvent* Event, bool& Error)
{
  QMenu* const menu = qobject_cast<QMenu*>(Object);
  QMenuBar* const menubar = qobject_cast<QMenuBar*>(Object);
  if (!menu && !menubar)
  {
    return false;
  }

  if (menubar)
  {
    QMouseEvent* e = dynamic_cast<QMouseEvent*>(Event);
    if (e && e->button() == Qt::LeftButton)
    {
      QAction* action = menubar->actionAt(e->pos());
      if (action && action->menu())
      {
        QString which = action->menu()->objectName();
        if (which.isEmpty())
        {
          which = action->text();
        }
        emit recordEvent(menubar, "activate", which);
      }
    }
    return true;
  }

  const auto actionArgument = [](QAction* action) -> QString {
    QString argument = action->objectName();
    if (argument.isNull())
    {
      argument = action->text();
    }
    return argument;
  };

  if (Event->type() == QEvent::Show)
  {
    // If this menu has any sub-menu's record this menu as the parent for subsequent enter event.
    for (auto action : menu->actions())
    {
      if (action->menu())
      {
        this->SubMenuParent[action] = menu;
      }
    }

    return true;
  }
  else if (Event->type() == QEvent::Enter)
  {
    // Note: Using QEvent::Enter instead of QEvent::FocusIn here because the menu
    // can be activated without first getting focus.
    if (this->SubMenuParent.find(menu->menuAction()) != this->SubMenuParent.end())
    { // Then a previous menu has recorded this action as a sub-menu
      emit recordEvent(
        this->SubMenuParent[menu->menuAction()], "activate", actionArgument(menu->menuAction()));
    }
  }
  else if (Event->type() == QEvent::Close || Event->type() == QEvent::Hide)
  {
    // Clean up sub-menu mapping
    for (auto it = this->SubMenuParent.begin(); it != this->SubMenuParent.end();)
    {
      if (it->second == menu)
      {
        it = this->SubMenuParent.erase(it);
      }
      else
      {
        ++it;
      }
    }
    return true;
  }
  else if (Event->type() == QEvent::KeyPress)
  {

    QKeyEvent* e = static_cast<QKeyEvent*>(Event);
    if (e->key() == Qt::Key_Enter || e->key() == Qt::Key_Return)
    {
      QAction* action = menu->activeAction();
      if (action)
      {
        emit recordEvent(menu, "activate", actionArgument(action));
      }
    }
    else if (e->key() == Qt::Key_Right)
    {
      QAction* action = menu->activeAction();
      if (action && action->menu())
      {
        emit recordEvent(menu, "activate", actionArgument(action));
      }
    }
    else
    {
      for (auto action : menu->actions())
      {
        const QKeySequence mnemonic = QKeySequence::mnemonic(action->text());
        if (!mnemonic.isEmpty())
        { // Then the action has a keyboard accelerator
          if (mnemonic == QKeySequence(e->modifiers() + e->key()))
          {
            emit recordEvent(menu, "activate", actionArgument(action));
          }
        }
      }
    }
    return true;
  }
  else if (Event->type() == QEvent::MouseButtonRelease)
  {
    QMouseEvent* e = static_cast<QMouseEvent*>(Event);
    if (e->button() == Qt::LeftButton)
    {
      QAction* action = menu->actionAt(e->pos());
      if (action && !action->menu())
      {
        emit recordEvent(menu, "activate", actionArgument(action));
      }
    }
    return true;
  }
  return this->Superclass::translateEvent(Object, Event, Error);
}