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

**

** 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 HbWidgets 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 "hbpushbutton.h"

#include "hbpushbutton_p.h"

#include "hbstyle.h"

#include "hbstyleoptionpushbutton_p.h"

#include "hbframedrawerpool_p.h"

#include "hbnamespace.h"

#ifdef HB_EFFECTS

#include "hbeffect.h"

#include "hbeffectinternal_p.h"

#endif

#ifdef HB_GESTURE_FW

#include <hbtapgesture.h>

#endif

#include <QGraphicsSceneMouseEvent>

#include <QTimer>

#include <QGraphicsItem>

#include <QDebug>

/*!

    @beta

    @hbwidgets

    \class HbPushButton

    \brief The HbPushButton widget provides a button with command.

    \image html hbpushbutton.png A pushbutton with text ,icon and tooltip provided . 

    A push button enable users to perform important commands easily.

    A push button has a rectangular shape and typically displays a text label describing its command.

    Push Button can appear in any container except toolbars where ToolButton HbToolButton is used and palettes.

    A simple push button can be created as shown in the example below.

    \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,16}

    A Push buttons display a textual label. Pushbutton also

    can have icon.These can be set using the constructors and changed later using setText(),setIcon( ).

    In addition to this a push button also displays additional text label.

    Additional text can be set using setAdditionalText().

    Aligning of icon , text and additional text can be changed using setStretched()true/false property.

    Default with setStretched()=false it will place icon and text vertically.

    \image html buttonIconTextV.png A pushbutton with icon ,text.

    and along with additional text will place icon horizontally to both texts ,where both text comes vertically aligned.    

    \image html buttonIconTextAdditionalTextV.png A pushbutton with icon ,text and additional text.

    For setStretched()=true, it will stretch layout to have icon and text horizontally,side by side.

    \image html buttonIconTextH.png A pushbutton with icon ,text.

    and along with additional text will place all of them to Horizontally in one line .

    \image html buttonIconTextAdditionalTextH.png A pushbutton with custom icon ,text and additional text.

    Pushbutton can have both text and additoinal text placed vertically,this can be used in case Dialer button or 

    Virtual key pad buttons with stretched = false.Pushbutton doesn't supports both text in one line 

    stretched = true is not valid.

    Pushbutton will not have stretch layout by default.

    \image html buttonTextAdditional.png A pushbutton with additional text and text.

    Pushbutton can have different states like normal, pressed, disabled, latched and focused.

    A push button emits the signal clicked() when it is activated by tapping it.

    Push buttons also provide less commonly used signals, for example, pressed() and

    released() and emits longPress() on long press.

    Alignment of the text within the text and additionaltext items can be set using 

    setTextAlignment() and setAdditionalText(), default text alignment is Qt::AlignHCenter | Qt::AlignVCenter

    The push button is derived from HbWidget so it can be added to any QGraphicsLayout

    instance for layouting.

    \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,17}

    Push button can also be used as toggle button , following is code snippet

     \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,30}

    and onOffButton as 

     \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,29}

    Push button will come up with additional text following is code snippet.

    1. Push button with icon , text and additionalText

     \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,35}

    2. Pushbutton with additionalText and text.

     \snippet{ultimatecodesnippet/ultimatecodesnippet.cpp,36}

    \sa HbAbstractButton , HbToolButton

*/

/*!

    \reimp

    \fn int HbPushButton::type() const

 */

/*!

    \fn void HbPushButton::longPress( QPointF )

    This signal is emitted in case of longpress.

 */

HbPushButtonPrivate::HbPushButtonPrivate() :

    textItem(0),

    additionalTextItem(0),

    touchArea(0),

    iconItem(0),

    frameItem(0),

    focusItem(0),

    backgroundFrameDrawer(0),

    longPressTimer(0),

    textAlignment(Qt::AlignHCenter | Qt::AlignVCenter ),

    additionalTextAlignment(Qt::AlignHCenter | Qt::AlignVCenter ),

    stretched(false),

    navigationKeyPress(false),

    hasTextAlignment(false),

    hasAdditionalTextAlignment(false)

{

#ifdef HB_EFFECTS

     //HbEffectInternal::add(HB_PUSHBUTTON_TYPE,"pushbutton_pressed.fxml", "pressed");

     HbEffectInternal::add(HB_PUSHBUTTON_TYPE,"pushbutton_released", "released");

#endif

}

/*

  Destructor.

 */

HbPushButtonPrivate::~HbPushButtonPrivate()

{

}

/*

  createPrimitives.

 */

void HbPushButtonPrivate::createPrimitives()

