127 lines
2.8 KiB
C++
127 lines
2.8 KiB
C++
/*
|
|
SPDX-FileCopyrightText: 2020 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
|
|
|
|
SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
#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
|