dash.utility.bindings.awesomium

Members

Enums

awe_jsvalue_type
enum awe_jsvalue_type

JS Value Functions *

Functions

awe_history_entry_destroy
void awe_history_entry_destroy(awe_history_entry* entry)

* History Entry * ************************/ /// Destroy the instanc

awe_history_entry_get_title
awe_string* awe_history_entry_get_title(awe_history_entry* entry)

Get the title of the page

awe_history_entry_get_url
awe_string* awe_history_entry_get_url(awe_history_entry* entry)

Get the URL of the page

awe_history_entry_get_visit_count
int awe_history_entry_get_visit_count(awe_history_entry* entry)

Get the number of times this page was visited.

awe_history_entry_get_visit_time
double awe_history_entry_get_visit_time(awe_history_entry* entry)

Get the last time this page was visited (in seconds since epoch)

awe_history_query_result_destroy
void awe_history_query_result_destroy(awe_history_query_result* res)

* History Query Result * ************************/ /// Destroy the instance (you must call this once you're done using the instance

awe_history_query_result_get_entry_at_index
awe_history_entry* awe_history_query_result_get_entry_at_index(awe_history_query_result* res, size_t idx)

Get a certain entry (you must destroy any returned entry using awe_history_entry_destroy). May return NULL if the index is out of bounds.

awe_history_query_result_get_size
size_t awe_history_query_result_get_size(awe_history_query_result* res)

Get the total number of entries

awe_jsarray_create
awe_jsarray* awe_jsarray_create(const(awe_jsvalue*)* jsvalue_array, size_t length)

Create a JSValue Array.

awe_jsarray_destroy
void awe_jsarray_destroy(awe_jsarray* jsarray)

Destroys a JSValue Array created with awe_jsarray_create.

awe_jsarray_get_element
const(awe_jsvalue)* awe_jsarray_get_element(const(awe_jsarray)* jsarray, size_t index)

Get a specific element of a JSValue Array. The Array retains ownership of the returned JSValue instance (you do not need to destroy it).

awe_jsarray_get_size
size_t awe_jsarray_get_size(const(awe_jsarray)* jsarray)

Get the size of a JSValue Array.

awe_jsobject_create
awe_jsobject* awe_jsobject_create()

Creates a JSValue Object.

awe_jsobject_destroy
void awe_jsobject_destroy(awe_jsobject* jsobject)

Destroys a JSValue Object created with awe_jsobject_create

awe_jsobject_get_keys
awe_jsarray* awe_jsobject_get_keys(awe_jsobject* jsobject)

Get a list of all key names as a JSValue Array, you need to call awe_jsarray_destroy on the returned value after you're done using it.

awe_jsobject_get_property
const(awe_jsvalue)* awe_jsobject_get_property(const(awe_jsobject)* jsobject, const(awe_string)* property_name)

Gets the value of a certain named property of a JSValue Object. You do not need to destroy the returned jsvalue instance, it is owned by the object.

awe_jsobject_get_size
size_t awe_jsobject_get_size(awe_jsobject* jsobject)

Get the number of key/value pairs in a JSValue object.

awe_jsobject_has_property
bool awe_jsobject_has_property(const(awe_jsobject)* jsobject, const(awe_string)* property_name)

Returns whether or not a JSValue Object has a certained named property.

awe_jsobject_set_property
void awe_jsobject_set_property(awe_jsobject* jsobject, const(awe_string)* property_name, const(awe_jsvalue)* value)

Sets the value of a certained named property of a JSValue Object.

awe_jsvalue_create_array_value
awe_jsvalue* awe_jsvalue_create_array_value(const(awe_jsarray)* value)

Create a JSValue instance initialized with an array type. You must call awe_jsvalue_destroy with the returned instance once you're done using it.

awe_jsvalue_create_bool_value
awe_jsvalue* awe_jsvalue_create_bool_value(bool value)

Create a JSValue instance initialized with a boolean type. You must call awe_jsvalue_destroy with the returned instance once you're done using it.

awe_jsvalue_create_double_value
awe_jsvalue* awe_jsvalue_create_double_value(double value)

Create a JSValue instance initialized with a double type. You must call awe_jsvalue_destroy with the returned instance once you're done using it.

awe_jsvalue_create_integer_value
awe_jsvalue* awe_jsvalue_create_integer_value(int value)

Create a JSValue instance initialized with an integer type. You must call awe_jsvalue_destroy with the returned instance once you're done using it.

awe_jsvalue_create_null_value
awe_jsvalue* awe_jsvalue_create_null_value()

Create a JSValue instance initialized as a null type. You must call awe_jsvalue_destroy with the returned instance once you're done using it.

awe_jsvalue_create_object_value
awe_jsvalue* awe_jsvalue_create_object_value(const(awe_jsobject)* value)

