gz/common/KeyEvent.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 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 GZ_COMMON_KEYEVENT_HH_
#define GZ_COMMON_KEYEVENT_HH_
 
#include <memory>
#include <string>
 
#include <gz/common/events/Export.hh>
#include <gz/common/SuppressWarning.hh>
 
namespace ignition
{
  namespace common
  {
    // Forward declare private data class
    class KeyEventPrivate;
 
    class IGNITION_COMMON_EVENTS_VISIBLE KeyEvent
    {
      public: enum EventType {NO_EVENT, PRESS, RELEASE};
 
      public: KeyEvent();
 
      public: KeyEvent(const KeyEvent &_other);
 
      // \brief  Move constructor.
      public: KeyEvent(KeyEvent &&_other);
 
      public: ~KeyEvent();
 
      public: EventType Type() const;
 
      public: void SetType(const EventType _type);
 
      public: int Key() const;
 
      public: void SetKey(const int _key);
 
      public: std::string Text() const;
 
      public: void SetText(const std::string &_text);
 
      public: bool Control() const;
 
      public: void SetControl(const bool _control);
 
      public: bool Shift() const;
 
      public: void SetShift(const bool _shift);
 
      public: bool Alt() const;
 
      public: void SetAlt(const bool _alt);
 
      public: KeyEvent &operator=(const KeyEvent &_other);
 
      public: KeyEvent& operator=(KeyEvent&& other);
 
      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<KeyEventPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}
#endif