emailuis/nmailuiwidgets/src/nmattachmentlistitem.cpp
branchRCL_3
changeset 63 d189ee25cf9d
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/emailuis/nmailuiwidgets/src/nmattachmentlistitem.cpp	Tue Aug 31 15:04:17 2010 +0300
@@ -0,0 +1,296 @@
+/*
+* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: Attachment list item widget
+*
+*/
+
+#include "nmailuiwidgetsheaders.h"
+
+static const QString FILE_PATH_WIDGETML = ":nmattachmentlistitem.widgetml";
+static const QString FILE_PATH_CSS = ":nmattachmentlistitem.css";
+static const QString LIST_ITEM_BG_FRAME_NORMAL ("qtg_fr_list_normal");
+static const QString LIST_ITEM_BG_FRAME_PRESSED("qtg_fr_list_pressed");
+
+static const int PROGRESSBAR_MIN = 0; 
+static const int PROGRESSBAR_MAX = 100;
+static const int PROGRESSBAR_HIDE_COUNTDOWN = 500;
+
+/*!
+ @nmailuiwidgets
+ \class NmAttachmentListItem
+
+ \brief The NmAttachmentListItem widget provides for showing a single attachment with file size and
+        download progress in the attachment list.
+
+
+
+ */
+
+
+/*!
+    Constructs a new NmAttachmentListItem with \a parent.
+ */
+NmAttachmentListItem::NmAttachmentListItem(QGraphicsItem *parent)
+    : HbWidget( parent ),
+      mFileNameText(NULL),
+      mFileSizeText(NULL),
+      mProgressBar(NULL),
+      mBackGround(NULL)
+{
+    NM_FUNCTION;
+    
+    init( );
+	
+    // Informs GestureFramework that NmAttachmentListItem widget is interested 
+    // Tap gesture and TapAndHold gesture.
+    grabGesture(Qt::TapGesture);
+    HbEffect::add("mailAttachmentWidget", "listviewitem_press", "pressed");
+    HbEffect::add("mailAttachmentWidget", "listviewitem_release", "released");
+}
+
+/*!
+    Setter for items text color override. This fucntion can be used
+    if theme background is not used and text needs to be shown in diferent color.
+ */
+void NmAttachmentListItem::setTextColor(const QColor color)
+{
+    NM_FUNCTION;
+    
+    mTextColor=color;
+    if (mTextColor.isValid() && mFileNameText){
+        mFileNameText->setTextColor(mTextColor);
+    }    
+}
+
+/*!
+    Destructor.
+ */
+NmAttachmentListItem::~NmAttachmentListItem( )
+{
+    NM_FUNCTION;
+    
+    HbStyleLoader::unregisterFilePath(FILE_PATH_WIDGETML);
+    HbStyleLoader::unregisterFilePath(FILE_PATH_CSS);
+}
+
+/*!
+    Set the text to be displayed in the file name item.
+ */
+void NmAttachmentListItem::setFileNameText(const QString &fileName)
+{
+    NM_FUNCTION;
+    
+    if (mFileNameText){
+        if (mTextColor.isValid()){
+            mFileNameText->setTextColor(mTextColor);
+        }
+        mFileNameText->setTextWrapping(Hb::TextNoWrap);
+        mFileNameText->setText(fileName);    
+    }
+}
+
+/*!
+    Set the text to be displayed in the file size item
+ */
+void NmAttachmentListItem::setFileSizeText(const QString &fileSize)
+{
+    NM_FUNCTION;
+    
+    if (mFileSizeText){
+        if (mTextColor.isValid()){
+            mFileSizeText->setTextColor(mTextColor);
+        }
+        mFileSizeText->setTextWrapping(Hb::TextNoWrap);
+        mFileSizeText->setText(fileSize);
+    }
+}
+
+/*!
+    Set the download progress bar value (0-100)%, if value is 0 progress bar is hidden
+ */
+void NmAttachmentListItem::setProgressBarValue(const int value)
+{
+    NM_FUNCTION;
+    
+    //first check if value is 0 or below -> hide progressbar
+    if ( 0 >= value ){
+        removeProgressBar();
+        return;
+    }
+
+    if ( !mProgressBar ){
+        mProgressBar = new HbProgressBar(this); 
+        mProgressBar->setObjectName("attachmentlistitem_progress");
+        mProgressBar->setRange(PROGRESSBAR_MIN,PROGRESSBAR_MAX);
+        HbStyle::setItemName( mProgressBar, "progressbar" );
+        repolish();
+    }
+    mProgressBar->setProgressValue(value);
+    
+    //start hiding count down
+    if(PROGRESSBAR_MAX <= value){
+        hideProgressBar();
+    }
+}
+
+/*!
+    Get the download progress bar value
+*/
+int NmAttachmentListItem::progressBarValue() const
+{
+    NM_FUNCTION;
+    
+    int ret = 0;
+    if ( mProgressBar ){
+        ret = mProgressBar->progressValue();
+    }
+
+    return ret;
+}
+
+/*!
+    Hides progress bar, used if download is cancelled before 100 precent is reached
+*/
+void NmAttachmentListItem::hideProgressBar()
+{
+    NM_FUNCTION;
+    
+    QTimer::singleShot(PROGRESSBAR_HIDE_COUNTDOWN,this, SLOT(removeProgressBar()));
+}
+
+/*!
+    Initialize
+*/
+void NmAttachmentListItem::init( )
+{
+    NM_FUNCTION;
+    
+    constructUi();
+
+    //set default values
+    setFlag(QGraphicsItem::ItemIsFocusable);
+    setFlag(QGraphicsItem::ItemIsSelectable);
+}
+
+/*!
+    Constructs the UI, sets style itemnames etc.
+*/
+void NmAttachmentListItem::constructUi()
+{
+    NM_FUNCTION;
+    
+    //background
+    QScopedPointer<HbFrameItem> backGround(new HbFrameItem(this));
+    backGround->frameDrawer().setFrameGraphicsName(LIST_ITEM_BG_FRAME_NORMAL);
+    backGround->frameDrawer().setFrameType(HbFrameDrawer::NinePieces);
+    setBackgroundItem(backGround.data());
+    // ownership was transferred to base class
+    mBackGround = backGround.take();
+    
+    
+    //construct default ui.    
+    HbStyleLoader::registerFilePath(FILE_PATH_WIDGETML);
+    HbStyleLoader::registerFilePath(FILE_PATH_CSS);
+    
+    
+    QScopedPointer<HbTextItem> fileNameText(new HbTextItem(this));
+    fileNameText->setObjectName("nmattachmentlistitem_filenametext");
+    HbStyle::setItemName( fileNameText.data(), "filename" );  
+    fileNameText->setElideMode(Qt::ElideRight);
+    
+    
+    QScopedPointer<HbTextItem> fileSizeText(new HbTextItem(this));
+    fileSizeText->setObjectName("nmattachmentlistitem_filenamesize");
+    HbStyle::setItemName( fileSizeText.data(), "filesize" );
+    fileSizeText->setElideMode(Qt::ElideNone);
+    
+    // ownership transferred to this object
+    mFileSizeText = fileSizeText.take(); 
+    mFileNameText = fileNameText.take();
+}
+
+
+/*!
+    Hides the download progress bar
+ */
+void NmAttachmentListItem::removeProgressBar()
+{
+    NM_FUNCTION;
+    
+	if ( mProgressBar ){
+	    HbStyle::setItemName( mProgressBar, "" );
+	    mProgressBar->deleteLater();
+	    mProgressBar = 0;
+	    repolish();
+	}
+}
+
+
+/*!
+    This function handles gestures
+ */
+
+void NmAttachmentListItem::gestureEvent(QGestureEvent *event)
+{
+    NM_FUNCTION;
+    
+    if (HbTapGesture *tap = qobject_cast<HbTapGesture *>(event->gesture(Qt::TapGesture))) {
+        switch(tap->tapStyleHint()) {
+        case HbTapGesture::Tap: 
+            {
+                Qt::GestureState state = tap->state();
+                HbInstantFeedback::play(HbFeedback::Basic);
+                setPressed(true);
+                if (state == Qt::GestureFinished) {
+                    emit itemActivated();
+                    setPressed(false);
+                }
+                else if (state == Qt::GestureCanceled) {
+                    setPressed(false);
+                }
+             }
+             break;
+            
+         case HbTapGesture::TapAndHold:
+             {
+                 emit itemLongPressed(event->mapToGraphicsScene(tap->position()));
+                 setPressed(false);
+             }    
+             break;
+        }
+    }
+    else {
+           HbWidget::gestureEvent(event);
+    }
+}
+
+/*!
+    Sets the effect of the item when tapping it
+*/
+void NmAttachmentListItem::setPressed(bool pressed)
+{
+    if (pressed) {
+        setProperty("state", "pressed");
+        mBackGround->frameDrawer().setFrameGraphicsName(LIST_ITEM_BG_FRAME_PRESSED);
+        HbEffect::cancel(mBackGround, "released");
+        HbEffect::start(mBackGround, "mailAttachmentWidget", "pressed");
+
+    }
+    else {
+        setProperty("state", "normal");
+        mBackGround->frameDrawer().setFrameGraphicsName(LIST_ITEM_BG_FRAME_NORMAL);
+        HbEffect::cancel(mBackGround, "pressed");
+        HbEffect::start(mBackGround, "mailAttachmentWidget", "released");
+    }    
+}