tvout/tvoutwrapper/inc/glxtvoutwrapper.h
changeset 52 a3a4c0de738e
parent 43 72396548277c
child 69 45459746d5e8
equal deleted inserted replaced
50:a0f57508af73 52:a3a4c0de738e
    17 
    17 
    18 #ifndef GLXTVOUTWRAPPER_H
    18 #ifndef GLXTVOUTWRAPPER_H
    19 #define GLXTVOUTWRAPPER_H
    19 #define GLXTVOUTWRAPPER_H
    20 
    20 
    21 #include <QAbstractItemModel>
    21 #include <QAbstractItemModel>
       
    22 #include <QSize>
    22 
    23 
    23 // forward decleration
    24 // forward decleration
    24 class GlxTvOutWrapperPrivate;
    25 class GlxTvOutWrapperPrivate;
    25 
    26 
    26 #ifdef BUILD_TVOUTWRAPPER
    27 #ifdef BUILD_TVOUTWRAPPER
    27 #define GLX_TVOUTWRAPPER_EXPORT Q_DECL_EXPORT
    28 #define GLX_TVOUTWRAPPER_EXPORT Q_DECL_EXPORT
    28 #else
    29 #else
    29 #define GLX_TVOUTWRAPPER_EXPORT Q_DECL_IMPORT
    30 #define GLX_TVOUTWRAPPER_EXPORT Q_DECL_IMPORT
    30 #endif
    31 #endif
    31 
    32 
       
    33 /**
       
    34  * Class Description This is Wrapper entry point for Qt based classes for HDMI
       
    35  * 
       
    36  * Client needs to create an instance of this class and setModel() 
       
    37  * 
       
    38  * To Shift from native to clone and vice versa, use setToNativeMode() and 
       
    39  * setToCloningMode() respectively 
       
    40  *
       
    41  * For Not supported items, make sure to call itemNotSupported() API
       
    42  */
       
    43 
    32 class GLX_TVOUTWRAPPER_EXPORT GlxTvOutWrapper
    44 class GLX_TVOUTWRAPPER_EXPORT GlxTvOutWrapper
    33 {
    45 {
    34 public:
    46 public:
    35     /*
    47     /**
    36      * Constructor
    48      * Constructor
    37      */
    49      */
    38     GlxTvOutWrapper();
    50     GlxTvOutWrapper();
    39     
    51     
    40     /*
    52     /**
    41      * Destructor
    53      * Destructor
    42      */
    54      */
    43     ~GlxTvOutWrapper();
    55     ~GlxTvOutWrapper();
    44 
    56 
    45     /*
    57     /**
    46      * Setting the model
    58      * Setting the model
    47      * This also creates the private instance of the wrapper
    59      * This also creates the private instance of the wrapper
    48      * to pass the model 
    60      * to pass the model 
       
    61      * @param Model datamodel
       
    62      * @param screensize the size of the phone screen
       
    63      * @param aEfectsOn if slideshow effects on tv needs to be on, off by default 
    49      */
    64      */
    50     void setModel(QAbstractItemModel* aModel,bool aEfectsOn = false);
    65     void setModel(QAbstractItemModel* aModel,QSize aScreenSize,bool aEfectsOn = false);
    51     
    66     
    52     /*
    67     /**
    53      * Set the image on to HDMI
    68      * Set the image on to HDMI
    54      */
    69      */
    55     void setImagetoHDMI();
    70     void setImagetoHDMI();
    56     
    71     
    57     /*
    72     /**
    58      * Sets HDMI to cloning mode
    73      * Sets HDMI to cloning mode
    59      */
    74      */
    60     void setToCloningMode();
    75     void setToCloningMode();
    61     
    76     
    62     /*
    77     /**
    63      * Sets HDMI to Native posting mode
    78      * Sets HDMI to Native posting mode
    64      */
    79      */
    65     void setToNativeMode();
    80     void setToNativeMode();
    66     
    81     
    67     /*
    82     /**
    68      * views should call this if for any item it doesnt want to move to 
    83      * views should call this if for any item it doesnt want to move to 
    69      * HDMI posting mode
    84      * HDMI posting mode
    70      */
    85      */
    71     void itemNotSupported();
    86     void itemNotSupported();
    72     
    87     
    73     /*
    88     /**
    74      * Activate zoom in posting mode
    89      * Activate zoom in posting mode
    75      * This can be called if the zoom animation in HDMI(bounce back effect)
    90      * This can be called if the zoom animation in HDMI(bounce back effect)
    76      * needs to be shown 
    91      * needs to be shown 
    77      * @param1 - send true if want to auto zoom out on animation effect
    92      * @param autoZoomOut send true if want to auto zoom out on animation effect
    78      */
    93      */
    79     void activateZoom(bool autoZoomOut);
    94     void activateZoom(bool autoZoomOut);
    80     
    95     
    81     /*
    96     /**
    82      * Deactivate zoom in posting mode.
    97      * Deactivate zoom in posting mode.
    83      * This can be called when zoom animation needs to bounce back.
    98      * This can be called when zoom animation needs to bounce back.
    84      * Note : This function is not required if bounce back effect finishes automatically
    99      * Note : This function is not required if bounce back effect finishes automatically
    85      */
   100      */
    86     void deactivateZoom();
   101     void deactivateZoom();
    87     
   102     
    88     /*
   103     /**
    89      * Fadeing of the Surface
   104      * Fadeing of the Surface
    90      * @param1 ETrue - FadeIn ( as in gaining brightness )
   105      * @param aFadeInOut    ETrue - FadeIn ( as in gaining brightness )
    91      *         EFalse - FadeOut ( as in loosing brightness ) 
   106      *                      EFalse - FadeOut ( as in loosing brightness ) 
    92      */
   107      */
    93     void fadeSurface(bool aFadeInOut);
   108     void fadeSurface(bool aFadeInOut);
    94     
   109     
    95 private:
   110 private:
       
   111     /// Private wrapper handler according to PIMPL pattern 
    96     GlxTvOutWrapperPrivate* mTvOutWrapperPrivate;
   112     GlxTvOutWrapperPrivate* mTvOutWrapperPrivate;
    97 };
   113 };
    98     
   114     
    99 #endif //GLXTVOUTWRAPPER_H 
   115 #endif //GLXTVOUTWRAPPER_H 
   100 // End of file
   116 // End of file