1330abc93d
Currently, the trend is to get the coordinates of the hotspot and map it to the device independent pixels at the call site. This change makes the KXcursorSprite return the coordinates of the hotspot in the device independent pixels to reduce the amount of duplicated code.
137 lines
3.4 KiB
C++
137 lines
3.4 KiB
C++
/*
|
|
* Copyright (C) 2020 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <kwin_export.h>
|
|
|
|
#include <QImage>
|
|
#include <QSharedDataPointer>
|
|
#include <QVector>
|
|
|
|
#include <chrono>
|
|
|
|
namespace KWin
|
|
{
|
|
|
|
class KXcursorSpritePrivate;
|
|
class KXcursorThemePrivate;
|
|
|
|
/**
|
|
* The KXcursorSprite class represents a single sprite in the Xcursor theme.
|
|
*/
|
|
class KWIN_EXPORT KXcursorSprite
|
|
{
|
|
public:
|
|
/**
|
|
* Constructs an empty XcursorSprite.
|
|
*/
|
|
KXcursorSprite();
|
|
|
|
/**
|
|
* Constructs a copy of the KXcursorSprite object @a other.
|
|
*/
|
|
KXcursorSprite(const KXcursorSprite &other);
|
|
|
|
/**
|
|
* Constructs an XcursorSprite with the specified @a data, @a hotspot, and @a delay.
|
|
*/
|
|
KXcursorSprite(const QImage &data, const QPoint &hotspot,
|
|
const std::chrono::milliseconds &delay);
|
|
|
|
/**
|
|
* Destructs the KXcursorSprite object.
|
|
*/
|
|
~KXcursorSprite();
|
|
|
|
/**
|
|
* Assigns the value of @a other to the Xcursor sprite object.
|
|
*/
|
|
KXcursorSprite &operator=(const KXcursorSprite &other);
|
|
|
|
/**
|
|
* Returns the image for this sprite.
|
|
*/
|
|
QImage data() const;
|
|
|
|
/**
|
|
* Returns the hotspot for this sprite. (0, 0) corresponds to the upper left corner.
|
|
*
|
|
* The coordinates of the hotspot are in device independent pixels.
|
|
*/
|
|
QPoint hotspot() const;
|
|
|
|
/**
|
|
* Returns the time interval between this sprite and the next one, in milliseconds.
|
|
*/
|
|
std::chrono::milliseconds delay() const;
|
|
|
|
private:
|
|
QSharedDataPointer<KXcursorSpritePrivate> d;
|
|
};
|
|
|
|
/**
|
|
* The KXcursorTheme class represents an Xcursor theme.
|
|
*/
|
|
class KWIN_EXPORT KXcursorTheme
|
|
{
|
|
public:
|
|
/**
|
|
* Constructs an empty Xcursor theme.
|
|
*/
|
|
KXcursorTheme();
|
|
|
|
/**
|
|
* Constructs a copy of the KXcursorTheme object @a other.
|
|
*/
|
|
KXcursorTheme(const KXcursorTheme &other);
|
|
|
|
/**
|
|
* Destructs the KXcursorTheme object.
|
|
*/
|
|
~KXcursorTheme();
|
|
|
|
/**
|
|
* Assigns the value of @a other to the Xcursor theme object.
|
|
*/
|
|
KXcursorTheme &operator=(const KXcursorTheme &other);
|
|
|
|
/**
|
|
* Returns the ratio between device pixels and logical pixels for the Xcursor theme.
|
|
*/
|
|
qreal devicePixelRatio() const;
|
|
|
|
/**
|
|
* Returns @c true if the Xcursor theme is empty; otherwise returns @c false.
|
|
*/
|
|
bool isEmpty() const;
|
|
|
|
/**
|
|
* Returns the list of cursor sprites for the cursor with the given @a name.
|
|
*/
|
|
QVector<KXcursorSprite> shape(const QByteArray &name) const;
|
|
|
|
/**
|
|
* Attempts to load the Xcursor theme with the given @a themeName and @a size.
|
|
*/
|
|
static KXcursorTheme fromTheme(const QString &themeName, int size, qreal dpr);
|
|
|
|
private:
|
|
QSharedDataPointer<KXcursorThemePrivate> d;
|
|
};
|
|
|
|
} // namespace KWin
|