INotePaletteUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Wai Cheuk
// 
// $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 __INOTEPALETTEUTILS__
#define __INOTEPALETTEUTILS__

#include "IPMUnknown.h"
#include "UIDList.h"
#include "NoteID.h"

//-----------------------------------
// Forward References
//
class IPanelControlData;
class ITextLines;
class RangeData;
class IControlView;

class INotePaletteUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_INOTEPALETTEUTILS };
 
 virtual void SetNoteToPalette(UIDRef docRef, UIDRef storyRef, UID noteDataUID, bool16 setSelection = kTrue, const RangeData* range = nil) = 0;
 
 virtual void TextLineInit(IControlView* writingView, UIDRef storyRef) = 0;
 
 virtual void ResetNotePalette( bool16 resetDocument /*= kFalse*/, bool16 deactivatePalette /*= kFalse*/, bool16 callingDuringResetView = kFalse) = 0;
 
 virtual void ClearOneButtonWidget(IPanelControlData* containerPanelData, WidgetID thisWidgetID) = 0;
 
 virtual void SetOneInfoWidget(IPanelControlData* containerPanelData, WidgetID thisWidget, const PMString& thisString) = 0; 

 virtual IControlView* GetNoteWritingPad() = 0;

 virtual UIDRef GetNotePaletteUIDRef() = 0;

 virtual UIDRef GetNotePaletteStoryRef() = 0; 
 
 virtual IControlView* GetNotePanel() = 0;
 
 virtual bool16 IsNotePanelVisible() = 0;
 virtual bool16 ShowNotePanel(bool16 show = kTrue) = 0;
 
 virtual bool16 InitializePaletteData() = 0;
 
 virtual bool16 DisplayedNoteActive() = 0;
 
 virtual void UpdatePaletteButtons(bool16 collapsed) = 0; 

 virtual void UpdateStoryLabel() = 0; 

 virtual void UpdateTotalNotesDisplay() = 0;
 
 virtual void UpdatePaletteNoteModifyTime(UIDRef noteDataRef) = 0;
 
 virtual void InitPaletteWidgets(UIDRef storyRef, UIDRef docRef, UIDRef noteRef = UIDRef::gNull) = 0;

 virtual void SuspendDisplay() = 0;
 
 virtual void ResumeDisplay() = 0; 

};

#endif // __INOTEPALETTEUTILS__