Create a JSValue instance initialized with an object type. You must call awe_jsvalue_destroy with the returned instance once you're done using it.

awe_jsvalue_create_string_value
awe_jsvalue* awe_jsvalue_create_string_value(const(awe_string)* value)

Create a JSValue instance initialized with a string type. You must call awe_jsvalue_destroy with the returned instance once you're done using it.

awe_jsvalue_destroy
void awe_jsvalue_destroy(awe_jsvalue* jsvalue)

Destroys a JSValue instance.

awe_jsvalue_get_array
const(awe_jsarray)* awe_jsvalue_get_array(const(awe_jsvalue)* jsvalue)

Returns this value as an array. Will throw an exception if not an array.

awe_jsvalue_get_object
const(awe_jsobject)* awe_jsvalue_get_object(const(awe_jsvalue)* jsvalue)

Returns this value as an object. Will throw an exception if not an object.

awe_jsvalue_get_type
awe_jsvalue_type awe_jsvalue_get_type(const(awe_jsvalue)* jsvalue)

Get the type of a JSValue.

awe_jsvalue_to_boolean
bool awe_jsvalue_to_boolean(const(awe_jsvalue)* jsvalue)

Returns this value as an boolean.

awe_jsvalue_to_double
double awe_jsvalue_to_double(const(awe_jsvalue)* jsvalue)

Returns this value as an double.

awe_jsvalue_to_integer
int awe_jsvalue_to_integer(const(awe_jsvalue)* jsvalue)

Returns this value as an integer.

awe_jsvalue_to_string
awe_string* awe_jsvalue_to_string(const(awe_jsvalue)* jsvalue)

Get the value as a string.

awe_renderbuffer_copy_to
void awe_renderbuffer_copy_to(const(awe_renderbuffer)* renderbuffer, ubyte* dest_buffer, int dest_rowspan, int dest_depth, bool convert_to_rgba, bool flip_y)

Copy a RenderBuffer to a specific destination with the same dimensions.

awe_renderbuffer_copy_to_float
void awe_renderbuffer_copy_to_float(const(awe_renderbuffer)* renderbuffer, float* dest_buffer)

Copy a RenderBuffer to a pixel buffer with a floating-point pixel format for use with game engines like Unity3D.

awe_renderbuffer_flush_alpha
void awe_renderbuffer_flush_alpha(const(awe_renderbuffer)* renderbuffer)

Sets the alpha channel to completely opaque values.

awe_renderbuffer_get_alpha_at_point
ubyte awe_renderbuffer_get_alpha_at_point(const(awe_renderbuffer)* renderbuffer, int x, int y)

Get the alpha value at a certain point (origin is top-left). This is useful for alpha-picking.

awe_renderbuffer_get_buffer
const(ubyte)* awe_renderbuffer_get_buffer(const(awe_renderbuffer)* renderbuffer)

Get a pointer to the actual pixel buffer within a RenderBuffer.

awe_renderbuffer_get_height
int awe_renderbuffer_get_height(const(awe_renderbuffer)* renderbuffer)

Get the height (in pixels) of a RenderBuffer.

awe_renderbuffer_get_rowspan
int awe_renderbuffer_get_rowspan(const(awe_renderbuffer)* renderbuffer)

Get the rowspan (number of bytes per row) of a RenderBuffer.

awe_renderbuffer_get_width
int awe_renderbuffer_get_width(const(awe_renderbuffer)* renderbuffer)

Get the width (in pixels) of a RenderBuffer.

awe_renderbuffer_save_to_jpeg
bool awe_renderbuffer_save_to_jpeg(const(awe_renderbuffer)* renderbuffer, const(awe_string)* file_path, int quality)

Save a copy of this RenderBuffer to a JPEG image file with quality 1 to 100.

awe_renderbuffer_save_to_png
bool awe_renderbuffer_save_to_png(const(awe_renderbuffer)* renderbuffer, const(awe_string)* file_path, bool preserve_transparency)

Save a copy of this RenderBuffer to a PNG image file.

awe_resource_request_append_extra_header
void awe_resource_request_append_extra_header(awe_resource_request* request, const(awe_string)* name, const(awe_string)* value)

Append an extra header to the request.

awe_resource_request_append_upload_bytes
void awe_resource_request_append_upload_bytes(awe_resource_request* request, const(awe_string)* bytes)

Append a string of bytes for POST data (adds a new UploadElement)

awe_resource_request_append_upload_file_path
void awe_resource_request_append_upload_file_path(awe_resource_request* request, const(awe_string)* file_path)

Append a file for POST data (adds a new UploadElement)

awe_resource_request_cancel
void awe_resource_request_cancel(awe_resource_request* request)

* Resource Request * ************************/ /// Cancel the request (this is useful for blocking a resource load)

awe_resource_request_clear_upload_elements
void awe_resource_request_clear_upload_elements(awe_resource_request* request)

