a98a88e1e5fb62a5530fe64e56d851c4b6765aac
[WebKit-https.git] / Source / WebCore / rendering / RenderMarquee.h
1 /*
2  * Copyright (C) 2003 Apple Inc.
3  *
4  * Portions are Copyright (C) 1998 Netscape Communications Corporation.
5  *
6  * Other contributors:
7  *   Robert O'Callahan <roc+@cs.cmu.edu>
8  *   David Baron <dbaron@fas.harvard.edu>
9  *   Christian Biesinger <cbiesinger@web.de>
10  *   Randall Jesup <rjesup@wgate.com>
11  *   Roland Mainz <roland.mainz@informatik.med.uni-giessen.de>
12  *   Josh Soref <timeless@mac.com>
13  *   Boris Zbarsky <bzbarsky@mit.edu>
14  *
15  * This library is free software; you can redistribute it and/or
16  * modify it under the terms of the GNU Lesser General Public
17  * License as published by the Free Software Foundation; either
18  * version 2.1 of the License, or (at your option) any later version.
19  *
20  * This library is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
23  * Lesser General Public License for more details.
24  *
25  * You should have received a copy of the GNU Lesser General Public
26  * License along with this library; if not, write to the Free Software
27  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
28  *
29  * Alternatively, the contents of this file may be used under the terms
30  * of either the Mozilla Public License Version 1.1, found at
31  * http://www.mozilla.org/MPL/ (the "MPL") or the GNU General Public
32  * License Version 2.0, found at http://www.fsf.org/copyleft/gpl.html
33  * (the "GPL"), in which case the provisions of the MPL or the GPL are
34  * applicable instead of those above.  If you wish to allow use of your
35  * version of this file only under the terms of one of those two
36  * licenses (the MPL or the GPL) and not to allow others to use your
37  * version of this file under the LGPL, indicate your decision by
38  * deletingthe provisions above and replace them with the notice and
39  * other provisions required by the MPL or the GPL, as the case may be.
40  * If you do not delete the provisions above, a recipient may use your
41  * version of this file under any of the LGPL, the MPL or the GPL.
42  */
43
44 #ifndef RenderMarquee_h
45 #define RenderMarquee_h
46
47 #include "Length.h"
48 #include "RenderStyleConstants.h"
49 #include "Timer.h"
50
51 namespace WebCore {
52
53 class RenderLayer;
54
55 // This class handles the auto-scrolling for <marquee>
56 class RenderMarquee final {
57     WTF_MAKE_NONCOPYABLE(RenderMarquee); WTF_MAKE_FAST_ALLOCATED;
58 public:
59     explicit RenderMarquee(RenderLayer*);
60     ~RenderMarquee();
61
62     int speed() const { return m_speed; }
63     int marqueeSpeed() const;
64
65     EMarqueeDirection reverseDirection() const { return static_cast<EMarqueeDirection>(-direction()); }
66     EMarqueeDirection direction() const;
67
68     bool isHorizontal() const;
69
70     int computePosition(EMarqueeDirection, bool stopAtClientEdge);
71
72     void setEnd(int end) { m_end = end; }
73     
74     void start();
75     void suspend();
76     void stop();
77
78     void updateMarqueeStyle();
79     void updateMarqueePosition();
80
81 private:
82     void timerFired();
83
84     RenderLayer* m_layer;
85     int m_currentLoop;
86     int m_totalLoops;
87     Timer m_timer;
88     int m_start;
89     int m_end;
90     int m_speed;
91     Length m_height;
92     bool m_reset: 1;
93     bool m_suspended : 1;
94     bool m_stopped : 1;
95     EMarqueeDirection m_direction : 4; // Not unsigned because EMarqueeDirection has negative values
96 };
97
98 } // namespace WebCore
99
100 #endif // RenderMarquee_h