uifw/ganes/src/HgScrollBufferManager.cpp
changeset 47 2f0c06423c72
parent 46 0e1e0022bd03
child 53 3c67ea82fafc
equal deleted inserted replaced
46:0e1e0022bd03 47:2f0c06423c72
     1 /*
       
     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:     
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #include "HgScrollBufferManager.h"
       
    20 #include <ganes/HgScrollBufferObserverIface.h>
       
    21 
       
    22 #include <e32debug.h>
       
    23 
       
    24 // -----------------------------------------------------------------------------
       
    25 // CHgScrollBufferManager::NewL()
       
    26 // -----------------------------------------------------------------------------
       
    27 //
       
    28 CHgScrollBufferManager* CHgScrollBufferManager::NewL( 
       
    29         MHgScrollBufferObserver& aObserver, 
       
    30         TInt aBufferSize,
       
    31         TInt aBufferTreshold,
       
    32         TInt aInitialPosition,
       
    33         TInt aTotalCount )
       
    34     {
       
    35     CHgScrollBufferManager* self = new (ELeave) CHgScrollBufferManager(
       
    36                                                         aObserver, 
       
    37                                                         aBufferSize, 
       
    38                                                         aBufferTreshold, 
       
    39                                                         aInitialPosition, 
       
    40                                                         aTotalCount );
       
    41     CleanupStack::PushL(self);
       
    42     self->ConstructL();
       
    43     CleanupStack::Pop(self);
       
    44     return self;
       
    45     }
       
    46 
       
    47 // -----------------------------------------------------------------------------
       
    48 // CHgScrollBufferManager::CHgScrollBufferManager()
       
    49 // -----------------------------------------------------------------------------
       
    50 //
       
    51 CHgScrollBufferManager::CHgScrollBufferManager(
       
    52         MHgScrollBufferObserver& aObserver, 
       
    53         TInt aBufferSize,
       
    54         TInt aBufferTreshold,
       
    55         TInt aInitialPosition,
       
    56         TInt aTotalCount )
       
    57 : CActive( CActive::EPriorityHigh ), 
       
    58     iObserver( aObserver ),
       
    59     iBufferSize( aBufferSize ),
       
    60     iBufferTreshold( aBufferTreshold ),
       
    61     iBufferPosition( aInitialPosition ),
       
    62     iTotalCount( aTotalCount )
       
    63     {
       
    64     
       
    65     }
       
    66 
       
    67 // -----------------------------------------------------------------------------
       
    68 // CHgScrollBufferManager::ConstructL()
       
    69 // -----------------------------------------------------------------------------
       
    70 //
       
    71 void CHgScrollBufferManager::ConstructL()
       
    72     {
       
    73     CActiveScheduler::Add(this);
       
    74     
       
    75     iResetOrdered = ETrue;
       
    76     ResetBuffer(iBufferPosition, iTotalCount);
       
    77     }
       
    78 
       
    79 // -----------------------------------------------------------------------------
       
    80 // CHgScrollBufferManager::~CHgScrollBufferManager()
       
    81 // -----------------------------------------------------------------------------
       
    82 //
       
    83 CHgScrollBufferManager::~CHgScrollBufferManager()
       
    84     {
       
    85     Cancel();
       
    86     }
       
    87 
       
    88 // -----------------------------------------------------------------------------
       
    89 // CHgScrollBufferManager::RunL()
       
    90 // -----------------------------------------------------------------------------
       
    91 //
       
    92 void CHgScrollBufferManager::RunL()
       
    93     {
       
    94     MHgScrollBufferObserver::THgScrollDirection direction = MHgScrollBufferObserver::EHgBufferNoMove;
       
    95     
       
    96     if(iResetOrdered)
       
    97         {
       
    98         iResetOrdered = EFalse;
       
    99         direction = MHgScrollBufferObserver::EHgBufferReset;
       
   100         }
       
   101     else
       
   102         {
       
   103         if(iDiff < 0)
       
   104             {
       
   105             iReleaseStart = iBufferPosition;
       
   106             iRequestStart = iBufferPosition + iBufferSize;
       
   107             direction = MHgScrollBufferObserver::EHgBufferScrollDown;
       
   108             }
       
   109         else if( iDiff > 0)
       
   110             {
       
   111             iReleaseStart = iBufferPosition + iBufferSize - iDiff;
       
   112             iRequestStart = iBufferPosition - iDiff;
       
   113             direction = MHgScrollBufferObserver::EHgBufferScrollUp;
       
   114             }
       
   115         }
       
   116     
       
   117     // Release 
       
   118     TInt end = iReleaseStart + iReleaseCount < iTotalCount ?
       
   119         iReleaseStart + iReleaseCount: iTotalCount; 
       
   120     end--;
       
   121     if(end >= iReleaseStart )
       
   122         {
       
   123         iObserver.Release(iReleaseStart, end);
       
   124         if(iOwner) iOwner->Release( iReleaseStart, end );
       
   125         }
       
   126     
       
   127     iReleaseCount = 0;
       
   128     
       
   129     // Request
       
   130     end = iRequestStart + iRequestCount < iTotalCount ? 
       
   131         iRequestStart + iRequestCount : iTotalCount;
       
   132 
       
   133     end--;
       
   134     if(end >= iRequestStart )
       
   135         iObserver.Request(iRequestStart, end, direction);
       
   136       
       
   137     iRequestCount = 0;
       
   138 
       
   139     // Move Buffer
       
   140     iBufferPosition -= iDiff;
       
   141     // Reset Diff
       
   142     iDiff = 0;
       
   143     }
       
   144 
       
   145 // -----------------------------------------------------------------------------
       
   146 // CHgScrollBufferManager::DoCancel()
       
   147 // -----------------------------------------------------------------------------
       
   148 //
       
   149 void CHgScrollBufferManager::DoCancel()
       
   150     {
       
   151     // Nothing to do here
       
   152     }
       
   153 
       
   154 // -----------------------------------------------------------------------------
       
   155 // CHgScrollBufferManager::RunError()
       
   156 // -----------------------------------------------------------------------------
       
   157 //
       
   158 TInt CHgScrollBufferManager::RunError( TInt /*aError*/ )
       
   159     {
       
   160     return KErrNone;
       
   161     }
       
   162 
       
   163 // -----------------------------------------------------------------------------
       
   164 // CHgScrollBufferManager::SetPosition()
       
   165 // -----------------------------------------------------------------------------
       
   166 //
       
   167 void CHgScrollBufferManager::SetPosition( TInt aIndex )
       
   168     {
       
   169     TBool forceUpdate = EFalse;
       
   170     aIndex -= iBufferSize / 2; // normalize index to Buffer start
       
   171     
       
   172     if(aIndex < 0)
       
   173         {
       
   174         aIndex = 0;
       
   175         forceUpdate = ETrue;
       
   176         }
       
   177     else if( aIndex > iTotalCount - iBufferSize )
       
   178         {
       
   179         aIndex = iTotalCount - iBufferSize;
       
   180         forceUpdate = ETrue;
       
   181         }
       
   182     
       
   183     iDiff = iBufferPosition - aIndex; 
       
   184     
       
   185     // Too large change reset whole buffer
       
   186     if( iDiff >= iBufferSize || -iDiff >= iBufferSize || iResetOrdered ) 
       
   187         {
       
   188         ResetBuffer(aIndex + (iBufferSize/2), iTotalCount);
       
   189         }
       
   190     // Move Up
       
   191     else if( iDiff >= iBufferTreshold ) 
       
   192         {
       
   193         iRequestCount = iDiff;
       
   194         iReleaseCount = iDiff;
       
   195         NotifyObserver();
       
   196         }
       
   197     // Move Down
       
   198     else if( -iDiff >= iBufferTreshold ) 
       
   199         {
       
   200         iRequestCount = -iDiff;
       
   201         iReleaseCount = -iDiff;
       
   202         NotifyObserver();
       
   203         }
       
   204     // Top or bottom has been reached
       
   205     else if( forceUpdate && iDiff )
       
   206         {
       
   207         TInt diff = iDiff < 0 ? -iDiff : iDiff;
       
   208         iRequestCount = diff;
       
   209         iReleaseCount = diff;
       
   210         NotifyObserver();
       
   211         }
       
   212     }
       
   213 
       
   214 // -----------------------------------------------------------------------------
       
   215 // CHgScrollBufferManager::SetTotalCount()
       
   216 // -----------------------------------------------------------------------------
       
   217 //
       
   218 void CHgScrollBufferManager::SetTotalCount( TInt aTotalCount )
       
   219     {
       
   220     iTotalCount = aTotalCount;
       
   221     }
       
   222 
       
   223 // -----------------------------------------------------------------------------
       
   224 // CHgScrollBufferManager::SetBufferOwner()
       
   225 // -----------------------------------------------------------------------------
       
   226 //
       
   227 void CHgScrollBufferManager::SetBufferOwner( MHgBufferOwner& aOwner )
       
   228     {
       
   229     iOwner = &aOwner;
       
   230     }
       
   231 
       
   232 // -----------------------------------------------------------------------------
       
   233 // CHgScrollBufferManager::ResetBuffer()
       
   234 // -----------------------------------------------------------------------------
       
   235 //
       
   236 void CHgScrollBufferManager::ResetBuffer( TInt aPosition, TInt aTotalCount)
       
   237     {
       
   238     if( !iResetOrdered )
       
   239         {
       
   240         // release Old buffer
       
   241         iReleaseStart = iBufferPosition;
       
   242         iReleaseCount = iBufferSize;
       
   243         }
       
   244     
       
   245     // set position and count
       
   246     iBufferPosition = aPosition - (iBufferSize / 2);
       
   247     iTotalCount = aTotalCount;
       
   248     iDiff = 0;
       
   249     
       
   250     if( iBufferPosition + iBufferSize > iTotalCount - 1 )
       
   251         {
       
   252         iBufferPosition = iTotalCount - iBufferSize;
       
   253         }
       
   254     
       
   255     if(iBufferPosition < 0 )
       
   256         {
       
   257         iBufferPosition = 0;
       
   258         }
       
   259     
       
   260     //request new Buffer
       
   261     iRequestStart = iBufferPosition;
       
   262     iRequestCount = iBufferSize;
       
   263     iResetOrdered = ETrue;
       
   264     
       
   265     NotifyObserver();
       
   266     }
       
   267 
       
   268 // -----------------------------------------------------------------------------
       
   269 // CHgScrollBufferManager::NotifyObserver()
       
   270 // -----------------------------------------------------------------------------
       
   271 //
       
   272 void CHgScrollBufferManager::NotifyObserver()
       
   273     {
       
   274     if( !IsActive() )
       
   275         {
       
   276         SetActive();
       
   277         TRequestStatus* status = &iStatus;
       
   278         User::RequestComplete(status, KErrNone);
       
   279         }
       
   280     }
       
   281 
       
   282 // -----------------------------------------------------------------------------
       
   283 // CHgScrollBufferManager::ItemChanged()
       
   284 // -----------------------------------------------------------------------------
       
   285 //
       
   286 void CHgScrollBufferManager::ItemCountChanged( 
       
   287         TInt aIndex, 
       
   288         TBool aRemoved,
       
   289         TInt aNewTotalCount )
       
   290     {  
       
   291     iTotalCount = aNewTotalCount;
       
   292     if ( aIndex >= iBufferPosition && aIndex < iBufferPosition + iBufferSize )
       
   293         {
       
   294         // Change inside the buffer
       
   295         MHgScrollBufferObserver::THgScrollDirection direction = MHgScrollBufferObserver::EHgBufferNoMove;
       
   296         if( aRemoved )
       
   297             {
       
   298             // Release removed item ( Item deleted already from the owner )
       
   299             iObserver.Release( aIndex, aIndex );
       
   300             if( iTotalCount >= iBufferSize )
       
   301                 {
       
   302                 // There are more items to keep the buffer filled
       
   303                 if( iBufferPosition + iBufferSize <= iTotalCount )
       
   304                     {
       
   305                     // Requested from the end
       
   306                     iObserver.Request( iBufferPosition + iBufferSize - 1, 
       
   307                             iBufferPosition + iBufferSize - 1, direction );
       
   308                     }
       
   309                 else if( iBufferPosition > 0 )
       
   310                     {
       
   311                     // Move buffer and request from the beginning 
       
   312                     iBufferPosition--;
       
   313                     iObserver.Request( iBufferPosition, iBufferPosition, direction );
       
   314                     }
       
   315                 }
       
   316             }            
       
   317         else
       
   318             {
       
   319             if( iTotalCount > iBufferSize )
       
   320                 {
       
   321                 // One item needs to be released
       
   322                 if( iBufferPosition + iBufferSize < iTotalCount )
       
   323                     {
       
   324                     // Release from the end of the buffer
       
   325                     iObserver.Release(iBufferPosition + iBufferSize, iBufferPosition + iBufferSize);
       
   326                     if(iOwner)
       
   327                         iOwner->Release(iBufferPosition + iBufferSize, iBufferPosition + iBufferSize);
       
   328                     }
       
   329                 }
       
   330             // Request added item
       
   331             iObserver.Request(aIndex, aIndex, direction);
       
   332             }
       
   333         }
       
   334     }
       
   335