iWidgetForm Struct Reference

Inheritance diagram for iWidgetForm:

Detailed Description

Form widget interface.

Remarks

Form widgets implements iWidgetDockable.

Public Member Functions
virtual tBool	SetTitle (const achar *aVal)=0
	Set the form's title. {Property}. More...
virtual const achar *	GetTitle () const =0
	Get the form's title. {Property}. More...
virtual tBool	SetResizeBorderArea (tF32 aVal)=0
	Set the size/area of the resize border. {Property}. More...
virtual tF32	GetResizeBorderArea () const =0
	Get the size/area of the resize border. {Property}. More...
virtual tU32	GetNumTitleWidgets () const =0
	Get the number of widgets in the title bar. {Property}. More...
virtual iWidget *	GetTitleWidget (tU32 anIndex) const =0
	Get the title bar widget at the specified index. {Property}. More...
virtual tU32	GetTitleWidgetIndex (iWidget *apWidget) const =0
	Get the index of the specified title bar widget. {Property}. More...
virtual iWidget *	GetTitleWidgetFromID (iHString *ahspID) const =0
	Get the title bar widget with the specified ID. {Property}. More...
virtual tBool	AddTitleWidget (iWidget *apWidget, tF32 afWidth)=0
	Add a title bar widget. More...
virtual void	SetFormFrameFlags (tRectFrameFlags aFlags)=0
	Set the border frame flags. {Property}. More...
virtual tRectFrameFlags	GetFormFrameFlags () const =0
	Get the form 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 tBool SetTitle ( const achar *  aVal )

pure virtual

Set the form's title. {Property}.

virtual const achar* GetTitle ( ) const

pure virtual

Get the form's title. {Property}.

virtual tBool SetResizeBorderArea ( tF32  aVal )

pure virtual

Set the size/area of the resize border. {Property}.

virtual tF32 GetResizeBorderArea ( ) const

pure virtual

Get the size/area of the resize border. {Property}.

virtual tU32 GetNumTitleWidgets ( ) const

pure virtual

Get the number of widgets in the title bar. {Property}.

virtual iWidget* GetTitleWidget ( tU32  anIndex ) const

pure virtual

Get the title bar widget at the specified index. {Property}.

virtual tU32 GetTitleWidgetIndex ( iWidget *  apWidget ) const

pure virtual

Get the index of the specified title bar widget. {Property}.

virtual iWidget* GetTitleWidgetFromID ( iHString *  ahspID ) const

pure virtual

Get the title bar widget with the specified ID. {Property}.

virtual tBool AddTitleWidget ( iWidget *  apWidget, tF32  afWidth  )

pure virtual

Add a title bar widget.

Remarks

The widget's parent is always set to the form's 'title dock area'.

virtual void SetFormFrameFlags ( tRectFrameFlags  aFlags )

pure virtual

Set the border frame flags. {Property}.

virtual tRectFrameFlags GetFormFrameFlags ( ) const

pure virtual

Get the form frame flags. {Property}.