/****************************************************************************

**

** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (developer.feedback@nokia.com)

**

** This file is part of the HbPlugins module of the UI Extensions for Mobile.

**

** GNU Lesser General Public License Usage

** This file may be used under the terms of the GNU Lesser General Public

** License version 2.1 as published by the Free Software Foundation and

** appearing in the file LICENSE.LGPL included in the packaging of this file.

** Please review the following information to ensure the GNU Lesser General

** Public License version 2.1 requirements will be met:

** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at developer.feedback@nokia.com.

**

****************************************************************************/

#include "hbfeedbackeffectutils.h"

#include "hbnamespace_p.h"

#include <hbtoolbutton.h>

#include <hbabstractbutton.h>

#include <hbabstractedit.h>

#include <hbtextedit.h>

#include <hblineedit.h>

#include <hbabstractslidercontrol.h>

#include <hbprogressslider.h>

#include <hbscrollbar.h>

#include <hbabstractviewitem.h>

#include <hbabstractitemview.h>

#include <hbgridview.h>

#include <hbgridviewitem.h>

#include <hblistview.h>

#include <hbtreeview.h>

#include <hbtreeviewitem.h>

#include <hbdataformviewitem.h>

#include <hbpopup.h>

#include <hbmenu.h>

#include <hbview.h>

#include <hbmainwindow.h>

#include <QGraphicsScene>

#include <QPointF>

#include <QRectF>

const int continuousSliderStepLimit = 15;

#define IF_INSTANCEOF_SET_FAMILY(className, widgetFamily) \

  if (qobject_cast<const className *>(widget))  \

  {                                             \

      family = HbFeedbackEffectUtils::widgetFamily;        \

  }

/*!

    Finds out the graphics item type of the parent widget.

*/

int HbFeedbackEffectUtils::parentItemType(const HbWidget *widget)

{

    QGraphicsItem *parent = widget->parentItem();

    if(parent)

        return parent->type();

    else

        return 0;

}

/*!

    Returns the widget family for a widget.

*/

HbFeedbackEffectUtils::WidgetFamily HbFeedbackEffectUtils::widgetFamily(const HbWidget *widget)

