ITreeAttributes Class Reference

#include <ITreeAttributes.h>

Inheritance diagram for ITreeAttributes:

Public Types
enum	{ kDefaultIID = IID_ITREEATTRIBUTES }

Public Member Functions
Root Node Display
virtual bool16	IsRootNodeDisplayed () const =0
virtual void	DisplayRootNode (bool16 displayRoot)=0
Attributes
virtual void	SetDrawEndLine (const bool16 willDrawEndLine)=0
virtual bool16	DrawsEndLine () const =0
virtual void	SetDrawBorder (const bool16 willDrawBorder)=0
virtual bool16	DrawsBorder () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Scroll Bar
enum	ScrollBarType { kVerticalScrollBar, kHorizontalScrollBar }
virtual bool16	IsScrollBarUsed (ScrollBarType scrollType) const =0
virtual void	UseScrollBar (ScrollBarType scrollType, bool16 useScrollBar)=0
virtual int16	GetThumbScrollIncrement (ScrollBarType scrollType) const =0
virtual int16	GetScrollButtonIncrement (ScrollBarType scrollType) const =0
virtual void	SetScrollAmount (ScrollBarType scrollType, int16 scrollButtonIncrement, int16 thumbScrollIncrement)=0

Detailed Description

Interface for maintaining Tree display attributes, part of kTreeViewWidgetBoss

Member Function Documentation

virtual void ITreeAttributes::DisplayRootNode ( bool16  displayRoot )

pure virtual

Sets display of the root node

Parameters

displayRoot

kTrue to display root node, kFalse to not display root node

virtual bool16 ITreeAttributes::DrawsBorder ( ) const

pure virtual

returns whether or not the tree draws a black line border around itself

virtual bool16 ITreeAttributes::DrawsEndLine ( ) const

pure virtual

returns whether or not the tree draws a black line after the last element. See list panels like Layers

virtual int16 ITreeAttributes::GetScrollButtonIncrement ( ScrollBarType  scrollType ) const

pure virtual

Gets the setting for Button Increment

Parameters

scrollType

specifies which scroll bar we are targetting, kVerticalScrollBar or kHorizontalScrollBar

virtual int16 ITreeAttributes::GetThumbScrollIncrement ( ScrollBarType  scrollType ) const

pure virtual

The scroll button increment is the number of pixels that will scroll when you click on either of the scroll buttons.

The thumb scroll increment is the smallest number of pixels that will scroll when you use the scroll bar thumb. For instance, you can have the scroll button move 20 pixels, but have the thumb scroll 1 pixel for greater accuracy. The thumb scroll increment must be a factor of the scroll button increment.

Gets the setting for Thumb Scroll Increment

Parameters

scrollType

specifies which scroll bar we are targetting, kVerticalScrollBar or kHorizontalScrollBar

virtual bool16 ITreeAttributes::IsRootNodeDisplayed ( ) const

pure virtual

Should the root node be displayed in the tree?

virtual bool16 ITreeAttributes::IsScrollBarUsed ( ScrollBarType  scrollType ) const

pure virtual

Determine if the specified scroll bar is to be used

Parameters

scrollType

specifies which scroll bar we are targetting, kVerticalScrollBar or kHorizontalScrollBar

virtual void ITreeAttributes::SetDrawBorder ( const bool16  willDrawBorder )

pure virtual

Set whether or not the tree draws a black line border around itself

Parameters

willDrawBorder

boolean value specifing if the border is to be drawn(true) for not(false)

virtual void ITreeAttributes::SetDrawEndLine ( const bool16  willDrawEndLine )

pure virtual

Set whether or not the tree draws a black line after the last element. See list panels like Layers

Parameters

willDrawEndLine

boolean value specifing if the line is to be drawn(true) for not(false)

virtual void ITreeAttributes::SetScrollAmount ( ScrollBarType  scrollType, int16  scrollButtonIncrement, int16  thumbScrollIncrement  )

pure virtual

Change the values for the scroll thumb and scroll button This will cause a call to ChangeRoot() on the ITreeViewMgr

Parameters

scrollType	specifies which scroll bar we are targetting, kVerticalScrollBar or kHorizontalScrollBar
scrollButtonIncrement	specifies the button increment for the scroll bar
thumbScrollIncrement	specifies the thumb scroll increment

virtual void ITreeAttributes::UseScrollBar ( ScrollBarType  scrollType, bool16  useScrollBar  )

pure virtual

Sets whether we want to use the specified scroll bar

Parameters

scrollType

specifies which scroll bar we are targetting, kVerticalScrollBar or kHorizontalScrollBar