Clear all upload elements

awe_resource_request_get_extra_headers
awe_string* awe_resource_request_get_extra_headers(awe_resource_request* request)

Get extra headers for the request (You must destroy returned string)

awe_resource_request_get_method
awe_string* awe_resource_request_get_method(awe_resource_request* request)

Get the HTTP method (usually "GET" or "POST") (You must destroy returned string)

awe_resource_request_get_num_upload_elements
size_t awe_resource_request_get_num_upload_elements(awe_resource_request* request)

Get the number of upload elements (essentially, batches of POST data).

awe_resource_request_get_referrer
awe_string* awe_resource_request_get_referrer(awe_resource_request* request)

Get the referrer (You must destroy returned string)

awe_resource_request_get_upload_element
const(awe_upload_element)* awe_resource_request_get_upload_element(awe_resource_request* request, size_t idx)

Get a certain upload element (returned instance is owned by this class)

awe_resource_request_get_url
awe_string* awe_resource_request_get_url(awe_resource_request* request)

Get the URL associated with this request. (You must destroy returned string)

awe_resource_request_set_extra_headers
void awe_resource_request_set_extra_headers(awe_resource_request* request, const(awe_string)* headers)

Override extra headers for the request, delimited by /r/n (CRLF).

awe_resource_request_set_method
void awe_resource_request_set_method(awe_resource_request* request, const(awe_string)* method)

Set the HTTP method

awe_resource_request_set_referrer
void awe_resource_request_set_referrer(awe_resource_request* request, const(awe_string)* referrer)

Set the referrer

awe_resource_response_create
awe_resource_response* awe_resource_response_create(size_t num_bytes, ubyte* buffer, const(awe_string)* mime_type)

Create a ResourceResponse from a raw block of data. (Buffer is copied)

awe_resource_response_create_from_file
awe_resource_response* awe_resource_response_create_from_file(const(awe_string)* file_path)

Create a ResourceResponse from a file on disk.

awe_string_create_from_ascii
awe_string* awe_string_create_from_ascii(const(char)* str, size_t len)

Create a string from an ASCII string. You must call awe_string_destroy with the returned instance once you're done using it.

awe_string_create_from_utf16
awe_string* awe_string_create_from_utf16(const(wchar16)* str, size_t len)

Create a string from a UTF-16 string. You must call awe_string_destroy with the returned instance once you're done using it.

awe_string_create_from_utf8
awe_string* awe_string_create_from_utf8(const(char)* str, size_t len)

Create a string from a UTF-8 string. You must call awe_string_destroy with the returned instance once you're done using it.

awe_string_create_from_wide
awe_string* awe_string_create_from_wide(const(wchar_t)* str, size_t len)

Create a string from a Wide string. You must call awe_string_destroy with the returned instance once you're done using it.

awe_string_destroy
void awe_string_destroy(awe_string* str)

Destroys a string instance created with one of the above functions.

awe_string_empty
const(awe_string)* awe_string_empty()

Get an instance of an empty string. This is a convenience method to quickly pass an empty string to the C API-- you should not destroy this string yourself.

awe_string_get_length
size_t awe_string_get_length(const(awe_string)* str)

Gets the length of a string.

awe_string_get_utf16
const(wchar16)* awe_string_get_utf16(const(awe_string)* str)

Get a pointer to the actual internal UTF-16 bytes of a string.

awe_string_to_utf8
int awe_string_to_utf8(const(awe_string)* str, char* dest, size_t len)

Converts a string to a UTF-8 string by copying to the destination buffer.

awe_string_to_wide
int awe_string_to_wide(const(awe_string)* str, wchar_t* dest, size_t len)

Converts a string to a wide string by copying to the destination buffer.

awe_upload_element_get_bytes
awe_string* awe_upload_element_get_bytes(const(awe_upload_element)* ele)

Get the string of bytes associated with this UploadElement (You must destroy returned string)

awe_upload_element_get_file_path
awe_string* awe_upload_element_get_file_path(const(awe_upload_element)* ele)

Get the file path associated with this UploadElement (You must destroy returned string)

awe_upload_element_is_bytes
bool awe_upload_element_is_bytes(const(awe_upload_element)* ele)

Whether or not this UploadElement is a string of bytes

awe_upload_element_is_file_path
bool awe_upload_element_is_file_path(const(awe_upload_element)* ele)

* Upload Element * ************************/ /// Whether or not this UploadElement is a fil

awe_webcore_are_plugins_enabled
bool awe_webcore_are_plugins_enabled()

Returns whether or not plugins are enabled.

awe_webcore_clear_cache
void awe_webcore_clear_cache()

Clear the disk cache and media cache.

awe_webcore_clear_cookies
void awe_webcore_clear_cookies()

Clear all cookies.

awe_webcore_create_webview
awe_webview* awe_webcore_create_webview(int width, int height, bool view_source)

