Scroll bar operations
[Window creating/destroying]

Data Structures

• struct _SCROLLINFO

Defines

• #define SB_ARROW_LTUP   0x0001
• #define SB_ARROW_BTDN   0x0002
• #define SB_ARROW_BOTH   (SB_ARROW_LTUP | SB_ARROW_BTDN)

Typedefs

• typedef struct _SCROLLINFO SCROLLINFO

Functions

• MG_EXPORT BOOL GUIAPI EnableScrollBar (HWND hWnd, int iSBar, BOOL bEnable)

  Enables or disables one scroll bar arrows.
  

• MG_EXPORT BOOL GUIAPI GetScrollPos (HWND hWnd, int iSBar, int *pPos)

  Retrieves the current position of the scroll box (thumb) in the specified scroll bar.
  

• MG_EXPORT BOOL GUIAPI GetScrollRange (HWND hWnd, int iSBar, int *pMinPos, int *pMaxPos)

  Retrives the minimum and maximum position values for the specified scroll bar.
  

• MG_EXPORT BOOL GUIAPI SetScrollPos (HWND hWnd, int iSBar, int iNewPos)

  Sets the position of the scroll box (thumb) of the specified scroll bar.
  

• MG_EXPORT BOOL GUIAPI SetScrollRange (HWND hWnd, int iSBar, int iMinPos, int iMaxPos)

  Sets the minimum and maximum position values for the specified scroll bar.
  

• MG_EXPORT BOOL GUIAPI ShowScrollBar (HWND hWnd, int iSBar, BOOL bShow)

  Shows or hides the specified scroll bar.
  

• MG_EXPORT BOOL GUIAPI SetScrollInfo (HWND hWnd, int iSBar, const SCROLLINFO *lpsi, BOOL fRedraw)

  Sets the parameters of a scroll bar.
  

• MG_EXPORT BOOL GUIAPI GetScrollInfo (HWND hWnd, int iSBar, PSCROLLINFO lpsi)

  Retrieves the parameters of a scroll bar.
  

---

Define Documentation

#define SB_ARROW_BOTH   (SB_ARROW_LTUP | SB_ARROW_BTDN)

left,up, right or bottom arrow

Definition at line 6790 of file window.h.

#define SB_ARROW_BTDN   0x0002

right or bottom arrow

Definition at line 6787 of file window.h.

#define SB_ARROW_LTUP   0x0001

left or up arrow

Definition at line 6784 of file window.h.

---

Typedef Documentation

typedef struct _SCROLLINFO SCROLLINFO

Scroll bar information structure.

---

Function Documentation

BOOL GUIAPI EnableScrollBar	(	HWND	hWnd,
		int	iSBar,
		BOOL	bEnable
	)

Enables or disables one scroll bar arrows.

This function enables or disables one scroll bar arrows.

Parameters:

	hWnd	The handle to the window.
	iSBar	Indicates to enable or disable which scroll bar, can be one of the following values: SB_HORZ The horizontal scroll bar. SB_VERT The vertical scroll bar.
	bEnable	Indicates whether to enable or disable the scroll bar.

Returns:

TRUE on success, FALSE on error.

See also:

ShowScrollBar

BOOL GUIAPI GetScrollInfo	(	HWND	hWnd,
		int	iSBar,
		PSCROLLINFO	lpsi
	)

Retrieves the parameters of a scroll bar.

This function retrieves the parameters of a scroll bar, including the minimum and maximum scrolling positions, the page size, and the position of the scroll box (thumb).

Parameters:

	hWnd	The handle to the window.
	iSBar	Indicates to enable or disable which scroll bar, can be one of the following values: SB_HORZ The horizontal scroll bar. SB_VERT The vertical scroll bar.
	lpsi	The pointer to a structure of SCROLLINFO which receives the parameters.

Returns:

TRUE on success, FALSE on error.

See also:

SetScrollInfo, SCROLLINFO

BOOL GUIAPI GetScrollPos	(	HWND	hWnd,
		int	iSBar,
		int *	pPos
	)

