ICreateFormFieldCmdData Class Reference

#include <ICreateFormFieldCmdData.h>

Inheritance diagram for ICreateFormFieldCmdData:

Public Types
enum	{ kDefaultIID = IID_ICREATEFORMFIELDCMDDATA }

Public Member Functions
virtual void	SetFormPageItemType (ClassID inFormType)=0
virtual void	SetFormRect (const PMRect &inRect)=0
virtual void	SetIconList (const UIDList &inIconList)=0
virtual void	SetParent (const UIDRef &inParent)=0
virtual ClassID	GetFormPageItemType () const =0
virtual PMRect	GetFormRect () const =0
virtual void	GetIconList (UIDList *outIconList)=0
virtual UIDRef	GetParent () const =0
virtual IDataBase *	GetDataBase () const =0
virtual bool16	GetUseIcons () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Command parameters for the CreateFormField command

Member Function Documentation

virtual IDataBase* ICreateFormFieldCmdData::GetDataBase ( ) const

pure virtual

Get destination database for new form field

Returns

the form fields database

virtual ClassID ICreateFormFieldCmdData::GetFormPageItemType ( ) const

pure virtual

Get the form field type to create

Returns

inFormType Boss of form field to create e.g. kPushButtonItemBoss

virtual PMRect ICreateFormFieldCmdData::GetFormRect ( ) const

pure virtual

Get the dimensions form field type to create

Returns

inFormType Boss of form field to create e.g. kPushButtonItemBoss

virtual void ICreateFormFieldCmdData::GetIconList ( UIDList *  outIconList )

pure virtual

Returns

A list of page items to be moved inside of the newly created form.

virtual UIDRef ICreateFormFieldCmdData::GetParent ( ) const

pure virtual

Get page item destination for new form field

Returns

UIDRef of the form fields parent

virtual bool16 ICreateFormFieldCmdData::GetUseIcons ( ) const

pure virtual

Returns

kTrue if the form field has icons (i.e. page items to be placed in the new form field)

virtual void ICreateFormFieldCmdData::SetFormPageItemType ( ClassID  inFormType )

pure virtual

Set the form field type to create

Parameters

inFormType

Boss of form field to create e.g. kPushButtonItemBoss

virtual void ICreateFormFieldCmdData::SetFormRect ( const PMRect &  inRect )

pure virtual

Set dimensions of form field

virtual void ICreateFormFieldCmdData::SetIconList ( const UIDList &  inIconList )

pure virtual

A list of page items to be moved inside of the newly created form. Used to "Create Button" from non-form field page items

virtual void ICreateFormFieldCmdData::SetParent ( const UIDRef &  inParent )

pure virtual

Set page item desination for new form field

Parameters

inParent

The form field will be created as a child of this page item.