IListBoxController.h

//========================================================================================
// 
// $File$
// 
// Owner: Tom Taylor
// 
// $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 __IListBoxController__
#define __IListBoxController__


// WARNING: listboxes are DEPRECATED and will disappear from a future version of InDesign. Please use TreeViews instead.

#include "IPMUnknown.h"
#include "IControlView.h"
#include "widgetid.h"
#include "IEvent.h"

// Some List Constants

const int16 kTopAutoScrollSlop = 4; // area below top of list that we autoscroll the list in while dragging
const int16 kScrollBarWidth = 15;

class IListBoxController : public IPMUnknown
{
public:
 enum { kNoSelection = -1 };
 enum { kDefaultIID = IID_ILISTBOXCONTROLLER };
 

 virtual void Select(int32 index, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;
 
 virtual void SelectAll(bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;
 
 virtual void Deselect(int32 index = -1, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;
 
 virtual void DeselectAll(bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;
 
 virtual bool16 IsSelected(int32 index) const = 0;
 
 virtual int32 GetSelected() const = 0;
 
 virtual void GetSelected(K2Vector<int32>& multipleSelection) const = 0;

 virtual void GetCheckedItems(K2Vector<int32>& checkedItems) const = 0;

 virtual void SetCheckedItems( const K2Vector<int32>& vecIndices, bool16 bInvalidate = kTrue, bool16 bNotify = kTrue) = 0;

 virtual void SetMasterItem(int32 itemNumber) = 0;
 
 virtual int32 GetMasterItem() const = 0;


 virtual void SetClickItem(int32 itemNumber) = 0;
 
 
 virtual int32 GetClickItem() const = 0;
 
 
 virtual int32 FindRowHit(const PMPoint& clickPoint) = 0;
 
 enum eListBoxPart {
 kInNothing = 0, 
 kInScrollbar, 
 kInList, 
 kInListBelowItems, 
 kInTopAutoScrollArea
 };
 
 virtual eListBoxPart ClickedWhichPart(const PMPoint& clickPoint) = 0;
 
 enum eScrollDirection { kNoScroll = 0, kScrollUp, kScrollUpSlow, kScrollDown, kScrollDownSlow, kScrollLeft, kScrollLeftSlow, kScrollRight, kScrollRightSlow, kInsideDoNothing
 };
 
 virtual void ScrollList(const eScrollDirection direction) = 0;
 
 
 virtual void ScrollItemIntoView(int32 itemNumber) = 0;
 
 
 virtual int32 GetFirstVisibleItem() const = 0;
 
 
 virtual int32 GetMaximumVisibleItems() const = 0;
 
 
 virtual int32 Search(const PMString& subString) const = 0;
 

 virtual PMString GetNthItemString(int32 n) const = 0;
 

 // These function are typically for internal use
 virtual void GetVisibleItemBounds(int32 item, PMRect& newBounds) = 0;

 virtual eScrollDirection CheckScrollDirection(eScrollDirection direction) = 0;

 virtual eScrollDirection CheckDragScroll(const PMPoint& where) = 0;
 
 virtual void SetSelected( const K2Vector<int32>& vecIndices, bool16 bInvalidate = kTrue, bool16 bNotify = kTrue) = 0;

 virtual void ProcessSelectionRules(IEvent* event, int32 index) = 0;
 


};

#endif