src/third_party/WebKit/Source/core/events/MouseRelatedEvent.h

   1 /*
   2  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
   3  * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
   4  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
   5  * Copyright (C) 2003, 2004, 2005, 2006 Apple Computer, Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public License
  18  * along with this library; see the file COPYING.LIB.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  *
  22  */
  23
  24 #ifndef MouseRelatedEvent_h
  25 #define MouseRelatedEvent_h
  26
  27 #include "core/events/UIEventWithKeyState.h"
  28 #include "platform/geometry/LayoutPoint.h"
  29
  30 namespace blink {
  31
  32     // Internal only: Helper class for what's common between mouse and wheel events.
  33     class MouseRelatedEvent : public UIEventWithKeyState {
  34     public:
  35         // Note that these values are adjusted to counter the effects of zoom, so that values
  36         // exposed via DOM APIs are invariant under zooming.
  37         int screenX() const { return m_screenLocation.x(); }
  38         int screenY() const { return m_screenLocation.y(); }
  39         const IntPoint& screenLocation() const { return m_screenLocation; }
  40         int clientX() const { return m_clientLocation.x(); }
  41         int clientY() const { return m_clientLocation.y(); }
  42         int movementX() const { return m_movementDelta.x(); }
  43         int movementY() const { return m_movementDelta.y(); }
  44         const LayoutPoint& clientLocation() const { return m_clientLocation; }
  45         virtual int layerX() OVERRIDE FINAL;
  46         virtual int layerY() OVERRIDE FINAL;
  47         int offsetX();
  48         int offsetY();
  49         bool isSimulated() const { return m_isSimulated; }
  50         virtual int pageX() const OVERRIDE FINAL;
  51         virtual int pageY() const OVERRIDE FINAL;
  52         int x() const;
  53         int y() const;
  54
  55         // Page point in "absolute" coordinates (i.e. post-zoomed, page-relative coords,
  56         // usable with RenderObject::absoluteToLocal).
  57         const LayoutPoint& absoluteLocation() const { return m_absoluteLocation; }
  58         void setAbsoluteLocation(const LayoutPoint& p) { m_absoluteLocation = p; }
  59
  60         virtual void trace(Visitor*) OVERRIDE;
  61
  62     protected:
  63         MouseRelatedEvent();
  64         MouseRelatedEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtrWillBeRawPtr<AbstractView>,
  65                           int detail, const IntPoint& screenLocation, const IntPoint& windowLocation,
  66                           const IntPoint& movementDelta,
  67                           bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, bool isSimulated = false);
  68
  69         void initCoordinates();
  70         void initCoordinates(const LayoutPoint& clientLocation);
  71         virtual void receivedTarget() OVERRIDE FINAL;
  72
  73         void computePageLocation();
  74         void computeRelativePosition();
  75
  76         // Expose these so MouseEvent::initMouseEvent can set them.
  77         IntPoint m_screenLocation;
  78         LayoutPoint m_clientLocation;
  79         LayoutPoint m_movementDelta;
  80
  81     private:
  82         LayoutPoint m_pageLocation;
  83         LayoutPoint m_layerLocation;
  84         LayoutPoint m_offsetLocation;
  85         LayoutPoint m_absoluteLocation;
  86         bool m_isSimulated;
  87         bool m_hasCachedRelativePosition;
  88     };
  89
  90 } // namespace blink
  91
  92 #endif // MouseRelatedEvent_h