ewk_view.h

Go to the documentation of this file.

/*
   Copyright (C) 2011 Samsung Electronics
   Copyright (C) 2012 Intel Corporation. All rights reserved.
   Copyright (C) 2015 Naver Corp. All rights reserved.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef ewk_view_h
#define ewk_view_h

#include "ewk_back_forward_list.h"
#include "ewk_color_picker.h"
#include "ewk_context.h"
#include "ewk_context_menu.h"
#include "ewk_download_job.h"
#include "ewk_page_group.h"
#include "ewk_popup_menu.h"
#include "ewk_security_origin.h"
#include "ewk_touch.h"
#include "ewk_url_request.h"
#include "ewk_url_response.h"
#include "ewk_view_configuration.h"
#include "ewk_window_features.h"
#include <Evas.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    EWK_TEXT_DIRECTION_RIGHT_TO_LEFT,
    EWK_TEXT_DIRECTION_LEFT_TO_RIGHT
} Ewk_Text_Direction;

typedef enum {
    EWK_PAGE_CONTENTS_TYPE_MHTML,
    EWK_PAGE_CONTENTS_TYPE_STRING
} Ewk_Page_Contents_Type;

typedef struct Ewk_View_Smart_Data Ewk_View_Smart_Data;
typedef struct Ewk_View_Smart_Class Ewk_View_Smart_Class;

struct Ewk_View_Smart_Class {
    Evas_Smart_Class sc; 
    unsigned long version;

    Eina_Bool (*custom_item_selected)(Ewk_View_Smart_Data *sd, Ewk_Context_Menu_Item *item);
    Eina_Bool (*context_menu_show)(Ewk_View_Smart_Data *sd, Evas_Coord x, Evas_Coord y, Ewk_Context_Menu *menu);
    Eina_Bool (*context_menu_hide)(Ewk_View_Smart_Data *sd);

    Eina_Bool (*popup_menu_show)(Ewk_View_Smart_Data *sd, Eina_Rectangle rect, Ewk_Text_Direction text_direction, double page_scale_factor, Ewk_Popup_Menu *menu);
    Eina_Bool (*popup_menu_hide)(Ewk_View_Smart_Data *sd);

    // event handling:
    //  - returns true if handled
    //  - if overridden, have to call parent method if desired
    Eina_Bool (*focus_in)(Ewk_View_Smart_Data *sd);
    Eina_Bool (*focus_out)(Ewk_View_Smart_Data *sd);
    Eina_Bool (*fullscreen_enter)(Ewk_View_Smart_Data *sd, Ewk_Security_Origin *origin);
    Eina_Bool (*fullscreen_exit)(Ewk_View_Smart_Data *sd);
    Eina_Bool (*mouse_wheel)(Ewk_View_Smart_Data *sd, const Evas_Event_Mouse_Wheel *ev);
    Eina_Bool (*mouse_down)(Ewk_View_Smart_Data *sd, const Evas_Event_Mouse_Down *ev);
    Eina_Bool (*mouse_up)(Ewk_View_Smart_Data *sd, const Evas_Event_Mouse_Up *ev);
    Eina_Bool (*mouse_move)(Ewk_View_Smart_Data *sd, const Evas_Event_Mouse_Move *ev);
    Eina_Bool (*key_down)(Ewk_View_Smart_Data *sd, const Evas_Event_Key_Down *ev);
    Eina_Bool (*key_up)(Ewk_View_Smart_Data *sd, const Evas_Event_Key_Up *ev);
    Eina_Bool (*window_geometry_set)(Ewk_View_Smart_Data *sd, Evas_Coord x, Evas_Coord y, Evas_Coord width, Evas_Coord height);
    Eina_Bool (*window_geometry_get)(Ewk_View_Smart_Data *sd, Evas_Coord *x, Evas_Coord *y, Evas_Coord *width, Evas_Coord *height);

    // javascript popup:
    //   - All strings should be guaranteed to be stringshared.
    void (*run_javascript_alert)(Ewk_View_Smart_Data *sd, const char *message);
    Eina_Bool (*run_javascript_confirm)(Ewk_View_Smart_Data *sd, const char *message);
    const char *(*run_javascript_prompt)(Ewk_View_Smart_Data *sd, const char *message, const char *default_value); 
    Eina_Bool (*run_javascript_before_unload_confirm)(Ewk_View_Smart_Data *sd, const char *message);

    // color picker:
    //   - Shows and hides color picker.
    Eina_Bool (*input_picker_color_request)(Ewk_View_Smart_Data *sd, Ewk_Color_Picker *color_picker);
    Eina_Bool (*input_picker_color_dismiss)(Ewk_View_Smart_Data *sd);

    // storage:
    //   - Web database.
    unsigned long long (*exceeded_database_quota)(Ewk_View_Smart_Data *sd, const char *databaseName, const char *displayName, unsigned long long currentQuota, unsigned long long currentOriginUsage, unsigned long long currentDatabaseUsage, unsigned long long expectedUsage);

    // window creation and closing:
    //   - Create a new window with specified features and close window.
    Evas_Object *(*window_create)(Ewk_View_Smart_Data *sd, Ewk_View_Configuration* configuration, const Ewk_Window_Features *window_features);
    void (*window_close)(Ewk_View_Smart_Data *sd);
};

#define EWK_VIEW_SMART_CLASS_VERSION 9UL

#define EWK_VIEW_SMART_CLASS_INIT(smart_class_init) {smart_class_init, EWK_VIEW_SMART_CLASS_VERSION, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}

#define EWK_VIEW_SMART_CLASS_INIT_NULL EWK_VIEW_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)

#define EWK_VIEW_SMART_CLASS_INIT_NAME_VERSION(name) EWK_VIEW_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NAME_VERSION(name))

#ifdef __cplusplus
typedef class EwkView EwkView;
#else
typedef struct EwkView EwkView;
#endif

struct Ewk_View_Smart_Data {
    Evas_Object_Smart_Clipped_Data base;
    const Ewk_View_Smart_Class* api; 
    Evas_Object* self; 
    Evas_Object* image; 
    EwkView* priv; 
    struct {
        Evas_Coord x, y, w, h; 
    } view;
    struct { 
        Eina_Bool any:1;
        Eina_Bool size:1;
        Eina_Bool position:1;
    } changed;
};

typedef struct Ewk_CSS_Size Ewk_CSS_Size;

struct Ewk_CSS_Size {
    Evas_Coord w; 
    Evas_Coord h; 
};

enum Ewk_Find_Options {
    EWK_FIND_OPTIONS_NONE, 
    EWK_FIND_OPTIONS_CASE_INSENSITIVE = 1 << 0, 
    EWK_FIND_OPTIONS_AT_WORD_STARTS = 1 << 1, 
    EWK_FIND_OPTIONS_TREAT_MEDIAL_CAPITAL_AS_WORD_START = 1 << 2, 
    EWK_FIND_OPTIONS_BACKWARDS = 1 << 3, 
    EWK_FIND_OPTIONS_WRAP_AROUND = 1 << 4, 
    EWK_FIND_OPTIONS_SHOW_OVERLAY = 1 << 5, 
    EWK_FIND_OPTIONS_SHOW_FIND_INDICATOR = 1 << 6, 
    EWK_FIND_OPTIONS_SHOW_HIGHLIGHT = 1 << 7 
};
typedef enum Ewk_Find_Options Ewk_Find_Options;

typedef enum {
    EWK_PAGINATION_MODE_INVALID = -1, 
    EWK_PAGINATION_MODE_UNPAGINATED, 
    EWK_PAGINATION_MODE_LEFT_TO_RIGHT, 
    EWK_PAGINATION_MODE_RIGHT_TO_LEFT, 
    EWK_PAGINATION_MODE_TOP_TO_BOTTOM, 
    EWK_PAGINATION_MODE_BOTTOM_TO_TOP 
} Ewk_Pagination_Mode;

typedef enum Ewk_Focus_Direction {
    EWK_FOCUS_DIRECTION_FORWARD = 0,
    EWK_FOCUS_DIRECTION_BACKWARD,
} Ewk_Focus_Direction;

typedef void (*Ewk_View_Script_Execute_Cb)(Evas_Object *o, const char *return_value, void *user_data);

typedef void (*Ewk_Page_Contents_Cb)(Ewk_Page_Contents_Type type, const char *data, void *user_data);

EAPI Eina_Bool ewk_view_smart_class_set(Ewk_View_Smart_Class *api);

EAPI Evas_Object *ewk_view_smart_add(Evas *e, Evas_Smart *smart, Ewk_Context *context, Ewk_Page_Group *pageGroup);

EAPI Evas_Object *ewk_view_add_with_configuration(Evas *e, Evas_Smart *smart, Ewk_View_Configuration *configuration);

EAPI Evas_Object *ewk_view_add(Evas *e);

EAPI Evas_Object *ewk_view_add_with_context(Evas *e, Ewk_Context *context);

EAPI void ewk_view_try_close(Evas_Object *o);

EAPI Ewk_Context *ewk_view_context_get(const Evas_Object *o);

EAPI Ewk_Page_Group *ewk_view_page_group_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_url_set(Evas_Object *o, const char *url);

EAPI const char *ewk_view_url_get(const Evas_Object *o);

EAPI Eina_Bool    ewk_view_reload(Evas_Object *o);

EAPI Eina_Bool ewk_view_reload_bypass_cache(Evas_Object *o);

EAPI Eina_Bool    ewk_view_stop(Evas_Object *o);

EAPI Eina_Bool    ewk_view_back(Evas_Object *o);

EAPI Eina_Bool    ewk_view_forward(Evas_Object *o);

EAPI Eina_Bool    ewk_view_back_possible(Evas_Object *o);

EAPI Eina_Bool    ewk_view_forward_possible(Evas_Object *o);

EAPI Ewk_Back_Forward_List *ewk_view_back_forward_list_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_navigate_to(Evas_Object *o, const Ewk_Back_Forward_List_Item *item);

EAPI const char *ewk_view_title_get(const Evas_Object *o);

EAPI double ewk_view_load_progress_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_html_string_load(Evas_Object *o, const char *html, const char *baseUrl, const char *unreachableUrl);

EAPI Eina_Bool ewk_view_scale_set(Evas_Object *o, double scale_factor, int cx, int cy);

EAPI double ewk_view_scale_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_page_zoom_set(Evas_Object *o, double zoom_factor);

EAPI double ewk_view_page_zoom_get(const Evas_Object *o);

EAPI float ewk_view_device_pixel_ratio_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_device_pixel_ratio_set(Evas_Object *o, float ratio);

EAPI void ewk_view_theme_set(Evas_Object *o, const char *path);

EAPI const char *ewk_view_theme_get(const Evas_Object *o);

EAPI const char *ewk_view_custom_encoding_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_custom_encoding_set(Evas_Object *o, const char *encoding);

EAPI const char *ewk_view_user_agent_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_user_agent_set(Evas_Object *o, const char *user_agent);

EAPI const char *ewk_view_application_name_for_user_agent_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_application_name_for_user_agent_set(Evas_Object *o, const char *application_name);

EAPI Eina_Bool ewk_view_text_find(Evas_Object *o, const char *text, Ewk_Find_Options options, unsigned max_match_count);

EAPI Eina_Bool ewk_view_text_find_highlight_clear(Evas_Object *o);

EAPI Eina_Bool ewk_view_text_matches_count(Evas_Object *o, const char *text, Ewk_Find_Options options, unsigned max_match_count);

EAPI Eina_Bool ewk_view_mouse_events_enabled_set(Evas_Object *o, Eina_Bool enabled);

EAPI Eina_Bool ewk_view_mouse_events_enabled_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_feed_touch_event(Evas_Object *o, Ewk_Touch_Event_Type type, const Eina_List *points, const Evas_Modifier *modifiers);

EAPI Eina_Bool ewk_view_touch_events_enabled_set(Evas_Object *o, Eina_Bool enabled);

EAPI Eina_Bool ewk_view_touch_events_enabled_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_inspector_show(Evas_Object *o);

EAPI Eina_Bool ewk_view_inspector_close(Evas_Object *o);

EAPI Eina_Bool ewk_view_pagination_mode_set(Evas_Object *o, Ewk_Pagination_Mode mode);

EAPI Ewk_Pagination_Mode ewk_view_pagination_mode_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_fullscreen_exit(Evas_Object *o);

EAPI Eina_Bool ewk_view_page_contents_get(const Evas_Object *o, Ewk_Page_Contents_Type type, Ewk_Page_Contents_Cb callback, void *user_data);

EAPI Eina_Bool ewk_view_script_execute(Evas_Object *o, const char *script, Ewk_View_Script_Execute_Cb callback, void *user_data);

EAPI Eina_Bool ewk_view_layout_fixed_set(Evas_Object *o, Eina_Bool enabled);

EAPI Eina_Bool ewk_view_layout_fixed_get(const Evas_Object *o);

EAPI void ewk_view_layout_fixed_size_set(const Evas_Object *o, Evas_Coord width, Evas_Coord height);

EAPI void ewk_view_layout_fixed_size_get(const Evas_Object *o, Evas_Coord *width, Evas_Coord *height);

EAPI void ewk_view_bg_color_set(Evas_Object *o, int r, int g, int b, int a);

EAPI void ewk_view_bg_color_get(const Evas_Object *o, int *r, int *g, int *b, int *a);

EAPI Eina_Bool ewk_view_contents_size_get(const Evas_Object *o, Evas_Coord *width, Evas_Coord *height);

EAPI Eina_Bool ewk_view_accessibility_action_activate_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_accessibility_action_next_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_accessibility_action_prev_get(const Evas_Object *o);

EAPI Eina_Bool ewk_view_accessibility_action_read_by_point_get(const Evas_Object *o);

#ifdef __cplusplus
}
#endif
#endif // ewk_view_h