Creates a new WebView.

awe_webcore_delete_cookie
void awe_webcore_delete_cookie(const(awe_string)* url, const(awe_string)* cookie_name)

Deletes a certain cookie on a certain URL.

awe_webcore_get_base_directory
const(awe_string)* awe_webcore_get_base_directory()

Retrieves the base directory.

awe_webcore_get_cookies
const(awe_string)* awe_webcore_get_cookies(const(awe_string)* url, bool exclude_http_only)

Gets all cookies for a certain URL.

awe_webcore_initialize
void awe_webcore_initialize(bool enable_plugins, bool enable_javascript, bool enable_databases, const(awe_string)* package_path, const(awe_string)* locale_path, const(awe_string)* user_data_path, const(awe_string)* plugin_path, const(awe_string)* log_path, awe_loglevel log_level, bool force_single_process, const(awe_string)* child_process_path, bool enable_auto_detect_encoding, const(awe_string)* accept_language_override, const(awe_string)* default_charset_override, const(awe_string)* user_agent_override, const(awe_string)* proxy_server, const(awe_string)* proxy_config_script, const(awe_string)* auth_server_whitelist, bool save_cache_and_cookies, int max_cache_size, bool disable_same_origin_policy, bool disable_win_message_pump, const(awe_string)* custom_css)

Instantiates the WebCore singleton with a set of configuration parameters.

awe_webcore_initialize_default
void awe_webcore_initialize_default()

Instantiates the WebCore singleton with the default parameters specified in the method above.

awe_webcore_query_history
awe_history_query_result* awe_webcore_query_history(const(awe_string)* full_text_query, int num_days_ago, int max_count)

Query the on-disk history database.

awe_webcore_set_base_directory
void awe_webcore_set_base_directory(const(awe_string)* base_dir_path)

Sets the base directory.

awe_webcore_set_cookie
void awe_webcore_set_cookie(const(awe_string)* url, const(awe_string)* cookie_string, bool is_http_only, bool force_session_cookie)

Sets a cookie for a certain URL.

awe_webcore_set_custom_response_page
void awe_webcore_set_custom_response_page(int status_code, const(awe_string)* file_path)

Sets a custom response page to use when a WebView encounters a certain HTML status code from the server (like '404 - File not found').

awe_webcore_set_suppress_printer_dialog
void awe_webcore_set_suppress_printer_dialog(bool suppress)

Set whether or not the printer dialog should be suppressed or not. Set this to "true" to hide printer dialogs and print immediately using the OS's default printer when WebView::print is called. Default is "false" if you never call this.

awe_webcore_shutdown
void awe_webcore_shutdown()

Destroys the WebCore singleton and destroys any remaining WebViews.

awe_webcore_update
void awe_webcore_update()

Updates the WebCore and allows it to conduct various operations such as updating the render buffer of each WebView, destroying any WebViews that are queued for destruction, and invoking any queued callback events.

awe_webview_activate_ime
void awe_webview_activate_ime(awe_webview* webview, bool activate)

Call this method to let the WebView know you will be passing text input via IME and will need to be notified of any IME-related events (caret position, user unfocusing textbox, etc.) Please see awe_webview_set_callback_update_ime

awe_webview_add_header_rewrite_rule
void awe_webview_add_header_rewrite_rule(awe_webview* webview, const(awe_string)* rule, const(awe_string)* name)

Adds a new a header re-write rule. All requests whose URL matches the specified rule will have its HTTP headers re-written with the specified header definition before sending it to the server.

awe_webview_add_url_filter
void awe_webview_add_url_filter(awe_webview* webview, const(awe_string)* filter)

Adds a new URL Filter rule.

awe_webview_call_javascript_function
void awe_webview_call_javascript_function(awe_webview* webview, const(awe_string)* object, const(awe_string)* function_, const(awe_jsarray)* arguments, const(awe_string)* frame_name)

Call a certain function defined in Javascript directly.

awe_webview_cancel_ime_composition
void awe_webview_cancel_ime_composition(awe_webview* webview)

Cancel a current IME text composition.

awe_webview_cancel_login
void awe_webview_cancel_login(awe_webview* webview, int request_id)

Respond to the "request login" callback by telling the server that the user cancelled the authentication request.

awe_webview_choose_file
void awe_webview_choose_file(awe_webview* webview, const(awe_string)* file_path)

This should be called as a response to the request file chooser callback.

awe_webview_clear_all_url_filters
void awe_webview_clear_all_url_filters(awe_webview* webview)

Clears all URL Filter rules.

awe_webview_close_javascript_dialog
void awe_webview_close_javascript_dialog(awe_webview* webview, int request_id, bool was_cancelled, const(awe_string)* prompt_text)

Respond to the "show javascript dialog" callback.

