Kstars

indilightbox.h
1 /*
2  SPDX-FileCopyrightText: 2015 Jasem Mutlaq <[email protected]>
3 
4  SPDX-License-Identifier: GPL-2.0-or-later
5 */
6 
7 #pragma once
8 
9 #include "indidustcap.h"
10 #include "indistd.h"
11 
12 namespace ISD
13 {
14 /**
15  * @class LightBox
16  * Handles operation of a remotely controlled light box.
17  *
18  * @author Jasem Mutlaq
19  */
20 class LightBox : public ConcreteDevice
21 {
22  Q_OBJECT
23 
24  public:
26 
27  Q_SCRIPTABLE virtual bool isLightOn();
28 
29 public slots:
30  /**
31  * @brief SetBrightness Set light box brightness levels if dimmable.
32  * @param val Value of brightness level.
33  * @return True if operation is successful, false otherwise.
34  */
35  Q_SCRIPTABLE bool setBrightness(uint16_t val);
36 
37  /**
38  * @brief SetLightEnabled Turn on/off light
39  * @param enable true to turn on, false to turn off
40  * @return True if operation is successful, false otherwise.
41  */
42  Q_SCRIPTABLE bool setLightEnabled(bool enable);
43 };
44 }
Q_OBJECTQ_OBJECT
Q_SCRIPTABLE bool setLightEnabled(bool enable)
SetLightEnabled Turn on/off light.
The ConcreteDevice class.
Q_SCRIPTABLE bool setBrightness(uint16_t val)
SetBrightness Set light box brightness levels if dimmable.
QObject * parent() const const
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Dec 10 2023 04:03:45 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.