Messages of scrollview control
[ScrollView control]

Defines

Define Documentation

#define SVM_ADDCTRLS   0xF303

Adds controls to the scrollview. 

 SVM_ADDCTRLS
 int itemNr;
 PCTRLDATA pctrls;

 wParam = (WPARAM)itemNr;
 lParam = (LPARAM)pctrls;
Parameters:
ctrlNr Control number in the pctrls control array.
pctrls Points to a CTRLDATA array that defines controls.
Returns:
Zero on success; otherwise -1.

Definition at line 317 of file scrollview.h.

#define SVM_ADDITEM   0xF300

Adds an item in the scrollview. 

 SVM_ADDITEM
 SVITEMINFO svii;
 HSVITEM *phsvi;

 wParam = (WPARAM)phsvi;
 lParam = (LPARAM)&svii;
Parameters:
&svii Pointer to a scrollview item information structure.
phsvi Pointer to a HSVITEM var, used to store the item handle returned.
Returns:
Index of the scrollview item on success; otherwise -1.

Definition at line 255 of file scrollview.h.

#define SVM_CHOOSEITEM   0xF321

Makes an item selected and visible in the scrollview item. 

 SVM_CHOOSEITEM
 int nItem;
 HSVITEM hsvi;

 wParam = (WPARAM)nItem;
 lParam = (LPARAM)hsvi;
Parameters:
nItem Item index. Be useful when hsvi is zero.
hsvi Item handle.
Returns:
0 on success, otherwise -1.

Definition at line 721 of file scrollview.h.

#define SVM_DELITEM   0xF301

Deletes an item from the scrollview. 

 SVM_DELITEM
 int nItem;
 HSVITEM hsvi;

 wParam = (WPARAM)nItem;
 lParam = (LPARAM)hsvi;
Parameters:
nItem Scrollview item index to delete. If hsvi is not zero, nItem will be ignored.
hsvi Scrollview item handle to delete.
Returns:
Zero on success; otherwise -1.

Definition at line 276 of file scrollview.h.

#define SVM_GETBOTTOMMARGIN   0xF315

Gets the bottom margin value of the scrollview. 

 SVM_GETBOTTOMMARGIN

 wParam = 0;
 lParam = 0;
Returns:
Bottom margin value on success, otherwise -1.

Definition at line 511 of file scrollview.h.

#define SVM_GETCONTENTX   0xF31b

Gets the content x offset in the viewport. 

 SVM_GETCONTENTX

 wParam = 0;
 lParam = 0;
Returns:
Content x coordinate in the viewport on success, otherwise -1.

Definition at line 608 of file scrollview.h.

#define SVM_GETCONTENTY   0xF31c

Gets the content y offset in the viewport. 

 SVM_GETCONTENTY

 wParam = 0;
 lParam = 0;
Returns:
Content y coordinate in the viewport on success, otherwise -1.

Definition at line 623 of file scrollview.h.

#define SVM_GETCONTHEIGHT   0xF319

Gets the height of the content area. 

 SVM_GETCONTHEIGHT

 wParam = 0;
 lParam = 0;
Returns:
Height of the content area on success, otherwise -1.

Definition at line 571 of file scrollview.h.

#define SVM_GETCONTWIDTH   0xF318

Gets the width of the content area. 

 SVM_GETCONTWIDTH

 wParam = 0;
 lParam = 0;
Returns:
Width of the content area on success, otherwise -1.

Definition at line 556 of file scrollview.h.

#define SVM_GETCTRL   0xF308

Gets the control handle in the scrollview window by control id. 

 SVM_GETCTRL
 int id;

 wParam = (WPARAM)id;
 lParam = 0;
Parameters:
id Control id.
Returns:
Control window handle on success; otherwise 0.

Definition at line 375 of file scrollview.h.

#define SVM_GETCURSEL   0xF31e

Gets the index of the current hilighted scrollview item.

An application sends an this message to a scrollview window to get the index of the currently selected item, if there is one, in a single-selection scrollview. For multiple-selection case, appliction send this message to a scrollview to get the index of the current highlighted item.

 SVM_GETCURSEL

 wParam = 0;
 lParam = 0;
Returns:
Index of current hilighted item.

Definition at line 662 of file scrollview.h.

#define SVM_GETFIRSTVISIBLEITEM   0xF337

Gets the index of the first visible item. 

 SVM_GETFIRSTVISIBLEITEM
Returns:
Item index.

