InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CXMLImportOptionsServiceProvider Class Reference
Inheritance diagram for CXMLImportOptionsServiceProvider:
CPMUnknown< IXMLImportOptionsService >IXMLImportOptionsServiceIPMUnknown

Public Member Functions

 CXMLImportOptionsServiceProvider (IPMUnknown *boss)
 
virtual void Initialize (IDocument *doc)
 
virtual K2Vector< int32 > WarnOfChange (IXMLImportOptionsService *changedService, IControlView *controlView, int32 which)
 
virtual void CommitChanges ()
 
virtual PMString GetGroupName () const
 
virtual int32 GetUIElementsCount () const
 
virtual bool16 IsNthElementEnabled (int32 n) const
 
virtual
IXMLImportOptionsService::kUIElementType 		GetNthElementType (int32 n) const
 
virtual PMString GetNthElementName (int32 n) const
 
virtual bool16 GetNthElementBoolValue (int32 n) const
 
virtual void SetNthElementBoolValue (int32 n, bool16 newValue)
 
virtual int32 GetNthElementIntValue (int32 n) const
 
virtual void SetNthElementIntValue (int32 n, int32 selected)
 
virtual IDFile GetNthElementFileName (int32 n) const
 
virtual void SetNthElementFileName (int32 n, IDFile fileName)
 
virtual PMString GetNthElementDefaultText (int32 n) const
 
virtual void GetNthFileTypeInfo (int32 n, PMString &typeName, PMString &extension) const
 
virtual bool16 ShouldIndentNthControl (int32 n) const
 
virtual void GetNthElementPopupValueList (int32 n, K2Vector< PMString > &valueList) const
 
- Public Member Functions inherited from CPMUnknown< IXMLImportOptionsService >
IPMUnknown * QueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknown & operator= (const CPMUnknown &)=delete
 

Protected Member Functions

void AddCheckbox (const PMString &name, bool16 enabled, bool16 state, bool16 indent=kFalse)
 
void AddPopup (const PMString &name, const K2Vector< PMString > &values, bool16 enabled, int32 selection, bool16 indent=kFalse)
 
void AddRadioGroup (const PMString &name, const K2Vector< PMString > &values, bool16 enabled, int32 selection, bool16 indent=kFalse)
 
void AddFileName (const PMString name, const IDFile &fileName, const PMString &defaultText, const PMString &fileTypeFamily, const PMString &fileTypeExtension, bool16 enabled, bool16 state, bool16 indent)
 
void ClearData ()
 
- Protected Member Functions inherited from CPMUnknown< IXMLImportOptionsService >
 CPMUnknown (IPMUnknown *boss)
 

Protected Attributes

K2Vector< StoredValuePair > fStoredValue
 
K2Vector< bool16 > fStoredEnableState
 
K2Vector< IDFile > fStoredFileName
 
K2Vector< PMString > fStoredDefaultText
 
K2Vector< FileTypeData > fStoredFileType
 
K2Vector< int32 > fStoredType
 
PMString fGroupName
 
int32 fUIElementCount
 
K2Vector< PMString > fElementName
 
K2Vector< K2Vector< PMString > > fValueList
 
K2Vector< bool16 > fIndented
 
- Protected Attributes inherited from CPMUnknown< IXMLImportOptionsService >
HelperInterface fHelperInterface
 

Additional Inherited Members

- Public Types inherited from IXMLImportOptionsService
enum  { kDefaultIID = IID_IIXMLIMPORTOPTIONSSERVICE }
 
enum  kUIElementType { kCheckbox, kPopup, kRadioGroup, kFileName }
 

Member Function Documentation

virtual void CXMLImportOptionsServiceProvider::CommitChanges ()
virtual

Commit the changes that have been stored while the dialog was open.

Implements IXMLImportOptionsService.

virtual PMString CXMLImportOptionsServiceProvider::GetGroupName () const
inlinevirtual

Get the name of the group box for this list of options. A group box will not be added if the name is an empty string

Returns
- the name of the import options group

Implements IXMLImportOptionsService.

virtual bool16 CXMLImportOptionsServiceProvider::GetNthElementBoolValue (int32 n) const
inlinevirtual

Get the value of the Nth element

Parameters
n- The item you want information about
Returns
- The default value for this UI element (kFalse if the element is not a checkbox)

Implements IXMLImportOptionsService.

virtual PMString CXMLImportOptionsServiceProvider::GetNthElementDefaultText (int32 n) const
inlinevirtual

Get the default text to use when a text edit box is empty.

NOTE: This is only used for filename elements right now

Parameters
n- The item you want information about
Returns
- The text to use by default.

