Navigation:  thinBasic Modules > UI (User Interface) > Windows >

Win_Animate

Previous pageReturn to chapter overviewNext page

 

Description

 

Produce special effects when showing or hiding windows.

There are four types of animation: roll, slide, collapse or expand, and alpha-blended fade.

 

Syntax

 

n = Win_Animate(hWnd, dwTime, dwFlags)

 

Returns

 

Number. If the function succeeds, the return value is nonzero.

 

Parameters

 

Name

Type

Optional

Meaning

hWnd

Number

No

Handle to the window to animate. The calling thread must own this window.

dwTime

Number

No

Specifies how long it takes to play the animation, in milliseconds. Typically, an animation takes 200 milliseconds to play.

dwFlags

Number

No

Specifies the type of animation. This parameter can be one or more of the following values. Note that, by default, these flags take effect when showing a window. To take effect when hiding a window, use %AW_HIDE and a logical OR operator with the appropriate flags.

%AW_SLIDEUses slide animation. By default, roll animation is used. This flag is ignored when used with %AW_CENTER.
%AW_ACTIVATEActivates the window. Do not use this value with %AW_HIDE.
%AW_BLENDUses a fade effect. This flag can be used only if hwnd is a top-level window.
%AW_HIDEHides the window. By default, the window is shown.
%AW_CENTERMakes the window appear to collapse inward if %AW_HIDE is used or expand outward if the %AW_HIDE is not used. The various direction flags have no effect.
%AW_HOR_POSITIVEAnimates the window from left to right. This flag can be used with roll or slide animation. It is ignored when used with %AW_CENTER or %AW_BLEND.
%AW_HOR_NEGATIVEAnimates the window from right to left. This flag can be used with roll or slide animation. It is ignored when used with %AW_CENTER or %AW_BLEND.
%AW_VER_POSITIVEAnimates the window from top to bottom. This flag can be used with roll or slide animation. It is ignored when used with %AW_CENTER or %AW_BLEND.
%AW_VER_NEGATIVEAnimates the window from bottom to top. This flag can be used with roll or slide animation. It is ignored when used with %AW_CENTER or %AW_BLEND.

 

Remarks

 

For additional info, please refer to MS documentation at: http://msdn.microsoft.com/en-us/library/ms632669(VS.85).aspx

 

Restrictions

 

See also

 

Examples