{

    HbFeedbackEffectUtils::WidgetFamily family = Undefined;

    switch(widget->type()) {

        case Hb::ItemType_AbstractButton:

        case Hb::ItemType_PushButton:

        case Hb::ItemType_ToolButton:

        case Hb::ItemType_CheckBox:

        case HbPrivate::ItemType_SliderElement:

        case HbPrivate::ItemType_IndicatorGroup:

        case HbPrivate::ItemType_TitlePane:

        case Hb::ItemType_InputButtonGroup:

        case Hb::ItemType_InputFunctionButton:

        case Hb::ItemType_ComboBox:

            family = HbFeedbackEffectUtils::Button;

            break;

        case Hb::ItemType_MenuItem:

        case Hb::ItemType_AbstractItemView:

        case Hb::ItemType_ListView:

        case Hb::ItemType_ListViewItem:

        case Hb::ItemType_TreeViewItem:

        case Hb::ItemType_ListWidgetItem:

        case Hb::ItemType_RadioButtonList:

        case Hb::ItemType_CarouselView:

        case HbPrivate::ItemType_MenuListView:

        case HbPrivate::ItemType_GroupBoxHeadingWidget:

        case HbPrivate::ItemType_GroupBoxContentWidget:

        case HbPrivate::ItemType_DataGroupHeadingWidget:

            family = HbFeedbackEffectUtils::List;

            IF_INSTANCEOF_SET_FAMILY(HbGridView, Grid)

            break;

        case Hb::ItemType_GridViewItem:

            family = HbFeedbackEffectUtils::Grid;

            break;

        case Hb::ItemType_AbstractSlider:

        case Hb::ItemType_Slider:

        case HbPrivate::ItemType_SliderControl:

        case HbPrivate::ItemType_SliderHandle:

        case HbPrivate::ItemType_SliderTickmarks:

        case HbPrivate::ItemType_ZoomSlider:

        case HbPrivate::ItemType_VolumeSlider:

        case Hb::ItemType_ProgressBar:

        case Hb::ItemType_ProgressSlider:

        case HbPrivate::ItemType_ProgressSliderHandle:

        case Hb::ItemType_ScrollBar:

        case Hb::ItemType_RatingSlider:

            family = HbFeedbackEffectUtils::Slider;

            break;

        case Hb::ItemType_Menu:

        case HbPrivate::ItemType_IndicatorMenu:

        case Hb::ItemType_Popup:

        case Hb::ItemType_ToolBarExtension:

        case HbPrivate::ItemType_ToolTipLabel:

        case Hb::ItemType_InputVkbWidget:

        case Hb::ItemType_ColorDialog:

            family = HbFeedbackEffectUtils::Popup;

            break;

        case Hb::ItemType_LineEdit:

        case Hb::ItemType_TextEdit:

        case Hb::ItemType_AbstractEdit:

        case Hb::ItemType_VirtualTrackPoint:

        case Hb::ItemType_WritingBox:

            family = HbFeedbackEffectUtils::Editor;

            break;

        default:

            break;

    }

    // fallback if item type cannot be found

    if (family == HbFeedbackEffectUtils::Undefined) {

        IF_INSTANCEOF_SET_FAMILY(HbAbstractButton, Button)

        IF_INSTANCEOF_SET_FAMILY(HbAbstractEdit, Editor)

        IF_INSTANCEOF_SET_FAMILY(HbAbstractSliderControl, Slider)

        IF_INSTANCEOF_SET_FAMILY(HbPopup, Popup)

        IF_INSTANCEOF_SET_FAMILY(HbAbstractItemView, List)

        IF_INSTANCEOF_SET_FAMILY(HbAbstractViewItem, List)

        IF_INSTANCEOF_SET_FAMILY(HbGridView, Grid)

        IF_INSTANCEOF_SET_FAMILY(HbGridViewItem, Grid)

    }

    return family;

}

/*!

    Returns the instant feedback effect on press interaction.

*/

HbFeedback::InstantEffect HbFeedbackEffectUtils::instantOnPress(const HbWidget *widget, Hb::InteractionModifiers modifiers)

