## ev-mapping ev-mapping |

## Synopsis

    struct              EvMapping;
                        EvMappingList;
    EvMappingList *     ev_mapping_list_new                 (guint page,
                                                             GList *list,
                                                             GDestroyNotify data_destroy_func);
    EvMappingList *     ev_mapping_list_ref                 (EvMappingList *mapping_list);
    void                ev_mapping_list_unref               (EvMappingList *mapping_list);
    EvMapping *         ev_mapping_list_get                 (EvMappingList *mapping_list,
                                                             gdouble x,
                                                             gdouble y);
    gpointer            ev_mapping_list_get_data            (EvMappingList *mapping_list,
                                                             gdouble x,
                                                             gdouble y);
    GList *             ev_mapping_list_get_list            (EvMappingList *mapping_list);
    guint               ev_mapping_list_get_page            (EvMappingList *mapping_list);
    guint               ev_mapping_list_length              (EvMappingList *mapping_list);
    EvMapping *         ev_mapping_list_nth                 (EvMappingList *mapping_list,
                                                             guint n);
    EvMapping *         ev_mapping_list_find                (EvMappingList *mapping_list,
                                                             gconstpointer data);
    EvMapping *         ev_mapping_list_find_custom         (EvMappingList *mapping_list,
                                                             gconstpointer data,
                                                             GCompareFunc func);

## Object Hierarchy

      GBoxed
       +----EvMappingList

## Description

## Details

### struct EvMapping

    struct EvMapping {
    	EvRectangle area;
    	gpointer    data;
    };

### EvMappingList

    typedef struct _EvMappingList EvMappingList;

### ev_mapping_list_new ()

    EvMappingList *     ev_mapping_list_new                 (guint page,
                                                             GList *list,
                                                             GDestroyNotify data_destroy_func);

`page` : | page index for this mapping
`list` : | a GList of data for the page. [element-type EvMapping]
`data_destroy_func` : | function to free a list element
Returns : | an EvMappingList

### ev_mapping_list_ref ()

    EvMappingList *     ev_mapping_list_ref                 (EvMappingList *mapping_list);

### ev_mapping_list_unref ()

    void                ev_mapping_list_unref               (EvMappingList *mapping_list);

### ev_mapping_list_get ()

    EvMapping *         ev_mapping_list_get                 (EvMappingList *mapping_list,
                                                             gdouble x,
                                                             gdouble y);

`mapping_list` : | an EvMappingList
`x` : | X coordinate
`y` : | Y coordinate
Returns : | the EvMapping in the list at coordinates (x, y). [transfer none]

Since 3.12

### ev_mapping_list_get_data ()

    gpointer            ev_mapping_list_get_data            (EvMappingList *mapping_list,
                                                             gdouble x,
                                                             gdouble y);

`mapping_list` : | an EvMappingList
`x` : | X coordinate
`y` : | Y coordinate
Returns : | the data of a mapping in the list at coordinates (x, y). [transfer none]

### ev_mapping_list_get_list ()

    GList *             ev_mapping_list_get_list            (EvMappingList *mapping_list);

`mapping_list` : | an EvMappingList
Returns : | the data for this mapping list. [transfer none][element-type EvMapping]

### ev_mapping_list_get_page ()

    guint               ev_mapping_list_get_page            (EvMappingList *mapping_list);

### ev_mapping_list_length ()

    guint               ev_mapping_list_length              (EvMappingList *mapping_list);

### ev_mapping_list_nth ()

    EvMapping *         ev_mapping_list_nth                 (EvMappingList *mapping_list,
                                                             guint n);

`mapping_list` : | an EvMappingList
`n` : | the position to retrieve
Returns : | the Evmapping at position `n` in `mapping_list`. [transfer none]

### ev_mapping_list_find ()

    EvMapping *         ev_mapping_list_find                (EvMappingList *mapping_list,
                                                             gconstpointer data);

`mapping_list` : | an EvMappingList
`data` : | mapping data to find
Returns : | an EvMapping. [transfer none]

### ev_mapping_list_find_custom ()

    EvMapping *         ev_mapping_list_find_custom         (EvMappingList *mapping_list,
                                                             gconstpointer data,
                                                             GCompareFunc func);

`mapping_list` : | an EvMappingList
`data` : | mapping data to find
`func` : | function to use for equality check. [scope call]
Returns : | an EvMapping. [transfer none]