icon.h File Reference

#include <mupnp/typedef.h>
#include <mupnp/util/list.h>
#include <mupnp/xml/xml.h>

Data Structures
struct	_mUpnpIcon

Macros
#define	MUPNP_ICON_ELEM_NAME   "icon"
#define	MUPNP_ICONLIST_ELEM_NAME   "iconList"
#define	MUPNP_ICON_MIME_TYPE   "mimetype"
#define	MUPNP_ICON_WIDTH   "width"
#define	MUPNP_ICON_HEIGHT   "height"
#define	MUPNP_ICON_DEPTH   "depth"
#define	MUPNP_ICON_URL   "url"
#define	mupnp_icon_next(icon)
#define	mupnp_icon_isiconnode(node)
#define	mupnp_icon_seticonnode(icon, node)
#define	mupnp_icon_geticonnode(icon)
#define	mupnp_icon_setmimetype(icon, value)
#define	mupnp_icon_getmimetype(icon)
#define	mupnp_icon_setwidth(icon, value)
#define	mupnp_icon_getwidth(icon)
#define	mupnp_icon_setheight(icon, value)
#define	mupnp_icon_getheight(icon)
#define	mupnp_icon_setdepth(icon, value)
#define	mupnp_icon_getdepth(icon)
#define	mupnp_icon_seturl(icon, value)
#define	mupnp_icon_geturl(icon)
#define	mupnp_iconlist_clear(iconList)
#define	mupnp_iconlist_size(iconList)
#define	mupnp_iconlist_gets(iconList)
#define	mupnp_iconlist_add(iconList, icon)

Typedefs
typedef struct _mUpnpIcon	mUpnpIcon
typedef struct _mUpnpIcon	mUpnpIconList

Functions
mUpnpIcon *	mupnp_icon_new (void)
void	mupnp_icon_delete (mUpnpIcon *dev)
mUpnpIconList *	mupnp_iconlist_new (void)
void	mupnp_iconlist_delete (mUpnpIconList *iconList)

Macro Definition Documentation

MUPNP_ICON_DEPTH

#define MUPNP_ICON_DEPTH   "depth"

MUPNP_ICON_ELEM_NAME

#define MUPNP_ICON_ELEM_NAME   "icon"

mupnp_icon_getdepth

#define mupnp_icon_getdepth

(

icon

)

Value:

mupnp_xml_node_getchildnodeintvalue(mupnp_icon_geticonnode(icon), MUPNP_ICON_DEPTH)

Get icon's colour depth

mupnp_icon_getheight

#define mupnp_icon_getheight

(

icon

)

Value:

mupnp_xml_node_getchildnodeintvalue(mupnp_icon_geticonnode(icon), MUPNP_ICON_HEIGHT)

Get icon height

mupnp_icon_geticonnode

#define mupnp_icon_geticonnode

(

icon

)

Value:

(icon->iconNode)

Get the XML icon node from an icon struct

Parameters

icon	The icon struct

mupnp_icon_getmimetype

#define mupnp_icon_getmimetype

(

icon

)

Value:

mupnp_xml_node_getchildnodevalue(mupnp_icon_geticonnode(icon), MUPNP_ICON_MIME_TYPE)

Get the icon's MIME type

mupnp_icon_geturl

#define mupnp_icon_geturl

(

icon

)

Value:

mupnp_xml_node_getchildnodevalue(mupnp_icon_geticonnode(icon), MUPNP_ICON_URL)

Get icon's URL

mupnp_icon_getwidth

#define mupnp_icon_getwidth

(

icon

)

Value:

mupnp_xml_node_getchildnodeintvalue(mupnp_icon_geticonnode(icon), MUPNP_ICON_WIDTH)

Get icon width

MUPNP_ICON_HEIGHT

#define MUPNP_ICON_HEIGHT   "height"

mupnp_icon_isiconnode

#define mupnp_icon_isiconnode

(

node

)

Value:

mupnp_xml_node_isname(node, MUPNP_ICON_ELEM_NAME)

Check whether the given node is a member of an icon list

Parameters

node

List node

MUPNP_ICON_MIME_TYPE

#define MUPNP_ICON_MIME_TYPE   "mimetype"

mupnp_icon_next