{

    HbFeedback::InstantEffect effect = HbFeedback::Sensitive;

    switch (widgetFamily(widget)) {

        case HbFeedbackEffectUtils::Undefined:

            effect = HbFeedback::None;

            break;

        case HbFeedbackEffectUtils::Button:

            effect = HbFeedback::SensitiveButton;

            // latched down button special case (isChecked information required)

            if (const HbAbstractButton* button = qobject_cast<const HbAbstractButton *>(widget)) {

                if (button->type() == Hb::ItemType_PushButton) {

                    // toggleable push button

                    if (button->isCheckable()) {

                        if (button->isChecked()) {

                            effect = HbFeedback::SensitiveButton;

                        } else {

                            effect = HbFeedback::BasicButton;

                        }

                    // normal push button

                    } else {

                        effect = HbFeedback::BasicButton;

                    }

                }

            }

            if (widget->type() == HbPrivate::ItemType_NavigationButton || 

                widget->type() == Hb::ItemType_ToolButton) {

                effect = HbFeedback::BasicButton;

            }

            // input widget special case

            if (widget->type() == Hb::ItemType_InputButtonGroup && modifiers & Hb::ModifierInputFunctionButton) {

                effect = HbFeedback::BasicKeypad;

            }

            else if (widget->type() == Hb::ItemType_InputButtonGroup) {

                effect = HbFeedback::SensitiveKeypad;

            } 

            else if (widget->type() == Hb::ItemType_InputFunctionButton) {

                effect = HbFeedback::BasicKeypad;

            } 

            if (widget->type() == Hb::ItemType_CheckBox) {

                effect = HbFeedback::BasicButton;

            }

            // title pane specific special case

            if (widget->type() == HbPrivate::ItemType_TitlePane) {

                if (isOptionsMenuEmpty(widget)) {

                    effect = HbFeedback::None;

                }

            }

            if (widget->type() == Hb::ItemType_ComboBox) {

                effect = HbFeedback::BasicButton;

            }

            break;

        case HbFeedbackEffectUtils::List:

            if (modifiers & (Hb::ModifierExpandedItem | Hb::ModifierCollapsedItem)) {

                effect = HbFeedback::BasicItem;

            }

            else {

                effect = HbFeedback::BasicItem;

            }

            if (widget->type() == Hb::ItemType_DataFormViewItem ||

                widget->type() == HbPrivate::ItemType_DataGroup) {

                effect = HbFeedback::None;

            }

            break;

        case HbFeedbackEffectUtils::Grid:

            effect = HbFeedback::BasicItem;

            break;

        case HbFeedbackEffectUtils::Slider:

            // slider track default

            effect = HbFeedback::BasicSlider;

            // special cases

            if (const HbProgressSlider *progressSlider = qobject_cast<const HbProgressSlider *>(widget)) {

                Q_UNUSED(progressSlider)

                effect = HbFeedback::BasicSlider;

            } else if (const HbScrollBar *scrollBar = qobject_cast<const HbScrollBar *>(widget)) {

                Q_UNUSED(scrollBar)

                effect = HbFeedback::SensitiveSlider;

            }

            // slider handle

            if (modifiers & Hb::ModifierSliderHandle) {

                effect = HbFeedback::BasicSlider;

            }

            // slider elements

            if (modifiers & Hb::ModifierSliderElement) {

                effect = HbFeedback::BasicButton;

            }

            break;

        case HbFeedbackEffectUtils::Popup:

            if (widget->type() == Hb::ItemType_InputVkbWidget) {

                effect = HbFeedback::SensitiveButton;

            }

            else {

                effect = HbFeedback::None;

            }

            break;

        case HbFeedbackEffectUtils::Editor:

            if (const HbAbstractEdit* editor = qobject_cast<const HbAbstractEdit *>(widget)) {

                if(editor->isReadOnly() && (Hb::TextCursorHidden == editor->cursorVisibility())) {

                    // cannot edit nor select

                    effect = HbFeedback::None;

                } else {

                    effect = HbFeedback::Editor;

                }

            }

            break;

        default:

            break;

    }

    // item view specific special cases

    if ( const HbAbstractViewItem * viewItem = qobject_cast<const HbAbstractViewItem *>(widget)) {

        const HbAbstractItemView* itemView = viewItem->itemView();

        if (itemView) {

            // Different press feedbacks for single and multiselection list items

            switch (itemView->selectionMode()) {

                case HbAbstractItemView::SingleSelection:

                case HbAbstractItemView::MultiSelection: {

                    effect = HbFeedback::BasicItem;

                    break;

                }

                case HbAbstractItemView::NoSelection:

                    if (const HbListView * listView = qobject_cast<const HbListView *>(itemView)) {

                        if (listView->arrangeMode()

                            && !(modifiers & Hb::ModifierScrolling)) {

                            effect = HbFeedback::ItemPick;

                        }

                    }

                    break;

                default:

                    break;

            }

            // radio button list behaves like an item view on press

            if (viewItem->type() == Hb::ItemType_RadioButtonListViewItem) {

                effect = HbFeedback::BasicItem;

            }

            else if(viewItem->type() == Hb::ItemType_DatePickerViewItem ||

                    viewItem->type() == Hb::ItemType_TumbleViewItem) {

                effect = HbFeedback::BasicItem;

            }

            // expandable or collapsable items give a BasicItem feedback

            if (const HbTreeViewItem* treeItem = qobject_cast<const HbTreeViewItem *>(widget)) {

                if (itemView->model()->rowCount(treeItem->modelIndex()) > 0) {

                    effect = HbFeedback::BasicItem;

                }

                else {

                    effect = HbFeedback::BasicItem;

                }

            }

            // Combo box drop down list

            if (QString(widget->metaObject()->className()) == "HbComboListViewItem") {

                effect = HbFeedback::BasicItem;

            }

        }

    }

    if (widget->type() == Hb::ItemType_VirtualTrackPoint || QString(widget->metaObject()->className()) == "HbSelectionControl") {

        effect = HbFeedback::BasicButton;

    }

    else if (widget->type() == Hb::ItemType_NotificationDialog) {

        effect = HbFeedback::BasicItem;

    }

    if (modifiers & Hb::ModifierScrolling) {

        effect = HbFeedback::StopFlick;

    }

    return effect;

}

