IScrollBarHost Struct Reference

Interface for scrollbar host. More...

#include <SScrollBarHandler.h>

Inheritance diagram for IScrollBarHost:

Public Types
enum	kSbConst { Timer_Wait = 100 , Timer_Go = 101 , kTime_Wait = 200 , kTime_Go = 100 }

Public Member Functions
CRect	GetScrollBarRect (BOOL bVert) SCONST PURE
	Gets the rectangle of the scrollbar.
ISkinObj *	GetScrollBarSkin (BOOL bVert) SCONST PURE
	Gets the skin for the scrollbar.
const SCROLLINFO *	GetScrollBarInfo (BOOL bVert) SCONST PURE
	Gets the scroll information for the scrollbar.
int	GetScrollBarArrowSize (BOOL bVert) SCONST PURE
	Gets the arrow size for the scrollbar.
void	OnScrollUpdatePart (BOOL bVert, int iPart) PURE
	Updates a part of the scrollbar.
void	OnScrollUpdateThumbTrack (BOOL bVert, int nPos) PURE
	Updates the thumb track of the scrollbar.
ISwndContainer *	GetScrollBarContainer () PURE
	Gets the container for the scrollbar.
BOOL	IsScrollBarEnable (BOOL bVertical) SCONST PURE
	Checks if the scrollbar is enabled.
void	OnScrollCommand (BOOL bVert, int iCmd, int nPos) PURE
	Handles scroll commands.
void	OnScrollSetTimer (BOOL bVert, char id, UINT uElapse) PURE
	Sets a timer for the scrollbar.
void	OnScrollKillTimer (BOOL bVert, char id) PURE
	Kills a timer for the scrollbar.
const IInterpolator *	GetScrollInterpolator () SCONST PURE
	Gets the interpolator for the scrollbar.
int	GetScrollFadeFrames () SCONST PURE
	Gets the number of fade frames for the scrollbar.
BYTE	GetScrollThumbTrackMinAlpha () SCONST PURE
	Gets the minimum alpha value for the scrollbar thumb track.

Detailed Description

Interface for scrollbar host.

Description: Defines the interface for the scrollbar host, which provides necessary methods for scrollbar operations.

Definition at line 12 of file SScrollBarHandler.h.

Member Enumeration Documentation

kSbConst

enum IScrollBarHost::kSbConst

Definition at line 14 of file SScrollBarHandler.h.

Member Function Documentation

GetScrollBarArrowSize()

int IScrollBarHost::GetScrollBarArrowSize

(

BOOL

bVert

)

Gets the arrow size for the scrollbar.

Parameters

bVert

TRUE for vertical scrollbar, FALSE for horizontal scrollbar.

Returns

Arrow size.

GetScrollBarContainer()

ISwndContainer * IScrollBarHost::GetScrollBarContainer

(

)

Gets the container for the scrollbar.

Returns

Pointer to the scrollbar container.

GetScrollBarInfo()

const SCROLLINFO * IScrollBarHost::GetScrollBarInfo

(

BOOL

bVert

)

Gets the scroll information for the scrollbar.

Parameters

bVert

TRUE for vertical scrollbar, FALSE for horizontal scrollbar.

Returns

Pointer to the scroll information structure.

GetScrollBarRect()

CRect IScrollBarHost::GetScrollBarRect

(

BOOL

bVert

)

Gets the rectangle of the scrollbar.

Parameters

bVert

TRUE for vertical scrollbar, FALSE for horizontal scrollbar.

Returns

Rectangle of the scrollbar.

GetScrollBarSkin()

ISkinObj * IScrollBarHost::GetScrollBarSkin

(

BOOL

bVert

)

Gets the skin for the scrollbar.

Parameters

bVert

TRUE for vertical scrollbar, FALSE for horizontal scrollbar.

Returns

Pointer to the scrollbar skin.

GetScrollFadeFrames()

int IScrollBarHost::GetScrollFadeFrames

(

)

Gets the number of fade frames for the scrollbar.

Returns

Number of fade frames.

GetScrollInterpolator()

const IInterpolator * IScrollBarHost::GetScrollInterpolator

(

)

Gets the interpolator for the scrollbar.

Returns

Pointer to the interpolator.

GetScrollThumbTrackMinAlpha()

BYTE IScrollBarHost::GetScrollThumbTrackMinAlpha

(

)

Gets the minimum alpha value for the scrollbar thumb track.

Returns

Minimum alpha value.

IsScrollBarEnable()

BOOL IScrollBarHost::IsScrollBarEnable

(

BOOL

bVertical

)

Checks if the scrollbar is enabled.

Parameters

bVertical

TRUE for vertical scrollbar, FALSE for horizontal scrollbar.

Returns

TRUE if the scrollbar is enabled, FALSE otherwise.

OnScrollCommand()

void IScrollBarHost::OnScrollCommand	(	BOOL	bVert,
		int	iCmd,
		int	nPos )

Handles scroll commands.

Parameters

bVert	TRUE for vertical scrollbar, FALSE for horizontal scrollbar.
iCmd	Command identifier.
nPos	Position for the command.

OnScrollKillTimer()

void IScrollBarHost::OnScrollKillTimer	(	BOOL	bVert,
		char	id )

Kills a timer for the scrollbar.

Parameters

bVert	TRUE for vertical scrollbar, FALSE for horizontal scrollbar.
id	Timer identifier.

OnScrollSetTimer()

void IScrollBarHost::OnScrollSetTimer	(	BOOL	bVert,
		char	id,
		UINT	uElapse )

Sets a timer for the scrollbar.

Parameters

bVert	TRUE for vertical scrollbar, FALSE for horizontal scrollbar.
id	Timer identifier.
uElapse	Elapse time for the timer.

OnScrollUpdatePart()

void IScrollBarHost::OnScrollUpdatePart	(	BOOL	bVert,
		int	iPart )

Updates a part of the scrollbar.

Parameters

bVert	TRUE for vertical scrollbar, FALSE for horizontal scrollbar.
iPart	Part to update.

OnScrollUpdateThumbTrack()

void IScrollBarHost::OnScrollUpdateThumbTrack	(	BOOL	bVert,
		int	nPos )

Updates the thumb track of the scrollbar.

Parameters

bVert	TRUE for vertical scrollbar, FALSE for horizontal scrollbar.
nPos	New position of the thumb.

---

The documentation for this struct was generated from the following file:

• SOUI/include/core/SScrollBarHandler.h