2011-03-01 Joseph Pecoraro <joepeck@webkit.org>
[WebKit-https.git] / Source / WebCore / dom / ViewportArguments.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
6  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
7  * Copyright (C) 2008 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
8  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Library General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Library General Public License for more details.
19  *
20  * You should have received a copy of the GNU Library General Public License
21  * along with this library; see the file COPYING.LIB.  If not, write to
22  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23  * Boston, MA 02110-1301, USA.
24  *
25  */
26
27 #ifndef ViewportArguments_h
28 #define ViewportArguments_h
29
30 #include "IntSize.h"
31 #include <wtf/Forward.h>
32
33 namespace WebCore {
34
35 class Document;
36
37 enum ViewportErrorCode {
38     DeviceWidthShouldBeUsedWarning,
39     DeviceHeightShouldBeUsedWarning,
40     UnrecognizedViewportArgumentError,
41     TruncatedViewportArgumentValueError,
42     MaximumScaleTooLargeError,
43     TargetDensityDpiTooSmallOrLargeError
44 };
45
46 struct ViewportAttributes {
47     IntSize layoutSize;
48
49     float devicePixelRatio;
50
51     float initialScale;
52     float minimumScale;
53     float maximumScale;
54
55     bool userScalable;
56 };
57
58 struct ViewportArguments {
59
60     enum {
61         ValueAuto = -1,
62         ValueDesktopWidth = -2,
63         ValueDeviceWidth = -3,
64         ValueDeviceHeight = -4,
65         ValueDeviceDPI = -5,
66         ValueLowDPI = -6,
67         ValueMediumDPI = -7,
68         ValueHighDPI = -8
69     };
70
71     ViewportArguments()
72         : initialScale(ValueAuto)
73         , minimumScale(ValueAuto)
74         , maximumScale(ValueAuto)
75         , width(ValueAuto)
76         , height(ValueAuto)
77         , targetDensityDpi(ValueAuto)
78         , userScalable(true)
79     {
80     }
81
82     float initialScale;
83     float minimumScale;
84     float maximumScale;
85     float width;
86     float height;
87     float targetDensityDpi;
88
89     bool userScalable;
90
91     bool operator==(const ViewportArguments& other) const
92     {
93         return initialScale == other.initialScale
94             && minimumScale == other.minimumScale
95             && maximumScale == other.maximumScale
96             && width == other.width
97             && height == other.height
98             && targetDensityDpi == other.targetDensityDpi
99             && userScalable == other.userScalable;
100     }
101 };
102
103 ViewportAttributes computeViewportAttributes(ViewportArguments args, int desktopWidth, int deviceWidth, int deviceHeight, int deviceDPI, IntSize visibleViewport);
104
105 void setViewportFeature(const String& keyString, const String& valueString, Document*, void* data);
106 void reportViewportWarning(Document*, ViewportErrorCode, const String& replacement1, const String& replacement2);
107
108 } // namespace WebCore
109
110 #endif // ViewportArguments_h