1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QPAINTDEVICE_H
41 #define QPAINTDEVICE_H
42 
43 #include <QtGui/qtguiglobal.h>
44 #include <QtGui/qwindowdefs.h>
45 #include <QtCore/qrect.h>
46 
47 QT_BEGIN_NAMESPACE
48 
49 
50 
51 class QPaintEngine;
52 class QPaintDevicePrivate;
53 
54 class Q_GUI_EXPORT QPaintDevice                                // device for QPainter
55 {
56 public:
57     enum PaintDeviceMetric {
58         PdmWidth = 1,
59         PdmHeight,
60         PdmWidthMM,
61         PdmHeightMM,
62         PdmNumColors,
63         PdmDepth,
64         PdmDpiX,
65         PdmDpiY,
66         PdmPhysicalDpiX,
67         PdmPhysicalDpiY,
68         PdmDevicePixelRatio,
69         PdmDevicePixelRatioScaled
70     };
71 
72     virtual ~QPaintDevice();
73 
74     virtual int devType() const;
75     bool paintingActive() const;
76     virtual QPaintEngine *paintEngine() const = 0;
77 
width()78     int width() const { return metric(PdmWidth); }
height()79     int height() const { return metric(PdmHeight); }
widthMM()80     int widthMM() const { return metric(PdmWidthMM); }
heightMM()81     int heightMM() const { return metric(PdmHeightMM); }
logicalDpiX()82     int logicalDpiX() const { return metric(PdmDpiX); }
logicalDpiY()83     int logicalDpiY() const { return metric(PdmDpiY); }
physicalDpiX()84     int physicalDpiX() const { return metric(PdmPhysicalDpiX); }
physicalDpiY()85     int physicalDpiY() const { return metric(PdmPhysicalDpiY); }
devicePixelRatio()86     int devicePixelRatio() const { return metric(PdmDevicePixelRatio); }
devicePixelRatioF()87     qreal devicePixelRatioF()  const { return metric(PdmDevicePixelRatioScaled) / devicePixelRatioFScale(); }
colorCount()88     int colorCount() const { return metric(PdmNumColors); }
depth()89     int depth() const { return metric(PdmDepth); }
90 
devicePixelRatioFScale()91     static inline qreal devicePixelRatioFScale() { return 0x10000; }
92 protected:
93     QPaintDevice() noexcept;
94     virtual int metric(PaintDeviceMetric metric) const;
95     virtual void initPainter(QPainter *painter) const;
96     virtual QPaintDevice *redirected(QPoint *offset) const;
97     virtual QPainter *sharedPainter() const;
98 
99     ushort        painters;                        // refcount
100 private:
101     Q_DISABLE_COPY(QPaintDevice)
102 
103     QPaintDevicePrivate *reserved;
104 
105     friend class QPainter;
106     friend class QPainterPrivate;
107     friend class QFontEngineMac;
108     friend class QX11PaintEngine;
109     friend Q_GUI_EXPORT int qt_paint_device_metric(const QPaintDevice *device, PaintDeviceMetric metric);
110 };
111 
112 /*****************************************************************************
113   Inline functions
114  *****************************************************************************/
115 
devType()116 inline int QPaintDevice::devType() const
117 { return QInternal::UnknownDevice; }
118 
paintingActive()119 inline bool QPaintDevice::paintingActive() const
120 { return painters != 0; }
121 
122 QT_END_NAMESPACE
123 
124 #endif // QPAINTDEVICE_H
125