src/cobalt/dom/ui_event.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_H_
#define COBALT_DOM_UI_EVENT_H_

#include <string>

#include "base/string_piece.h"
#include "cobalt/dom/document.h"
#include "cobalt/dom/event.h"
#include "cobalt/dom/window.h"
#include "cobalt/script/wrappable.h"

namespace cobalt {
namespace dom {

// The UIEvent provides specific contextual information associated with User
// Interface events.
//   https://www.w3.org/TR/DOM-Level-3-Events/#events-uievents
class UIEvent : public Event {
 public:
  explicit UIEvent(const std::string& type);

  // Creates an event with its "initialized flag" unset.
  explicit UIEvent(UninitializedFlag uninitialized_flag);

  // Web API: UIEvent
  //
  void InitUIEvent(const std::string& type, bool bubbles, bool cancelable,
                   const scoped_refptr<Window>& view, int32 detail);

  const scoped_refptr<Window>& view() const { return view_; }
  // The following properties are defined inside UIEvent but are not valid for
  // all UIEvent subtypes.  Subtypes should override the getters when necessary.
  virtual int32 page_x() const { return 0; }
  virtual int32 page_y() const { return 0; }
  virtual uint32 which() const { return 0; }

  DEFINE_WRAPPABLE_TYPE(UIEvent);

 protected:
  explicit UIEvent(base::Token type);
  UIEvent(base::Token type, Bubbles bubbles, Cancelable cancelable);

  ~UIEvent() OVERRIDE {}

  scoped_refptr<Window> view_;
};

}  // namespace dom
}  // namespace cobalt

#endif  // COBALT_DOM_UI_EVENT_H_