#define mupnp_icon_next

(

icon

)

Value:

(mUpnpIcon*)mupnp_list_next((mUpnpList*)icon)

Get the next icon in list. Use as an iterator.

Parameters

icon	Node in a list of icons

mupnp_icon_setdepth

#define mupnp_icon_setdepth	(		icon,
			value )

Value:

mupnp_xml_node_setchildnode(mupnp_icon_geticonnode(icon), MUPNP_ICON_DEPTH, value)

Set icon's colour depth

Parameters

icon	Icon in question
value	Colour depth

mupnp_icon_setheight

#define mupnp_icon_setheight	(		icon,
			value )

Value:

mupnp_xml_node_setchildnode(mupnp_icon_geticonnode(icon), MUPNP_ICON_HEIGHT, value)

Set icon height

Parameters

icon	Icon in question
value	Icon height

mupnp_icon_seticonnode

#define mupnp_icon_seticonnode	(		icon,
			node )

Value:

(icon->iconNode = node)

Set the XML icon node to an icon struct

Parameters

icon	The icon struct
node	XML node

mupnp_icon_setmimetype

#define mupnp_icon_setmimetype	(		icon,
			value )

Value:

mupnp_xml_node_setchildnode(mupnp_icon_geticonnode(icon), MUPNP_ICON_MIME_TYPE, value)

Set the icon's MIME type

Parameters

icon	Icon in question
value	MIME type

mupnp_icon_seturl

#define mupnp_icon_seturl	(		icon,
			value )

Value:

mupnp_xml_node_setchildnode(mupnp_icon_geticonnode(icon), MUPNP_ICON_URL, value)

Set icon's URL

Parameters

icon	Icon in question
value	Icon's URL

mupnp_icon_setwidth

#define mupnp_icon_setwidth	(		icon,
			value )

Value:

mupnp_xml_node_setchildnode(mupnp_icon_geticonnode(icon), MUPNP_ICON_WIDTH, value)

Set icon width

Parameters

icon	Icon in question
value	Icon width

MUPNP_ICON_URL

#define MUPNP_ICON_URL   "url"

MUPNP_ICON_WIDTH

#define MUPNP_ICON_WIDTH   "width"

mupnp_iconlist_add

#define mupnp_iconlist_add	(		iconList,
			icon )

Value:

mupnp_list_add((mUpnpList*)iconList, (mUpnpList*)icon)

Add an icon to an icon list

Parameters

iconList	List of icons
icon	Icon to add

mupnp_iconlist_clear

#define mupnp_iconlist_clear

(

iconList

)

Value:

mupnp_list_clear((mUpnpList*)iconList, (MUPNP_LIST_DESTRUCTORFUNC)mupnp_icon_delete)

Clear the contents of an icon list

Parameters

iconList

List of icons

MUPNP_ICONLIST_ELEM_NAME

#define MUPNP_ICONLIST_ELEM_NAME   "iconList"

mupnp_iconlist_gets

#define mupnp_iconlist_gets

(

iconList

)

Value:

(mUpnpIcon*)mupnp_list_next((mUpnpList*)iconList)

Todo

Get the first icon from the list for iteration

Parameters

iconList

List of icons

mupnp_iconlist_size

#define mupnp_iconlist_size

(

iconList

)

Value:

mupnp_list_size((mUpnpList*)iconList)

Get the size (number of elements) of an icon list

Parameters

iconList

List of icons

Typedef Documentation

mUpnpIcon

typedef struct _mUpnpIcon mUpnpIcon

The generic icon struct

mUpnpIconList

typedef struct _mUpnpIcon mUpnpIconList

Function Documentation

mupnp_icon_delete()

void mupnp_icon_delete

(

mUpnpIcon *

dev

)

Delete an icon struct

Parameters

dev	Icon to delete

mupnp_icon_new()

mUpnpIcon * mupnp_icon_new

(

void

)

Create a new icon struct

mupnp_iconlist_delete()

void mupnp_iconlist_delete

(

mUpnpIconList *

iconList

)

Delete a list of icons

Parameters

iconList

List of icons

mupnp_iconlist_new()

mUpnpIconList * mupnp_iconlist_new

(

void

)

Create a new list of icons