/usr/include/KF5/KScreen/kscreen/config.h is in libkf5screen-dev 4:5.12.4-0ubuntu1.
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 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 | /*************************************************************************************
* Copyright (C) 2012 by Alejandro Fiestas Olivares <afiestas@kde.org> *
* Copyright (C) 2014 by Daniel Vrátil <dvratil@redhat.com> *
* *
* 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) any later version. *
* *
* 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, write to the Free Software *
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
*************************************************************************************/
#ifndef KSCREEN_CONFIG_H
#define KSCREEN_CONFIG_H
#include "screen.h"
#include "types.h"
#include "kscreen_export.h"
#include <QtCore/QHash>
#include <QtCore/QObject>
#include <QtCore/QMetaType>
namespace KScreen {
/**
* Represents a (or the) screen configuration.
*
* This is the main class of KScreen, with it you can use
* the static methods current() to get the systems config and
* setConfig() to apply a config to the system.
*
* Also, you can instance an empty Config, this is usualy done
* to create a config (with the objective of setting it) from scratch
* and for example unserialize a saved config to it.
*
*/
class KSCREEN_EXPORT Config : public QObject
{
Q_OBJECT
Q_PROPERTY(ScreenPtr screen READ screen)
Q_PROPERTY(OutputList outputs READ outputs)
public:
enum class ValidityFlag {
None = 0x0,
RequireAtLeastOneEnabledScreen = 0x1
};
Q_DECLARE_FLAGS(ValidityFlags, ValidityFlag)
/** This indicates which features the used backend supports.
*
* @see supportedFeatures
* @since 5.7
*/
enum class Feature {
None = 0, ///< None of the mentioned features are supported.
PrimaryDisplay = 1, ///< The backend knows about the concept of a primary display, this is mostly limited to X11.
Writable = 1 << 1, ///< The backend supports setting the config, it's not read-only.
PerOutputScaling = 1 << 2 ///< The backend supports scaling each output individually.
};
Q_DECLARE_FLAGS(Features, Feature)
/**
* Validates that a config can be applied in the current system
*
* Each system has different constrains, this method will test
* the given config with those constrains to see if it
* can be applied.
*
* @arg config to be checked
* @flags enable additional optional checks
* @return true if the configuration can be applied, false if not.
* @since 5.3.0
*/
static bool canBeApplied(const ConfigPtr &config, ValidityFlags flags);
/**
* Validates that a config can be applied in the current system
*
* Each system has different constrains, this method will test
* the given config with those constrains to see if it
* can be applied.
*
* @arg config to be checked
* @return true if the configuration can be applied, false if not.
*/
static bool canBeApplied(const ConfigPtr &config);
/**
* Instance an empty config
*
* Usually you never want to use this constructor since there are some
* values that make no sense to set (for example you want the Screen of
* the current systme).
*
* So usually what you do is call current() and then modify
* whatever you need.
*/
explicit Config();
virtual ~Config();
/**
* Duplicates the config
*
* @return a new Config instance with same property values
*/
ConfigPtr clone() const;
ScreenPtr screen() const;
void setScreen(const ScreenPtr &screen);
OutputPtr output(int outputId) const;
OutputList outputs() const;
OutputList connectedOutputs() const;
OutputPtr primaryOutput() const;
void setPrimaryOutput(const OutputPtr &output);
void addOutput(const OutputPtr &output);
void removeOutput(int outputId);
void setOutputs(OutputList outputs);
bool isValid() const;
void setValid(bool valid);
void apply(const ConfigPtr &other);
/** Indicates features supported by the backend. This exists to allow the user
* to find out which of the features offered by libkscreen are actually supported
* by the backend. Not all backends are writable (QScreen, for example is
* read-only, only XRandR, but not KWayland support the primary display, etc.).
*
* @return Flags for features that are supported for this config, determined by
* the backend.
* @see setSupportedFeatures
* @since 5.7
*/
Features supportedFeatures() const;
/** Sets the features supported by this backend. This should not be called by the
* user, but by the backend.
*
* @see supportedFeatures
* @since 5.7
*/
void setSupportedFeatures(const Features &features);
Q_SIGNALS:
void outputAdded(const KScreen::OutputPtr &output);
void outputRemoved(int outputId);
void primaryOutputChanged(const KScreen::OutputPtr &output);
private:
Q_DISABLE_COPY(Config)
class Private;
Private * const d;
};
} //KScreen namespace
Q_DECLARE_OPERATORS_FOR_FLAGS(KScreen::Config::Features)
KSCREEN_EXPORT QDebug operator<<(QDebug dbg, const KScreen::ConfigPtr &config);
#endif //KSCREEN_CONFIG_H
|