WebCore/OverflowEvent.h

   1 /*
   2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef OverflowEvent_h
  27 #define OverflowEvent_h
  28
  29 #include "Event.h"
  30
  31 namespace WebCore {
  32
  33     class OverflowEvent : public Event {
  34     public:
  35         enum orientType {
  36             VERTICAL   = 0,
  37             HORIZONTAL = 1,
  38             BOTH       = 2
  39         };
  40
  41         static PassRefPtr<OverflowEvent> create()
  42         {
  43             return adoptRef(new OverflowEvent);
  44         }
  45         static PassRefPtr<OverflowEvent> create(bool horizontalOverflowChanged, bool horizontalOverflow, bool verticalOverflowChanged, bool verticalOverflow)
  46         {
  47             return adoptRef(new OverflowEvent(horizontalOverflowChanged, horizontalOverflow, verticalOverflowChanged, verticalOverflow));
  48         }
  49
  50         void initOverflowEvent(unsigned short orient, bool horizontalOverflow, bool verticalOverflow);
  51
  52         unsigned short orient() const { return m_orient; }
  53         bool horizontalOverflow() const { return m_horizontalOverflow; }
  54         bool verticalOverflow() const { return m_verticalOverflow; }
  55
  56         virtual bool isOverflowEvent() const;
  57
  58     private:
  59         OverflowEvent();
  60         OverflowEvent(bool horizontalOverflowChanged, bool horizontalOverflow, bool verticalOverflowChanged, bool verticalOverflow);
  61
  62         unsigned short m_orient;
  63         bool m_horizontalOverflow;
  64         bool m_verticalOverflow;
  65     };
  66 }
  67
  68 #endif // OverflowEvent_h
  69