awe_webview_confirm_ime_composition
void awe_webview_confirm_ime_composition(awe_webview* webview, const(awe_string)* input_string)

Confirm a current IME text composition.

awe_webview_copy
void awe_webview_copy(awe_webview* webview)

Invokes a 'copy' action using the system clipboard.

awe_webview_copy_image_at
void awe_webview_copy_image_at(awe_webview* webview, int x, int y)

Copies an image on the page to the system clipboard.

awe_webview_create_object
void awe_webview_create_object(awe_webview* webview, const(awe_string)* object_name)

Creates a new global Javascript object that will persist throughout the lifetime of this WebView. This object is managed directly by Awesomium and so you can modify its properties and bind callback functions via awe_webview_set_object_property() and awe_webview_set_object_callback(), respectively.

awe_webview_cut
void awe_webview_cut(awe_webview* webview)

Invokes a 'cut' action using the system clipboard.

awe_webview_destroy
void awe_webview_destroy(awe_webview* webview)

Queue a WebView for destruction by the WebCore.

awe_webview_destroy_object
void awe_webview_destroy_object(awe_webview* webview, const(awe_string)* object_name)

Destroys a Javascript object previously created by awe_webview_create_object

awe_webview_execute_javascript
void awe_webview_execute_javascript(awe_webview* webview, const(awe_string)* javascript, const(awe_string)* frame_name)

Executes a string of Javascript in the context of the current page asynchronously.

awe_webview_execute_javascript_with_result
awe_jsvalue* awe_webview_execute_javascript_with_result(awe_webview* webview, const(awe_string)* javascript, const(awe_string)* frame_name, int timeout_ms)

Executes a string of Javascript in the context of the current page asynchronously with a result.

awe_webview_find
void awe_webview_find(awe_webview* webview, int request_id, const(awe_string)* search_string, bool forward, bool case_sensitive, bool find_next)

Start finding a certain string on the current web-page. All matches of the string will be highlighted on the page and you can jump to different instances of the string by using the 'findNext' parameter. To get actual stats about a certain query, please see awe_webview_set_callback_get_find_results.

awe_webview_focus
void awe_webview_focus(awe_webview* webview)

Notifies the current page that is has gained focus. You will need to call this to gain textbox focus, among other things. (If you fail to ever see a blinking caret when typing text, this is why).

awe_webview_get_dirty_bounds
awe_rect awe_webview_get_dirty_bounds(awe_webview* webview)

Returns the bounds of the area that has changed since the last call to awe_webview_render.

awe_webview_get_history_back_count
int awe_webview_get_history_back_count(awe_webview* webview)

Get the number of steps back in history we can go.

awe_webview_get_history_forward_count
int awe_webview_get_history_forward_count(awe_webview* webview)

Get the number of steps forward in history we can go.

awe_webview_get_zoom
int awe_webview_get_zoom(awe_webview* webview)

Gets the current zoom level.

awe_webview_get_zoom_for_host
int awe_webview_get_zoom_for_host(awe_webview* webview, const(awe_string)* host)

Gets the zoom level for a specific hostname.

awe_webview_go_to_history_offset
void awe_webview_go_to_history_offset(awe_webview* webview, int offset)

Navigates back/forward in history via a relative offset.

awe_webview_inject_keyboard_event
void awe_webview_inject_keyboard_event(awe_webview* webview, awe_webkeyboardevent key_event)

Injects a keyboard event. You'll need to initialize the members of awe_webkeyboardevent yourself.

awe_webview_inject_keyboard_event_win
void awe_webview_inject_keyboard_event_win(awe_webview* webview, UINT msg, WPARAM wparam, LPARAM lparam)

Injects a native Windows keyboard event.

awe_webview_inject_mouse_down
void awe_webview_inject_mouse_down(awe_webview* webview, awe_mousebutton button)

Injects a mouse-down event.

awe_webview_inject_mouse_move
void awe_webview_inject_mouse_move(awe_webview* webview, int x, int y)

Injects a mouse-move event in local coordinates.

awe_webview_inject_mouse_up
void awe_webview_inject_mouse_up(awe_webview* webview, awe_mousebutton button)

Injects a mouse-up event.

awe_webview_inject_mouse_wheel
void awe_webview_inject_mouse_wheel(awe_webview* webview, int scroll_amount_vert, int scroll_amount_horz)

Injects a mouse-wheel event.

awe_webview_is_dirty
bool awe_webview_is_dirty(awe_webview* webview)

Returns whether or not the WebView is dirty and needs to be re-rendered via awe_webview_render.

awe_webview_is_loading_page
bool awe_webview_is_loading_page(awe_webview* webview)

Returns whether or not a page is currently loading in the WebView.

awe_webview_is_resizing
bool awe_webview_is_resizing(awe_webview* webview)

Checks whether or not there is a resize operation pending. * @return Returns true if we are waiting for the WebView process to return acknowledgement of a pending resize operation.

