/*
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, version 2.1 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not,
* see "http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html/".
*
* Description:
*
*/
#ifndef QSTMGESTURELISTENER_H_
#define QSTMGESTURELISTENER_H_
#include "qstmgesture_if.h"
namespace qstmGesture
{
/*!
* The gesture listener interface. This interface needs to be implemented by the
* listener of the standard gestures implemented in the gesture framework.
*/
class QStm_GestureListenerIf
{
public:
/*!
* The method that will be called by the gesture framework
* to inform about a gesture being recognised.
* \param theGesture: contains the recognised gesture.
* The QStm_GestureIf contains generic part and gesture specific part
* so the listener needs to know how to handle specific gestures.
*/
virtual void gestureEnter(QStm_GestureIf& theGesture) = 0 ;
/*!
* The method to inform the listener that the gesture has ended.
* This happens if another gesture is recognised or e.g. the Release UI
* event is handled.
* \note Some gestures produce only gestureEnter() callback and no gestureExit().
*/
virtual void gestureExit(QStm_GestureIf& theGesture) = 0 ;
/*!
* The listener needs to provide the target control to the
* standard gestures. Since the gesture framework processes all events in the
* application, the gesture recognisers check whether the events are targeted
* to the listener owning control.
* Not all gesture recognisers need to perform this check.
* \return the owning control of the gesture listener.
*/
virtual void* getOwner() = 0 ;
};
}
#endif /* QSTMGESTURELISTENER_H_ */