LBitmapWindow::SetAutoFloaterToRgn

#include "ltwrappr.h"

L_BOOL LBitmapWindow::SetAutoFloaterToRgn(bAutoFloaterToRgn=TRUE)

L_BOOL bAutoFloaterToRgn;

/* flag that indicates whether to automatically create a region */

Enables or disables the automatic creation of a bitmap region when using the TOOL_REGION tool.

Parameter

Description

bAutoFloaterToRgn

Flag that indicates whether to automatically create a region when using the TOOL_REGION. Possible values are:

 

Value

Meaning

 

TRUE

Enable the automatic creation of a region when creating floaters using the TOOL_REGION tool.

 

FALSE

Disable the automatic creation of a region when creating floaters using the TOOL_REGION tool.

Returns

The previous setting.

TRUE

The previous setting was TRUE.

FALSE

The previous setting was FALSE.

Comments

LbitmapWindow::SetToolType(TOOL_REGION) lets the user create a floater with the mouse. To create a bitmap region, in addition to the floater, call LbitmapWindow::SetAutoFloaterToRgn(TRUE). By default, a floater is created, but not a region.

Required DLLs and Libraries

LTKRN
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:

LBitmapWindow::SetAutoFloaterToRgn, LBitmapWindow::GetFloater, LBitmapWindow::HasFloater, LBitmapWindow::CancelRgn, LBitmapWindow::SetAutoRgnToFloater, LBitmapWindow::GetAutoRgnToFloater, Class Members

Topics:

Floaters and Regions in the LBitmapWindow Class

Example

For an example, refer to LBitmapWindow::GetAutoFloaterToRgn.