Implements IXMLImportOptionsService.

virtual IDFile CXMLImportOptionsServiceProvider::GetNthElementFileName (int32 n) const
inlinevirtual

Get the filename to use by default in the filename widget.

NOTE: This is only used for filename elements

Parameters
n- The item you want information about
Returns
- The fileName to use by default (Empty file if this is not a file name, or client wants nothing by default)

Implements IXMLImportOptionsService.

virtual int32 CXMLImportOptionsServiceProvider::GetNthElementIntValue (int32 n) const
inlinevirtual

Get the item to select in the popup or radio group.

NOTE: This is only used for popup or radio group elements

Parameters
n- The item you want information about
Returns
- The item to be selected by default (-1 if this is not a popup)

Implements IXMLImportOptionsService.

virtual PMString CXMLImportOptionsServiceProvider::GetNthElementName (int32 n) const
inlinevirtual

Get the name of the Nth element

Parameters
n- The item you want information about
Returns
- The name of the element that should appear in the dialog

Implements IXMLImportOptionsService.

virtual void CXMLImportOptionsServiceProvider::GetNthElementPopupValueList (int32 n,
K2Vector< PMString > & valueList 
) const
inlinevirtual

Get the list of items in the popup.

NOTE: This is only used for popup elements

Parameters
n- The item you want information about
valueList- Filled with all of the items in the popup

Implements IXMLImportOptionsService.

virtual IXMLImportOptionsService::kUIElementType CXMLImportOptionsServiceProvider::GetNthElementType (int32 n) const
inlinevirtual

Get the type of the Nth element

Parameters
n- The item you want information about
Returns
- The type of the element

Implements IXMLImportOptionsService.

virtual void CXMLImportOptionsServiceProvider::GetNthFileTypeInfo (int32 n,
PMString & typeName,
PMString & extension 
) const
inlinevirtual

Get the file type information for file elements.

NOTE: This is only used for filename elements right now

Parameters
n- The item you want information about
typeName- The name to display for this file type
extension- The extension that type file box should expect

Implements IXMLImportOptionsService.

virtual int32 CXMLImportOptionsServiceProvider::GetUIElementsCount () const
inlinevirtual

Get the number of UI elements that this Service Provider supports

Returns
- the number of elements supported

Implements IXMLImportOptionsService.

virtual void CXMLImportOptionsServiceProvider::Initialize (IDocument * doc)
virtual

Use this to initialze the state of each of the controls This simply makes it easier and faster to retrieve info about various controls while the dialog is running

Parameters
doc- The document we are initializing the options for. This is important because different docs can have different default options

Implements IXMLImportOptionsService.

virtual bool16 CXMLImportOptionsServiceProvider::IsNthElementEnabled (int32 n) const
inlinevirtual

Get the enabled state of the Nth element

Parameters
n- The item you want information about
Returns
- 'kTrue' element should be enabled

Implements IXMLImportOptionsService.

virtual void CXMLImportOptionsServiceProvider::SetNthElementBoolValue (int32 n,
bool16 newValue 
)
inlinevirtual

Get the value of the Nth element

Parameters
n- The item you want information about
newValue- The new value for this UI element

Implements IXMLImportOptionsService.

virtual void CXMLImportOptionsServiceProvider::SetNthElementFileName (int32 n,
IDFile fileName 
)
inlinevirtual

Set the filename to use by default in the filename widget.

NOTE: This is only used for filename elements

Parameters
n- The item you want information about
selected- The filename that is in the widget

Implements IXMLImportOptionsService.

virtual void CXMLImportOptionsServiceProvider::SetNthElementIntValue (int32 n,
int32 selected 
)
inlinevirtual

Set the item that the user selected in the popup or radio group.

NOTE: This is only used for popup or radio group elements

Parameters
n- The item you want information about
selected- The item that is selected

Implements IXMLImportOptionsService.

virtual bool16 CXMLImportOptionsServiceProvider::ShouldIndentNthControl (int32 n) const
inlinevirtual

Used to determine whether the control should be indented

Parameters
n- Which item you care about
Returns
- kTrue == Indent; kFalse == don't indent

Implements IXMLImportOptionsService.

virtual K2Vector<int32> CXMLImportOptionsServiceProvider::WarnOfChange (IXMLImportOptionsService * changedService,
IControlView * controlView,
int32 which 
)
virtual

Warn this service that another control has changed values This gives this service a chance to change its state when other controls that it may care about change their states

Parameters
changedService- The service that has been changed
controlView- The control view of the element being changed
which- Which element in the service changed
Returns
- A list of elements that cared (empty list if nobody cares)

Implements IXMLImportOptionsService.