LAnimationWindow::EnablePlayWhileLoad

#include "ltwrappr.h"

L_BOOL LAnimationWindow::EnablePlayWhileLoad(bEnable=TRUE)

L_BOOL bEnable;

/* flag that indicates whether to enable the play while load feature */

Enables or disables the play while load feature.

Parameter

Description

bEnable

Flag that indicates whether to enable the play while load feature. Possible values are:

 

Value

Meaning

 

TRUE

Enable the play while load feature.

 

FALSE

Disable the play while load feature.

Returns

The previous state.

Comments

If play while load is enabled, an animation file will be played while it is being loaded. Each loaded page is displayed directly after it is loaded.

Required DLLs and Libraries

LTDIS
LTDLG
LTEFX
LTFIL
LTIMG
LTSCR
LTTWN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

LAnimationWindow::PlayWhileLoad, LAnimationWindow::LAnimationWindow, LFile::LoadFile, LAnimationWindow::Load, LAnimationWindow::SetBitmapList, LAnimationWindow::IsPlayWhileLoadEnabled, Class Members

Topics:

Implementing Animation

Example

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName
class MyClass : public LAnimationWindow
{
   public :
      virtual L_VOID AnimateEvent(L_INT nEvent,L_INT nFrameNumber)
      {
         switch (nEvent)
         {
            case EVENT_PLAYSTATE_WAITDELAY:
               if (GetRemainingDelay()>1)
                  break;
            case EVENT_PLAYSTATE_WAITINPUT :
               CancelWait();
               break;
         }
         //call base class
         LAnimationWindow::AnimateEvent(nEvent, nFrameNumber);
      }
};
L_INT LAnimationWindow_EnablePlayWhileLoadExample(HWND hWndParent)
{
   L_INT nRet;
   LBase::LoadLibraries(LT_ALL_LEADLIB); //make sure all libraries are loaded
   WRPUNLOCKSUPPORT(); //unlock GIF support
   MyClass MyAnimation;
   MyAnimation.SetFileName(MAKE_IMAGE_PATH(TEXT("image1.gif")));
   MyAnimation.CreateWnd(hWndParent,0, WS_VISIBLE|WS_CHILD|WS_BORDER,0,0,300,300);
   nRet = MyAnimation.EnableAnimateEvent(); 
   if(nRet != SUCCESS)
      return nRet;
 //Allow user to receive events
   //Enable play-while-load feature
   if (!MyAnimation.IsPlayWhileLoadEnabled())
   {
     nRet = MyAnimation.EnablePlayWhileLoad();
     if(nRet != SUCCESS)
        return nRet;
   }
   MyAnimation.EnableAutoErrorDisplay(TRUE);
   nRet = MyAnimation.Load();
   if (nRet!=SUCCESS)
   {
      return nRet;
   }
   MessageBox(hWndParent, TEXT("Finished loading..."),TEXT("Example"), MB_OK | MB_ICONINFORMATION);
   return SUCCESS;
}