IFormFieldSuite Class Reference

#include <IFormFieldSuite.h>

Inheritance diagram for IFormFieldSuite:

Public Types
enum	{ kDefaultIID = IID_IFORMFIELDSUITE }

Public Member Functions
virtual bool16	IsFieldSelection () const =0
virtual bool16	IsFieldSelectionOfType (ClassID inFormFieldType) const =0
virtual bool16	IsMixedSelection () const =0
virtual bool16	IsDefaultSelection () const =0
virtual IFormFieldFactory *	QueryFormFieldFactory () const =0
virtual bool16	CanEditFieldSelection () const =0
virtual bool16	CanCreateFieldFromSelection (ClassID inFormFieldType) const =0
virtual ErrorCode	CreateFieldFromSelection (ClassID inFormFieldType)=0
virtual bool16	CanDestroyFieldFromSelection (bool16 &outWarnNonEmptyStates) const =0
virtual ErrorCode	DestroyFieldFromSelection (ClassID formFieldToConvert=kInvalidClass)=0
virtual bool16	SelectionHasAnyFormFields () const =0
virtual bool16	SelectionHasAnyFieldsOfType (ClassID inFieldType) const =0
virtual bool16	GetIsInitiallyHidden (bool16 &isMixed) const =0
virtual bool16	GetIsPrintable (bool16 &isMixed) const =0
virtual bool16	GetIsReadOnly (bool16 &isMixed) const =0
virtual bool16	GetIsRequired (bool16 &isMixed) const =0
virtual bool16	GetIsSelectedByDefault (bool16 &isMixed) const =0
virtual bool16	GetIsMultiLineTextField (bool16 &isMixed) const =0
virtual bool16	GetIsPasswordTextField (bool16 &isMixed) const =0
virtual bool16	GetIsScrollableTextField (bool16 &isMixed) const =0
virtual ErrorCode	GetFormFieldDescription (PMString &description) const =0
virtual ErrorCode	SetIsInitiallyHidden (bool16 inHidden) const =0
virtual ErrorCode	SetIsPrintable (bool16 isPrintable) const =0
virtual ErrorCode	SetIsReadOnly (bool16 isReadOnly) const =0
virtual ErrorCode	SetIsRequired (bool16 isRequired) const =0
virtual ErrorCode	SetIsSelectedByDefault (bool16 isSelectedByDefault) const =0
virtual ErrorCode	SetIsTextFieldMultiline (bool16 isMultiLine) const =0
virtual ErrorCode	SetIsTextFieldPasswordField (bool16 isPasswordField) const =0
virtual ErrorCode	SetIsTextFieldScrollable (bool16 isScrollable) const =0
virtual ErrorCode	SetFormFieldDescription (const PMString &description) const =0
virtual ErrorCode	GetChoiceList (Form::ChoiceList &choices) const =0
virtual ErrorCode	AddChoice (const PMString &choice) const =0
virtual ErrorCode	RemoveChoice (const PMString &choice) const =0
virtual ErrorCode	SetIsMultipleSelectionEnabled (bool16 isMultipleSelectionEnabled) const =0
virtual bool16	GetIsMultipleSelectionEnabled (bool16 &isMixed) const =0
virtual ErrorCode	MoveChoice (const PMString &choice, int32 pos) const =0
virtual ErrorCode	SetTextSizeAttribute (const PMReal &FontSize) const =0
virtual bool16	GetTextSizeAttribute (PMReal &FontSize) const =0
virtual bool16	GetShouldSortListItems (bool16 &isMixed) const =0
virtual ErrorCode	SetShouldSortListItems (bool16 isSorted) const =0
virtual bool16	GetIsMERTLEnabled (bool16 &isMixed) const =0
virtual ErrorCode	SetIsMERTLEnabled (bool16 isMERTLEnabled) const =0
virtual bool16	GetDefaultChoice (PMString &choice, int32 &index) const =0
virtual ErrorCode	SetDefaultChoice (const PMString &choice) const =0
virtual ErrorCode	GetExportValue (PMString &exportValue) const =0
virtual ErrorCode	SetExportValue (const PMString &exportValue) const =0
virtual ErrorCode	SetFontFamilyAttr (const PMString &fontFamilyName) const =0
virtual bool16	GetFontFamilyAttribute (PMString &fontFamilyName) const =0
virtual ErrorCode	SetFontFamilyUIDAttr (const PMString &fontFamilyName, const PMString &fontStyleName) const =0
virtual bool16	GetFontFamilyUIDAttr (UID &FontUID) const =0
virtual ErrorCode	SetFontStyleAttribute (const PMString &fontStyleName) const =0
virtual bool16	GetFontStyleAttribute (PMString &fontStyleName) 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

Selection suite for manipulating form field page items  and attributes.

See Also

IAppearanceList

Member Function Documentation

virtual ErrorCode IFormFieldSuite::AddChoice ( const PMString &  choice ) const

pure virtual

Add a choice to the list of choices for the selected combo/list box.    

Returns

kSuccess if no error occurs while adding the choice for the selected list/combo box.

