IAssignmentUIUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Michele Goodwin
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IASSIGNMENTUIUTILS__
#define __IASSIGNMENTUIUTILS__

#include "AssignmentUIID.h"
#include "ITreeViewMgr.h"
#include "Utils.h"

class IAssignedDocument;

class IAssignmentUIUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IASSIGNMENTUIUTILS };

 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;
};

#endif // __IASSIGNMENTUIUTILS__