/*!

    Returns the instant feedback effect on release interaction.

*/

HbFeedback::InstantEffect HbFeedbackEffectUtils::instantOnRelease(const HbWidget *widget, Hb::InteractionModifiers modifiers)

{

    // mostly the same as when the widget is pressed

    HbFeedback::InstantEffect effect = instantOnPress(widget, modifiers);

    // clicking on a sub menu item, indicator group or title pane causes release feedback

    // even if all of those widgets open a new menu popup, which initiates IncreasingPopUp

    switch (widgetFamily(widget)) {

        case HbFeedbackEffectUtils::Undefined:

            effect = HbFeedback::None;

            break;

        case HbFeedbackEffectUtils::Button:

            effect = HbFeedback::SensitiveButton;

            // latched down button special case (isChecked information required)

            if (const HbAbstractButton* button = qobject_cast<const HbAbstractButton *>(widget)) {

                if (button->type() == Hb::ItemType_PushButton) {

                    // toggleable push button

                    if (button->isCheckable()) {

                        if (button->isChecked()) {

                            effect = HbFeedback::BasicButton;

                        } else {

                            effect = HbFeedback::None;

                        }

                    // normal push button

                    } else {

                        effect = HbFeedback::BasicButton;

                    }

                }

            }

            if (widget->type() == HbPrivate::ItemType_NavigationButton || 

                widget->type() == Hb::ItemType_ToolButton) {

                effect = HbFeedback::BasicButton;

            }

            // input widget special case

            if (widget->type() == Hb::ItemType_InputButtonGroup && modifiers & Hb::ModifierInputFunctionButton) {

                effect = HbFeedback::BasicKeypad;

            }

            else if (widget->type() == Hb::ItemType_InputButtonGroup) {

                effect = HbFeedback::SensitiveKeypad;

            }

            if (widget->type() == Hb::ItemType_CheckBox) {

                effect = HbFeedback::Checkbox;

            }

            // title pane specific special case

            if (widget->type() == HbPrivate::ItemType_TitlePane) {

                effect = HbFeedback::None;

            }

            if (widget->type() == Hb::ItemType_ComboBox) {

                effect = HbFeedback::PopupOpen;

            }

            break;

        case HbFeedbackEffectUtils::List:

            if (modifiers & (Hb::ModifierExpandedItem | Hb::ModifierCollapsedItem)) {

                effect = HbFeedback::BasicItem;

            }

            else {

                effect = HbFeedback::BasicItem;

            }

            // menu items give popup close feedback on release

            if (widget->type() == Hb::ItemType_MenuItem) {

                effect = HbFeedback::None;

            }

            else if (widget->type() == Hb::ItemType_DataFormViewItem) {

                effect = HbFeedback::None;

            }

            break;

        case HbFeedbackEffectUtils::Grid:

            if (widget->type() == HbPrivate::ItemType_ColorGridViewItem) {

                effect = HbFeedback::None;

            }

            else {

                effect = HbFeedback::BasicItem;

            }

            break;

        case HbFeedbackEffectUtils::Slider:

            if (widget->type() == Hb::ItemType_ScrollBar) {

                effect = HbFeedback::None;

            }

            else {  // slider track default

                effect = HbFeedback::BasicSlider;

            }

            // slider handle

            if (modifiers & Hb::ModifierSliderHandle) {

                effect = HbFeedback::BasicSlider;

            }

            // slider elements

            if (modifiers & Hb::ModifierSliderElement) {

                effect = HbFeedback::None;

            }

            break;