{

    Q_Q(HbPushButton);

    if ( !frameItem ) {

        frameItem = q->style()->createPrimitive( HbStyle::P_PushButton_background, q );

    }

    if ( !text.isNull() ) {

        if ( !textItem ) {

            textItem = q->style()->createPrimitive( HbStyle::P_PushButton_text, q );

        }

    } else {

        if( textItem ){

            delete textItem;

        }

        textItem = 0;

    }

    if ( !additionalText.isNull() ) {

        if ( !additionalTextItem ) {

            additionalTextItem = q->style()->createPrimitive( HbStyle::P_PushButton_additionaltext, q );

        }

    } else {

        if( additionalTextItem ){

            delete additionalTextItem;

        }

        additionalTextItem = 0;

    }

    if ( !icon.isNull() ) {

        if ( !iconItem ) {

            iconItem = q->style()->createPrimitive( HbStyle::P_PushButton_icon, q);

        }

    } else {

        if( iconItem ) {

            delete iconItem;

        }

        iconItem = 0;

    }

    if( !touchArea ) {

        touchArea = q->style()->createPrimitive( HbStyle::P_PushButton_toucharea, q );

        if(QGraphicsObject *ta = qgraphicsitem_cast<QGraphicsObject*>(touchArea)) {

            ta->grabGesture(Qt::TapGesture);

            q->ungrabGesture(Qt::TapGesture);

        } else {

            q->grabGesture(Qt::TapGesture);

        }

    }

    if( !focusItem ) {

        focusItem = q->style()->createPrimitive(HbStyle::P_PushButton_focus, q);

        //focus primitive is will not be visible by default, 

        //only in case of keyboard focus events it will be Visible.

        focusItem->setVisible( false );

    }

}

void HbPushButtonPrivate::_q_handleLongKeyPress( )

{

    Q_Q( HbPushButton );

    if(!longPress) {

        longPress = true;

        emit q->longPress( q->pos( ) );

    }

}

void HbPushButtonPrivate::initialize()

{

    Q_Q( HbPushButton );

    q_ptr = q;

    createPrimitives( );

}

/*!

    @beta

    Constructs a new HbPushButton with \a parent.

 */

HbPushButton::HbPushButton( QGraphicsItem *parent )

    : HbAbstractButton( *new HbPushButtonPrivate, parent )

{

    Q_D( HbPushButton );

    d->initialize( );

    setProperty( "state", "normal" );

}

/*!

    @beta

    Constructs a new HbPushButton with \a text and \a parent.

 */

HbPushButton::HbPushButton( const QString &text, QGraphicsItem *parent )

    : HbAbstractButton( *new HbPushButtonPrivate, parent )

{

    Q_D( HbPushButton );

    d->text = text;

    d->initialize( );

    setProperty( "state", "normal" );

}

/*!

    @beta

    Constructs a new HbPushButton with \a icon, \a text and \a parent.

 */

HbPushButton::HbPushButton( const HbIcon &icon, const QString &text, QGraphicsItem *parent )

    : HbAbstractButton( *new HbPushButtonPrivate, parent )

{

    Q_D( HbPushButton );

    d->icon = icon;

    d->text = text;

    d->initialize( );

    setProperty( "state", "normal" );

}

/*!

    Destructs the push button.

 */

HbPushButton::~HbPushButton( )

{

}

/*!

    @beta

    Sets the \a background of the button.

    \note The background can contain different images for pressed and released states.

    \sa background()

 */

void  HbPushButton::setBackground( const HbIcon &background )

{

    Q_D( HbPushButton );

    if ( d->background != background ) {

        d->background = background;

        d->backgroundFrameDrawer = 0;

        HbStyleOptionPushButton buttonOption;

        initStyleOption( &buttonOption );

        style()->updatePrimitive( d->frameItem, HbStyle::P_PushButton_background, &buttonOption );

    }

}

/*!

    @beta

    Returns the background of the button.

    \sa setBackground()

 */

HbIcon HbPushButton::background( ) const

{

    Q_D( const HbPushButton );

    return d->background;

}

/*!

    @beta

    Sets the \a framebackground of the button.

    \note The background can contain different types of frame drawers(Nine piece,

    three piece or single).Ownership is transferred to the Pushbutton

    \sa frameBackground()

 */

void  HbPushButton::setFrameBackground( HbFrameDrawer *backgroundFrameDrawer )

{

    Q_D( HbPushButton );

    if ( d->backgroundFrameDrawer != backgroundFrameDrawer ) {

        d->backgroundFrameDrawer = backgroundFrameDrawer;

        d->background = HbIcon( );

        HbStyleOptionPushButton buttonOption;

        initStyleOption( &buttonOption );

        style( )->updatePrimitive( d->frameItem, HbStyle::P_PushButton_background, &buttonOption );

    }

}

