dom/events/KeyboardEvent.h
author Sylvestre Ledru <sledru@mozilla.com>
Thu, 17 Aug 2017 11:13:01 +0200
changeset 648192 c236dfe7dc98c387219d7cb45d0693560db708fd
parent 646161 8ee32af87bd4ce492f0882184ab558a5a722dcad
permissions -rw-r--r--
indent all (with js specific coding style) MozReview-Commit-ID: LU1md2wyB8

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_dom_KeyboardEvent_h_
#define mozilla_dom_KeyboardEvent_h_

#include "mozilla/dom/UIEvent.h"
#include "mozilla/dom/KeyboardEventBinding.h"
#include "mozilla/EventForwards.h"
#include "nsIDOMKeyEvent.h"

namespace mozilla {
namespace dom {

class KeyboardEvent
  : public UIEvent
  , public nsIDOMKeyEvent
{
public:
  KeyboardEvent(EventTarget* aOwner,
                nsPresContext* aPresContext,
                WidgetKeyboardEvent* aEvent);

  NS_DECL_ISUPPORTS_INHERITED

  // nsIDOMKeyEvent Interface
  NS_DECL_NSIDOMKEYEVENT

  // Forward to base class
  NS_FORWARD_TO_UIEVENT

  static already_AddRefed<KeyboardEvent> Constructor(
    const GlobalObject& aGlobal,
    const nsAString& aType,
    const KeyboardEventInit& aParam,
    ErrorResult& aRv);

  virtual JSObject* WrapObjectInternal(
    JSContext* aCx,
    JS::Handle<JSObject*> aGivenProto) override
  {
    return KeyboardEventBinding::Wrap(aCx, this, aGivenProto);
  }

  bool AltKey();
  bool CtrlKey();
  bool ShiftKey();
  bool MetaKey();

  bool GetModifierState(const nsAString& aKey)
  {
    return GetModifierStateInternal(aKey);
  }

  bool Repeat();
  bool IsComposing();
  uint32_t CharCode();
  uint32_t KeyCode();
  virtual uint32_t Which() override;
  uint32_t Location();

  void GetCode(nsAString& aCode);
  void GetInitDict(KeyboardEventInit& aParam);

  void InitKeyEvent(const nsAString& aType,
                    bool aCanBubble,
                    bool aCancelable,
                    nsGlobalWindow* aView,
                    bool aCtrlKey,
                    bool aAltKey,
                    bool aShiftKey,
                    bool aMetaKey,
                    uint32_t aKeyCode,
                    uint32_t aCharCode)
  {
    auto* view = aView ? aView->AsInner() : nullptr;
    InitKeyEvent(aType,
                 aCanBubble,
                 aCancelable,
                 view,
                 aCtrlKey,
                 aAltKey,
                 aShiftKey,
                 aMetaKey,
                 aKeyCode,
                 aCharCode);
  }

  void InitKeyboardEvent(const nsAString& aType,
                         bool aCanBubble,
                         bool aCancelable,
                         nsGlobalWindow* aView,
                         const nsAString& aKey,
                         uint32_t aLocation,
                         bool aCtrlKey,
                         bool aAltKey,
                         bool aShiftKey,
                         bool aMetaKey,
                         ErrorResult& aRv);

protected:
  ~KeyboardEvent() {}

  void InitWithKeyboardEventInit(EventTarget* aOwner,
                                 const nsAString& aType,
                                 const KeyboardEventInit& aParam,
                                 ErrorResult& aRv);

private:
  // True, if the instance is created with Constructor().
  bool mInitializedByCtor;

  // If the instance is created with Constructor(), which may have independent
  // value.  mInitializedWhichValue stores it.  I.e., this is invalid when
  // mInitializedByCtor is false.
  uint32_t mInitializedWhichValue;
};

} // namespace dom
} // namespace mozilla

already_AddRefed<mozilla::dom::KeyboardEvent>
NS_NewDOMKeyboardEvent(mozilla::dom::EventTarget* aOwner,
                       nsPresContext* aPresContext,
                       mozilla::WidgetKeyboardEvent* aEvent);

#endif // mozilla_dom_KeyboardEvent_h_