| Name |
Description |
awe_child_process_main
|
|
awe_history_entry_destroy
|
History Entry *
|
awe_history_entry_get_title
|
Get the title of the page
|
awe_history_entry_get_url
|
Get the URL of the page
|
awe_history_entry_get_visit_count
|
Get the number of times this page was visited.
|
awe_history_entry_get_visit_time
|
Get the last time this page was visited (in seconds since epoch)
|
awe_history_query_result_destroy
|
History Query Result *
|
awe_history_query_result_get_entry_at_index
|
Get a certain entry (you must destroy any returned entry using awe_history_entry_destroy).
|
awe_history_query_result_get_size
|
Get the total number of entries
|
awe_is_child_process
|
|
awe_jsarray_create
|
JS Value Array Functions *
|
awe_jsarray_destroy
|
Destroys a JSValue Array created with awe_jsarray_create.
|
awe_jsarray_get_element
|
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
|
Get the size of a JSValue Array.
|
awe_jsobject_create
|
JS Value Object Functions *
|
awe_jsobject_destroy
|
Destroys a JSValue Object created with awe_jsobject_create
|
awe_jsobject_get_keys
|
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
|
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
|
Get the number of key/value pairs in a JSValue object.
|
awe_jsobject_has_property
|
Returns whether or not a JSValue Object has a certained named property.
|
awe_jsobject_set_property
|
Sets the value of a certained named property of a JSValue Object.
|
awe_jsvalue_create_array_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
|
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
|
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
|
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
|
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
|
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
|
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
|
Destroys a JSValue instance.
|
awe_jsvalue_get_array
|
Returns this value as an array. Will throw an exception if not an array.
|
awe_jsvalue_get_object
|
Returns this value as an object. Will throw an exception if not an object.
|
awe_jsvalue_get_type
|
Get the type of a JSValue.
|
awe_jsvalue_to_boolean
|
Returns this value as an boolean.
|
awe_jsvalue_to_double
|
Returns this value as an double.
|
awe_jsvalue_to_integer
|
Returns this value as an integer.
|
awe_jsvalue_to_string
|
Get the value as a string.
|
awe_renderbuffer_copy_to
|
Copy a RenderBuffer to a specific destination with the same dimensions.
|
awe_renderbuffer_copy_to_float
|
Copy a RenderBuffer to a pixel buffer with a floating-point pixel format
for use with game engines like Unity3D.
|
awe_renderbuffer_flush_alpha
|
Sets the alpha channel to completely opaque values.
|
awe_renderbuffer_get_alpha_at_point
|
Get the alpha value at a certain point (origin is top-left). This is
useful for alpha-picking.
|
awe_renderbuffer_get_buffer
|
Get a pointer to the actual pixel buffer within a RenderBuffer.
|
awe_renderbuffer_get_height
|
Get the height (in pixels) of a RenderBuffer.
|
awe_renderbuffer_get_rowspan
|
Get the rowspan (number of bytes per row) of a RenderBuffer.
|
awe_renderbuffer_get_width
|
Render Buffer Functions *
|
awe_renderbuffer_save_to_jpeg
|
Save a copy of this RenderBuffer to a JPEG image file with quality 1 to 100.
|
awe_renderbuffer_save_to_png
|
Save a copy of this RenderBuffer to a PNG image file.
|
|
|
Append an extra header to the request.
|
awe_resource_request_append_upload_bytes
|
Append a string of bytes for POST data (adds a new UploadElement)
|
awe_resource_request_append_upload_file_path
|
Append a file for POST data (adds a new UploadElement)
|
awe_resource_request_cancel
|
Resource Request *
|
awe_resource_request_clear_upload_elements
|
Clear all upload elements
|
|
|
Get extra headers for the request (You must destroy returned string)
|
awe_resource_request_get_method
|
Get the HTTP method (usually "GET" or "POST") (You must destroy returned string)
|
awe_resource_request_get_num_upload_elements
|
Get the number of upload elements (essentially, batches of POST data).
|
awe_resource_request_get_referrer
|
Get the referrer (You must destroy returned string)
|
awe_resource_request_get_upload_element
|
Get a certain upload element (returned instance is owned by this class)
|
awe_resource_request_get_url
|
Get the URL associated with this request. (You must destroy returned string)
|
|
|
Override extra headers for the request, delimited by /r/n (CRLF).
|
awe_resource_request_set_method
|
Set the HTTP method
|
awe_resource_request_set_referrer
|
Set the referrer
|
awe_resource_response_create
|
Create a ResourceResponse from a raw block of data. (Buffer is copied)
|
awe_resource_response_create_from_file
|
Create a ResourceResponse from a file on disk.
|
awe_string_create_from_ascii
|
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
|
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
|
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
|
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
|
Destroys a string instance created with one of the above functions.
|
awe_string_empty
|
UTF-16 String Definitions *
|
awe_string_get_length
|
Gets the length of a string.
|
awe_string_get_utf16
|
Get a pointer to the actual internal UTF-16 bytes of a string.
|
awe_string_to_utf8
|
Converts a string to a UTF-8 string by copying to the destination buffer.
|
awe_string_to_wide
|
Converts a string to a wide string by copying to the destination buffer.
|
awe_upload_element_get_bytes
|
Get the string of bytes associated with this UploadElement (You must destroy returned string)
|
awe_upload_element_get_file_path
|
Get the file path associated with this UploadElement (You must destroy returned string)
|
awe_upload_element_is_bytes
|
Whether or not this UploadElement is a string of bytes
|
awe_upload_element_is_file_path
|
Upload Element *
|
awe_webcore_are_plugins_enabled
|
Returns whether or not plugins are enabled.
|
awe_webcore_clear_cache
|
Clear the disk cache and media cache.
|
awe_webcore_clear_cookies
|
Clear all cookies.
|
awe_webcore_create_webview
|
Creates a new WebView.
|
awe_webcore_delete_cookie
|
Deletes a certain cookie on a certain URL.
|
awe_webcore_get_base_directory
|
Retrieves the base directory.
|
awe_webcore_get_cookies
|
Gets all cookies for a certain URL.
|
awe_webcore_initialize
|
Web Core Functions *
|
awe_webcore_initialize_default
|
Instantiates the WebCore singleton with the default parameters
specified in the method above.
|
awe_webcore_query_history
|
Query the on-disk history database.
|
awe_webcore_set_base_directory
|
Sets the base directory.
|
awe_webcore_set_cookie
|
Sets a cookie for a certain URL.
|
awe_webcore_set_custom_response_page
|
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
|
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
|
Destroys the WebCore singleton and destroys any remaining WebViews.
|
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
|
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
|
|
|
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
|
Adds a new URL Filter rule.
|
awe_webview_call_javascript_function
|
Call a certain function defined in Javascript directly.
|
awe_webview_cancel_ime_composition
|
Cancel a current IME text composition.
|
awe_webview_cancel_login
|
Respond to the "request login" callback by telling the
server that the user cancelled the authentication request.
|
awe_webview_choose_file
|
This should be called as a response to the request file chooser callback.
|
awe_webview_clear_all_url_filters
|
Clears all URL Filter rules.
|
awe_webview_close_javascript_dialog
|
Respond to the "show javascript dialog" callback.
|
awe_webview_confirm_ime_composition
|
Confirm a current IME text composition.
|
awe_webview_copy
|
Invokes a 'copy' action using the system clipboard.
|
awe_webview_copy_image_at
|
Copies an image on the page to the system clipboard.
|
awe_webview_create_object
|
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
|
Invokes a 'cut' action using the system clipboard.
|
awe_webview_destroy
|
Web View Functions *
|
awe_webview_destroy_object
|
Destroys a Javascript object previously created by
awe_webview_create_object
|
awe_webview_execute_javascript
|
Executes a string of Javascript in the context of the current page
asynchronously.
|
awe_webview_execute_javascript_with_result
|
Executes a string of Javascript in the context of the current page
asynchronously with a result.
|
awe_webview_find
|
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
|
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
|
Returns the bounds of the area that has changed since the last call
to awe_webview_render.
|
awe_webview_get_history_back_count
|
Get the number of steps back in history we can go.
|
awe_webview_get_history_forward_count
|
Get the number of steps forward in history we can go.
|
awe_webview_get_url
|
|
awe_webview_get_zoom
|
Gets the current zoom level.
|
awe_webview_get_zoom_for_host
|
Gets the zoom level for a specific hostname.
|
awe_webview_go_to_history_offset
|
Navigates back/forward in history via a relative offset.
|
awe_webview_inject_keyboard_event
|
Injects a keyboard event. You'll need to initialize the members of
awe_webkeyboardevent yourself.
|
awe_webview_inject_keyboard_event_win
|
Injects a native Windows keyboard event.
|
awe_webview_inject_mouse_down
|
Injects a mouse-down event.
|
awe_webview_inject_mouse_move
|
Injects a mouse-move event in local coordinates.
|
awe_webview_inject_mouse_up
|
Injects a mouse-up event.
|
awe_webview_inject_mouse_wheel
|
Injects a mouse-wheel event.
|
awe_webview_is_dirty
|
Returns whether or not the WebView is dirty and needs to be
re-rendered via awe_webview_render.
|
awe_webview_is_loading_page
|
Returns whether or not a page is currently loading in the WebView.
|
awe_webview_is_resizing
|
Checks whether or not there is a resize operation pending.
|
awe_webview_is_transparent
|
|
awe_webview_load_file
|
Loads a local file into the WebView asynchronously.
|
awe_webview_load_html
|
Loads a string of HTML into the WebView asynchronously.
|
awe_webview_load_url
|
Loads a URL into the WebView asynchronously.
|
awe_webview_login
|
Respond to the "request login" callback with some user-supplied
credentials.
|
awe_webview_paste
|
Invokes a 'paste' action using the system clipboard.
|
awe_webview_pause_rendering
|
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
|
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
|
Reloads the current page.
|
|
|
Removes a header re-write rule from this WebView.
|
|
|
Removes all header re-write rules that are using a certain header
definition.
|
awe_webview_render
|
Renders this WebView into an offscreen render buffer and clears the
dirty state.
|
awe_webview_request_scroll_data
|
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
|
Resets the zoom level.
|
awe_webview_resize
|
Resizes this WebView to certain dimensions.
|
awe_webview_resume_rendering
|
Resume rendering after all call to awe_webview_pause_rendering.
|
awe_webview_select_all
|
Selects all items on the current page.
|
awe_webview_set_callback_begin_loading
|
Assign a callback function to be notified when a WebView begins to actually
receive data from a server.
|
awe_webview_set_callback_begin_navigation
|
Assign a callback function to be notified when a WebView begins navigation
to a certain URL.
|
awe_webview_set_callback_change_cursor
|
Assign a callback function to be notified when a cursor has changed state.
|
awe_webview_set_callback_change_history
|
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
|
Assign a callback function to be notified when keyboard focus has changed.
|
awe_webview_set_callback_change_target_url
|
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
|
Assign a callback function to be notified when a tooltip has changed state.
|
awe_webview_set_callback_dom_ready
|
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
|
Assign a callback function to be notified when a WebView has finished
all loads.
|
awe_webview_set_callback_finish_resize
|
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
|
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
|
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
|
Assign a callback function to be notified of a response to
awe_webview_request_scroll_data.
|
awe_webview_set_callback_js_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
|
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
|
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
|
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
|
Assign a callback function to be notified when a page title is received.
|
awe_webview_set_callback_request_download
|
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
|
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
|
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
|
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
|
Resource Interceptor *
|
awe_webview_set_callback_resource_response
|
Assign a callback function to intercept responses to requests. You can use
this for tracking/statistic purposes.
|
|
|
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
|
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
|
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
|
Assign a callback function to be notified when the renderer for a certain
WebView (which is isolated in a separate process) crashes unexpectedly.
|
|
|
Defines a new Header Definition or updates it if it already exists.
|
awe_webview_set_ime_composition
|
Update the current IME text composition.
|
awe_webview_set_object_callback
|
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
|
Sets a property of a Javascript object previously created by
awe_webview_create_object().
|
awe_webview_set_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
|
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
|
Zooms the page a specified percent.
|
awe_webview_stop
|
Stops the current navigation.
|
awe_webview_stop_find
|
Stop finding. This will un-highlight all matches of a previous
call to awe_webview_find.
|
awe_webview_translate_page
|
Attempt automatic translation of the current page via Google
Translate. All language codes are ISO 639-2.
|
awe_webview_unfocus
|
Notifies the current page that it has lost focus.
|