FBAddRegionParam Class Reference

This class provide a placeholder to put values necessary to create a Region with FBLayout.AddRegion. More...

#include <pyfbsdk.h>

Public Member Functions
	FBAddRegionParam (int pPos, FBAttachType pType, char *pRelative, float pMult=1.0f)
	Initialize a region params.

Public Attributes
FBPropertyInt	mPos
	Read Property: Offset in pixel according depending on the use of FBAddRegionParam (X, Y, W or H).
FBAttachType	mType
	Read Property: Type of Attachment.
str	mRelative
	Read Property: Name of Region to attach relative to.
FBPropertyFloat	mMult
	Read Property: Multiplier of relative value.

Detailed Description

This class provide a placeholder to put values necessary to create a Region with FBLayout.AddRegion.

Each region components: X, Y, Width and Height needs its own FBAddRegionParam. ex: x = FBAddRegionParam(0,FBAttachType.kFBAttachLeft,"") y = FBAddRegionParam(0,FBAttachType.kFBAttachTop,"") w = FBAddRegionParam(0,FBAttachType.kFBAttachRight,"") h = FBAddRegionParam(25,FBAttachType.kFBAttachNone,"") mainLyt.AddRegion("main","main", x, y, w, h)

Constructor & Destructor Documentation

FBAddRegionParam()

FBAddRegionParam	(	int	pPos,
		FBAttachType	pType,
		char *	pRelative,
		float	pMult = 1.0f
	)

Initialize a region params.

Parameters

pPos	Offset in pixel according depending on the use of FBAddRegionParam (X, Y, W or H)
pType	Type of Attachment.
pRelative	Name of Region to attach relative to.
pMult	Multiplier of relative value.

Member Data Documentation

mMult

FBPropertyFloat mMult

Read Property: Multiplier of relative value.

mPos

FBPropertyInt mPos

Read Property: Offset in pixel according depending on the use of FBAddRegionParam (X, Y, W or H).

mRelative

str mRelative

Read Property: Name of Region to attach relative to.

mType

FBAttachType mType

Read Property: Type of Attachment.