INoteUIUtils.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 __INOTEUIUTILS__
#define __INOTEUIUTILS__

#include "NoteID.h"
//-----------------------------------
// Forward References
//
class IPanelControlData;
class ITextLines;
class IControlView;
class IWaxStrand;
class ITextModel;
class ISelectionManager;

#include "IPMUnknown.h"
#include "UIDList.h"
#include "PMPoint.h"
#include "IRangeData.h"

class INoteUIUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_INOTEUIUTILS };
 enum SelectionOwnerType { kNone, kSelectionInLayout, kSelectionInGalley, kSelectionInNoteInGalley, kSelectionInNoteInLayout };
 

 virtual void GoToNextNote(ISelectionManager* selMgr, TextIndex fromThisTextIndex, UIDRef docRef, UIDRef storyRef) = 0;
 // Search the next note from the given text index in the main story.
 // Display the content in the appropriate UI and ends with selecting
 // the note anchor of the note we're searching. 
 

 virtual void GoToPreviousNote(ISelectionManager* selMgr, TextIndex fromThisTextIndex, UIDRef docRef, UIDRef storyRef) = 0;
 // Search the previous note from the given text index in the main story.
 // Display the content in the appropriate UI and ends with selecting
 // the note anchor of the note we're searching. 
 

 virtual void ShowNoteAnchorAt(ISelectionManager* selMgr, TextIndex noteAnchorPosition, UIDRef storyRef) = 0;
 // Select the note anchor at the given text index in the given story and 
 // scroll the page to the location if the anchor is not already in the 
 // current page


 virtual void DrawGalleyCaret(IControlView* writingView, ITextLines* textLines, int32 lineIndex, int32 caretOffsetIntoLine, int32 runIndex = -1, int32 caretOffsetIntoRun = -1) = 0;

 virtual void RenderThickCaret(IControlView* writingView, const IPMPoint& startPt, const IPMPoint& endPt) = 0;
 // 

 virtual bool16 TextFocusInNote(UIDRef storyRef, TextIndex textIndex, TextIndex* anchorPosition) = 0;

 virtual bool16 TextFocusInOwnedItem(UIDRef storyRef, TextIndex textFocus, TextIndex* owneItemPosition) = 0;
 // If textFocus is inside any owned item (regardless of UI) return kTrue and its anchor position,
 // otherwise, return kFalse and kInvalidTextIndex in anchorPosition


 virtual void SetGalleyWritingSelection( const RangeData& range) = 0;
 // activate the galley writing widget;
 // hilite selection from start to end.


 virtual void SelectNextNote(ISelectionManager*) = 0;
 // Actions driven calls - main note menu, palette fly-out menu, kbsc


 virtual void SelectPrevNote(ISelectionManager*) = 0;
 // Actions driven calls - main note menu, palette fly-out menu, kbsc


 virtual void ToggleNoteDisplay() = 0;
 // Actions driven calls - main note menu, palette fly-out menu, kbsc


 virtual void ExpandAllNotes() = 0;
 // Expand all inline notes in the view story


 virtual void CollapseAllNotes() = 0;
 // Collapse all inline notes in the view story


 virtual void DoClearAllNotes() = 0;
 // Remove all note data from the view document (layout),
 // or remove all note data from the view story (galley)


 virtual void DoOpenCloseNote() = 0;
 // Galley: expand or collapse inline note (a toggle) based on current selection
 // Layout: open the selected note in the note palette


 virtual bool16 GetFindChangeTextWalker() const = 0;

 virtual bool16 GetSpellTextWalker() const = 0;
 // find text walker is active, find/change or spell


 virtual bool16 GiveUpNoteSelection(IControlView *noteView = nil) = 0;
 
 virtual ErrorCode SetFrontDocViewSelection() = 0;

 virtual void DrawHitTestBox(IControlView* view, const RangeData &caret, UIDRef storyRef) = 0;

 virtual bool16 GetNoteRegion(ITextModel* textModel, TextIndex cursorIndexHit, int32 hitTestExpandOffset, TextIndex& anchorIndex) const = 0;
 // With the given cursor position in a story and an expansion zone (in terms of
 // number of characters), this method returns if there is any note near
 // the cursor position with hitTestExpandOffset as offset to its right
 // and to its left position. It returns kTrue and the note anchor position
 // if note is found in the region. It returns kFalse if no note is found.

 virtual void ActivateInlineNote(UIDRef storyRef, UIDRef noteDataRef) = 0;

 virtual void InvalidateLayoutView() = 0;
 
 virtual SelectionOwnerType GetCurrentTextSelection_(TextIndex& nStart, TextIndex& nEnd, UIDRef* storyRef) = 0;
 
 virtual bool16 InGalleyView() = 0;

 virtual void GetCurrentActionState(TextIndex& focusStart, TextIndex& focusEnd, TextIndex& noteAnchorPos,
 UIDRef& storyRef, bool16& storyHasFocus, bool16& focusInsideNote,
 bool16& focusInMainStoryThread, bool16& noteHidden, bool16& editable,
 bool16& focusInsideDeletedText, TextIndex * threadStart = nil, TextIndex * threadEnd = nil) = 0;

 virtual bool16 GetNewNoteActionState() = 0;
 virtual bool16 GetConvertToNoteActionState() = 0;
 virtual bool16 GetOpenNoteActionState() = 0;
 virtual bool16 GetDeleteNoteActionState() = 0;
 virtual bool16 GetScrollToAnchorActionState() = 0;
 virtual bool16 GetConvertToTextActionState() = 0;
 virtual bool16 GetSplitNoteActionState() = 0;
 virtual bool16 GetNaviationActionState() = 0;
 virtual bool16 GetExpandAllNoteActionState() = 0;
 virtual bool16 GetCollapseAllNoteActionState() = 0;
 virtual bool16 GetRemoveAllNoteActionState() = 0;
 virtual bool16 GetDisplayNoteActionState() = 0;
 // Various methods to alllow access to the action states

 virtual bool16 GetStoryNoteState(bool16 checkCollapsedState) = 0;
 // helper method

 virtual bool16 FrontWindowGalley() = 0;
 // InCopy 2.0 - return the front most galley window

};

#endif // __INOTEUIUTILS__