mi32/mxgrlist.h File Reference

#include <mi32/xdefns.h>
#include <mi32/mcb.h>

Include dependency graph for mxgrlist.h:

Classes
struct	MxGraphListButtonStruct
struct	MxGraphListCallbackStruct
struct	MxGraphListDrawStruct
struct	MxGraphListKeyStruct
struct	MxGraphListMotionStruct
Defines
#define	MxGraphList_ButtonPressReason 0x0002
#define	MxGraphList_ButtonReason 0x0006
#define	MxGraphList_ButtonReleaseReason 0x0004
#define	MxGraphList_HeaderDrawReason 0x0040
#define	MxGraphList_KeyPressReason 0x0010
#define	MxGraphList_KeyReason 0x0030
#define	MxGraphList_KeyReleaseReason 0x0020
#define	MxGraphList_MotionNotifyReason 0x0008
#define	MxGraphList_MultipleSelection 1
#define	MxGraphList_OwnDrawReason 0x0001
#define	MxGraphList_SingleSelection 0
Functions
int	MxGraphListAddCallback (Widget w, void(func)(McbAnyCallbackStruct , void ), void data, UINT32 reason)
void	MxGraphListAddItem (Widget w, int item, int position)
void	MxGraphListAddItems (Widget w, int *items, int item_count, int position)
Widget	MxGraphListCreate (Widget parent, int Width, int Height, void userdata, UINT32 flags, Arg arg, int n)
void	MxGraphListDeleteAllItems (Widget w)
void	MxGraphListDeleteItem (Widget w, int item)
void	MxGraphListDeleteItems (Widget w, int *items, int item_count)
void	MxGraphListDeleteItemsPos (Widget w, int item_count, int position)
void	MxGraphListDeletePos (Widget w, int position)
void	MxGraphListDeselectAllItems (Widget w)
void	MxGraphListDeselectItem (Widget w, int item)
void	MxGraphListDeselectPos (Widget w, int position)
void	MxGraphListDrawPos (Widget w, int position)
void	MxGraphListEnableRedraw (Widget w, int EnableRedraw)
Widget	MxGraphListGetDrawingAreaWidget (Widget w)
void	MxGraphListGetHeaderHeight (Widget w, int *height)
int	MxGraphListGetItem (Widget w, int item)
int	MxGraphListGetItemCount (Widget w)
void	MxGraphListGetItemGeometry (Widget w, int Width, int Height)
int	MxGraphListGetKbdItemPos (Widget w)
void	MxGraphListGetMatchPos (Widget w, int item, int *position_list, int position_count)
int	MxGraphListGetSelectedItemCount (Widget w)
int	MxGraphListGetSelectedPos (Widget w, int *position_list, int postion_count)
void	MxGraphListGetVisibleItemsCount (Widget w, int *count)
int	MxGraphListGrabPointer (Widget w)
void	MxGraphListInvertSelect (Widget w)
int	MxGraphListItemExists (Widget w, int item)
int	MxGraphListItemPos (Widget w, int item)
int	MxGraphListPosSelected (Widget w, int position)
void	MxGraphListRedraw (Widget w)
void	MxGraphListSelectAllItems (Widget w)
void	MxGraphListSelectItem (Widget w, int item)
void	MxGraphListSelectPos (Widget w, int position)
void	MxGraphListSetBottomItem (Widget w, int item)
void	MxGraphListSetBottomPos (Widget w, int position)
void	MxGraphListSetHeaderHeight (Widget w, int height)
void	MxGraphListSetItem (Widget w, int item)
void	MxGraphListSetItemGeometry (Widget w, int Width, int Height)
int	MxGraphListSetKbdItemPos (Widget w, int position)
void	MxGraphListSetPos (Widget w, int position)
int	MxGraphListSetSelectionMode (Widget w, int mode)
void	MxGraphListSetVisibleItemsCount (Widget w, int count)
int	MxGraphListUngrabPointer (Widget w)

Define Documentation

#define MxGraphList_ButtonPressReason 0x0002

#define MxGraphList_ButtonReason 0x0006

#define MxGraphList_ButtonReleaseReason 0x0004

#define MxGraphList_HeaderDrawReason 0x0040

#define MxGraphList_KeyPressReason 0x0010

#define MxGraphList_KeyReason 0x0030

#define MxGraphList_KeyReleaseReason 0x0020

#define MxGraphList_MotionNotifyReason 0x0008

#define MxGraphList_MultipleSelection 1

#define MxGraphList_OwnDrawReason 0x0001

