#include <IAssignmentUIUtils.h>

Inheritance diagram for IAssignmentUIUtils:

Public Types
enum	{ kDefaultIID = IID_IASSIGNMENTUIUTILS }

Public Member Functions
virtual bool16	CanGoTo ()=0

virtual void	GoTo ()=0

virtual bool16	CanNewAssignment (IActiveContext *ac)=0

virtual UIDRef	NewAssignment (IActiveContext *ac, UIFlags uiFlag, bool16 saveAssignment=kTrue)=0

virtual bool16	CanPanelAddSelToAssignment (IActiveContext *ac)=0

virtual void	PanelAddSelToAssignment (IActiveContext *ac, UIDRef &assignRef)=0

virtual bool16	CanAddSelToAssignment (IActiveContext *ac)=0

virtual ErrorCode	AddSelToAssignment (IActiveContext *ac, UIDRef assignRef)=0

virtual ErrorCode	AddListToAssignment (UIDRef assignRef, UIDList itemList)=0

virtual bool16	CanInvokeAssignmentOptions (IActiveContext *ac)=0

virtual void	InvokeAssignmentOptions ()=0

virtual bool16	CanRelinkAssignment ()=0

virtual void	RelinkAssignment ()=0

virtual bool16	CanRemove (bool16 &removeStory)=0

virtual void	Remove (bool16 byPassDialog=kFalse)=0

virtual bool16	CanUpdateSelectedAssignments ()=0

virtual bool16	CanUpdateAllAssignments (IActiveContext *ac)=0

virtual bool16	CanUpdateOutOfDateAssignments (IActiveContext *ac)=0

virtual void	UpdateSelectedAssignments ()=0

virtual void	UpdateAllAssignments (IActiveContext *ac)=0

virtual void	UpdateOutOfDateAssignments (IActiveContext *ac)=0

virtual bool16	CanEditOnSelection (IActiveContext *ac)=0

virtual bool16	EditInPlace (void)=0

virtual bool16	CanSubmitOnSelection (IActiveContext *ac)=0

virtual bool16	Submit (void)=0

virtual bool16	CanRevertOnSelection (IActiveContext *ac)=0

virtual bool16	RevertChanges (void)=0

virtual bool16	CanSubmitAll (IActiveContext *ac)=0

virtual bool16	SubmitAll (void)=0

virtual bool16	CanUpdateContentOnSelection (IActiveContext *ac)=0

virtual bool16	UpdateContent (void)=0

virtual bool16	CanToggleAssignmentColor ()=0

virtual bool16	CanRevealInFinderExplorer ()=0

virtual void	RevealInFinderExplorer ()=0

virtual bool16	CanRevealInBridge ()=0

virtual void	RevealInBridge ()=0

virtual void	ToggleAssignmentColor ()=0

virtual void	DoubleClickNode ()=0

virtual int32	ShouldSaveAssignments (IAssignedDocument *doc, bool8 allowCancel=kTrue)=0

virtual void	CheckForMissingAssignments (UIDRef doc)=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

IAssignmentUIUtils is an utility functions to help ICBridge to enable and process the menu items on assignment panel

Member Function Documentation

virtual ErrorCode IAssignmentUIUtils::AddListToAssignment	(	UIDRef	assignRef,
		UIDList	itemList
	)

pure virtual

Add the objects to assignment

Parameters

assignRef	assignment UIDRef
itemList	UIDList of objects to be added to assignment

Returns: An error code indicating whether the add to assignment succeeded or not.

virtual ErrorCode IAssignmentUIUtils::AddSelToAssignment	(	IActiveContext *	ac,
		UIDRef	assignRef
	)

pure virtual

Add the objects selected in window to the assignment

Parameters

ac	The active context
assignRef	The UIDRef of the assignment the objects added to

Returns: An error code indicating whether the add to assignment succeeded or not.

virtual bool16 IAssignmentUIUtils::CanAddSelToAssignment ( IActiveContext * ac )

pure virtual

Parameters

ac	The active context

Returns: kTrue if unassigned exported/unexported objects are selected on active doc window

virtual bool16 IAssignmentUIUtils::CanEditOnSelection ( IActiveContext * ac )

pure virtual

Can check out the selection on the panel

Parameters

ac	The active context

