class GlxState: public QObject

Q_OBJECT

public:

    /**

     * Constructor

     * id = state id, state is and view id should be same

     * preState = previous state pointer. It value will be null, if it is only one state in the stack

     */

    GlxState( qint32 id, GlxState *preState );

    /**

     * Destructor

     */

    virtual ~GlxState();

    /**

     * compare() - It wiil compare the states, is it same or different state.

     * @param - Id of the state

     * @return - return the true if the state is same else false

     */

    bool compare( qint32 id ) const;

    /**

     * id() - Return the state id of the state

     * @return - return the state id of the state

     */

    qint32 id() const

    {

        return mId;

    }

    /**

     * previousState() - Retrun the pointer of the the previous state

     * @return - Retrun the pointer of the the previous state

     */

    GlxState * previousState() const

    {

        return mPreState;

    }

    /**

     * eventHandler() - Pure virtual function. It is default event handler of the state

     * @param - command or event id

     */

    virtual void eventHandler( qint32 &id ) = 0;

    /** 

     * setState() - This funtion use for set the internal state of a state

     * default implementation

     * @param - internal state of the state

     */

    virtual void setState( int internalState )

    {

        Q_UNUSED( internalState )

    }

    /**

     * commandId() - it will return the current runing command id

     * @reutn - command id

     */

    virtual qint32 commandId()

    {

        return -1;

    }

    /**

     * state() - This funtion return the internal state of a state

     * default implementation

     * @return - internal state

     */

    virtual int state() const

    {

        return 0;

    }

    /**

     * setTranstionParameter() - This function set the view transtion effect parameter.

     * These values is use for run the animation for vies transtion

     * In the case of forward direction it should call with the next state and in the case of back ward direction

     * it should call with the current state

     * @param View transtion id

     * @param to play the animation on which views

     */

    virtual void setTranstionParameter( NavigationDir dir, GlxEffect &effect, GlxViewEffect &viewEffect );