#define MxGraphList_SingleSelection 0

Function Documentation

int MxGraphListAddCallback	(	Widget	w,
		void()(McbAnyCallbackStruct , void *)	func,
		void *	data,
		UINT32	reason
	)

Add callback to the GraphList widget.

Reasons: MxGraphList_OwnDrawReason MxGraphList_ButtonPressReason MxGraphList_ButtonReleaseReason MxGraphList_ButtonReason MxGraphList_MotionNotifyReason MxGraphList_KeyPressReason MxGraphList_KeyReleaseReason MxGraphList_KeyReason MxGraphList_HeaderDrawReason

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	data	Callback function Data passed to the callback function
	reason	Callback reason

void MxGraphListAddItem	(	Widget	w,
		int	item,
		int	position
	)

Add an item to the GraphList.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	item	Item to be added to list
	position	Position of the new item in the list (started from 1, 0 means to end)

void MxGraphListAddItems	(	Widget	w,
		int *	items,
		int	item_count,
		int	position
	)

Add items to the GraphList.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	items	Pointer to the items to be added to the list
	item_count	Number of items in items
	position	Position of the first new item in the list (started from 1, 0 means to end)

Widget MxGraphListCreate	(	Widget	parent,
		int	Width,
		int	Height,
		void *	userdata,
		UINT32	flags,
		Arg *	arg,
		int	n
	)

Create the GraphList widget.

Returns:: MxGraphList widget returned or NULL if error.

Parameters:

	parent	Parent widget
	Width	Initial width of the drawing area
	Height	Initial height of the drawing area
	userdata	Userdata (not used)
	flags	Flags
	arg	Attachments for the "MxGraphList" widget
	n	Number of elements in arg array

void MxGraphListDeleteAllItems ( Widget w )

Delete all items from GraphList.

Parameters:

w

"MxGraphList" widget returned by MxGraphListCreate function

void MxGraphListDeleteItem	(	Widget	w,
		int	item
	)

Delete an item from the GraphList.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	item	Item to be deleted from list (all items match specified item)

void MxGraphListDeleteItems	(	Widget	w,
		int *	items,
		int	item_count
	)

Delete items from the GraphList.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	items	Pointer to the items to be deleted from list (all items match specified items)
	item_count	Number of elements in items

void MxGraphListDeleteItemsPos	(	Widget	w,
		int	item_count,
		int	position
	)

Delete items from the GraphList starting at the given position.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	item_count	Number of items to be deleted
	position	Position in the list of the first item to be deleted

void MxGraphListDeletePos	(	Widget	w,
		int	position
	)

Delete item from the GraphList at a specified position.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	position	Position of the item to be deleted

void MxGraphListDeselectAllItems ( Widget w )

Deselect all items.

Parameters:

w

"MxGraphList" widget returned by MxGraphListCreate function

void MxGraphListDeselectItem	(	Widget	w,
		int	item
	)

Deselect the specified item.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	item	Item to be deselected from list (all items match specified item)

void MxGraphListDeselectPos	(	Widget	w,
		int	position
	)

Deselect an item at a specified position.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	position	Position of the item to be deselected

void MxGraphListDrawPos	(	Widget	w,
		int	position
	)

Draw specified item.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	position	Position in list

void MxGraphListEnableRedraw	(	Widget	w,
		int	EnableRedraw
	)

Enable/disable the GraphList redrawing.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	EnableRedraw	Enable redraw if not 0, disable redraw if 0

Widget MxGraphListGetDrawingAreaWidget ( Widget w )

Get drawing area widget.

Returns:: DrawingArea widget or NULL if error.

Parameters:

w

"MxGraphList" widget returned by MxGraphListCreate function

void MxGraphListGetHeaderHeight	(	Widget	w,
		int *	height
	)

Get header's height.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	height	Header's height in pixels returned

int MxGraphListGetItem	(	Widget	w,
		int	item
	)

Get an item at a specified position.

Returns:: Item or error code if < 0.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	item	Position in the list

int MxGraphListGetItemCount ( Widget w )

Get items count.

Returns:: Item count or error code if < 0.

Parameters:

w

"MxGraphList" widget returned by MxGraphListCreate function

void MxGraphListGetItemGeometry	(	Widget	w,
		int *	Width,
		int *	Height
	)

Get an item geometrical size.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	Width	Item's width in pixels returned
	Height	Item's height in pixels returned

int MxGraphListGetKbdItemPos ( Widget w )

Get the position of the item at the location cursor.

