Home | History | Annotate | Download | only in events
      1 /*
      2  * Copyright (C) 2001 Peter Kelly (pmk (at) post.com)
      3  * Copyright (C) 2001 Tobias Anton (anton (at) stud.fbi.fh-darmstadt.de)
      4  * Copyright (C) 2006 Samuel Weinig (sam.weinig (at) 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         // FIXME: rename isSimulated to fromKeyboard() and replace m_isSimulated with a new value
     50         // in PlatformMouseEvent::SyntheticEventType. isSimulated() is only true for synthetic
     51         // mouse events that derive from keyboard input, which do not have a position.
     52         bool isSimulated() const { return m_isSimulated; }
     53         virtual int pageX() const OVERRIDE FINAL;
     54         virtual int pageY() const OVERRIDE FINAL;
     55         int x() const;
     56         int y() const;
     57 
     58         // Page point in "absolute" coordinates (i.e. post-zoomed, page-relative coords,
     59         // usable with RenderObject::absoluteToLocal).
     60         const LayoutPoint& absoluteLocation() const { return m_absoluteLocation; }
     61         void setAbsoluteLocation(const LayoutPoint& p) { m_absoluteLocation = p; }
     62 
     63         virtual void trace(Visitor*) OVERRIDE;
     64 
     65     protected:
     66         MouseRelatedEvent();
     67         MouseRelatedEvent(const AtomicString& type, bool canBubble, bool cancelable,
     68             PassRefPtrWillBeRawPtr<AbstractView>, int detail, const IntPoint& screenLocation,
     69             const IntPoint& windowLocation, const IntPoint& movementDelta, bool ctrlKey, bool altKey,
     70             bool shiftKey, bool metaKey, bool isSimulated = false);
     71 
     72         void initCoordinates();
     73         void initCoordinates(const LayoutPoint& clientLocation);
     74         virtual void receivedTarget() OVERRIDE FINAL;
     75 
     76         void computePageLocation();
     77         void computeRelativePosition();
     78 
     79         // Expose these so MouseEvent::initMouseEvent can set them.
     80         IntPoint m_screenLocation;
     81         LayoutPoint m_clientLocation;
     82         LayoutPoint m_movementDelta;
     83 
     84     private:
     85         LayoutPoint m_pageLocation;
     86         LayoutPoint m_layerLocation;
     87         LayoutPoint m_offsetLocation;
     88         LayoutPoint m_absoluteLocation;
     89         bool m_isSimulated;
     90         bool m_hasCachedRelativePosition;
     91     };
     92 
     93 } // namespace blink
     94 
     95 #endif // MouseRelatedEvent_h
     96