ewebkit2  1.11.0
Web engine based on WebKit2 for EFL
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Macros | Typedefs | Functions
ewk_back_forward_list.h File Reference

Describes the Ewk Back Forward List API. More...

#include "ewk_back_forward_list_item.h"

Go to the source code of this file.

Macros

#define ewk_back_forward_list_back_items_copy(list)   ewk_back_forward_list_n_back_items_copy(list, -1)
 
#define ewk_back_forward_list_forward_items_copy(list)   ewk_back_forward_list_n_forward_items_copy(list, -1)
 

Typedefs

typedef struct EwkBackForwardList Ewk_Back_Forward_List
 

Functions

EAPI Ewk_Back_Forward_List_Itemewk_back_forward_list_current_item_get (const Ewk_Back_Forward_List *list)
 
EAPI Ewk_Back_Forward_List_Itemewk_back_forward_list_previous_item_get (const Ewk_Back_Forward_List *list)
 
EAPI Ewk_Back_Forward_List_Itemewk_back_forward_list_next_item_get (const Ewk_Back_Forward_List *list)
 
EAPI Ewk_Back_Forward_List_Itemewk_back_forward_list_item_at_index_get (const Ewk_Back_Forward_List *list, int index)
 
EAPI unsigned ewk_back_forward_list_count (Ewk_Back_Forward_List *list)
 
EAPI Eina_List * ewk_back_forward_list_n_back_items_copy (const Ewk_Back_Forward_List *list, int limit)
 
EAPI Eina_List * ewk_back_forward_list_n_forward_items_copy (const Ewk_Back_Forward_List *list, int limit)
 

Detailed Description

Describes the Ewk Back Forward List API.

Macro Definition Documentation

#define ewk_back_forward_list_back_items_copy (   list)    ewk_back_forward_list_n_back_items_copy(list, -1)

Creates the list containing the items preceding the current item.

The Ewk_Back_Forward_List_Item elements are located in the result list starting with the oldest one.

Parameters
listthe back-forward list instance
Returns
Eina_List containing Ewk_Back_Forward_List_Item elements or NULL in case of error, the Eina_List and its items should be freed after use. Use ewk_object_unref() to free the items
See Also
ewk_back_forward_list_n_back_items_copy
#define ewk_back_forward_list_forward_items_copy (   list)    ewk_back_forward_list_n_forward_items_copy(list, -1)

Creates the list containing the items following the current item.

The Ewk_Back_Forward_List_Item elements are located in the result list starting with the oldest one.

Parameters
listthe back-forward list instance
Returns
Eina_List containing Ewk_Back_Forward_List_Item elements or NULL in case of error, the Eina_List and its items should be freed after use. Use ewk_object_unref() to free the items
See Also
ewk_back_forward_list_n_forward_items_copy

Typedef Documentation

typedef struct EwkBackForwardList Ewk_Back_Forward_List

Creates a type name for Ewk_Back_Forward_List

Function Documentation

EAPI unsigned ewk_back_forward_list_count ( Ewk_Back_Forward_List list)

Returns the length of the back-forward list including current item.

Parameters
listthe back-forward list instance
Returns
the length of the back-forward list including current item or 0 in case of error
EAPI Ewk_Back_Forward_List_Item* ewk_back_forward_list_current_item_get ( const Ewk_Back_Forward_List list)

Returns the current item in the list.

Parameters
listthe back-forward list instance
Returns
the current item in the list or NULL in case of error
EAPI Ewk_Back_Forward_List_Item* ewk_back_forward_list_item_at_index_get ( const Ewk_Back_Forward_List list,
int  index 
)

Returns the item at a given index relative to the current item.

Parameters
listthe back-forward list instance
indexthe index of the item
Returns
the item at a given index relative to the current item or NULL in case of error
EAPI Eina_List* ewk_back_forward_list_n_back_items_copy ( const Ewk_Back_Forward_List list,
int  limit 
)

Creates the list containing the items preceding the current item limited by limit.

The Ewk_Back_Forward_List_Item elements are located in the result list starting with the oldest one. if limit is equal to -1 all the items preceding the current item are returned.

Parameters
listthe back-forward list instance
limitthe number of items to retrieve
Returns
Eina_List containing Ewk_Back_Forward_List_Item elements or NULL in case of error, the Eina_List and its items should be freed after use. Use ewk_object_unref() to free the items
EAPI Eina_List* ewk_back_forward_list_n_forward_items_copy ( const Ewk_Back_Forward_List list,
int  limit 
)

Creates the list containing the items following the current item limited by limit.

The Ewk_Back_Forward_List_Item elements are located in the result list starting with the oldest one. if limit is equal to -1 all the items preceding the current item are returned.

Parameters
listthe back-forward list instance
limitthe number of items to retrieve
Returns
Eina_List containing Ewk_Back_Forward_List_Item elements or NULL in case of error, the Eina_List and its items should be freed after use. Use ewk_object_unref() to free the items
EAPI Ewk_Back_Forward_List_Item* ewk_back_forward_list_next_item_get ( const Ewk_Back_Forward_List list)

Returns the item that follows the current item in the list.

Parameters
listthe back-forward list instance
Returns
the item that follows the current item in the list or NULL in case of error
EAPI Ewk_Back_Forward_List_Item* ewk_back_forward_list_previous_item_get ( const Ewk_Back_Forward_List list)

Returns the item that precedes the current item in the list.

Parameters
listthe back-forward list instance
Returns
the item that precedes the current item the list or NULL in case of error