Returns:: Position in the list.

Parameters:

w

"MxGraphList" widget returned by MxGraphListCreate function

void MxGraphListGetMatchPos	(	Widget	w,
		int	item,
		int **	position_list,
		int *	position_count
	)

Get an array of positions where a specified item is found.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	item	Item to be matched
	position_list	Array of positions (allocated and returned)
	position_count	Number of elements in the position_list

int MxGraphListGetSelectedItemCount ( Widget w )

Get selected items count.

Returns:: Number of selected elements or error code if < 0.

Parameters:

w

"MxGraphList" widget returned by MxGraphListCreate function

int MxGraphListGetSelectedPos	(	Widget	w,
		int **	position_list,
		int *	postion_count
	)

Get an array of the positions of the selected items.

Returns:: 1 if the GraphList has any selected elements, 0 if the GraphList doesn't have any selected elements, <0 if error.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	position_list	Array of positions of the selected items (allocated and returned)
	postion_count	Number of elements in the position_list

void MxGraphListGetVisibleItemsCount	(	Widget	w,
		int *	count
	)

Get visible items count.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	count	Visible items count returned

int MxGraphListGrabPointer ( Widget w )

Grab control of the pointer.

Parameters:

w

"MxGraphList" widget returned by MxGraphListCreate function

void MxGraphListInvertSelect ( Widget w )

Invert selection status for every item.

Parameters:

w

"MxGraphList" widget returned by MxGraphListCreate function

int MxGraphListItemExists	(	Widget	w,
		int	item
	)

Check if a specified item is in the GraphList.

Returns:: 1 if the specified item is present in the list.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	item	Item whose presence is checked

int MxGraphListItemPos	(	Widget	w,
		int	item
	)

Get the position of an item in the GraphList.

Returns:: Position in the list of the first instance of the specified item or error code if < 0.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	item	Item whose position is returned

int MxGraphListPosSelected	(	Widget	w,
		int	position
	)

Check if the item at a specified position is selected.

Returns:: 1 if item is selected.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	position	Position in the list

void MxGraphListRedraw ( Widget w )

Redraw the GraphList widget.

Parameters:

w

"MxGraphList" widget returned by MxGraphListCreate function

void MxGraphListSelectAllItems ( Widget w )

Select all items.

Parameters:

w

"MxGraphList" widget returned by MxGraphListCreate function

void MxGraphListSelectItem	(	Widget	w,
		int	item
	)

Select an item.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	item	Item to be selected in list (all items match specified item)

void MxGraphListSelectPos	(	Widget	w,
		int	position
	)

Select an item at a specified position.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	position	Position of the item to be selected

void MxGraphListSetBottomItem	(	Widget	w,
		int	item
	)

Make an item the last visible item.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	item	Item to be last visible in list (first item matches specified item)

void MxGraphListSetBottomPos	(	Widget	w,
		int	position
	)

Make an item at the specified position the last visible item.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	position	Position of the item to be selected

void MxGraphListSetHeaderHeight	(	Widget	w,
		int	height
	)

Set header's height.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	height	Header's height in pixels

void MxGraphListSetItem	(	Widget	w,
		int	item
	)

Make an item the first visible item.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	item	Item to be first visible in list (first item matches specified item)

void MxGraphListSetItemGeometry	(	Widget	w,
		int	Width,
		int	Height
	)

Set list an item geometrical size.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	Width	Item's width in pixels
	Height	Item's height in pixels

int MxGraphListSetKbdItemPos	(	Widget	w,
		int	position
	)

Set the location cursor at a specified position.

Returns:: 1 if operation is succesful.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	position	Position in the list

void MxGraphListSetPos	(	Widget	w,
		int	position
	)

Make an item at the specified position the first visible item.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	position	Position of the item to be selected

int MxGraphListSetSelectionMode	(	Widget	w,
		int	mode
	)

Set selection mode.

Returns:: 1 if operation is succesful.

Selection modes: MxGraphList_SingleSelection MxGraphList_MultipleSelection

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	mode	Selection mode

void MxGraphListSetVisibleItemsCount	(	Widget	w,
		int	count
	)

Set visible items count.

Parameters:

	w	"MxGraphList" widget returned by MxGraphListCreate function
	count	Visible items count

int MxGraphListUngrabPointer ( Widget w )

Release the pointer.

Parameters:

w

"MxGraphList" widget returned by MxGraphListCreate function

mi32/mxgrlist.h File Reference

Classes

Defines

Functions

Define Documentation

Function Documentation