iWidgetButton Struct Reference

Inheritance diagram for iWidgetButton:

Detailed Description

Button widget interface.

Public Member Functions
virtual void	SetIcon (iOverlay *apIcon)=0
	Set the button's icon {Property}. More...
virtual iOverlay *	GetIcon () const =0
	Get the button's icon {Property}. More...
virtual void	SetIconPressed (iOverlay *apIcon)=0
	Set the button's icon in pressed state. {Property}. More...
virtual iOverlay *	GetIconPressed () const =0
	Get the button's icon in pressed state. {Property}. More...
virtual void	SetIconHover (iOverlay *apIcon)=0
	Set the button's icon in hover state. {Property}. More...
virtual iOverlay *	GetIconHover () const =0
	Get the button's icon in hover state. {Property}. More...
virtual void	SetIconSize (const sVec2f &avSize)=0
	Set the button's icon size. {Property}. More...
virtual sVec2f	GetIconSize () const =0
	Get the button's icon size. {Property}. More...
virtual void	SetCheck (tBool abCkecked)=0
	Set the button check status {Property}. More...
virtual tBool	GetCheck () const =0
	Get the button check status {Property}. More...
virtual tBool	SetGroupID (iHString *aVal)=0
	Set the button's group id. {Property}. More...
virtual iHString *	GetGroupID () const =0
	Get the button's group id. {Property}. More...
virtual void	SetIconMargin (const sVec4f &avMargin)=0
	Set the icon margin. {Property}. More...
virtual sVec4f	GetIconMargin () const =0
	Get the icon margin. {Property}. More...
virtual sRectf	GetIconDrawRect () const =0
	Get the icon's drawing rectangle, client rectangle relative. {Property}. More...
virtual void	SetDrawFrameFlags (tRectFrameFlags aFlags)=0
	Set the draw frame flags. {Property}. More...
virtual tRectFrameFlags	GetDrawFrameFlags () const =0
	Get the draw frame flags. {Property}. More...
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...
virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...
virtual tI32	Release ()=0
	Release a reference of the object. More...
virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...
virtual void	Invalidate ()=0
	Invalidate the object. More...
virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...
virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...
virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...
virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual void SetIcon ( iOverlay *  apIcon )

pure virtual

Set the button's icon {Property}.

virtual iOverlay* GetIcon ( ) const

pure virtual

Get the button's icon {Property}.

virtual void SetIconPressed ( iOverlay *  apIcon )

pure virtual

Set the button's icon in pressed state. {Property}.

virtual iOverlay* GetIconPressed ( ) const

pure virtual

Get the button's icon in pressed state. {Property}.

virtual void SetIconHover ( iOverlay *  apIcon )

pure virtual

Set the button's icon in hover state. {Property}.

virtual iOverlay* GetIconHover ( ) const

pure virtual

Get the button's icon in hover state. {Property}.

virtual void SetIconSize ( const sVec2f &  avSize )

pure virtual

Set the button's icon size. {Property}.

Remarks

If zero the size of the icon image is used.

virtual sVec2f GetIconSize ( ) const

pure virtual

Get the button's icon size. {Property}.

virtual void SetCheck ( tBool  abCkecked )

pure virtual

Set the button check status {Property}.

virtual tBool GetCheck ( ) const

pure virtual

Get the button check status {Property}.

virtual tBool SetGroupID ( iHString *  aVal )

pure virtual

Set the button's group id. {Property}.

virtual iHString* GetGroupID ( ) const

pure virtual

Get the button's group id. {Property}.

virtual void SetIconMargin ( const sVec4f &  avMargin )

pure virtual

Set the icon margin. {Property}.

Remarks

Default margin is Vec4(3,3,3,3)

virtual sVec4f GetIconMargin ( ) const

pure virtual

Get the icon margin. {Property}.

virtual sRectf GetIconDrawRect ( ) const

pure virtual

Get the icon's drawing rectangle, client rectangle relative. {Property}.

virtual void SetDrawFrameFlags ( tRectFrameFlags  aFlags )

pure virtual

Set the draw frame flags. {Property}.

virtual tRectFrameFlags GetDrawFrameFlags ( ) const

pure virtual

Get the draw frame flags. {Property}.