## GpeIconListView

GpeIconListView — Widget to arrange icons in columns and rows.

## Synopsis

    #define     GPE_ICON_LIST_VIEW_CONST        (obj)
    enum        t_gpe_textpos;
                GPEIconListView;
                GPEIconListViewClass;
    GtkWidget*  gpe_icon_list_view_new          ();
    void        gpe_icon_list_view_set_bg       (GPEIconListView *self,
                                                 char *bg);
    void        gpe_icon_list_view_set_bg_pixmap
                                                (GPEIconListView *self,
                                                 GdkPixbuf *bg);
    void        gpe_icon_list_view_set_bg_color (GPEIconListView *self,
                                                 guint32 color);
    void        gpe_icon_list_view_remove_item_with_udata
                                                (GPEIconListView *self,
                                                 gpointer udata);
    void        gpe_icon_list_view_update_icon_item_with_udata
                                                (GPEIconListView *self,
                                                 GdkPixbuf *pixbuf,
                                                 gpointer udata);
    GObject*    gpe_icon_list_view_add_item     (GPEIconListView *self,
                                                 char *title,
                                                 char *icon,
                                                 gpointer udata);
    GObject*    gpe_icon_list_view_add_item_pixbuf
                                                (GPEIconListView *self,
                                                 char *title,
                                                 GdkPixbuf *icon,
                                                 gpointer udata);
    void        gpe_icon_list_view_remove_item  (GPEIconListView *self,
                                                 GObject *item);
    void        gpe_icon_list_view_set_item_icon
                                                (GPEIconListView *self,
                                                 GObject *item,
                                                 GdkPixbuf *new_pixbuf);
    void        gpe_icon_list_view_set_embolden (GPEIconListView *self,
                                                 gboolean yes);
    void        gpe_icon_list_view_set_show_title
                                                (GPEIconListView *self,
                                                 gboolean yes);
    void        gpe_icon_list_view_set_icon_xmargin
                                                (GPEIconListView *self,
                                                 guint margin);
    void        gpe_icon_list_view_clear        (GPEIconListView *self);
    void        gpe_icon_list_view_set_icon_size
                                                (GPEIconListView *self,
                                                 guint size);
    void        gpe_icon_list_view_popup_removed
                                                (GPEIconListView *self);
    void        gpe_icon_list_view_set_rows     (GPEIconListView *self,
                                                 guint rows);
    void        gpe_icon_list_view_set_textpos  (GPEIconListView *self,
                                                 t_gpe_textpos textpos);
    void        gpe_icon_list_view_set_border_color
                                                (GPEIconListView *self,
                                                 guint32 color);
    void        gpe_icon_list_view_set_border_width
                                                (GPEIconListView *self,
                                                 int width);

## Description

This widget is used to arrange icons in columns and rows. It provides functions for user interactive actions clicking on a particular icon and methods to manage icons in the list.

## Details

### GPE_ICON_LIST_VIEW_CONST()

    #define GPE_ICON_LIST_VIEW_CONST(obj)	  G_TYPE_CHECK_INSTANCE_CAST ((obj), gpe_icon_list_view_get_type(), GPEIconListView const)

`obj` : |

### enum t_gpe_textpos

    typedef enum
    {
      GPE_TEXT_BELOW,
      GPE_TEXT_RIGHT
    } t_gpe_textpos;

Data type to define text postioning relative to a displayed icon.

`GPE_TEXT_BELOW` | Show text below the icon.
`GPE_TEXT_RIGHT` | Show text right besides the icon.

### GPEIconListView

    typedef struct _GPEIconListView GPEIconListView;

Object container for the GPEIconListView widget.

### GPEIconListViewClass

    typedef struct _GPEIconListViewClass GPEIconListViewClass;

Object class for the GPEIconListView widget.

### gpe_icon_list_view_new ()

    GtkWidget*  gpe_icon_list_view_new          ();

This function creates a new GpeIconListView widget.

Returns : | New widget

### gpe_icon_list_view_set_bg ()

    void        gpe_icon_list_view_set_bg       (GPEIconListView *self,
                                                 char *bg);

Change widget background to a pixmap from a file.

`self` : | Widget
`bg` : | Bitmap file to display in background.

### gpe_icon_list_view_set_bg_pixmap ()

    void        gpe_icon_list_view_set_bg_pixmap
                                                (GPEIconListView *self,
                                                 GdkPixbuf *bg);

Set the widget background from a GdkPixbuf.

`self` : | Widget
`bg` : | Pixbuf to use for background.

### gpe_icon_list_view_set_bg_color ()

    void        gpe_icon_list_view_set_bg_color (GPEIconListView *self,
                                                 guint32 color);

Change background color of icon list.

`self` : | Widget
`color` : | 32 bit integer defining the color.