awe_webview_load_file
void awe_webview_load_file(awe_webview* webview, const(awe_string)* file, const(awe_string)* frame_name)

Loads a local file into the WebView asynchronously.

awe_webview_load_html
void awe_webview_load_html(awe_webview* webview, const(awe_string)* html, const(awe_string)* frame_name)

Loads a string of HTML into the WebView asynchronously.

awe_webview_load_url
void awe_webview_load_url(awe_webview* webview, const(awe_string)* url, const(awe_string)* frame_name, const(awe_string)* username, const(awe_string)* password)

Loads a URL into the WebView asynchronously.

awe_webview_login
void awe_webview_login(awe_webview* webview, int request_id, const(awe_string)* username, const(awe_string)* password)

Respond to the "request login" callback with some user-supplied credentials.

awe_webview_paste
void awe_webview_paste(awe_webview* webview)

Invokes a 'paste' action using the system clipboard.

awe_webview_pause_rendering
void awe_webview_pause_rendering(awe_webview* webview)

All rendering is actually done asynchronously in a separate process and so the page is usually continuously rendering even if you never call awe_webview_render. Call this to temporarily pause rendering.

awe_webview_print
void awe_webview_print(awe_webview* webview)

Print the current page. To suppress the printer selection dialog and print immediately using the operating system's defaults, see awe_webcore_set_suppress_printer_dialog.

awe_webview_reload
void awe_webview_reload(awe_webview* webview)

Reloads the current page.

awe_webview_remove_header_rewrite_rule
void awe_webview_remove_header_rewrite_rule(awe_webview* webview, const(awe_string)* rule)

Removes a header re-write rule from this WebView.

awe_webview_remove_header_rewrite_rules_by_definition_name
void awe_webview_remove_header_rewrite_rules_by_definition_name(awe_webview* webview, const(awe_string)* name)

Removes all header re-write rules that are using a certain header definition.

awe_webview_render
const(awe_renderbuffer)* awe_webview_render(awe_webview* webview)

Renders this WebView into an offscreen render buffer and clears the dirty state.

awe_webview_request_scroll_data
void awe_webview_request_scroll_data(awe_webview* webview, const(awe_string)* frame_name)

Request the page dimensions and scroll position of the page. You can retrieve the response via the get scroll data callback.

awe_webview_reset_zoom
void awe_webview_reset_zoom(awe_webview* webview)

Resets the zoom level.

awe_webview_resize
bool awe_webview_resize(awe_webview* webview, int width, int height, bool wait_for_repaint, int repaint_timeout_ms)

Resizes this WebView to certain dimensions.

awe_webview_resume_rendering
void awe_webview_resume_rendering(awe_webview* webview)

Resume rendering after all call to awe_webview_pause_rendering.

awe_webview_select_all
void awe_webview_select_all(awe_webview* webview)

Selects all items on the current page.

awe_webview_set_callback_begin_loading
void awe_webview_set_callback_begin_loading(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* url, const(awe_string)* frame_name, int status_code, const(awe_string)* mime_type) callback)

Assign a callback function to be notified when a WebView begins to actually receive data from a server.

awe_webview_set_callback_begin_navigation
void awe_webview_set_callback_begin_navigation(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* url, const(awe_string)* frame_name) callback)

Assign a callback function to be notified when a WebView begins navigation to a certain URL.

awe_webview_set_callback_change_cursor
void awe_webview_set_callback_change_cursor(awe_webview* webview, void function(awe_webview* caller, awe_cursor_type cursor) callback)

Assign a callback function to be notified when a cursor has changed state.

awe_webview_set_callback_change_history
void awe_webview_set_callback_change_history(awe_webview* webview, void function(awe_webview* caller, int back_count, int forward_count) callback)

Assign a callback function to be notified whenever the history state has changed. (eg, the state of thie back/forward buttons should be updated)

awe_webview_set_callback_change_keyboard_focus
void awe_webview_set_callback_change_keyboard_focus(awe_webview* webview, void function(awe_webview* caller, bool is_focused) callback)

Assign a callback function to be notified when keyboard focus has changed.

awe_webview_set_callback_change_target_url
void awe_webview_set_callback_change_target_url(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* url) callback)

Assign a callback function to be notified when the target URL has changed. This is usually the result of hovering over a link on the page.

awe_webview_set_callback_change_tooltip
void awe_webview_set_callback_change_tooltip(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* tooltip) callback)

Assign a callback function to be notified when a tooltip has changed state.

awe_webview_set_callback_dom_ready
void awe_webview_set_callback_dom_ready(awe_webview* webview, void function(awe_webview* caller) callback)

Assign a callback function to be notified once the DOM (Document Object Model) for a page is ready. This is very useful for executing Javascript on a page before its content has finished loading.

