src/cobalt/dom/ui_event_with_key_state.h

// Copyright 2015 Google Inc. All Rights Reserved.
//
// 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 COBALT_DOM_UI_EVENT_WITH_KEY_STATE_H_
#define COBALT_DOM_UI_EVENT_WITH_KEY_STATE_H_

#include <string>

#include "cobalt/dom/ui_event.h"

namespace cobalt {
namespace dom {

// UIEventWithKeyState inherits UIEvent and has the key modifiers.
// Both KeyboardEvent and MouseEvent inherit UIEventWithKeyState.
class UIEventWithKeyState : public UIEvent {
 public:
  // Web API: KeyboardEvent, MouseEvent
  //
  static const uint32 kNoModifier = 0;
  static const uint32 kAltKey = 1 << 0;
  static const uint32 kCtrlKey = 1 << 1;
  static const uint32 kMetaKey = 1 << 2;
  static const uint32 kShiftKey = 1 << 3;

  uint32 modifiers() const { return modifiers_; }
  void set_modifiers(uint32 modifiers) { modifiers_ = modifiers; }

  bool alt_key() const { return (modifiers_ & kAltKey) != 0; }
  bool ctrl_key() const { return (modifiers_ & kCtrlKey) != 0; }
  bool meta_key() const { return (modifiers_ & kMetaKey) != 0; }
  bool shift_key() const { return (modifiers_ & kShiftKey) != 0; }

  bool GetModifierState(const std::string& keyArg) const;

 protected:
  UIEventWithKeyState(base::Token type, Bubbles bubbles, Cancelable cancelable,
                      uint32 modifiers)
      : UIEvent(type, bubbles, cancelable), modifiers_(modifiers) {}

  ~UIEventWithKeyState() OVERRIDE {}

  uint32 modifiers_;
};

}  // namespace dom
}  // namespace cobalt

#endif  // COBALT_DOM_UI_EVENT_WITH_KEY_STATE_H_