### gpe_icon_list_view_remove_item_with_udata ()

    void        gpe_icon_list_view_remove_item_with_udata
                                                (GPEIconListView *self,
                                                 gpointer udata);

Removes an item from an icon list identified by its user data.

`self` : | Widget
`udata` : | Data pointer to identify item.

### gpe_icon_list_view_update_icon_item_with_udata ()

    void        gpe_icon_list_view_update_icon_item_with_udata
                                                (GPEIconListView *self,
                                                 GdkPixbuf *pixbuf,
                                                 gpointer udata);

Updates the icon of an item identified by its user data.

`self` : | Widget
`pixbuf` : | GdkPixbuf containing the new icon.
`udata` : | Data pointer to identify item.

### gpe_icon_list_view_add_item ()

    GObject*    gpe_icon_list_view_add_item     (GPEIconListView *self,
                                                 char *title,
                                                 char *icon,
                                                 gpointer udata);

Add a new icon item to a GpeIconList widget.

`self` : | Widget
`title` : | Short text to label the icon.
`icon` : | Icon bitmap file.
`udata` : | Pointer to user data passed to signal handlers.
Returns : | New item widget

### gpe_icon_list_view_add_item_pixbuf ()

    GObject*    gpe_icon_list_view_add_item_pixbuf
                                                (GPEIconListView *self,
                                                 char *title,
                                                 GdkPixbuf *icon,
                                                 gpointer udata);

Add a new icon item to a GpeIconList widget using a GdkPixbuf for icon data instead of a file.

`self` : | Widget
`title` : | Short text to label the icon.
`icon` : | Icon pixbuf.
`udata` : | Pointer to user data passed to signal handlers.
Returns : | New item widget

### gpe_icon_list_view_remove_item ()

    void        gpe_icon_list_view_remove_item  (GPEIconListView *self,
                                                 GObject *item);

Remove an item from a GpeIconListView.

`self` : | Widget
`item` : | Item widget

### gpe_icon_list_view_set_item_icon ()

    void        gpe_icon_list_view_set_item_icon
                                                (GPEIconListView *self,
                                                 GObject *item,
                                                 GdkPixbuf *new_pixbuf);

Updates the icon of a list view item.

`self` : | Widget
`item` : | Item of icon list to become updated.
`new_pixbuf` : | GdkPixbuf containing the new icon.

### gpe_icon_list_view_set_embolden ()

    void        gpe_icon_list_view_set_embolden (GPEIconListView *self,
                                                 gboolean yes);

Turn bold text for selected items on/off.

`self` : | Widget
`yes` : | Set TRUE to enable bold text, FALSE to disable.

### gpe_icon_list_view_set_show_title ()

    void        gpe_icon_list_view_set_show_title
                                                (GPEIconListView *self,
                                                 gboolean yes);

Turn titles on/off.

`self` : | Widget
`yes` : | Set TRUE to enable, FALSE to disable.

### gpe_icon_list_view_set_icon_xmargin ()

    void        gpe_icon_list_view_set_icon_xmargin
                                                (GPEIconListView *self,
                                                 guint margin);

Change margin in X dimension for icons inside a GpeIconListView.

`self` : | Widget
`margin` : | Margin in pixels

### gpe_icon_list_view_clear ()

    void        gpe_icon_list_view_clear        (GPEIconListView *self);

Removes all items from an icon list.

`self` : | Widget to clear

### gpe_icon_list_view_set_icon_size ()

    void        gpe_icon_list_view_set_icon_size
                                                (GPEIconListView *self,
                                                 guint size);

Changes the size of the icons displayed in the icon list view.

`self` : | Widget
`size` : | Size in pixels

### gpe_icon_list_view_popup_removed ()

    void        gpe_icon_list_view_popup_removed
                                                (GPEIconListView *self);

Executes actions that take place when popup menu is closed.

`self` : |

### gpe_icon_list_view_set_rows ()

    void        gpe_icon_list_view_set_rows     (GPEIconListView *self,
                                                 guint rows);

Sets the number of rows used for arranging icons.

`self` : | Widget
`rows` : | Number of rows

### gpe_icon_list_view_set_textpos ()

    void        gpe_icon_list_view_set_textpos  (GPEIconListView *self,
                                                 t_gpe_textpos textpos);

This function sets the position of the descriptive text of items.

`self` : | Widget
`textpos` : | Text position

### gpe_icon_list_view_set_border_color ()

    void        gpe_icon_list_view_set_border_color
                                                (GPEIconListView *self,
                                                 guint32 color);

This function is used to set the colour of the icon lists border.

`self` : | Widget
`color` : | New border color

### gpe_icon_list_view_set_border_width ()

    void        gpe_icon_list_view_set_border_width
                                                (GPEIconListView *self,
                                                 int width);

This function is used to change the width of the icon lists border.

`self` : | Widget
`width` : | New width in pixels