libkf5wayland-dev 4:5.28.0-1 / usr / include / KF5 / KWayland / Client / outputmanagement.h

This file is indexed.

/usr/include/KF5/KWayland/Client/outputmanagement.h is in libkf5wayland-dev 4:5.28.0-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
/****************************************************************************
* Copyright 2015  Sebastian Kügler <sebas@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) version 3, or any
* later version accepted by the membership of KDE e.V. (or its
* successor approved by the membership of KDE e.V.), which shall
* act as a proxy defined in Section 6 of version 3 of the license.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library.  If not, see <http://www.gnu.org/licenses/>.
****************************************************************************/
#ifndef KWAYLAND_CLIENT_OUTPUTMANAGEMENT_H
#define KWAYLAND_CLIENT_OUTPUTMANAGEMENT_H

#include <QObject>

#include <KWayland/Client/kwaylandclient_export.h>

struct org_kde_kwin_outputmanagement;
struct org_kde_kwin_outputconfiguration;

namespace KWayland
{
namespace Client
{

class EventQueue;
class OutputDevice;
class OutputConfiguration;

/**
* @short Wrapper for the org_kde_kwin_outputmanagement interface.
*
* This class provides a convenient wrapper for the org_kde_kwin_outputmanagement interface.
*
* To use this class one needs to interact with the Registry. There are two
* possible ways to create the OutputManagement interface:
* @code
* OutputManagement *c = registry->createOutputManagement(name, version);
* @endcode
*
* This creates the OutputManagement and sets it up directly. As an alternative this
* can also be done in a more low level way:
* @code
* OutputManagement *c = new OutputManagement;
* c->setup(registry->bindOutputManagement(name, version));
* @endcode
*
* The OutputManagement can be used as a drop-in replacement for any org_kde_kwin_outputmanagement
* pointer as it provides matching cast operators.
*
* @see Registry
* @since 5.5
**/
class KWAYLANDCLIENT_EXPORT OutputManagement : public QObject
{
    Q_OBJECT
public:
    /**
    * Creates a new OutputManagement.
    * Note: after constructing the OutputManagement it is not yet valid and one needs
    * to call setup. In order to get a ready to use OutputManagement prefer using
    * Registry::createOutputManagement.
    **/
    explicit OutputManagement(QObject *parent = nullptr);
    virtual ~OutputManagement();

    /**
    * Setup this OutputManagement to manage the @p outputmanagement.
    * When using Registry::createOutputManagement there is no need to call this
    * method.
    **/
    void setup(org_kde_kwin_outputmanagement *outputmanagement);
    /**
    * @returns @c true if managing a org_kde_kwin_outputmanagement.
    **/
    bool isValid() const;
    /**
    * Releases the org_kde_kwin_outputmanagement interface.
    * After the interface has been released the OutputManagement instance is no
    * longer valid and can be setup with another org_kde_kwin_outputmanagement interface.
    **/
    void release();
    /**
    * Destroys the data hold by this OutputManagement.
    * This method is supposed to be used when the connection to the Wayland
    * server goes away. If the connection is not valid any more, it's not
    * possible to call release any more as that calls into the Wayland
    * connection and the call would fail. This method cleans up the data, so
    * that the instance can be deleted or setup to a new org_kde_kwin_outputmanagement interface
    * once there is a new connection available.
    *
    * It is suggested to connect this method to ConnectionThread::connectionDied:
    * @code
    * connect(connection, &ConnectionThread::connectionDied, outputmanagement, &OutputManagement::destroy);
    * @endcode
    *
    * @see release
    **/
    void destroy();

    /**
    * Sets the @p queue to use for creating objects with this OutputManagement.
    **/
    void setEventQueue(EventQueue *queue);
    /**
    * @returns The event queue to use for creating objects with this OutputManagement.
    **/
    EventQueue *eventQueue();

    OutputConfiguration *createConfiguration(QObject *parent = nullptr);

    operator org_kde_kwin_outputmanagement*();
    operator org_kde_kwin_outputmanagement*() const;

Q_SIGNALS:
    /**
    * The corresponding global for this interface on the Registry got removed.
    *
    * This signal gets only emitted if the OutputManagement got created by
    * Registry::createOutputManagement
    **/
    void removed();

private:
    class Private;
    QScopedPointer<Private> d;
};


}
}

#endif

APT Browse - Built by Thomas Orozco.