Returns: kTrue if the panel has same type selection and can be check out

virtual bool16 IAssignmentUIUtils::CanGoTo ( )

pure virtual

Can show the object in the document based on the selected item in assignment panel

Parameters

none

Returns: bool16 kTrue if one InCopy Content node is selected

virtual bool16 IAssignmentUIUtils::CanInvokeAssignmentOptions ( IActiveContext * ac )

pure virtual

Can invoke Assignment options

Parameters

ac	The active context

Returns: kTrue if one assignment is selected on the story list panel

virtual bool16 IAssignmentUIUtils::CanNewAssignment ( IActiveContext * ac )

pure virtual

Can new an Assignment in the active document

Parameters

ac	The active context

Returns: kTrue if document is saved

virtual bool16 IAssignmentUIUtils::CanPanelAddSelToAssignment ( IActiveContext * ac )

pure virtual

Can add the selection on the panel to Assignment

Parameters

ac	The active context

Returns: kTrue if unassigned exported/unexported objects are selected on the panel or on active doc window

virtual bool16 IAssignmentUIUtils::CanRelinkAssignment ( )

pure virtual

Can change the Assignment location

Returns: kTrue if one orphaned assignment is selected on the story list panel

virtual bool16 IAssignmentUIUtils::CanRemove ( bool16 & removeStory )

pure virtual

Can remove the selected items on the panel

Returns: kTrue if assigned InCopy content or assignments are selected on Assignment Panel

Parameters

removeStory return kTrue if assign InCopy content selected

virtual bool16 IAssignmentUIUtils::CanRevealInBridge ( )

pure virtual

Can reveal the selected item in the Adobe Bridge.

Parameters

none

Returns: kTrue if one node is selected.

virtual bool16 IAssignmentUIUtils::CanRevealInFinderExplorer ( )

pure virtual

Can reveal the selected item in the finder/explorer.

Parameters

none

Returns: kTrue if one node is selected.

virtual bool16 IAssignmentUIUtils::CanRevertOnSelection ( IActiveContext * ac )

pure virtual

Can cancel checkout the selection on Assignment panel

Parameters

ac	The active context

Returns: kTrue if the panel has same type selection and can be reverted

virtual bool16 IAssignmentUIUtils::CanSubmitAll ( IActiveContext * ac )

pure virtual

Can check in all stories on the active document

Parameters

ac	The active context

Returns: kTrue if the panel items can be check in

virtual bool16 IAssignmentUIUtils::CanSubmitOnSelection ( IActiveContext * ac )

pure virtual

Can check in selection on Assignment panel

Parameters

ac	The active context

Returns: kTrue if the panel has same type selection and can be check in

virtual bool16 IAssignmentUIUtils::CanToggleAssignmentColor ( )

pure virtual

Can show/hide the objects assigned color

Returns: kTrue if can toggle to show/hide the assigned frame color

virtual bool16 IAssignmentUIUtils::CanUpdateAllAssignments ( IActiveContext * ac )

pure virtual

Check if there is any Assignment in the active document

Parameters

ac	The active context

Returns: kTrue if the active document has any assignment

virtual bool16 IAssignmentUIUtils::CanUpdateContentOnSelection ( IActiveContext * ac )

pure virtual

Can update story selected on Assignment panel

Parameters

ac	The active context

Returns: kTrue if the panel has same type selection and can be relinked

virtual bool16 IAssignmentUIUtils::CanUpdateOutOfDateAssignments ( IActiveContext * ac )

pure virtual

Check if there is any Assignment in the active document that is out of date (or missing).

Parameters

ac	The active context

Returns: kTrue if the active document has any assignment that is out of date.

virtual bool16 IAssignmentUIUtils::CanUpdateSelectedAssignments ( )

pure virtual

Check the selected Assignments need to be saved

Returns: kTrue if assignments selected in panel are dirty

virtual void IAssignmentUIUtils::CheckForMissingAssignments ( UIDRef doc )

pure virtual

Display warning message if any assignment file is missing.

Parameters

doc	The document to be checked for missing assignments

virtual void IAssignmentUIUtils::DoubleClickNode ( )

pure virtual

Double click on Document node will bring the document forward Double click on Assignment node will open Assignment Options dialog Double click on InCopy content node will select the item on document view, or set the text insertion point on the document.