Retrieves the current position of the scroll box (thumb) in the specified scroll bar.

This function retrieves the current position of the scroll box (thumb) in the specified scroll bar. The current position is a relative value that depends on the current scrolling range.

Parameters:

	hWnd	The handle to the window.
	iSBar	Indicates to enable or disable which scroll bar, can be one of the following values: SB_HORZ The horizontal scroll bar. SB_VERT The vertical scroll bar.
	pPos	The pointer to a integer which receives the position value.

Returns:

TRUE on success, FALSE on error.

See also:

SetScrollPos

BOOL GUIAPI GetScrollRange	(	HWND	hWnd,
		int	iSBar,
		int *	pMinPos,
		int *	pMaxPos
	)

Retrives the minimum and maximum position values for the specified scroll bar.

This function retrives the minimum and maximum position values for the specified scroll bar.

Parameters:

	hWnd	The handle to the window.
	iSBar	Indicates to enable or disable which scroll bar, can be one of the following values: SB_HORZ The horizontal scroll bar. SB_VERT The vertical scroll bar.
	pMinPos	The pointer to a integer which receives the minimum position value.
	pMaxPos	The pointer to a integer which receives the maximum position value.

Returns:

TRUE on success, FALSE on error.

See also:

SetScrollRange

BOOL GUIAPI SetScrollInfo	(	HWND	hWnd,
		int	iSBar,
		const SCROLLINFO *	lpsi,
		BOOL	fRedraw
	)

Sets the parameters of a scroll bar.

This function sets the parameters of a scroll bar, including the minimum and maximum scrolling positions, the page size, and the position of the scroll box (thumb). The function also redraws the scroll bar, if requested.

Parameters:

	hWnd	The handle to the window.
	iSBar	Indicates to enable or disable which scroll bar, can be one of the following values: SB_HORZ The horizontal scroll bar. SB_VERT The vertical scroll bar.
	lpsi	The pointer to the structure of scroll bar information.
	fRedraw	A boolean indicates whether to redraw the scroll bar.

Returns:

TRUE on success, FALSE on error.

See also:

GetScrollInfo, SCROLLINFO

BOOL GUIAPI SetScrollPos	(	HWND	hWnd,
		int	iSBar,
		int	iNewPos
	)

Sets the position of the scroll box (thumb) of the specified scroll bar.

This function sets the position of the scroll box (thumb) of the specified scroll bar, and if needed, redraws the scroll bar to reflect the new position of the scroll box.

Parameters:

	hWnd	The handle to the window.
	iSBar	Indicates to enable or disable which scroll bar, can be one of the following values: SB_HORZ The horizontal scroll bar. SB_VERT The vertical scroll bar.
	iNewPos	The new position value.

Returns:

TRUE on success, FALSE on error.

See also:

GetScrollPos

BOOL GUIAPI SetScrollRange	(	HWND	hWnd,
		int	iSBar,
		int	iMinPos,
		int	iMaxPos
	)

Sets the minimum and maximum position values for the specified scroll bar.

This function sets the minimum and maximum position values for the specified scroll bar, and if needed, redraws the scroll bar to reflect the new position values of the scroll box.

Parameters:

	hWnd	The handle to the window.
	iSBar	Indicates to enable or disable which scroll bar, can be one of the following values: SB_HORZ The horizontal scroll bar. SB_VERT The vertical scroll bar.
	iMinPos	The new minimum position value.
	iMaxPos	The new maximum position value.

Returns:

TRUE on success, FALSE on error.

See also:

GetScrollRange

BOOL GUIAPI ShowScrollBar	(	HWND	hWnd,
		int	iSBar,
		BOOL	bShow
	)

Shows or hides the specified scroll bar.

This function shows or hides the specified scroll bar.

Parameters:

	hWnd	The handle to the window.
	iSBar	Indicates to enable or disable which scroll bar, can be one of the following values: SB_HORZ The horizontal scroll bar. SB_VERT The vertical scroll bar.
	bShow	Indicates whether show or hide the scrollbar.

Returns:

TRUE on success, FALSE on error.

See also:

EnableScrollBar