LBitmapWindow::GetAutoFloaterToRgn

#include "ltwrappr.h"

L_BOOL LBitmapWindow::GetAutoFloaterToRgn()

Returns a value that indicates whether the automatic creation of a bitmap region from a floater is currently enabled or disabled.

Returns

TRUE

The automatic creation of a region from a floater is currently enabled.

FALSE

The automatic creation of a region from a floater is currently disabled.

Comments

To enable or disable the automatic creation of a region from a floater, use LBitmapWindow::SetAutoFloaterToRgn.

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:

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

Topics:

Floaters and Regions in the LBitmapWindow Class

Example

L_INT LBitmapWindow__GetAutoFloaterToRgn(LBitmapWindow &BmpWnd)
{
   L_BOOL bOld;
   bOld = BmpWnd.GetAutoFloaterToRgn();
   CString strPrev = (bOld) ? TEXT("TRUE") : TEXT("FALSE");
   AfxMessageBox(TEXT("Previous AutoFloaterToRgn: ") + strPrev);
   //Enable automatic creation of region from floater
   BmpWnd.SetAutoFloaterToRgn(TRUE);
   //Set floater tool
   BmpWnd.SetToolType(TOOL_REGION);
   BmpWnd.SetRegionType(REGION_TYPE_RECT);
   //...Here you would drag the mouse to create a rectangular floater.
   //...When the floater is created, the region will also be created.
   return SUCCESS;
}