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

#include <IAssignSetPropsCmdData.h>

Inheritance diagram for IAssignSetPropsCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IASSIGNSETPROPSCMDDATA }
 

Public Member Functions

virtual void Set (const PMString *name, const PMString *file, const PMString *user, const UID *color, const IAssignment::AssignmentExportOptions *options, const bool16 *dirty, const bool16 *includeLinkedWhenPackage, const URI *uri=nil)=0
 
virtual const PMStringGetName ()=0
 
virtual const PMStringGetFile ()=0
 
virtual const PMStringGetUser ()=0
 
virtual const UIDGetColor ()=0
 
virtual const
IAssignment::AssignmentExportOptions
GetExportOption ()=0
 
virtual const bool16 * GetDirty ()=0
 
virtual const bool16 * GetIncludeLinkedFilesWhenPackage ()=0
 
virtual const URIGetURI ()=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

The data class for the IAssignSetPropsCmd.

See Also
IAssignSetPropsCmd

Member Function Documentation

virtual const UID* IAssignSetPropsCmdData::GetColor ()
pure virtual

GetColor description

Returns
- A pointer which may be nil, do not deallocate
virtual const bool16* IAssignSetPropsCmdData::GetDirty ()
pure virtual

GetDirty description

Returns
- A pointer which may be nil, do not deallocate
virtual const IAssignment::AssignmentExportOptions* IAssignSetPropsCmdData::GetExportOption ()
pure virtual

GetExportOption description

Returns
- A pointer which may be nil, do not deallocate
virtual const PMString* IAssignSetPropsCmdData::GetFile ()
pure virtual

GetFile description

Returns
- A PMString pointer which may be nil, do not deallocate
virtual const bool16* IAssignSetPropsCmdData::GetIncludeLinkedFilesWhenPackage ()
pure virtual

GetIncludeLinkedFilesWhenPackage description

Returns
- A pointer which may be nil, do not deallocate
virtual const PMString* IAssignSetPropsCmdData::GetName ()
pure virtual

Fetch the specified name

Returns
- A PMString pointer which may be nil, do not deallocate
virtual const URI* IAssignSetPropsCmdData::GetURI ()
pure virtual

GetURI description

Returns
- A URI pointer which may be nil, do not deallocate
virtual const PMString* IAssignSetPropsCmdData::GetUser ()
pure virtual

GetUser description

Returns
- A PMString pointer which may be nil, do not deallocate
virtual void IAssignSetPropsCmdData::Set (const PMStringname,
const PMStringfile,
const PMStringuser,
const UIDcolor,
const IAssignment::AssignmentExportOptionsoptions,
const bool16 * dirty,
const bool16 * includeLinkedWhenPackage,
const URIuri = nil 
)
pure virtual

Set the data to use for the AssignSetPropsCmd.

Parameters
name- A pointer to a new name, or nil to not change the name.
file- A pointer to a new file path, or nil to not change the file path.
user- A pointer to a new user name, or nil to not change the user name.
color- A pointer to the new color, or nil to not change the color.
options- A pointer to the new export options, or nil to not change the export options.
dirty- A pointer to the new dirty flag, or nil to not change the dirty state
includeLinkedWhenPackage- A pointer to the new include linked files when packaging flag, or nil to not change the state uri - A pointer to a new uri, or nil to not change the uri. (typically allowing the other changes to dirty the assignment).