tvout/tvoutwrapper/inc/glxtvoutwrapper.h
changeset 52 a3a4c0de738e
parent 43 72396548277c
child 69 45459746d5e8
--- a/tvout/tvoutwrapper/inc/glxtvoutwrapper.h	Sat Jul 10 00:59:39 2010 +0530
+++ b/tvout/tvoutwrapper/inc/glxtvoutwrapper.h	Fri Jul 23 20:41:04 2010 +0530
@@ -19,6 +19,7 @@
 #define GLXTVOUTWRAPPER_H
 
 #include <QAbstractItemModel>
+#include <QSize>
 
 // forward decleration
 class GlxTvOutWrapperPrivate;
@@ -29,70 +30,85 @@
 #define GLX_TVOUTWRAPPER_EXPORT Q_DECL_IMPORT
 #endif
 
+/**
+ * Class Description This is Wrapper entry point for Qt based classes for HDMI
+ * 
+ * Client needs to create an instance of this class and setModel() 
+ * 
+ * To Shift from native to clone and vice versa, use setToNativeMode() and 
+ * setToCloningMode() respectively 
+ *
+ * For Not supported items, make sure to call itemNotSupported() API
+ */
+
 class GLX_TVOUTWRAPPER_EXPORT GlxTvOutWrapper
 {
 public:
-    /*
+    /**
      * Constructor
      */
     GlxTvOutWrapper();
     
-    /*
+    /**
      * Destructor
      */
     ~GlxTvOutWrapper();
 
-    /*
+    /**
      * Setting the model
      * This also creates the private instance of the wrapper
      * to pass the model 
+     * @param Model datamodel
+     * @param screensize the size of the phone screen
+     * @param aEfectsOn if slideshow effects on tv needs to be on, off by default 
      */
-    void setModel(QAbstractItemModel* aModel,bool aEfectsOn = false);
+    void setModel(QAbstractItemModel* aModel,QSize aScreenSize,bool aEfectsOn = false);
     
-    /*
+    /**
      * Set the image on to HDMI
      */
     void setImagetoHDMI();
     
-    /*
+    /**
      * Sets HDMI to cloning mode
      */
     void setToCloningMode();
     
-    /*
+    /**
      * Sets HDMI to Native posting mode
      */
     void setToNativeMode();
     
-    /*
+    /**
      * views should call this if for any item it doesnt want to move to 
      * HDMI posting mode
      */
     void itemNotSupported();
     
-    /*
+    /**
      * Activate zoom in posting mode
      * This can be called if the zoom animation in HDMI(bounce back effect)
      * needs to be shown 
-     * @param1 - send true if want to auto zoom out on animation effect
+     * @param autoZoomOut send true if want to auto zoom out on animation effect
      */
     void activateZoom(bool autoZoomOut);
     
-    /*
+    /**
      * Deactivate zoom in posting mode.
      * This can be called when zoom animation needs to bounce back.
      * Note : This function is not required if bounce back effect finishes automatically
      */
     void deactivateZoom();
     
-    /*
+    /**
      * Fadeing of the Surface
-     * @param1 ETrue - FadeIn ( as in gaining brightness )
-     *         EFalse - FadeOut ( as in loosing brightness ) 
+     * @param aFadeInOut    ETrue - FadeIn ( as in gaining brightness )
+     *                      EFalse - FadeOut ( as in loosing brightness ) 
      */
     void fadeSurface(bool aFadeInOut);
     
 private:
+    /// Private wrapper handler according to PIMPL pattern 
     GlxTvOutWrapperPrivate* mTvOutWrapperPrivate;
 };