ugfx/include/gwin/list.h

85 lines
2.0 KiB
C

/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.org/license.html
*/
/**
* @file include/gwin/list.h
* @brief GWIN list widget header file
*
* @defgroup List List
* @ingroup GWIN
*
* @details GWIN allows it to create a list widget.
*
* @pre GFX_USE_GDISP must be set to TRUE in your gfxconf.h
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
* @pre GDISP_NEED_TEXT must be set to TRUE in your gfxconf.h
* @pre GWIN_NEED_LIST must be set to TRUE in your gfxconf.h
* @pre The font you want to use must be enabled in your gfxconf.h
*
* @{
*/
#ifndef _GWIN_LIST_H
#define _GWIN_LIST_H
// This file is included within "gwin/gwin.h"
/**
* @brief The event type for a list event
*/
#define GEVENT_GWIN_LIST (GEVENT_GWIN_FIRST+4)
/**
* @brief A list event
*/
typedef struct GEventGWinList {
GEventType type; // The type of this event (GEVENT_GWIN_LIST)
GHandle list; // The list
int item; // The item that has been selected (or unselected in a multi-select listbox)
} GEventGWinList;
// A list window
typedef struct GListObject {
GWidgetObject w;
int cnt; // Number of items currently in the list (quicker than counting each time)
gfxQueueASync list_head; // The list of items
} GListObject;
#ifdef __cplusplus
extern "C" {
#endif
GHandle gwinListCreate(GListObject *widget, GWidgetInit *pInit);
int gwinListAddItem(GHandle gh, const char* item, bool_t useAlloc);
char* gwinListItemGetText(GHandle gh, int item);
int gwinListFindText(GHandle gh, const char* text);
void gwinListItemSetParam(GHandle gh, int item, uint16_t param);
uint16_t gwinListItemGetParam(GHandle gh, int item);
void nListDeleteAll(GHandle gh);
void gwinListItemDelete(GHandle gh, int item);
int gwinListItemCount(GHandle gh);
bool_t gwinListItemIsSelected(GHandle gh, int item);
int gwinListGetSelected(GHandle gh);
#ifdef __cplusplus
}
#endif
#endif // _GWIN_LIST_H
/** @} */