WebCore/RenderMarquee.h

   1 /*
   2  * Copyright (C) 2003 Apple Computer, 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 "RenderStyle.h"
  48 #include "Timer.h"
  49
  50 namespace WebCore {
  51
  52 class RenderLayer;
  53
  54 // This class handles the auto-scrolling of layers with overflow: marquee.
  55 class RenderMarquee {
  56 public:
  57     RenderMarquee(RenderLayer*);
  58
  59     int speed() const { return m_speed; }
  60     int marqueeSpeed() const;
  61
  62     EMarqueeDirection reverseDirection() const { return static_cast<EMarqueeDirection>(-direction()); }
  63     EMarqueeDirection direction() const;
  64
  65     bool isHorizontal() const;
  66
  67     int computePosition(EMarqueeDirection, bool stopAtClientEdge);
  68
  69     void setEnd(int end) { m_end = end; }
  70
  71     void start();
  72     void suspend();
  73     void stop();
  74
  75     void updateMarqueeStyle();
  76     void updateMarqueePosition();
  77
  78 private:
  79     void timerFired(Timer<RenderMarquee>*);
  80
  81     RenderLayer* m_layer;
  82     int m_currentLoop;
  83     int m_totalLoops;
  84     Timer<RenderMarquee> m_timer;
  85     int m_start;
  86     int m_end;
  87     int m_speed;
  88     Length m_height;
  89     bool m_reset: 1;
  90     bool m_suspended : 1;
  91     bool m_stopped : 1;
  92     EMarqueeDirection m_direction : 4;
  93 };
  94
  95 } // namespace WebCore
  96
  97 #endif // RenderMarquee_h