pxmlw6n2f/Gazebo_Distributed_MPI/gazebo/common/KeyEvent.hh

62 lines
1.6 KiB
C++

/*
* Copyright (C) 2012 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef _GAZEBO_KEYEVENT_HH_
#define _GAZEBO_KEYEVENT_HH_
#include <string>
#include "gazebo/util/system.hh"
namespace gazebo
{
namespace common
{
/// \addtogroup gazebo_common
/// \{
/// \class KeyEvent KeyEvent.hh common/common.hh
/// \brief Generic description of a keyboard event.
class GZ_COMMON_VISIBLE KeyEvent
{
/// \brief Constructor.
public: KeyEvent();
/// \brief Key event types enumeration.
public: enum EventType {NO_EVENT, PRESS, RELEASE};
/// \brief Event type.
public: EventType type;
/// \brief The raw value of the key pressed.
public: int key;
/// \brief Formatted string of the key pressed (could be uppercase).
public: std::string text;
/// \brief Was control held during this key event?
public: bool control;
/// \brief Was shift held during this key event?
public: bool shift;
/// \brief Was alt held during this key event?
public: bool alt;
};
/// \}
}
}
#endif