IStrokeSelectAttributes Class Reference

#include <IStrokeSelectAttributes.h>

Inheritance diagram for IStrokeSelectAttributes:

Public Types
enum	{ kDefaultIID = IID_ISTROKESELECTATTRIBUTES }
enum	RectLines {   kNone = 0, kLeft = 1, kRight = 2, kTop = 4,   kBottom = 8, kOuterEdges = 15, kHorizontalMiddle = 16, kVerticalMiddle = 32,   kInnerEdges = 48, kAllSides = 63, kTopRight = 9, kTopLeft = 5,   kBottomRight = 10, kBottomLeft = 6, kTopMiddle = 17, kBottomMiddle = 18,   kLeftMiddle = 36, kRightMiddle = 40 }

Public Member Functions
virtual const bool	IsSelected (const IStrokeSelectAttributes::RectLines &position) const =0
virtual const int32	GetSelected () const =0
virtual void	SetSelected (const IStrokeSelectAttributes::RectLines &position)=0
virtual void	SetSelectedValue (const IStrokeSelectAttributes::RectLines &position)=0
virtual void	ResetSelected ()=0
virtual void	SelectAll ()=0
virtual int32	GetMostRecentSelection () const =0
virtual bool16	DrawVertical () const =0
virtual bool16	DrawBiDi () const =0
virtual bool16	IsDrawn (const IStrokeSelectAttributes::RectLines &position)=0
virtual void	SetDrawnPosition (const IStrokeSelectAttributes::RectLines &position, bool16 drawVertical, bool16 drawBiDi=kFalse)=0
virtual const int32	GetDrawnPositions () const =0
virtual void	DrawSingle (bool16 drawVertical, bool16 drawBiDi=kFalse)=0
virtual void	DrawDoubleVertical (bool16 drawVertical, bool16 drawBiDi=kFalse)=0
virtual void	DrawDoubleHorizontal (bool16 drawVertical, bool16 drawBiDi=kFalse)=0
virtual void	DrawAll (bool16 drawVertical, bool16 drawBiDi=kFalse)=0
virtual void	ResetDrawn (bool16 drawVertical, bool16 drawBiDi=kFalse)=0
virtual const int32	GetSelectedNeighbors (const RectLines &line) const =0
virtual void	SetStoreSidesWithSelection (bool16)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Abstract interface that defines API of cell-stroke widget for stroke-selection. This is an application UI-related interface and not likely to be relevant to client code directly.

Member Enumeration Documentation

enum IStrokeSelectAttributes::RectLines

Enumerates the possible configurations for selecting sides on a cell or pair of cells

Member Function Documentation

virtual void IStrokeSelectAttributes::DrawAll ( bool16  drawVertical, bool16  drawBiDi = kFalse  )

pure virtual

Draws all four cells

Parameters

drawVertical

true if we are in a vertical table – this way the sides draw correctly

virtual bool16 IStrokeSelectAttributes::DrawBiDi ( ) const

pure virtual

Returns true if table is Bidirectional

virtual void IStrokeSelectAttributes::DrawDoubleHorizontal ( bool16  drawVertical, bool16  drawBiDi = kFalse  )

pure virtual

Draws two cells horizontally

Parameters

drawVertical

true if we are in a vertical table – this way the sides draw correctly

virtual void IStrokeSelectAttributes::DrawDoubleVertical ( bool16  drawVertical, bool16  drawBiDi = kFalse  )

pure virtual

Draws two cells vertically

Parameters

drawVertical

true if we are in a vertical table – this way the sides draw correctly

virtual void IStrokeSelectAttributes::DrawSingle ( bool16  drawVertical, bool16  drawBiDi = kFalse  )

pure virtual

Draws a single cell

Parameters

drawVertical

true if we are in a vertical table – this way the sides draw correctly

virtual bool16 IStrokeSelectAttributes::DrawVertical ( ) const

pure virtual

Returns true if table is vertical

virtual const int32 IStrokeSelectAttributes::GetDrawnPositions ( ) const

pure virtual

Returns the cell drawing information (see comment one above)

virtual int32 IStrokeSelectAttributes::GetMostRecentSelection ( ) const

pure virtual

Determine most recent selection.

Returns

the selection that was most recently selected

virtual const int32 IStrokeSelectAttributes::GetSelected ( ) const

pure virtual

Gets the selected value

Returns

selected value

virtual const int32 IStrokeSelectAttributes::GetSelectedNeighbors ( const RectLines &  line ) const

pure virtual

Gets the neighbors that are selected (returns 00, 01, 10, 11)

Parameters

line

Returns

virtual bool16 IStrokeSelectAttributes::IsDrawn ( const IStrokeSelectAttributes::RectLines &  position )

pure virtual

Returns true if the position is being drawn

Parameters

position

one of the RectLines values

virtual const bool IStrokeSelectAttributes::IsSelected ( const IStrokeSelectAttributes::RectLines &  position ) const

pure virtual

Returns true if the value passed in is selected

Parameters

kTrue

if the specified configuration is selected

virtual void IStrokeSelectAttributes::ResetDrawn ( bool16  drawVertical, bool16  drawBiDi = kFalse  )

pure virtual

Resets drawn to 0

virtual void IStrokeSelectAttributes::ResetSelected ( )

pure virtual

No broadcast – sets the values back to 0 (calls SetSelectedValue)

virtual void IStrokeSelectAttributes::SelectAll ( )

pure virtual

No broadcast – sets the values back to 63 (calls SetSelectedValue)

virtual void IStrokeSelectAttributes::SetDrawnPosition ( const IStrokeSelectAttributes::RectLines &  position, bool16  drawVertical, bool16  drawBiDi = kFalse  )

pure virtual

Sets the positions that will be drawn in the widget (one cell, two vertical cells. two horizontal cells, four cells)

Parameters

position

one of the RectLines values

virtual void IStrokeSelectAttributes::SetSelected ( const IStrokeSelectAttributes::RectLines &  position )

pure virtual

Used when the user selects the value. Sends out a broadcast

Parameters

position

one of the RectLines values

virtual void IStrokeSelectAttributes::SetSelectedValue ( const IStrokeSelectAttributes::RectLines &  position )

pure virtual

Used when setting the value when we don't want a broadcast

Parameters

position

one of the RectLines values