/*!

    @beta

    Returns the background of the button.

    \sa setBackground()

 */

HbFrameDrawer *HbPushButton::frameBackground( ) const

{

    Q_D( const HbPushButton );

    return ( d->backgroundFrameDrawer );

}

/*!

    @beta

    Sets the \a text shown on the button.

    \sa text()

 */

void HbPushButton::setText( const QString &text )

{

    Q_D( HbPushButton );

    if ( d->text != text ) {

        bool doPolish = text.isEmpty() || d->text.isEmpty();

        d->text = text;

        d->createPrimitives( );

        //updatePrimitives();

        if( d->textItem ) {

            HbStyleOptionPushButton buttonOption;

            initStyleOption( &buttonOption );

            style( )->updatePrimitive( d->textItem, HbStyle::P_PushButton_text, &buttonOption);

        }

        if(doPolish) {

            repolish( );

        }

    }

}

/*!

    @beta

    Returns the text shown on the button.

    \sa setText()

 */

QString HbPushButton::text( ) const

{

    Q_D( const HbPushButton );

    return d->text;

}

/*!

    @beta

    Sets the \a additional text shown on the button.

    Additional text is only shown in case 

    1. with icon and text in Qt::Horizontal alignment.

    2. with additionalText and text in Qt::Vertical alignment.

    \sa additionalText()

 */

void HbPushButton::setAdditionalText( const QString &additionalText )

{

    Q_D( HbPushButton );

    if ( d->additionalText != additionalText ) {

        bool doPolish = additionalText.isEmpty() || d->additionalText.isEmpty();

        d->additionalText = additionalText;

        d->createPrimitives( );

        // updatePrimitives();

        if( d->additionalTextItem ) {

            HbStyleOptionPushButton buttonOption;

            initStyleOption( &buttonOption );

            style( )->updatePrimitive( d->additionalTextItem, HbStyle::P_PushButton_additionaltext, &buttonOption);

        }

        if( doPolish ) {

            repolish();

        }

    }

}

/*!

    @beta

    Returns the additional text shown on the button.

    \sa setAdditionalText()

 */

QString HbPushButton::additionalText( ) const

{

    Q_D( const HbPushButton );

    return d->additionalText;

}

/*!

    @beta

    Sets the \a icon shown on the button.

    \note The icon can contain images for different modes.

    \sa icon()

 */

void HbPushButton::setIcon( const HbIcon &icon )

{

    Q_D(HbPushButton);

    if ( d->icon != icon ) {

        bool doPolish = icon.isNull( ) || d->icon.isNull();

        d->icon = icon;

        d->createPrimitives( );

        //updatePrimitives();

        if( d->iconItem ) {

            HbStyleOptionPushButton buttonOption;

            initStyleOption( &buttonOption );

            style()->updatePrimitive( d->iconItem, HbStyle::P_PushButton_icon, &buttonOption );

        }

        if( doPolish ) {

            repolish();

        }

    }

}

/*!

    @beta

    Returns the icon shown on the button.

    \sa setIcon()

 */

HbIcon HbPushButton::icon( ) const

{

    Q_D( const HbPushButton );

    return d->icon;

}

/*!

    @beta

    Set the text alignment for primarytext  and additional text.

    The default alignment is Qt::AlignHCenter | Qt::AlignVCenter.

    \sa textAlignment()

*/

void HbPushButton::setTextAlignment( Qt::Alignment alignment )

{

    Q_D( HbPushButton ); 

    //HbWidgetBase* textItem = static_cast<HbWidgetBase*>(d->textItem);		

    if( !d->textItem ) {

        //need to create text item if user call alignment api before setText.

        d->textItem = style( )->createPrimitive( HbStyle::P_PushButton_text, this);

    }

    //HbWidgetBasePrivate *textItem_p = HbWidgetBasePrivate::d_ptr(textItem);	

    // check for textitem and api protection flag

    if( alignment != d->textAlignment ){

        //take the alignment 

        d->textAlignment = alignment;

        //set the api protection flag 

        //HbWidgetBasePrivate::d_ptr(textItem)->setApiProtectionFlag(HbWidgetBasePrivate::AC_TextAlign,true);

        d->hasTextAlignment = true;

        HbStyleOptionPushButton buttonOption;            

        initStyleOption( &buttonOption );

        style()->updatePrimitive( 

        d->textItem, HbStyle::P_PushButton_text, &buttonOption );

    }

    d->hasTextAlignment = true;

}

/*!

    @beta

    Returns the text alignment for primary text and additional text

    \sa setTextAlignment()

*/

Qt::Alignment HbPushButton::textAlignment( ) const

{