inc/screensaverengine.h
branchRCL_3
changeset 15 2e08ef6b6eda
parent 14 d8eca2b0590d
child 16 1f307dce3b5a
equal deleted inserted replaced
14:d8eca2b0590d 15:2e08ef6b6eda
   136      * 
   136      * 
   137      * @param aTimeout Timeout after the screensaver stops and hides itself in
   137      * @param aTimeout Timeout after the screensaver stops and hides itself in
   138      * microseconds. 0 or negative value will disable the timer.
   138      * microseconds. 0 or negative value will disable the timer.
   139      */
   139      */
   140     void SetExpiryTimerTimeout( TInt aTimeout );
   140     void SetExpiryTimerTimeout( TInt aTimeout );
   141 
   141     
   142     
   142 private:
   143     /**
   143     
   144     * Informs the engine about changes in keyguard state
   144     /**
   145     * @param aEnabled whether the keyguard is now on or off 
   145     * C++ default constructor
   146     */
   146     * 
   147     void HandleKeyguardStateChanged( TBool aEnabled );
   147     * @param aAppUi the AppUi of the application
   148     
   148     */
   149     /**
   149     CScreensaverEngine();
   150      * Informs the engine that a start/stop request was emitted through P&S
   150 
   151      * @param aStart True if screensaver should be started, false if stopped
   151 private:
       
   152     
       
   153     /**
       
   154     * Two-phased constructor
       
   155     */
       
   156     void ConstructL();
       
   157     
       
   158     /**
       
   159     * Constructs the shared data member
       
   160     */
       
   161     void EnableSharedDataAndMonitorL();
       
   162     
       
   163     /**
       
   164     * Destruct the shared data member
       
   165     */
       
   166     void DisableSharedDataAndMonitor();
       
   167 
       
   168     /**
       
   169     * Starts to monitor the user activity
       
   170     */
       
   171     void StartActivityMonitoringL();
       
   172     
       
   173     /**
       
   174     * Stops monitoring the user activity
       
   175     */
       
   176     void StopActivityMonitoring( CUserActivityManager*& aActivityManager );
       
   177 
       
   178     /**
       
   179     * Gets the color model from the resource
       
   180     */
       
   181     void SetupColorModelL();
       
   182 
       
   183     /**
       
   184     * Start the preview timer
       
   185     */
       
   186     void StartPreviewTimer();
       
   187     
       
   188     /**
       
   189      * Starts pause timer
   152      */
   190      */
   153     void HandleActivateSSChanged( TBool aStart );
   191     void StartPauseTimer();
   154     
       
   155 private:
       
   156     
       
   157     /**
       
   158     * C++ default constructor
       
   159     * 
       
   160     * @param aAppUi the AppUi of the application
       
   161     */
       
   162     CScreensaverEngine();
       
   163 
       
   164 private:
       
   165     
       
   166     /**
       
   167     * Two-phased constructor
       
   168     */
       
   169     void ConstructL();
       
   170     
       
   171     /**
       
   172     * Constructs the shared data member
       
   173     */
       
   174     void EnableSharedDataAndMonitorL();
       
   175     
       
   176     /**
       
   177     * Destruct the shared data member
       
   178     */
       
   179     void DisableSharedDataAndMonitor();
       
   180 
       
   181     /**
       
   182     * Starts to monitor the user activity
       
   183     */
       
   184     void StartActivityMonitoringL();
       
   185     
       
   186     /**
       
   187     * Stops monitoring the user activity
       
   188     */
       
   189     void StopActivityMonitoring( CUserActivityManager*& aActivityManager );
       
   190 
       
   191     /**
       
   192     * Gets the color model from the resource
       
   193     */
       
   194     void SetupColorModelL();
       
   195 
       
   196     /**
       
   197     * Start the preview timer
       
   198     */
       
   199     void StartPreviewTimer();
       
   200     
   192     
   201     /**
   193     /**
   202     * Kill the timer
   194     * Kill the timer
   203     * 
   195     * 
   204     * @param aTimer the timer you want stop
   196     * @param aTimer the timer you want stop
   218     
   210     
   219     /**
   211     /**
   220     * Called when the time that the user did no activity is out.
   212     * Called when the time that the user did no activity is out.
   221     */
   213     */
   222     static TInt HandleInactiveEventL(TAny* aPtr);
   214     static TInt HandleInactiveEventL(TAny* aPtr);
   223 
       
   224     /**
       
   225     * Called when the time that the user did activity is out.
       
   226     */
       
   227     static TInt HandleActiveEventShortL(TAny* aPtr);    
       
   228     
       
   229     /**
       
   230     * Called when the time that the user did no activity is out.
       
   231     */
       
   232     static TInt HandleInactiveEventShortL(TAny* aPtr);
       
   233     
   215     
   234     /**
   216     /**
   235     * Callback fuction. Called when the suspension tiemr time out
   217     * Callback fuction. Called when the suspension tiemr time out
   236     */
   218     */
   237     static TInt HandleSuspendTimerExpiry( TAny* aPtr );
   219     static TInt HandleSuspendTimerExpiry( TAny* aPtr );
       
   220     
       
   221     /**
       
   222     * Callback function. Called when the pause timer expires
       
   223     */
       
   224     static TInt HandlePauseTimerExpiry( TAny* aPtr );
   238 
   225 
   239     /**
   226     /**
   240     * Returns the CScreensaverView
   227     * Returns the CScreensaverView
   241     */
   228     */
   242     CScreensaverView* View() const;
   229     CScreensaverView* View() const;
   297     * Owned
   284     * Owned
   298     */
   285     */
   299     CScreensaverIndicatorArray* iIndicatorArray;
   286     CScreensaverIndicatorArray* iIndicatorArray;
   300     
   287     
   301     /**
   288     /**
   302     * The trigger for screensaver activation, short timeout
       
   303     */
       
   304     CUserActivityManager* iActivityManagerScreensaverShort;
       
   305     
       
   306     /**
       
   307     * moved from view class
   289     * moved from view class
   308     */
   290     */
   309     TScreensaverColorModel iColorModel;
   291     TScreensaverColorModel iColorModel;
   310     
   292     
   311     
   293     
   330     * 
   312     * 
   331     * Owned.
   313     * Owned.
   332     */
   314     */
   333     CPeriodic* iExpiryTimer;
   315     CPeriodic* iExpiryTimer;
   334     
   316     
       
   317     /**
       
   318     * Pause timer. Used to reactivate screensaver after 5s when being 
       
   319 	* interrupted and keys are locked
       
   320     */
       
   321     CPeriodic* iPauseTimer;
       
   322     
   335     };
   323     };
   336 
   324 
   337 
   325 
   338 
   326 
   339 #endif // C_SCREENSAVERENGINE_H
   327 #endif // C_SCREENSAVERENGINE_H