Doxygen documentation added

[qtmeetings] / src / IO / DeviceControl / DeviceManager.h

diff --git a/src/IO/DeviceControl/DeviceManager.h b/src/IO/DeviceControl/DeviceManager.h
index e65f714..f4c8ec8 100644 (file)
--- a/src/IO/DeviceControl/DeviceManager.h
+++ b/src/IO/DeviceControl/DeviceManager.h
@@ -9,6 +9,7 @@ class HWKeyListener;
 class StartupSettings;
 class DeviceDataStorage;
 class DeviceConfigurator;
+class OperationModeToggler;
 
 static const int ERROR_BASE=200;
 
@@ -84,13 +85,6 @@ public:
         * \return QString value of the current operation mode.
         */
        QString operationModeToString( OperationMode aMode );
-       //! Connects/disconnects the HWKeyListener signals to the private HWKeyFullScreenPressed() slot.
-       /*!
-        * Connects/disconnects the HWKeyListener signals to the private HWKeyFullScreenPressed() slot. In case
-        * a signal is caught the connection is disabled until the signal handling is finished.
-        * \param aHandle indicates if the signals should be connected or not.
-        */
-       void handleKeyPresses( bool aHandle );
        //! Changes the operation mode.
        /*!
         * Changes the operation mode.
@@ -112,6 +106,12 @@ signals:
         * \param aAddInfo Possible additional information.
         */
        void error( int aCode, const QString &aAddInfo );
+       //! Signal. Emitted during the operation mode change to explain the current sub-change.
+       /*!
+        * Signal. Emitted during the operation mode change to explain the current sub-change. 
+        * \param aMessage Explains the sub-change
+        */
+       void changingMode( const QString &aMessage );
 
 private slots:
        //! Slot. Handles "full screen"-hardware key presses.
@@ -128,6 +128,18 @@ private slots:
         * \param aAddInfo The possible additional error text.
         */
        void errorSender( DeviceManager::ErrorCode aErrorCode, const QString &aAddInfo = "" );
+       //! Slot. Is called after the operation mode changing is finished.
+       /*!
+        * Slot. Is called after the operation mode changing is finished. If everything went fine, restarts
+        * the device. 
+        */
+       void modeChanged();
+       //! Slot. Toggles an attribute that indicates whether the errors should be sent.
+       /*!
+        * Slot. Toggles an attribute that indicates whether the errors should be sent.
+        * \param aToggle Indicates if the errors are wanted to be shown.
+        */
+       void toggleErrorSending( bool aToggle );
 
 private:
        //! Updates the internal indicator of the current operation mode.
@@ -138,14 +150,6 @@ private:
         * \return True if operation mode fetching succeeds; otherwise, false.
         */
        bool setCurrentOperationMode();
-       //! Stores the current operation mode.
-       /*!
-        * Stores the current operation mode by asking the DeviceDataStorage to write it to the internal
-        * data storage.
-        * \param aMode The operation mode that user wants to activate.
-        * \return True if operation mode storing succeeds; otherwise, false.
-        */
-       bool storeOperationMode( OperationMode aMode );
        //! Asks DeviceConfigurator to remove the deactivate script of the application.
        /*!
         * Asks DeviceConfigurator to remove the deactivate script of the application. Also asks
@@ -153,6 +157,13 @@ private:
         * \return True if operation mode storing and deactivation of the init script succeed; otherwise, false.
         */
        bool finalizeStandAloneMode();
+       //! Connects/disconnects the HWKeyListener signals to the private HWKeyFullScreenPressed() slot.
+       /*!
+        * Connects/disconnects the HWKeyListener signals to the private HWKeyFullScreenPressed() slot. In case
+        * a signal is caught the connection is disabled until the signal handling is finished.
+        * \param aHandle indicates if the signals should be connected or not.
+        */
+       void handleKeyPresses( bool aHandle );
 
 private:
        AlarmSender *iAlarmSender;
@@ -160,6 +171,7 @@ private:
        StartupSettings *iSettings;
        DeviceDataStorage *iDataStorage;
        DeviceConfigurator *iConfigurator;
+       OperationModeToggler *iModeToggler;
 
        OperationMode iMode;
        bool iSendErrorMessages;