summaryrefslogtreecommitdiffstats
path: root/src/displaysettings/displaysettings.cpp
blob: de2d41626d0a9161fcc6cce3e406581498e0fbce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Device Utilities module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "displaysettings.h"
#include "displaysettings_p.h"

QT_BEGIN_NAMESPACE

/*!
    \class DisplaySettings
    \inmodule QtDeviceUtilities

    \brief The DisplaySettings class specifies display settings.

    The Boot to Qt demo launcher and Qt Quick Controls scale automatically to
    screens of different sizes, from 7-inch touch screens to 60-inch or larger
    television screens to ensure readability and touch friendliness. For this,
    Qt has to know the physical dimensions of the screen. By default, it tries
    to query these values from the framebuffer devices. However, many kernel
    drivers do not provide this information.

    The display settings enable overriding and manually setting the physical
    screen size.

    In addition, you can set the display brightness. That is, the intensity of
    the backlight.
*/

/*!
    \property DisplaySettings::displayBrightness
    \brief The display brightness.

    A value of \c 255 requests the maximum brightness, while that of \c 0
    requests the minimum (typically, the backlight turned off).
*/


/*!
    \property DisplaySettings::physicalScreenSizeInch
    \brief The physical screen size in inches.
*/

/*!
    \property DisplaySettings::physicalScreenWidthMm
    \brief The physical screen width in millimeters.
*/

/*!
    \property DisplaySettings::physicalScreenHeightMm
    \brief The physical screen height in millimeters.
*/

/*!
    \property DisplaySettings::physicalScreenSizeOverride
    \brief Whether to use the value set for the physical screen size.
*/

/*!
    Creates a new display settings object with the parent \a parent.
*/
DisplaySettings::DisplaySettings(QObject *parent)
    : QObject(parent)
    ,d_ptr(new DisplaySettingsPrivate(this))
{
}

/*!
    Deletes the display settings object.
*/
DisplaySettings::~DisplaySettings()
{
}


/*!
    Sets the display brightness to \a v.

    Returns \c true on success.
*/
bool DisplaySettings::setDisplayBrightness(int v)
{
    Q_D(DisplaySettings);
    return d->setDisplayBrightness(v);
}


/*!
 * Returns the current backlight intensity.
 * \sa setDisplayBrightness
 */
int DisplaySettings::displayBrightness()
{
    Q_D(DisplaySettings);
    return d->displayBrightness();
}

/*!
    Returns the physical screen size in inches.
*/
int DisplaySettings::physicalScreenSizeInch() const
{
    Q_D(const DisplaySettings);
    return d->physicalScreenSizeInch();
}

/*!
    Returns the physical screen width in millimeters.
*/
int DisplaySettings::physicalScreenWidthMm() const
{
    Q_D(const DisplaySettings);
    return d->physicalScreenWidthMm();
}

/*!
    Returns the physical screen height in millimeters.
*/
int DisplaySettings::physicalScreenHeightMm() const
{
    Q_D(const DisplaySettings);
    return d->physicalScreenHeightMm();
}

/*!
    Sets the physical screen size to \a inches.
*/
void DisplaySettings::setPhysicalScreenSizeInch(int inches)
{
    Q_D(DisplaySettings);
    d->setPhysicalScreenSizeInch(inches);
}

/*!
    Sets the physical screen width to \a newWidth.
*/
void DisplaySettings::setPhysicalScreenWidthMm(int newWidth)
{
    Q_D(DisplaySettings);
    d->setPhysicalScreenWidthMm(newWidth);
}

/*!
    Sets the physical screen height to \a newHeight.
*/
void DisplaySettings::setPhysicalScreenHeightMm(int newHeight)
{
    Q_D(DisplaySettings);
    d->setPhysicalScreenHeightMm(newHeight);
}

/*!
    Returns whether the value set for the physical screen size is used.

    \sa physicalScreenSizeInch()
*/
bool DisplaySettings::physicalScreenSizeOverride() const
{
    Q_D(const DisplaySettings);
    return d->physicalScreenSizeOverride();
}

/*!
    Sets whether the value set for the physical screen size is used to
    \a enable.

    \sa physicalScreenSizeInch()
*/
void DisplaySettings::setPhysicalScreenSizeOverride(bool enable)
{
    Q_D(DisplaySettings);
    d->setPhysicalScreenSizeOverride(enable);
}

QT_END_NAMESPACE