ILayoutMember Class Reference

Layout member. More...

#include <sdl_interface.h>

Inherits ISDKComponent.

Public Member Functions
virtual SDKResult SDK_CALLTYPE	Relayout (const sdk::gfx::RenderTargetSP &target)=0 throw ()
	Recalculates layout data for the specified render target. More...
virtual SDKResult SDK_CALLTYPE	AttachMember (IVisualObjectSP &vo, AnchorType anchor, float x_offset, float y_offset, ILayoutMemberSP &member)=0 throw ()
	Attaches a new member to the specified anchor. More...
virtual SDKResult SDK_CALLTYPE	GetVisualObject (IVisualObjectSP &vo)=0 throw ()
	Returns the corresponding visual object. More...
virtual SDKResult SDK_CALLTYPE	GetLayoutInfo (ILayoutInfoSP &info)=0 throw ()
	Returns the layout parameters. More...
virtual SDKResult SDK_CALLTYPE	GetOwner (IVisualObjectSP &owner)=0 throw ()
	Returns the nearest layout owner. More...
virtual SDKResult SDK_CALLTYPE	GetMembers (ILayoutMembersCollectionSP &members)=0 throw ()
	Returns members of the layout. More...

Detailed Description

Layout member.

Member Function Documentation

Relayout()

virtual SDKResult SDK_CALLTYPE Relayout ( const sdk::gfx::RenderTargetSP &  target ) throw ( )

pure virtual

Recalculates layout data for the specified render target.

Parameters

[in]

target

Render target interface.

Returns

kSDKResult_Succeeded if OK

kSDKResult_NotImplemented

AttachMember()

virtual SDKResult SDK_CALLTYPE AttachMember ( IVisualObjectSP &  vo, AnchorType  anchor, float  x_offset, float  y_offset, ILayoutMemberSP &  member  ) throw ( )

pure virtual

Attaches a new member to the specified anchor.

Parameters

[in]	vo	Visual object.
[in]	anchor	Layout anchor.
[in]	x_offset	Optional X-axes offset.
[in]	y_offset	Optional Y-axes offset.
[out]	member	Interface to the new layout member.

Returns

kSDKResult_Succeeded if OK

kSDKResult_NotImplemented

GetVisualObject()

virtual SDKResult SDK_CALLTYPE GetVisualObject ( IVisualObjectSP &  vo ) throw ( )

pure virtual

Returns the corresponding visual object.

Parameters

[out]

vo

Address of variable that receives the pointer to the visual object.

Returns

kSDKResult_Succeeded if OK

kSDKResult_NotImplemented

GetLayoutInfo()

virtual SDKResult SDK_CALLTYPE GetLayoutInfo ( ILayoutInfoSP &  info ) throw ( )

pure virtual

Returns the layout parameters.

Parameters

[out]

info

Layout parameters structure.

Returns

kSDKResult_Succeeded if OK

kSDKResult_NotImplemented

GetOwner()

virtual SDKResult SDK_CALLTYPE GetOwner ( IVisualObjectSP &  owner ) throw ( )

pure virtual

Returns the nearest layout owner.

Parameters

[out]

owner

Address of a variable that receives the pointer to the layout owner visual object.

Returns

Ok if succeeded.

Err_NotExist if there is no owner (root layout).

Err_NotImpl.

GetMembers()

virtual SDKResult SDK_CALLTYPE GetMembers ( ILayoutMembersCollectionSP &  members ) throw ( )

pure virtual

Returns members of the layout.

Parameters

[out]

members

Address of a variable that receives the pointer to the collection of layout members.

Returns

Ok if succeeded.

kSDKResult_EmptyValue if there is no layout members.

Err_NotImpl.

---

The documentation for this class was generated from the following file:

• sdl_interface.h