Definition at line 1067 of file scrollview.h.

#define SVM_GETFOCUSCHILD   0xF32a

Gets the focus control in the scrollview. 

 SVM_GETFOCUSCHILD

 wParam = 0;
 lParam = 0;
Returns:
Handle of the focus control.

Definition at line 851 of file scrollview.h.

#define SVM_GETHSCROLLPAGEVAL   0xF32d

Gets the horizontal page scroll value. 

 SVM_GETHSCROLLPAGEVAL

 wParam = 0;
 lParam = 0;
Returns:
Current horizontal page scroll value.

Definition at line 896 of file scrollview.h.

#define SVM_GETHSCROLLVAL   0xF32b

Gets the horizontal scroll value. 

 SVM_GETHSCROLLVAL

 wParam = 0;
 lParam = 0;
Returns:
Current horizontal scroll value.

Definition at line 866 of file scrollview.h.

#define SVM_GETITEMADDDATA   0xF333

Gets the additional data of the item. 

 SVM_GETITEMADDDATA
 int nItem;
 HSVITEM hsvi;

 wParam = (WPARAM)nItem;
 lParam = (LPARAM)hsvi;
Parameters:
nItem Scrollview item index to access. If hsvi is not zero, nItem will be ignored.
hsvi Scrollview item handle to access.
Returns:
Item additional data.

Definition at line 995 of file scrollview.h.

#define SVM_GETITEMCOUNT   0xF332

Gets the total number of the items.

Returns:
Number of the items.

Definition at line 974 of file scrollview.h.

#define SVM_GETLEFTMARGIN   0xF312

Gets the left margin value of the scrollview. 

 SVM_GETLEFTMARGIN

 wParam = 0;
 lParam = 0;
Returns:
Left margin value on success, otherwise -1.

Definition at line 466 of file scrollview.h.

#define SVM_GETMARGINS   0xF30b

Gets the margin values of the scrollview.

Application should use a RECT structure to get left, top, right, and bottom margins.

 SVM_GETMARGINS
 RECT rcMargin;

 wParam = 0;
 lParam = (LPARAM)&rcMargin;
Parameters:
rcMargin A RECT for storing 4 margin values.
Returns:
0 on success.

Definition at line 430 of file scrollview.h.

#define SVM_GETRIGHTMARGIN   0xF314

Gets the right margin value of the scrollview. 

 SVM_GETRIGHTMARGIN

 wParam = 0;
 lParam = 0;
Returns:
Right margin value on success, otherwise -1.

Definition at line 496 of file scrollview.h.

#define SVM_GETTOPMARGIN   0xF313

Gets the top margin value of the scrollview. 

 SVM_GETTOPMARGIN

 wParam = 0;
 lParam = 0;
Returns:
Top margin value on success, otherwise -1.

Definition at line 481 of file scrollview.h.

#define SVM_GETVISIBLEHEIGHT   0xF317

Gets the height of the visible content area. 

 SVM_GETVISIBLEHEIGHT

 wParam = 0;
 lParam = 0;
Returns:
Height of the visible content area on success, otherwise -1.

Definition at line 541 of file scrollview.h.

#define SVM_GETVISIBLEWIDTH   0xF316

Gets the width of the visible content area. 

 SVM_GETVISIBLEWIDTH

 wParam = 0;
 lParam = 0;
Returns:
Width of the visible content area on success, otherwise -1.

Definition at line 526 of file scrollview.h.

#define SVM_GETVSCROLLPAGEVAL   0xF32e

Gets the vertical page scroll value. 

 SVM_GETVSCROLLPAGEVAL

 wParam = 0;
 lParam = 0;
Returns:
Current vertical page scroll value.

Definition at line 911 of file scrollview.h.

#define SVM_GETVSCROLLVAL   0xF32c

Gets the vertical scroll value. 

 SVM_GETVSCROLLVAL

 wParam = 0;
 lParam = 0;
Returns:
Current vertical scroll value.

Definition at line 881 of file scrollview.h.

#define SVM_MAKEPOSVISIBLE   0xF328

Makes a position in the content area visible. 

 SVM_MAKEPOSVISIBLE
 int pos_x, pos_y;

 wParam = (WPARAM)pos_x;
 lParam = (LPARAM)pos_y;
Parameters:
pos_x X coordinate of the position to be made visible
pos_y Y coordinate of the position to be made visible

Definition at line 818 of file scrollview.h.

#define SVM_REFRESHITEM   0xF335

