InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IFormFieldUIFactory Class Referenceabstract

#include <IFormFieldUIFactory.h>

Inheritance diagram for IFormFieldUIFactory:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IFORMFIELDUIFACTORY }
 

Public Member Functions

virtual ActionID GetToolActionID () const =0
 
virtual WidgetID GetPropertiesWidget () const =0
 
virtual WidgetID ValidatePropertyFields (IPanelControlData *inPanelData)=0
 
virtual IControlViewCreatePanel () const =0
 
virtual void InitializePropertyFields (IPanelControlData *inPanelData, IGraphicAttributeSuite *inGraphicAttrSuite)=0
 
virtual void GetPropertyAttributes (IPanelControlData *inPanelData, IGraphicStyleAttributeBossList *ioProperties)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Add-in interface for Form Field Factory that provides ui utility functions for a form field type

Member Function Documentation

virtual IControlView* IFormFieldUIFactory::CreatePanel () const
pure virtual
Returns
a subpanel that contains controls that can be used to edit this form field type
virtual WidgetID IFormFieldUIFactory::GetPropertiesWidget () const
pure virtual
Returns
The widget id of panel that contains controls for field properties for this form field type
virtual void IFormFieldUIFactory::GetPropertyAttributes (IPanelControlDatainPanelData,
IGraphicStyleAttributeBossListioProperties 
)
pure virtual

Save attribute values to inGraphicAttrSuite, based on control values in inPanelData

Parameters
inPanelDatapaneldata from main panel of Form Field Properties dialog
ioPropertiesan attribute list to populate
virtual ActionID IFormFieldUIFactory::GetToolActionID () const
pure virtual
Returns
a tool action id that corresponds to this form field type. For example PushButtonUIFactory returns kPushButtonToolActionID
virtual void IFormFieldUIFactory::InitializePropertyFields (IPanelControlDatainPanelData,
IGraphicAttributeSuiteinGraphicAttrSuite 
)
pure virtual

Initialize controls in inPanelData based on form field attribute values in inGraphicAttrSuite

Parameters
inPanelDatapaneldata from main panel of Form Field Properties dialog
inGraphicAttrSuitegraphic attributes for the current selection.
virtual WidgetID IFormFieldUIFactory::ValidatePropertyFields (IPanelControlDatainPanelData)
pure virtual

Do any validation of field-specific properties, return any invalid widget.

Parameters
inPanelDatapaneldata from main panel of Form Field Properties dialog
Returns
any widget that contains an invalid value