Parameters

none

virtual bool16 IAssignmentUIUtils::EditInPlace ( void )

pure virtual

Checkout the selection items on Assignment Panel

Returns: the success of checkout

virtual void IAssignmentUIUtils::GoTo ( )

pure virtual

If text story is selected in the panel, go to the text story in the document If gaphic story is selected in the panel, bring the graphic story in center view of the document

Parameters

none

virtual void IAssignmentUIUtils::InvokeAssignmentOptions ( )

pure virtual

Display the Assignment Options dialog, widgets are read-only in InCopy.

Parameters

none

virtual UIDRef IAssignmentUIUtils::NewAssignment	(	IActiveContext *	ac,
		UIFlags	uiFlag,
		bool16	saveAssignment = `kTrue`
	)

pure virtual

Choose the location for the Assignment, display New Assignment dialog, and new a assignment

Parameters

ac	The active context
uiFlag	kFullUI means to display the Assignment options dialog, otherwise the new Assignment will have the default options
saveAssignment	kTrue means to save the physical Assignment file

Returns: UIDRef The UIDRef of the new Assignment

virtual void IAssignmentUIUtils::PanelAddSelToAssignment	(	IActiveContext *	ac,
		UIDRef &	assignRef
	)

pure virtual

Add the objects selected in panel or active window to the assignment

Parameters

ac	The active context
assignRef	The Assignment that the selected stories are added to. If a null UIDRef passed in, then a new Assignment will be created first.

virtual void IAssignmentUIUtils::RelinkAssignment ( )

pure virtual

Choose the new location for Assignment, and change it

Parameters

none

virtual void IAssignmentUIUtils::Remove ( bool16 byPassDialog = kFalse )

pure virtual

When stories are selected, remove the the selected assigned story from the Assignment and move them to unassigned, when Assignments are selected, remove all story belong to this Assignment and move them into unassigned, then remove this Assignment from document, display message to ask if it is ok the delete the physical Assignment file, then delete it

Parameters

byPassDialog kTrue means don't display the message about deleting the physical Assignment file

virtual void IAssignmentUIUtils::RevealInBridge ( )

pure virtual

Reveals the selected item (document, assignment, story) in the Adobe Bridge.

Parameters

none

virtual void IAssignmentUIUtils::RevealInFinderExplorer ( )

pure virtual

Reveals the selected item (document, assignment, story) in the finder/explorer.

Parameters

none

virtual bool16 IAssignmentUIUtils::RevertChanges ( void )

pure virtual

Cancel Checkedout items selected on Assignment Panel

Returns: the success of the Cancel Checkedout

virtual int32 IAssignmentUIUtils::ShouldSaveAssignments	(	IAssignedDocument *	doc,
		bool8	allowCancel = `kTrue`
	)

pure virtual

Ask the user if they want to save all modified assignments.

Parameters

doc	The assignment document to examine for assignments.
allowCancel	Flag indicating whether or not there should be a cancel button, true by default.

Returns: 0 = doc == nil, 1 = to save, 2 = not save, and 3 = cancel

virtual bool16 IAssignmentUIUtils::Submit ( void )

pure virtual

Check in the selection items on Assignment Panel

Returns: the success of the submit(checkin)

virtual bool16 IAssignmentUIUtils::SubmitAll ( void )

pure virtual

Checkin All items on active document

Returns: the success of check in all

virtual void IAssignmentUIUtils::ToggleAssignmentColor ( )

pure virtual

To toggle show/hide the assigned frame color

Parameters

none

virtual void IAssignmentUIUtils::UpdateAllAssignments ( IActiveContext * ac )

pure virtual

Save all asssignments in the active doc

Parameters

ac	The active context

virtual bool16 IAssignmentUIUtils::UpdateContent ( void )

pure virtual

Relink (update story) on selection on Assignment panel

Returns: the success of update story

virtual void IAssignmentUIUtils::UpdateOutOfDateAssignments ( IActiveContext * ac )

pure virtual

Save all out of date (or missing) asssignments in the active doc

Parameters

ac	The active context

virtual void IAssignmentUIUtils::UpdateSelectedAssignments ( )

pure virtual

Save the current asssignment selected in the panel

Parameters

none

Public Types

Public Member Functions

Detailed Description

Member Function Documentation