awe_webview_set_callback_finish_loading
void awe_webview_set_callback_finish_loading(awe_webview* webview, void function(awe_webview* caller) callback)

Assign a callback function to be notified when a WebView has finished all loads.

awe_webview_set_callback_finish_resize
void awe_webview_set_callback_finish_resize(awe_webview* webview, void function(awe_webview* caller, int width, int height) callback)

Assign a callback function to be notified whenever a WebView has finished resizing to a certain size (and has finished repainting the RenderBuffer).

awe_webview_set_callback_get_find_results
void awe_webview_set_callback_get_find_results(awe_webview* webview, void function(awe_webview* caller, int request_id, int num_matches, awe_rect selection, int cur_match, bool finalUpdate) callback)

Assign a callback function to be notified whenever we receive results back from an in-page find operation (awe_webview_find).

awe_webview_set_callback_get_page_contents
void awe_webview_set_callback_get_page_contents(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* url, const(awe_string)* contents) callback)

Assign a callback function to be notified when the contents of the page has finished loading. This occurs at the end of most page loads.

awe_webview_set_callback_get_scroll_data
void awe_webview_set_callback_get_scroll_data(awe_webview* webview, void function(awe_webview* caller, int contentWidth, int contentHeight, int preferredWidth, int scrollX, int scrollY) callback)

Assign a callback function to be notified of a response to awe_webview_request_scroll_data.

awe_webview_set_callback_js_callback
void awe_webview_set_callback_js_callback(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* object_name, const(awe_string)* callback_name, const(awe_jsarray)* arguments) callback)

Assign a callback function to be notified when a Javascript object callback has been invoked on a page.

awe_webview_set_callback_js_console_message
void awe_webview_set_callback_js_console_message(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* message, int line_number, const(awe_string)* source) callback)

Assign a callback function to be notified of any Javascript console messages. (Usually Javascript errors encountered in scripts)

awe_webview_set_callback_open_external_link
void awe_webview_set_callback_open_external_link(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* url, const(awe_string)* source) callback)

Assign a callback function to be notified when an external link is attempted to be opened. An external link is any link that normally opens in a new window in a standard browser (for example, links with target="_blank", calls to window.open(url), and URL open events from Flash plugins).

awe_webview_set_callback_plugin_crashed
void awe_webview_set_callback_plugin_crashed(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* plugin_name) callback)

Assign a callback function to be notified when when the renderer for a certain plugin (usually Flash, which is isolated in a separate process) crashes unexpectedly.

awe_webview_set_callback_receive_title
void awe_webview_set_callback_receive_title(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* title, const(awe_string)* frame_name) callback)

Assign a callback function to be notified when a page title is received.

awe_webview_set_callback_request_download
void awe_webview_set_callback_request_download(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* download) callback)

Assign a callback function to be notified when a page requests for a certain URL to be downloaded by the user.

awe_webview_set_callback_request_file_chooser
void awe_webview_set_callback_request_file_chooser(awe_webview* webview, void function(awe_webview* caller, bool select_multiple_files, const(awe_string)* title, const(awe_string)* default_path) callback)

Assign a callback function to be notified whenever a page requests a file chooser dialog to be displayed (usually the result of an "input" element with type "file" being clicked by a user). You will need to display your own dialog (it does not have to be modal, this request does not block). Once a file has been chosen by the user, awe_webview_choose_file or awe_webview_choose_multiple_files should be called.

awe_webview_set_callback_request_login
void awe_webview_set_callback_request_login(awe_webview* webview, void function(awe_webview* caller, int request_id, const(awe_string)* request_url, bool is_proxy, const(awe_string)* host_and_port, const(awe_string)* scheme, const(awe_string)* realm) callback)

Assign a callback function to be notified whenever a page requests authentication from the user (ex, Basic HTTP Auth, NTLM Auth, etc.). See awe_webview_login and awe_webview_cancel_login

awe_webview_set_callback_request_move
void awe_webview_set_callback_request_move(awe_webview* webview, void function(awe_webview* caller, int x, int y) callback)

Assign a callback function to be notified when the page requests for the containing window to be moved to a certain location on the screen.

awe_webview_set_callback_resource_request
void awe_webview_set_callback_resource_request(awe_webview* webview, awe_resource_response* function(awe_webview* caller, awe_resource_request* request) callback)

Assign a callback function to intercept requests for resources. You can use this to modify requests before they are sent, respond to requests using your own custom resource-loading back-end, or to monitor requests for tracking purposes.

awe_webview_set_callback_resource_response
void awe_webview_set_callback_resource_response(awe_webview* webview, void function(awe_webview* caller, const(awe_string)* url, int status_code, bool was_cached, int64 request_time_ms, int64 response_time_ms, int64 expected_content_size, const(awe_string)* mime_type) callback)

Assign a callback function to intercept responses to requests. You can use this for tracking/statistic purposes.