Refresh the item. 

 SVM_REFRESHITEM
 int nitem;
 HSVITEM hsvi;

 wParam = (WPARAM)nitem;
 lParam = (LPARAM)hsvi;
Parameters:
nitem Item index. If hsvi is not zero, nItem will be ignored.
hsvi Item handle.
Returns:
Returns 0.

Definition at line 1035 of file scrollview.h.

#define SVM_RESETCONTENT   0xF309

Clears all the controls and the items added to the scrollview window. 

 SVM_RESETCONTENT

 wParam = 0;
 lParam = 0;
Returns:
Zero on success; otherwise -1.

Definition at line 390 of file scrollview.h.

#define SVM_SELECTITEM   0xF31f

Selects or unselects an item in the scrollview item. 

 SVM_SELECTITEM
 int nItem;

 wParam = (WPARAM)nItem;
 lParam = (LPARAM)bSel;
Parameters:
nItem Index of the item to select or unselect.
bSel To select or unselect.
Returns:
0 on success, otherwise -1.

Definition at line 681 of file scrollview.h.

#define SVM_SETCONTAINERPROC   0xF329

Sets the window procedure of the container window in the scrollview. 

 SVM_SETCONTAINERPROC
 WNDPROC pfn;

 wParam = 0;
 lParam = (LPARAM)pfn;
Parameters:
pfn New container procedure function.
Returns:
Old container procedure.

Definition at line 836 of file scrollview.h.

#define SVM_SETCONTHEIGHT   0xF307

Sets the scrollview content area (scrollable area) height.

Scrollable area of a scrolled window is always larger than the visible area.

 SVM_SETCONTHEIGHT
 int cont_h;

 wParam = (WPARAM)cont_h;
 lParam = 0;
Parameters:
cont_h Scrollview content height.
Returns:
Zero on success; otherwise -1.

Definition at line 357 of file scrollview.h.

#define SVM_SETCONTPOS   0xF31d

Sets the content offset position in the viewport. 

 SVM_SETCONTPOS
 int cont_x, cont_y;

 wParam = (WPARAM)cont_x;
 lParam = (LPARAM)cont_y;
Parameters:
cont_x New content x offset
cont_y New content y offset
Returns:
0 on success, otherwise -1.

Definition at line 642 of file scrollview.h.

#define SVM_SETCONTRANGE   0xF31a

Sets the width and height of the content area.

If you want to change width and height, give a value large than zero. If you give -1, this value will remain untouched.

 SVM_SETCONTRANGE
 int cont_w, cont_h;

 wParam = (WPARAM)cont_w;
 lParam = (LPARAM)cont_h;
Parameters:
cont_w Width of the content area.
cont_h Height of the content area.
Returns:
0 on success, otherwise -1.

Definition at line 593 of file scrollview.h.

#define SVM_SETCONTWIDTH   0xF306

Sets the scrollview content area (scrollable area) width.

Scrollable area of a scrolled window is always larger than the visible area.

 SVM_SETCONTWIDTH
 int cont_w;

 wParam = (WPARAM)cont_w;
 lParam = 0;
Parameters:
cont_w Scrollview content width.
Returns:
Zero on success; otherwise -1.

Definition at line 337 of file scrollview.h.

#define SVM_SETCURSEL   0xF322

Makes an item as the current hilighted item in the scrollview item. 

 SVM_SETCURSEL
 int nItem;
 BOOL bVisible;

 wParam = (WPARAM)nItem;
 lParam = (LPARAM)bVisible;
Parameters:
nitem Item index.
bVisible If bVisible is TRUE, this item wille be made visible.
Returns:
old hilighted item index on success, otherwise -1.

Definition at line 741 of file scrollview.h.

#define SVM_SETITEMADDDATA   0xF334

Sets the additional data of the item. 

 SVM_SETITEMADDDATA
 int nitem;
 int addData;

 wParam = (WPARAM)nitem;
 lParam = (LPARAM)addData;
Parameters:
nitem Item index.
addData Additional data
Returns:
Old item additional data.

Definition at line 1015 of file scrollview.h.

#define SVM_SETITEMCMP   0xF327

Sets the item compare function. 

 SVM_SETITEMCMP
 SVITEM_CMP *pfn;

 wParam = 0;
 lParam = (LPARAM)pfn;
Parameters:
pfn New item compare function
Returns:
Old function on success; otherwise NULL.

Definition at line 801 of file scrollview.h.

