File indexing completed on 2024-12-22 05:17:15

 /*
  * This file is part of the KDE wacomtablet project. For copyright
  * information and license terms see the AUTHORS and COPYING files
  * in the top-level directory of this distribution.
  *
  * 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/>.
  */
 
 #ifndef PROFILEMANAGEMENT_H
 #define PROFILEMANAGEMENT_H
 
 #include "profilemanagementinterface.h"
 
 #include "deviceprofile.h"
 #include "profilemanager.h"
 
 // Qt includes
 #include <QString>
 #include <QStringList>
 
 class KConfigGroup;
 class QDBusInterface;
 
 namespace Wacom
 {
 /**
  * The profilemanagement is used as general tablet independent backend to store all parameters per profile
  * The KConfig approach is used to store the user data. To apply the profiles the deviceinterface has to
  * interpret the profile information into whatever the device backends expect.
  * Profiles are saved by tablet name and thus it is possible to have the same profile names for different tablets
  */
 class ProfileManagement : public ProfileManagementInterface
 {
 public:
     /**
      * Returns the instance of this singleton class.
      *
      * Asks DBus for the currently active device names
      */
     static ProfileManagement &instance();
 
     /**
      * @brief Returns a singleton of this class without asking DBus for devicename
      */
     static ProfileManagement &instance(const QString &deviceName, bool hasTouch);
 
     void setTabletId(const QString &tabletId) override;
 
     /**
      * Creates a new profile for the currently detected device and saves it back to the KConfig file
      *
      * @param profilename name of the profile that will be created
      */
     void createNewProfile(const QString &profilename) override;
 
     /**
      * Returns the KConfigGroup with all available profiles for the current tablet device
      *
      * This is used to fill the combobox with the profile names, create/delete profiles
      * and to update the configuration if something changed.
      *
      * @return the profile group object that holds all profile information.
      */
     const QStringList availableProfiles() override;
 
     /**
      * Deletes the profile from the current connected device.
      *
      * Should no profile be left a default profile will be created and selected.
      */
     void deleteProfile() override;
 
     /**
      * Returns a device profile of the currently active tablet profile.
      *
      * Always returns a device profile of the currently connected tablet. The
      * parameter @c device can be one of stylus/pad/eraser/touch or cursor.
      *
      * @param device The device profile to get.
      *
      * @return The device profile of the requested device.
      */
     DeviceProfile loadDeviceProfile(const DeviceType &device) override;
 
     /**
      * Saves the given profile as a device profile of the currently
      * active tablet profile.
      *
      * @param profile The profile to save.
      * @return True on success, false on error.
      */
     bool saveDeviceProfile(const DeviceProfile &profile) override;
 
     /**
      * Sets the used profile.
      *
      * If the kcmodule changes the profile the name here should change as well to obtain the
      * right config values
      *
      * @param name Name of the new profile
      */
     void setProfileName(const QString &name) override;
 
     /**
      * Returns the current used profile name.
      *
      * @return name of the profile in use
      */
     QString profileName() const override;
 
     /**
      * Reloads the profiles
      *
      * If the tablet is removed/connected/changed during runtime, this function updates its internal status
      */
     void reload() override;
 
 private:
     /**
      * Default constructor.
      * This is a singleton class, do not use this constructor, use \a instance() instead.
      */
     ProfileManagement();
 
     /**
      * Overloaded constructor.
      * This is a singleton class, do not use this constructor, use \a instance(deviceName, hasTouch) instead.
      */
     ProfileManagement(const QString &deviceName, bool hasTouch);
 
     /**
      * This is a singleton, no copying allowed
      */
     ProfileManagement(const ProfileManagement &) = delete;
     ProfileManagement &operator=(const ProfileManagement &) = delete;
 
     QString m_tabletId;
     QString m_vendorId;
     QString m_sensorId; /** Stores usb id for child device **/
     QString m_deviceName; /**< Cached name of the device so. So we don't have to ask via Dbus every time */
     bool m_hasTouch = false;
     QString m_profileName; /**< Current selected profile. */
     ProfileManager m_profileManager; /**< Manages the profile configuration file */
 }; // CLASS
 } // NAMESPACE
 #endif // PROFILEMANAGEMENT_H