/**
* Get the back list within the given limit.
*
* @param history which history instance to query.
* @param limit the maximum number of items to return.
*
* @return a newly allocated list of @b newly allocated item
* instance. This memory of each item must be released with
* ewk_history_item_free() after use. use
* ewk_history_item_list_free() for convenience.
*
* @see ewk_history_item_list_free()
* @see ewk_history_back_list_length()
* @see ewk_history_back_list_get()
*/
Eina_List* ewk_history_back_list_get_with_limit(const Ewk_History* history, int limit)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, 0);
WebCore::HistoryItemVector items;
core->backListWithLimit(limit, items);
return _ewk_history_item_list_get(items);
}
Eina_Bool ewk_history_history_item_add(Ewk_History* history, const Ewk_History_Item* item)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, history_core, false);
EWK_HISTORY_ITEM_CORE_GET_OR_RETURN(item, item_core, false);
history_core->addItem(item_core);
return true;
}
/**
* Sets the given item as current in history (go to item).
*
* Memory handling: This will not modify or even take references to
* given item (Ewk_History_Item), so you should still handle it with
* ewk_history_item_free().
*
* @param history which history instance to modify.
* @param item reference to go to history. Unmodified. Must @b not be @c NULL.
*
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
*/
Eina_Bool ewk_history_history_item_set(Ewk_History* history, const Ewk_History_Item* item)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, history_core, EINA_FALSE);
EWK_HISTORY_ITEM_CORE_GET_OR_RETURN(item, item_core, EINA_FALSE);
history_core->goToItem(item_core);
return EINA_TRUE;
}
Ewk_History_Item* ewk_history_history_item_current_get(const Ewk_History* history)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, 0);
WebCore::HistoryItem* currentItem = core->currentItem();
if (currentItem)
return ewk_history_item_new_from_core(currentItem);
return 0;
}
Eina_Bool ewk_history_forward(Ewk_History* history)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, false);
if (core->forwardListCount() < 1)
return false;
core->goForward();
return true;
}
Eina_Bool ewk_history_back(Ewk_History* history)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, false);
if (core->backListCount() < 1)
return false;
core->goBack();
return true;
}
/**
* Get the whole forward list.
*
* @param history which history instance to query.
*
* @return a newly allocated list of @b newly allocated item
* instance. This memory of each item must be released with
* ewk_history_item_free() after use. use
* ewk_history_item_list_free() for convenience.
*
* @see ewk_history_item_list_free()
* @see ewk_history_forward_list_get_with_limit()
*/
Eina_List* ewk_history_forward_list_get(const Ewk_History* history)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, 0);
WebCore::HistoryItemVector items;
int limit = core->forwardListCount();
core->forwardListWithLimit(limit, items);
return _ewk_history_item_list_get(items);
}
/**
* Go back in history one item, if possible.
*
* @param history which history instance to modify.
*
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
*/
Eina_Bool ewk_history_back(Ewk_History* history)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, EINA_FALSE);
if (core->backListCount() < 1)
return EINA_FALSE;
core->goBack();
return EINA_TRUE;
}
/**
* Go forward in history one item, if possible.
*
* @param history which history instance to modify.
*
* @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
*/
Eina_Bool ewk_history_forward(Ewk_History* history)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, EINA_FALSE);
if (core->forwardListCount() < 1)
return EINA_FALSE;
core->goForward();
return EINA_TRUE;
}
Eina_Bool ewk_history_clear(Ewk_History* history)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, false);
WebCore::Page* page = core->page();
if (page && page->groupPtr())
page->groupPtr()->removeVisitedLinks();
const int limit = ewk_history_limit_get(history);
ewk_history_limit_set(history, 0);
ewk_history_limit_set(history, limit);
return true;
}
/**
* Set maximum capacity of given history.
*
* @param history which history instance to modify.
* @param limit maximum size to allow.
*
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
*/
Eina_Bool ewk_history_limit_set(const Ewk_History* history, int limit)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, EINA_FALSE);
core->setCapacity(limit);
return EINA_TRUE;
}
/**
* Get maximum capacity of given history.
*
* @param history which history instance to query.
*
* @return maximum number of entries this history will hold.
*/
int ewk_history_limit_get(Ewk_History* history)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, 0);
return core->capacity();
}
/**
* Get the whole size of back list.
*
* @param history which history instance to query.
*
* @return number of elements in whole list.
*
* @see ewk_history_back_list_get_with_limit()
*/
int ewk_history_back_list_length(const Ewk_History* history)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, 0);
return core->backListCount();
}
Ewk_History_Item* ewk_history_history_item_back_get(const Ewk_History* history)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, 0);
return ewk_history_item_new_from_core(core->backItem());
}
/**
* Queries if given item is in history.
*
* Memory handling: This will not modify or even take references to
* given item (Ewk_History_Item), so you should still handle it with
* ewk_history_item_free().
*
* @param history which history instance to modify.
* @param item reference to check in history. Must @b not be @c NULL.
*
* @return @c EINA_TRUE if in history, @c EINA_FALSE if not or failure.
*/
Eina_Bool ewk_history_history_item_contains(const Ewk_History* history, const Ewk_History_Item* item)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, history_core, EINA_FALSE);
EWK_HISTORY_ITEM_CORE_GET_OR_RETURN(item, item_core, EINA_FALSE);
return history_core->containsItem(item_core);
}
/**
* Get item at given position, if any at that index.
*
* @param history which history instance to query.
* @param index position of item to get.
*
* @return the @b newly allocated item instance. This memory must be
* released with ewk_history_item_free() after use.
*/
Ewk_History_Item* ewk_history_history_item_nth_get(const Ewk_History* history, int index)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, 0);
return _ewk_history_item_new(core->itemAtIndex(index));
}
/**
* Get the first item from forward list, if any.
*
* @param history which history instance to query.
*
* @return the @b newly allocated item instance. This memory must be
* released with ewk_history_item_free() after use.
*/
Ewk_History_Item* ewk_history_history_item_forward_get(const Ewk_History* history)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, 0);
return _ewk_history_item_new(core->forwardItem());
}
Eina_Bool ewk_history_limit_set(const Ewk_History* history, int limit)
{
EWK_HISTORY_CORE_GET_OR_RETURN(history, core, false);
core->setCapacity(limit);
return true;
}