#define SVM_SETITEMDESTROY   0xF324

Sets the destroy operation of the items in the scrollview.

Normally item operations should be set before adding items. The destroy callback function will be called when deleting an item

 SVM_SETITEMDESTROY
 SVITEM_DESTROYFUNC *pfn;

 wParam = 0;
 lParam = (LPARAM)pfn;
Parameters:
pfn Item destroy operation function
Returns:
Old function on success; otherwise NULL.

Definition at line 783 of file scrollview.h.

#define SVM_SETITEMDRAW   0xF302

Sets the drawing operation of an item.

Scrollview item drawing function will be called when doing with MSG_PAINT message, scrollview window should define this function if it want to draw an customed item.

 SVM_SETITEMDRAW
 SVITEM_DRAWFUNC pfn;

 wParam = 0;
 lParam = (LPARAM)pfn;
Parameters:
pfn Scrollview item drawing function.
Returns:
Old drawing function pointer; otherwise 0.

Definition at line 297 of file scrollview.h.

#define SVM_SETITEMHEIGHT   0xF336

Sets the height of an item. 

 SVM_SETITEMHEIGHT
 int nitem;
 int height;

 wParam = (WPARAM)nitem;
 lParam = (LPARAM)height;
Parameters:
nitem Item index.
height New height of the item
Returns:
Old item height.

Definition at line 1055 of file scrollview.h.

#define SVM_SETITEMINIT   0xF323

Sets the init operation of the items in the scrollview.

Normally item operations should be set before adding items. The initialization callback function will be called when adding an item.

 SVM_SETITEMINIT
 SVITEM_INITFUNC *pfn;

 wParam = 0;
 lParam = (LPARAM)pfn;
Parameters:
pfn Item init operation function
Returns:
Old function on success; otherwise NULL.

Definition at line 762 of file scrollview.h.

#define SVM_SETITEMOPS   0xF30a

Sets the item operations of the items in the scrollview.

Normally item operations should be set before adding items.

 SVM_SETITEMOPS
 SVITEMOPS *iop;

 wParam = 0;
 lParam = (LPARAM)iop;
Parameters:
iop Points to a SVITEMOPS structure that defines item operations
Returns:
Zero on success; otherwise -1.

Definition at line 410 of file scrollview.h.

#define SVM_SETMARGINS   0xF311

Sets the margin values of the scrollview.

Application should use a RECT structure to give left, top, right, and bottom margins. If you want to change a margin value, give a value large than zero, or else -1.

 SVM_SETMARGINS
 RECT *rcMargin;

 wParam = 0;
 lParam = (LPARAM)rcMargin;
Parameters:
rcMargin A RECT Containing 4 margin values.
Returns:
0 on success.

Definition at line 451 of file scrollview.h.

#define SVM_SETSCROLLPAGEVAL   0xF330

Sets the horizontal and vertical page value. 

 SVM_SETSCROLLPAGEVAL
 int hval, vval;

 wParam = (WPARAM)hval;
 lParam = (WPARAM)vval;
Parameters:
hval New horizontal page value.
vval New vertical page value.
Returns:
Zero.

Definition at line 949 of file scrollview.h.

#define SVM_SETSCROLLVAL   0xF32f

Sets the horizontal and vertical scroll value. 

 SVM_SETSCROLLVAL
 int hval, vval;

 wParam = (WPARAM)hval;
 lParam = (LPARAM)vval;
Parameters:
hval New horizontal scroll value.
vval New vertical scroll value.
Returns:
Zero.

Definition at line 930 of file scrollview.h.

#define SVM_SHOWITEM   0xF320

Makes an item visible in the scrollview item. 

 SVM_SHOWITEM
 int nItem;
 HSVITEM hsvi;

 wParam = (WPARAM)nItem;
 lParam = (LPARAM)hsvi;
Parameters:
nItem Item index. Be useful when hsvi is zero.
hsvi Item handle.
Returns:
0 on success, otherwise -1.

Definition at line 701 of file scrollview.h.

#define SVM_SORTITEMS   0xF331

Sorts the items according to a specified comparision function. 

 SVM_SORTITEMS
 SVITEM_CMP pfn;

 lParam = pfn;
Parameters:
pfn Comparision function.
Returns:
Zero.

Definition at line 966 of file scrollview.h.

Generated on Thu Apr 7 15:58:36 2011 for MiniGUI V3.0.12 API Reference by  doxygen 1.6.3