Home | History | Annotate | Download | only in dom
      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, 2008 Apple Inc. All rights reserved.
      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 MouseEvent_h
     25 #define MouseEvent_h
     26 
     27 #include "Clipboard.h"
     28 #include "MouseRelatedEvent.h"
     29 
     30 namespace WebCore {
     31 
     32     // Introduced in DOM Level 2
     33     class MouseEvent : public MouseRelatedEvent {
     34     public:
     35         static PassRefPtr<MouseEvent> create()
     36         {
     37             return adoptRef(new MouseEvent);
     38         }
     39         static PassRefPtr<MouseEvent> create(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView> view,
     40             int detail, int screenX, int screenY, int pageX, int pageY,
     41             bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,
     42             PassRefPtr<EventTarget> relatedTarget, PassRefPtr<Clipboard> clipboard = 0, bool isSimulated = false)
     43         {
     44             return adoptRef(new MouseEvent(type, canBubble, cancelable, view, detail, screenX, screenY, pageX, pageY,
     45                 ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget, clipboard, isSimulated));
     46         }
     47         virtual ~MouseEvent();
     48 
     49         void initMouseEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView>,
     50                             int detail, int screenX, int screenY, int clientX, int clientY,
     51                             bool ctrlKey, bool altKey, bool shiftKey, bool metaKey,
     52                             unsigned short button, PassRefPtr<EventTarget> relatedTarget);
     53 
     54         // WinIE uses 1,4,2 for left/middle/right but not for click (just for mousedown/up, maybe others),
     55         // but we will match the standard DOM.
     56         unsigned short button() const { return m_button; }
     57         bool buttonDown() const { return m_buttonDown; }
     58         EventTarget* relatedTarget() const { return m_relatedTarget.get(); }
     59 
     60         Clipboard* clipboard() const { return m_clipboard.get(); }
     61 
     62         Node* toElement() const;
     63         Node* fromElement() const;
     64 
     65         Clipboard* dataTransfer() const { return isDragEvent() ? m_clipboard.get() : 0; }
     66 
     67         virtual bool isMouseEvent() const;
     68         virtual bool isDragEvent() const;
     69         virtual int which() const;
     70 
     71     private:
     72         MouseEvent();
     73         MouseEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView>,
     74                    int detail, int screenX, int screenY, int pageX, int pageY,
     75                    bool ctrlKey, bool altKey, bool shiftKey, bool metaKey, unsigned short button,
     76                    PassRefPtr<EventTarget> relatedTarget, PassRefPtr<Clipboard> clipboard, bool isSimulated);
     77 
     78         unsigned short m_button;
     79         bool m_buttonDown;
     80         RefPtr<EventTarget> m_relatedTarget;
     81         RefPtr<Clipboard> m_clipboard;
     82     };
     83 
     84 } // namespace WebCore
     85 
     86 #endif // MouseEvent_h
     87