MiniGUI API Reference (MiniGUI-Standalone)  v3.2.0
A mature and proven cross-platform GUI system for embedded and smart IoT devices
Modules | Data Structures | Macros | Typedefs | Functions
ScrollView control

Modules

 Styles of scrollview control
 
 Messages of scrollview control
 
 Notification codes of scrollview control
 

Data Structures

struct  _CONTAINERINFO
 
struct  _svitem_operations
 
struct  _SCROLLVIEWITEMINFO
 

Macros

#define CTRL_SCROLLVIEW   ("scrollview")
 The class name of scrollview control, uses this name to create a scrollable window that consists of items. More...
 
#define CTRL_SCROLLWND   ("scrollwnd")
 The class name of scrollwnd control, uses this name to create a scrollable window to which you can add controls. More...
 

Typedefs

typedef GHANDLE HSVITEM
 
typedef struct _CONTAINERINFO CONTAINERINFO
 
typedef CONTAINERINFOPCONTAINERINFO
 
typedef int(* SVITEM_INITFUNC) (HWND hWnd, HSVITEM hsvi)
 Type of the scrollview item initialization callback procedure. More...
 
typedef void(* SVITEM_DESTROYFUNC) (HWND hWnd, HSVITEM hsvi)
 Type of the scrollview item destroy callback procedure. More...
 
typedef void(* SVITEM_DRAWFUNC) (HWND hWnd, HSVITEM hsvi, HDC hdc, RECT *rcDraw)
 Type of the scrollview item drawing callback procedure. More...
 
typedef int(* SVITEM_CMP) (HSVITEM hsvi1, HSVITEM hsvi2)
 Type of the scrollview item compare function. More...
 
typedef struct _svitem_operations SVITEMOPS
 
typedef SVITEMOPSPSVITEMOPS
 
typedef struct _SCROLLVIEWITEMINFO SVITEMINFO
 
typedef SVITEMINFOPSVITEMINFO
 

Functions

MG_EXPORT LRESULT GUIAPI DefaultContainerProc (HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
 
MG_EXPORT DWORD mglist_get_item_adddata (GHANDLE hi)
 Use this to get additional data from a list item in a control, such as scrollview and iconview. More...
 
MG_EXPORT DWORD scrollview_get_item_adddata (HSVITEM hsvi)
 Use this to get additional data from scrollview item. More...
 
MG_EXPORT int scrollview_get_item_index (HWND hWnd, HSVITEM hsvi)
 To get item index. More...
 
MG_EXPORT BOOL scrollview_is_item_hilight (HWND hWnd, HSVITEM hsvi)
 To decide whether an item is the current hilighted item. More...
 
MG_EXPORT BOOL scrollview_is_item_selected (HSVITEM hsvi)
 To decide whether an item is a selected. More...
 
MG_EXPORT int scrollview_set_item_height (HWND hWnd, HSVITEM hsvi, int height)
 Sets the height of an item. More...
 

Detailed Description

Scrollview control is a scrollable window, which has a visible area and normally a larger content area, user can browse content area using scrollbar. Contents of the content area is totally user-defined, you can add controls in it, add customed listed items, or anything you want.

In fact, you can build a control needing scrolled window support on scrollview.

Macro Definition Documentation

#define CTRL_SCROLLVIEW   ("scrollview")

The class name of scrollview control, uses this name to create a scrollable window that consists of items.

Definition at line 81 of file scrollview.h.

#define CTRL_SCROLLWND   ("scrollwnd")

The class name of scrollwnd control, uses this name to create a scrollable window to which you can add controls.

Definition at line 89 of file scrollview.h.

Typedef Documentation

typedef struct _CONTAINERINFO CONTAINERINFO

Structure which defines a container.

typedef GHANDLE HSVITEM

Scrollview item object, use this handle to access a scrollview item

Definition at line 97 of file scrollview.h.

Data type of pointer to a CONTAINERINFO

Definition at line 119 of file scrollview.h.

Data type of pointer to a SVITEMINFO

Definition at line 219 of file scrollview.h.

Data type of pointer to a SVITEMOPS

Definition at line 206 of file scrollview.h.

typedef int(* SVITEM_CMP)(HSVITEM hsvi1, HSVITEM hsvi2)

Type of the scrollview item compare function.

Definition at line 193 of file scrollview.h.

typedef void(* SVITEM_DESTROYFUNC)(HWND hWnd, HSVITEM hsvi)

Type of the scrollview item destroy callback procedure.

Parameters
hWndHandle of the scrollview control .
hsviScrollview item handle.

Definition at line 176 of file scrollview.h.

typedef void(* SVITEM_DRAWFUNC)(HWND hWnd, HSVITEM hsvi, HDC hdc, RECT *rcDraw)

Type of the scrollview item drawing callback procedure.

Parameters
hWndHandle of the scrollview control.
hsviScrollview item handle.
hdcDrawing device context.
rcDrawDrawing rect area.

Definition at line 187 of file scrollview.h.

typedef void(* SVITEM_INITFUNC)(HWND hWnd, HSVITEM hsvi)

Type of the scrollview item initialization callback procedure.

Parameters
hWndHandle of the scrollview control .
hsviScrollview item handle.
Returns
Zero on success; otherwise -1.

Definition at line 167 of file scrollview.h.

Structure of the scrollview item info

typedef struct _svitem_operations SVITEMOPS

Structure of item operations

Function Documentation

MG_EXPORT LRESULT GUIAPI DefaultContainerProc ( HWND  hWnd,
UINT  message,
WPARAM  wParam,
LPARAM  lParam 
)

Default container window procedure

See also
DefaultDialogProc
DWORD mglist_get_item_adddata ( GHANDLE  hi)

Use this to get additional data from a list item in a control, such as scrollview and iconview.

DWORD scrollview_get_item_adddata ( HSVITEM  hsvi)

Use this to get additional data from scrollview item.

int scrollview_get_item_index ( HWND  hWnd,
HSVITEM  hsvi 
)

To get item index.

int scrollview_is_item_hilight ( HWND  hWnd,
HSVITEM  hsvi 
)

To decide whether an item is the current hilighted item.

int scrollview_is_item_selected ( HSVITEM  hsvi)

To decide whether an item is a selected.

int scrollview_set_item_height ( HWND  hWnd,
HSVITEM  hsvi,
int  height 
)

Sets the height of an item.