ui/views/slideshowview/inc/glxslideshowview.h
changeset 54 0f0f3f26f787
parent 42 5e1df1b52eb3
--- a/ui/views/slideshowview/inc/glxslideshowview.h	Fri Jul 23 20:41:04 2010 +0530
+++ b/ui/views/slideshowview/inc/glxslideshowview.h	Fri Aug 06 20:44:25 2010 +0530
@@ -33,29 +33,115 @@
 class GlxSlideShowWidget;
 class GlxTvOutWrapper;
 
+/**
+ * Class Description
+ * This is Slideshow view class used to play the slide show on set of images.
+ */
 class GlxSlideShowView : public GlxView
 {
     Q_OBJECT
 
 public:
-    GlxSlideShowView(HbMainWindow *window,HbDocumentLoader *Docloader);
+    /**
+     * Constructor
+     * @param - HbMainWindow object
+     * @param - fullscreen docloader object
+     */
+    GlxSlideShowView( HbMainWindow *window, HbDocumentLoader *Docloader );
+    
+    /**
+     * Destructor
+     */    
     ~GlxSlideShowView();
+
+    /**
+     * activate()
+     * ///From GlxView
+     */    
     void activate() ;
+    
+    /**
+     * deActivate()
+     * ///From GlxView
+     */    
     void deActivate();
-    void setModel(QAbstractItemModel *model);
+    
+    /**
+     * setmodel() 
+     * ///from GlxView
+     */    
+    void setModel( QAbstractItemModel *model );
+
+    /**
+     * setModelContext() - to set the context mode of the model.
+     */    
     void setModelContext();
+    
+    /**
+     * handleUserAction() - To handle the used action like back to paly the orientation change animation.
+     */
+    void handleUserAction( qint32 commandId );
         
 public slots :
-    void orientationChanged(Qt::Orientation);   
-    void slideShowEventHandler( GlxSlideShowEvent e);
+    /**
+     * orientationChanged() - Slot to upadte the layout when orientation of device has changed
+     * @param new orientation
+     */
+    void orientationChanged( Qt::Orientation ) ;
+    
+    /**
+     * slideShowEventHandler() - to handle the widget events like ui on / off, empty data etc
+     * @param slide show widget event type 
+     */
+    void slideShowEventHandler( GlxSlideShowEvent e );
+    
+    /**
+     * indexchanged() - call back to handle the selected image change. 
+     */
     void indexchanged();
+    
+    /**
+     * modelDestroyed() - call back to monitor the model destroy.
+     */
     void modelDestroyed();
     
+    /**
+     * playLsOrientChangeAnim() - To play the protrait to landscape orientation animation.
+     */
+    void playLsOrientChangeAnim();
+
+    /**
+     * playLsOrientChangeAnim() - To play the landscape to protrait orientation animation.
+     */
+    void playPtOrientChangeAnim();
+    
+    /**
+     * LsOrientChangeAnimFinished() - Call back fuction when protrait to landscape orientation animation 
+     * has been finished.
+     * @param - staus of effect
+     */
+    void LsOrientChangeAnimFinished( const HbEffect::EffectStatus );
+    
+    /**
+     * PtOrientChangeAnimFinished() - Call back fuction when landscape to protrait orientation animation 
+     * has been finished.
+     * @param - staus of effect
+     */    
+    void PtOrientChangeAnimFinished( const HbEffect::EffectStatus );
+    
 protected :
-    bool eventFilter(QObject *obj, QEvent *ev);
+    /**
+     * eventFilter - To handle the application foregrond and background event
+     * ///From HbView
+     */
+    bool eventFilter( QObject *obj, QEvent *ev );
     
 private:
+    /**
+     * loadWidgets() - The widgets are retrieved from the docml
+     */
     void loadObjects();
+
 private:
     QAbstractItemModel  *mModel;
     HbMainWindow        *mWindow;