Source/WebCore/page/Screen.h

   1 /*
   2  * Copyright (C) 2007 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  *
   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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29
  30 #ifndef Screen_h
  31 #define Screen_h
  32
  33 #include "DOMWindowProperty.h"
  34 #include <wtf/PassRefPtr.h>
  35 #include <wtf/RefCounted.h>
  36
  37 #if ENABLE(SCREEN_ORIENTATION_SUPPORT)
  38 #include "ActiveDOMObject.h"
  39 #include "EventListener.h"
  40 #include "EventNames.h"
  41 #include "EventTarget.h"
  42 #include <wtf/text/WTFString.h>
  43 #endif
  44
  45 namespace WebCore {
  46
  47     class Frame;
  48
  49     class Screen : public RefCounted<Screen>, public DOMWindowProperty
  50 #if ENABLE(SCREEN_ORIENTATION_SUPPORT)
  51                    , public ActiveDOMObject, public EventTarget
  52 #endif
  53     {
  54     public:
  55         static PassRefPtr<Screen> create(Frame *frame) { return adoptRef(new Screen(frame)); }
  56
  57         unsigned horizontalDPI() const;
  58         unsigned verticalDPI() const;
  59         unsigned height() const;
  60         unsigned width() const;
  61         unsigned colorDepth() const;
  62         unsigned pixelDepth() const;
  63         int availLeft() const;
  64         int availTop() const;
  65         unsigned availHeight() const;
  66         unsigned availWidth() const;
  67
  68 #if ENABLE(SCREEN_ORIENTATION_SUPPORT)
  69         bool naturalOrientationIsPortrait() { return gNaturalOrientationIsPortrait; }
  70         void setNaturalOrientationIsPortrait(bool flag) { gNaturalOrientationIsPortrait = flag; }
  71
  72         enum Orientation {
  73             InvalidOrientation = 0,
  74             OrientationPortraitPrimary = 1,
  75             OrientationLandscapePrimary = 1 << 1,
  76             OrientationPortraitSecondary = 1 << 2,
  77             OrientationLandscapeSecondary = 1 << 3,
  78             OrientationPortrait = OrientationPortraitPrimary | OrientationPortraitSecondary,
  79             OrientationLandscape = OrientationLandscapePrimary | OrientationLandscapeSecondary,
  80             OrientationAllDirection = OrientationPortrait | OrientationLandscape
  81         };
  82         String orientation() const;
  83
  84         bool lockOrientation(String orientation);
  85         void unlockOrientation();
  86
  87         DEFINE_ATTRIBUTE_EVENT_LISTENER(orientationchange);
  88
  89         void sendOrientationChangeEvent(int rawOrientation);
  90
  91         // EventTarget implementation.
  92         virtual const WTF::AtomicString& interfaceName() const { return eventNames().interfaceForScreen; }
  93         virtual ScriptExecutionContext* scriptExecutionContext() const { return ActiveDOMObject::scriptExecutionContext(); }
  94
  95         using RefCounted<Screen>::ref;
  96         using RefCounted<Screen>::deref;
  97 #endif
  98     private:
  99         explicit Screen(Frame*);
 100
 101 #if ENABLE(SCREEN_ORIENTATION_SUPPORT)
 102         virtual void refEventTarget() { ref(); }
 103         virtual void derefEventTarget() { deref(); }
 104
 105         // EventTarget implementation.
 106         virtual EventTargetData* eventTargetData() { return &m_eventTargetData; }
 107         virtual EventTargetData* ensureEventTargetData()  { return &m_eventTargetData; }
 108
 109         EventTargetData m_eventTargetData;
 110         Orientation m_orientation;
 111
 112         static bool gNaturalOrientationIsPortrait;
 113 #endif
 114     };
 115
 116 } // namespace WebCore
 117
 118 #endif // Screen_h