virtual bool16 IFormFieldSuite::CanCreateFieldFromSelection ( ClassID  inFormFieldType ) const

pure virtual

Returns

kTrue if the required form field type can be created from the selection.

Parameters

inFormFieldType

Type of form field to create (e.g. kPushButtonItemBoss)

virtual bool16 IFormFieldSuite::CanDestroyFieldFromSelection ( bool16 &  outWarnNonEmptyStates ) const

pure virtual

Returns

kTrue if selection is a form field(s) that can be destroyed, i.e. converted to object.

Parameters

outWarnNonEmptyStates

set true if there are states that are not empty that would be lost by destroying the field

virtual bool16 IFormFieldSuite::CanEditFieldSelection ( ) const

pure virtual

Returns

kTrue if selection is a Form Field selection that can be changed

virtual ErrorCode IFormFieldSuite::CreateFieldFromSelection ( ClassID  inFormFieldType )

pure virtual

Place selection inside a new form field

Parameters

inFormFieldType

Type of form field to create (e.g. kPushButtonItemBoss)

virtual ErrorCode IFormFieldSuite::DestroyFieldFromSelection ( ClassID  formFieldToConvert = kInvalidClass )

pure virtual

Destroy the selected form fields, i.e. convert the fields back to objects.

Returns

kTrue if the fields in selection converted to object successfully

Parameters

formFieldToConvert,if

this is invoked in the course of converting some form fields to another type, then this parameter would be the destination form field type

virtual ErrorCode IFormFieldSuite::GetChoiceList ( Form::ChoiceList &  choices ) const

pure virtual

Get the list of choices for the selected combo/list box.    

Returns

kSuccess if no error occurs while getting the list of choices for the selected list/combo box.

virtual bool16 IFormFieldSuite::GetDefaultChoice ( PMString &  choice, int32 &  index  ) const

pure virtual

Get the default option for the list box/combo box.

Returns

kTrue if a default choice had been specified for the list/combo box. choice is the string which has the default choice if any default choice had been set. index is the index of the default choice. If no default choice had been set, this will be set to -1.

virtual ErrorCode IFormFieldSuite::GetExportValue ( PMString &  exportValue ) const

pure virtual

Get the export value for all the selected radios and checks. 

Returns

kSuccess if no error occurred while getting export value for the the selected radios and checks.

virtual ErrorCode IFormFieldSuite::GetFormFieldDescription ( PMString &  description ) const

pure virtual

Get the description for all the selected form fields. 

Returns

kSuccess if no error occurred while getting description for the form fields

virtual bool16 IFormFieldSuite::GetIsInitiallyHidden ( bool16 &  isMixed ) const

pure virtual

Returns

kTrue if all the fields in the selection have their hidden until triggered flag set isMixed indicates whether for the selection, hidden until triggered flag has a mixed value

virtual bool16 IFormFieldSuite::GetIsMERTLEnabled ( bool16 &  isMixed ) const

pure virtual

Returns

kTrue if all the list/combo/text fields in the selection have ME right to left flag set isMixed indicates whether for the selection, the ME right to left flag has a mixed value

virtual bool16 IFormFieldSuite::GetIsMultiLineTextField ( bool16 &  isMixed ) const

pure virtual

Returns

kTrue if all the text fields in the selection have their multiline flag set isMixed indicates whether for the selection, multiline flag has a mixed value

virtual bool16 IFormFieldSuite::GetIsMultipleSelectionEnabled ( bool16 &  isMixed ) const

pure virtual

Returns

kTrue if all the list/combo fields in the selection have their multiple selection flag set isMixed indicates whether for the selection, the sort flag has a mixed value

virtual bool16 IFormFieldSuite::GetIsPasswordTextField ( bool16 &  isMixed ) const

pure virtual

Returns

kTrue if all the text fields in the selection have their password flag set isMixed indicates whether for the selection, password flag has a mixed value

virtual bool16 IFormFieldSuite::GetIsPrintable ( bool16 &  isMixed ) const

pure virtual

Returns

kTrue if all the fields in the selection have their printable flag set isMixed indicates whether for the selection, printable flag has a mixed value

virtual bool16 IFormFieldSuite::GetIsReadOnly ( bool16 &  isMixed ) const

pure virtual

Returns

kTrue if all the fields in the selection have their readonly flag set isMixed indicates whether for the selection, readonly flag has a mixed value

virtual bool16 IFormFieldSuite::GetIsRequired ( bool16 &  isMixed ) const

pure virtual

Returns

kTrue if all the fields in the selection have their required flag set isMixed indicates whether for the selection, required flag has a mixed value

virtual bool16 IFormFieldSuite::GetIsScrollableTextField ( bool16 &  isMixed ) const

pure virtual

Returns

kTrue if all the text fields in the selection have their scrollable flag set isMixed indicates whether for the selection, scrollable flag has a mixed value

virtual bool16 IFormFieldSuite::GetIsSelectedByDefault ( bool16 &  isMixed ) const

pure virtual

Returns

kTrue if all the check boxes and radio buttons in the selection have their selected by default flag set isMixed indicates whether for the selection, selected by default flag has a mixed value

