[Forms] Introduce SpinButtonElement.{cpp,h} into build
[WebKit-https.git] / Source / WebCore / html / shadow / SpinButtonElement.h
1 /*
2  * Copyright (C) 2006, 2008, 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26  
27 #ifndef SpinButtonElement_h
28 #define SpinButtonElement_h
29
30 #include "HTMLDivElement.h"
31 #include "Timer.h"
32 #include <wtf/Forward.h>
33
34 namespace WebCore {
35
36 class SpinButtonElement : public HTMLDivElement {
37 public:
38     enum UpDownState {
39         Indeterminate, // Hovered, but the event is not handled.
40         Down,
41         Up,
42     };
43
44     class StepActionHandler {
45     public:
46         virtual ~StepActionHandler() { }
47         virtual void spinButtonStepDown() = 0;
48         virtual void spinButtonStepUp() = 0;
49     };
50
51     // The owner of SpinButtonElement must call removeStepActionHandler
52     // because SpinButtonElement can be outlive StepActionHandler
53     // implementation, e.g. during event handling.
54     static PassRefPtr<SpinButtonElement> create(Document*, StepActionHandler&);
55     UpDownState upDownState() const { return m_upDownState; }
56     virtual void releaseCapture();
57     void removeStepActionHandler() { m_stepActionHandler = 0; }
58
59     void step(int amount);
60     
61     virtual bool willRespondToMouseMoveEvents() OVERRIDE;
62     virtual bool willRespondToMouseClickEvents() OVERRIDE;
63
64     void forwardEvent(Event*);
65
66 private:
67     SpinButtonElement(Document*, StepActionHandler&);
68
69     virtual const AtomicString& shadowPseudoId() const;
70     virtual void detach();
71     virtual bool isSpinButtonElement() const { return true; }
72     virtual bool isEnabledFormControl() const { return shadowHost()->isEnabledFormControl(); }
73     virtual bool shouldMatchReadOnlySelector() const OVERRIDE;
74     virtual bool shouldMatchReadWriteSelector() const OVERRIDE;
75     virtual void defaultEventHandler(Event*);
76     void doStepAction(int);
77     void startRepeatingTimer();
78     void stopRepeatingTimer();
79     void repeatingTimerFired(Timer<SpinButtonElement>*);
80     virtual void setHovered(bool = true);
81     virtual bool isMouseFocusable() const { return false; }
82
83     StepActionHandler* m_stepActionHandler;
84     bool m_capturing;
85     UpDownState m_upDownState;
86     UpDownState m_pressStartingState;
87     Timer<SpinButtonElement> m_repeatingTimer;
88 };
89
90 } // namespace
91
92 #endif