IAssignmentOptionsDialogData Class Reference

#include <IAssignmentOptionsDialogData.h>

Inheritance diagram for IAssignmentOptionsDialogData:

Public Types
enum	{ kDefaultIID = IID_IASSIGNMENTOPTIONSDIALOGDATA }

Public Member Functions
virtual void	CopyData (IAssignmentOptionsDialogData *data)=0
virtual IAssignment *	GetAssignment ()=0
virtual void	SetAssignment (IAssignment *asssignment)=0
virtual UIDRef	GetDocRef ()=0
virtual void	SetDocRef (UIDRef docRef)=0
virtual const PMString &	GetName ()=0
virtual void	SetName (const PMString &name)=0
virtual const PMString &	GetOriginalFile ()=0
virtual void	SetOriginalFile (const PMString &file)=0
virtual const PMString &	GetNewFile ()=0
virtual void	SetNewFile (const PMString &file)=0
virtual const PMString &	GetUser ()=0
virtual void	SetUser (const PMString &user)=0
virtual UID	GetColor ()=0
virtual void	SetColor (UID color)=0
virtual IAssignment::AssignmentExportOptions	GetExportOption ()=0
virtual void	SetExportOption (IAssignment::AssignmentExportOptions options)=0
virtual IAssignment::AssignmentCompatibility	GetExportCompatibility () const =0
virtual void	SetExportCompatibility (IAssignment::AssignmentCompatibility compatibility)=0
virtual bool16	GetIncludeLinkedFilesWhenPackage () const =0
virtual void	SetIncludeLinkedFilesWhenPackage (bool16 includeFlag)=0
virtual bool16	IsNewAssignment ()=0
virtual bool16	GetNewAssignmentLocationNeedsValidation ()=0
virtual bool16	SetNewAssignmentLocationNeedsValidation (bool16 validated)=0
virtual bool16	IsOrphaned ()=0
virtual void	SetOrphaned (bool16 Orphaned)=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

Data interface for the Assignment Options dialog

Member Function Documentation

virtual void IAssignmentOptionsDialogData::CopyData ( IAssignmentOptionsDialogData *  data )

pure virtual

Copy data from another object to this one.

Parameters

data	- The data object to copy from.

virtual IAssignment* IAssignmentOptionsDialogData::GetAssignment ( )

pure virtual

Set the assignment this dialog will be referring to.

Returns

- An IAssignment pointer for the assignment.

virtual UID IAssignmentOptionsDialogData::GetColor ( )

pure virtual

Get the color UID for the assignment.

Returns

- A UID for the color from IInCopyUIColors.

virtual UIDRef IAssignmentOptionsDialogData::GetDocRef ( )

pure virtual

Get the document UIDRef

Returns

- The UIDRef of the document.

virtual IAssignment::AssignmentCompatibility IAssignmentOptionsDialogData::GetExportCompatibility ( ) const

pure virtual

The assignment export compatibility for this assignment.

Returns

- The compatibility enumeration.

virtual IAssignment::AssignmentExportOptions IAssignmentOptionsDialogData::GetExportOption ( )

pure virtual

Get the assignment export preview level options.

Returns

- The enumeration for the preview level.

virtual bool16 IAssignmentOptionsDialogData::GetIncludeLinkedFilesWhenPackage ( ) const

pure virtual

The assignment option for including linked files or not when packaging.

Returns

bool16 kTrue if should include, otherwise kFalse.

virtual const PMString& IAssignmentOptionsDialogData::GetName ( )

pure virtual

Get the assignment name.

Returns

- A PMString reference containing the assignment name.

virtual bool16 IAssignmentOptionsDialogData::GetNewAssignmentLocationNeedsValidation ( )

pure virtual

Indicates whether the new assignment location needs validation by the dialog controller. The new assignment location may have been validated by the relink observer such that the controller validation is redundant so returns false in that case.

Returns

- A boolean indicating whether this new assignment location needs validation by the dialog controller; returns kFalse if this is not a new assignment dialog.

virtual const PMString& IAssignmentOptionsDialogData::GetNewFile ( )

pure virtual

Get the new file path for the assignment.

Returns

- A platform path for the assignment.

virtual const PMString& IAssignmentOptionsDialogData::GetOriginalFile ( )

pure virtual

Get the original file path for the assignment.

Returns

- A platform path for the assignment.

virtual const PMString& IAssignmentOptionsDialogData::GetUser ( )

pure virtual

Get the user name of the assignment.

Returns

- A reference to a PMString containing the user's name.

virtual bool16 IAssignmentOptionsDialogData::IsNewAssignment ( )

pure virtual

Indicates whether this is a new assignment dialog (based on whether SetAssignment was called).

Returns

- A boolean indicating whether this is a new assignment dialog.

virtual bool16 IAssignmentOptionsDialogData::IsOrphaned ( )

pure virtual

Indicates whether this is an orphaned assignment file.

Returns

- A boolean indicating whether this is an orphaned assignment file.

virtual void IAssignmentOptionsDialogData::SetAssignment ( IAssignment *  asssignment )

pure virtual

Get the assignment this dialog is referring to.

Parameters

data	- An IAssignment pointer. This object should not be modified until the dialog is dismissed.

virtual void IAssignmentOptionsDialogData::SetColor ( UID  color )

pure virtual

Set the color UID for the assignment.

Parameters

color

- A UID for the color from IInCopyUIColors.

virtual void IAssignmentOptionsDialogData::SetDocRef ( UIDRef  docRef )

pure virtual

Set the document.

Parameters

docRef

- A UIDRef of the document.

virtual void IAssignmentOptionsDialogData::SetExportCompatibility ( IAssignment::AssignmentCompatibility  compatibility )

pure virtual

Set the assignment export compatibility level.

Parameters

options

- The enumeration desired.

virtual void IAssignmentOptionsDialogData::SetExportOption ( IAssignment::AssignmentExportOptions  options )

pure virtual

Set the assignment export preview level option.

Parameters

options

- The enumeration for the new export level.

virtual void IAssignmentOptionsDialogData::SetIncludeLinkedFilesWhenPackage ( bool16  includeFlag )

pure virtual

Set the assignment option for including linked files or not when packaging.

Parameters

includeFlag

pass kTrue to include linked files, otherwise kFalse.

virtual void IAssignmentOptionsDialogData::SetName ( const PMString &  name )

pure virtual

Set the assignment name.

Parameters

name	- A PMString holding the assignment name.

virtual bool16 IAssignmentOptionsDialogData::SetNewAssignmentLocationNeedsValidation ( bool16  validated )

pure virtual

Sets whether the new assignment location needs validation by the dialog controller, this is the case if user sets location by changing the name thus bypassing the relink observer. Only sets if this is a new assignment dialog.

Parameters

validated

- A boolean indicating that this new assignment location needs validation.

Returns

- A boolean indicating whether the flag was set.

virtual void IAssignmentOptionsDialogData::SetNewFile ( const PMString &  file )

pure virtual

Set the new file path for the assignment.

Parameters

folder

- A platform path for the assignment.

virtual void IAssignmentOptionsDialogData::SetOriginalFile ( const PMString &  file )

pure virtual

Set the original file path for the assignment.

Parameters

folder

- A platform path for the assignment.

virtual void IAssignmentOptionsDialogData::SetOrphaned ( bool16  Orphaned )

pure virtual

Set whether this is an orphaned assignment file or not.

Parameters

Orphaned

- A boolean indicating whether this is an orphaned assignment file.

virtual void IAssignmentOptionsDialogData::SetUser ( const PMString &  user )

pure virtual

Set the user name for the assignment.

Parameters

user	- A PMString containing the user name.