virtual bool16 IFormFieldSuite::GetShouldSortListItems ( bool16 &  isMixed ) const

pure virtual

Returns

kTrue if all the list/combo fields in the selection have their multiple selection flag set isMixed indicates whether for the selection, the sort flag has a mixed value

virtual bool16 IFormFieldSuite::GetTextSizeAttribute ( PMReal &  FontSize ) const

pure virtual

Get the Font Size attribute for all the selected fields. 

Returns

kTrue if the font size is same for all fields.

virtual bool16 IFormFieldSuite::IsDefaultSelection ( ) const

pure virtual

Returns

kTrue if Form Field selection is a default pseudo form field item

virtual bool16 IFormFieldSuite::IsFieldSelection ( ) const

pure virtual

Returns

kTrue if selection is all form fields (or default selection)

virtual bool16 IFormFieldSuite::IsFieldSelectionOfType ( ClassID  inFormFieldType ) const

pure virtual

Returns

kTrue if selection is all form fields (or default selection)

Parameters

inFormFieldType

Type of form field to create (e.g. kPushButtonItemBoss)

virtual bool16 IFormFieldSuite::IsMixedSelection ( ) const

pure virtual

Returns

kTrue if Form Field selection is mixed (not a single type of field)

virtual ErrorCode IFormFieldSuite::MoveChoice ( const PMString &  choice, int32  pos  ) const

pure virtual

Move the currently selected option to position specified by pos in the combo/list box options.

virtual IFormFieldFactory* IFormFieldSuite::QueryFormFieldFactory ( ) const

pure virtual

Get a factory compatible with the selection. returns 0 for default selection, or a mixed selection. You can query based on currently selected tool with FormFieldUIUtils...

virtual ErrorCode IFormFieldSuite::RemoveChoice ( const PMString &  choice ) const

pure virtual

Remove a choice from the list of choices for the selected combo/list box.   

Returns

kSuccess if no error occurs while removing the choice from the list of choices for the selected list/combo box.

virtual bool16 IFormFieldSuite::SelectionHasAnyFieldsOfType ( ClassID  inFieldType ) const

pure virtual

Returns

kTrue if the selection has any fields of the type indicated by field type.

virtual bool16 IFormFieldSuite::SelectionHasAnyFormFields ( ) const

pure virtual

Returns

kTrue if the selection has any form fields

virtual ErrorCode IFormFieldSuite::SetDefaultChoice ( const PMString &  choice ) const

pure virtual

Set the default option for the list box/combo box.

Returns

kSuccess if the flag is set successfully for all the fields. choice is the default choice to be set.

virtual ErrorCode IFormFieldSuite::SetExportValue ( const PMString &  exportValue ) const

pure virtual

Set the export value for all the selected radios and checks. 

Returns

kSuccess if no error occurred while setting export value for the the selected radios and checks.

virtual ErrorCode IFormFieldSuite::SetFormFieldDescription ( const PMString &  description ) const

pure virtual

Set the description for all the selected form fields.

Returns

kSuccess if the description is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetIsInitiallyHidden ( bool16  inHidden ) const

pure virtual

Set the hidden until triggered flag for all the selected form fields.

Returns

kSuccess if the flag is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetIsMERTLEnabled ( bool16  isMERTLEnabled ) const

pure virtual

Set the ME right to left flag for all the selected list/combo/text fields.

Returns

kSuccess if the flag is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetIsMultipleSelectionEnabled ( bool16  isMultipleSelectionEnabled ) const

pure virtual

Set the multiple selection flag for all the selected Combo boxes/list fields.

Returns

kSuccess if the flag is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetIsPrintable ( bool16  isPrintable ) const

pure virtual

Set the printable flag for all the selected form fields.

Returns

kSuccess if the flag is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetIsReadOnly ( bool16  isReadOnly ) const

pure virtual

Set the readonly flag for all the selected form fields.

Returns

kSuccess if the flag is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetIsRequired ( bool16  isRequired ) const

pure virtual

Set the required flag for all the selected form fields.

Returns

kSuccess if the flag is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetIsSelectedByDefault ( bool16  isSelectedByDefault ) const

pure virtual

Set the selected by default flag for the selected radio buttons or check boxes.

Returns

kSuccess if the flag is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetIsTextFieldMultiline ( bool16  isMultiLine ) const

pure virtual

Set the multiline flag for all the selected text fields.

Returns

kSuccess if the flag is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetIsTextFieldPasswordField ( bool16  isPasswordField ) const

pure virtual

Set the password flag for all the selected text fields.

Returns

kSuccess if the flag is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetIsTextFieldScrollable ( bool16  isScrollable ) const

pure virtual

Set the scrollable flag for all the selected text fields.

Returns

kSuccess if the flag is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetShouldSortListItems ( bool16  isSorted ) const

pure virtual

Set the sorted flag for all the selected text fields.

Returns

kSuccess if the flag is set successfully for all the fields.

virtual ErrorCode IFormFieldSuite::SetTextSizeAttribute ( const PMReal &  FontSize ) const

pure virtual

Set the font size for the text in text field, list box, combo box.