awe_webview_set_callback_show_context_menu
void awe_webview_set_callback_show_context_menu(awe_webview* webview, void function(awe_webview* caller, int mouse_x, int mouse_y, awe_media_type type, int media_state, const(awe_string)* link_url, const(awe_string)* src_url, const(awe_string)* page_url, const(awe_string)* frame_url, const(awe_string)* selection_text, bool is_editable, int edit_flags) callback)

Assign a callback function to be notified whenever the page requests a context menu to be shown (usually the result of a user right-clicking somewhere on the page). It is your responsiblity to display a menu for the user to select an appropriate action.

awe_webview_set_callback_show_javascript_dialog
void awe_webview_set_callback_show_javascript_dialog(awe_webview* webview, void function(awe_webview* caller, int request_id, int dialog_flags, const(awe_string)* message, const(awe_string)* default_prompt, const(awe_string)* frame_url) callback)

Assign a callback function to be notified whenever a WebView requests that a certain Javascript dialog be shown (eg, alert, confirm, prompt). See awe_webview_close_javascript_dialog for more information.

awe_webview_set_callback_update_ime
void awe_webview_set_callback_update_ime(awe_webview* webview, void function(awe_webview* caller, awe_ime_state state, awe_rect caret_rect) callback)

Assign a callback function to be notified whenever the user does something that may change the position or visiblity of the IME Widget. This callback is only active when IME is activated (please see awe_webview_activate_ime).

awe_webview_set_callback_web_view_crashed
void awe_webview_set_callback_web_view_crashed(awe_webview* webview, void function(awe_webview* caller) callback)

Assign a callback function to be notified when the renderer for a certain WebView (which is isolated in a separate process) crashes unexpectedly.

awe_webview_set_header_definition
void awe_webview_set_header_definition(awe_webview* webview, const(awe_string)* name, size_t num_fields, const(awe_string*)* field_names, const(awe_string*)* field_values)

Defines a new Header Definition or updates it if it already exists.

awe_webview_set_ime_composition
void awe_webview_set_ime_composition(awe_webview* webview, const(awe_string)* input_string, int cursor_pos, int target_start, int target_end)

Update the current IME text composition.

awe_webview_set_object_callback
void awe_webview_set_object_callback(awe_webview* webview, const(awe_string)* object_name, const(awe_string)* callback_name)

Sets a callback function of a Javascript object previously created by awe_webview_create_object(). This is very useful for passing events from Javascript to C. To receive notification of the callback, please see awe_webview_set_callback_js_callback().

awe_webview_set_object_property
void awe_webview_set_object_property(awe_webview* webview, const(awe_string)* object_name, const(awe_string)* property_name, const(awe_jsvalue)* value)

Sets a property of a Javascript object previously created by awe_webview_create_object().

awe_webview_set_transparent
void awe_webview_set_transparent(awe_webview* webview, bool is_transparent)

Sets whether or not pages should be rendered with transparency preserved. (ex, for pages with style="background-color:transparent")

awe_webview_set_url_filtering_mode
void awe_webview_set_url_filtering_mode(awe_webview* webview, awe_url_filtering_mode mode)

Sets the current URL Filtering Mode (default is AWE_UFM_NONE). See awe_url_filtering_mode for more information on the modes.

awe_webview_set_zoom
void awe_webview_set_zoom(awe_webview* webview, int zoom_percent)

Zooms the page a specified percent.

awe_webview_stop
void awe_webview_stop(awe_webview* webview)

Stops the current navigation.

awe_webview_stop_find
void awe_webview_stop_find(awe_webview* webview, bool clear_selection)

Stop finding. This will un-highlight all matches of a previous call to awe_webview_find.

awe_webview_translate_page
void awe_webview_translate_page(awe_webview* webview, const(awe_string)* source_language, const(awe_string)* target_language)

Attempt automatic translation of the current page via Google Translate. All language codes are ISO 639-2.

awe_webview_unfocus
void awe_webview_unfocus(awe_webview* webview)

Notifies the current page that it has lost focus.

Structs

awe_header_definition
struct awe_header_definition

HeaderDefinition instance

awe_history_entry
struct awe_history_entry

HistoryEntry instance

awe_history_query_result
struct awe_history_query_result

HistoryQueryResult instance

awe_jsarray
struct awe_jsarray

JSArray instance

awe_jsobject
struct awe_jsobject

JSObject instance

awe_jsvalue
struct awe_jsvalue

JSValue instance

awe_renderbuffer
struct awe_renderbuffer

RenderBuffer instance, owned by the WebView

awe_resource_request
struct awe_resource_request

ResourceRequest instance

awe_resource_response
struct awe_resource_response

ResourceResponse instance

awe_string
struct awe_string

String instance

awe_upload_element
struct awe_upload_element

UploadElement instance

awe_webview
struct awe_webview

WebView instance

Meta