forked from enlightenment/efl
507 lines
18 KiB
Plaintext
507 lines
18 KiB
Plaintext
type Elm_Web_Console_Message: __undefined_type;
|
|
type Elm_Web_Window_Open: __undefined_type;
|
|
type Elm_Web_Dialog_File_Selector: __undefined_type;
|
|
type Elm_Web_Dialog_Confirm: __undefined_type;
|
|
type Elm_Web_Dialog_Prompt: __undefined_type;
|
|
type Elm_Web_Dialog_Alert: __undefined_type;
|
|
|
|
enum Elm.Web.Zoom_Mode
|
|
{
|
|
[[Types of zoom available.]]
|
|
manual = 0, [[Zoom controlled normally by elm_web_zoom_set]]
|
|
auto_fit, [[Zoom until content fits in web object]]
|
|
auto_fill, [[Zoom until content fills web object]]
|
|
last [[Sentinel value to indicate end]]
|
|
}
|
|
|
|
class Elm.Web (Elm.Widget)
|
|
{
|
|
eo_prefix: elm_obj_web;
|
|
methods {
|
|
@property text_matches_highlight @virtual_pure {
|
|
set {
|
|
[[Sets whether to highlight the matched marks.
|
|
|
|
If enabled, marks set with @.text_matches_mark will be
|
|
highlighted.
|
|
]]
|
|
return: bool;
|
|
}
|
|
get {
|
|
[[Get whether highlighting marks is enabled.]]
|
|
}
|
|
values {
|
|
highlight: bool; [[Whether to highlight the marks or not.]]
|
|
}
|
|
}
|
|
@property useragent @virtual_pure {
|
|
set {
|
|
[[Change useragent of a elm_web object.]]
|
|
}
|
|
get {
|
|
[[Return current useragent of elm_web object.]]
|
|
}
|
|
values {
|
|
user_agent: const(char)*; [[String for useragent.]]
|
|
}
|
|
}
|
|
@property url @virtual_pure {
|
|
set {
|
|
[[Sets the URL for the web object.
|
|
|
|
It must be a full URL, with resource included, in the form
|
|
http://www.enlightenment.org or file:///tmp/something.html
|
|
]]
|
|
return: bool;
|
|
}
|
|
get {
|
|
[[Get the current URL for the object.
|
|
|
|
The returned string must not be freed and is guaranteed to be
|
|
stringshared.
|
|
]]
|
|
}
|
|
values {
|
|
url: const(char)*; [[The URL to set.]]
|
|
}
|
|
}
|
|
@property bg_color @virtual_pure {
|
|
set {
|
|
[[Sets the background color to be used by the web object.
|
|
|
|
This is the color that will be used by default when the
|
|
loaded page does not set it's own. Color values are
|
|
pre-multiplied.
|
|
]]
|
|
}
|
|
get {
|
|
[[Get the background color to be used by the web object.
|
|
|
|
This is the color that will be used by default when the
|
|
loaded page does not set it's own. Color values are
|
|
pre-multiplied.
|
|
]]
|
|
}
|
|
values {
|
|
r: int; [[Red component.]]
|
|
g: int; [[Green component.]]
|
|
b: int; [[Blue component.]]
|
|
a: int; [[Alpha component.]]
|
|
}
|
|
}
|
|
@property inwin_mode @virtual_pure {
|
|
set {
|
|
[[Sets the default dialogs to use an Inwin instead of a
|
|
normal window.
|
|
|
|
If set, then the default implementation for the JavaScript
|
|
dialogs and file selector will be opened in an Inwin.
|
|
Otherwise they will use a normal separated window.
|
|
]]
|
|
}
|
|
get {
|
|
[[Get whether Inwin mode is set for the current object.]]
|
|
}
|
|
values {
|
|
value: bool;
|
|
}
|
|
}
|
|
@property tab_propagate @virtual_pure {
|
|
set {
|
|
[[Sets whether to use tab propagation.
|
|
|
|
If tab propagation is enabled, whenever the user presses the
|
|
Tab key, Elementary will handle it and switch focus to the
|
|
next widget. The default value is disabled, where WebKit
|
|
will handle the Tab key to cycle focus though its internal
|
|
objects, jumping to the next widget only when that cycle ends.
|
|
]]
|
|
}
|
|
get {
|
|
[[Get the status of the tab propagation.]]
|
|
}
|
|
values {
|
|
propagate: bool; [[Whether to propagate Tab keys to Elementary or not.]]
|
|
}
|
|
}
|
|
@property history_enabled @virtual_pure {
|
|
set {
|
|
[[Enables or disables the browsing history.]]
|
|
}
|
|
get {
|
|
[[Get whether browsing history is enabled for the given object.]]
|
|
}
|
|
values {
|
|
enable: bool; [[Whether to enable or disable the browsing history.]]
|
|
}
|
|
}
|
|
@property zoom_mode @virtual_pure {
|
|
set {
|
|
[[Sets the zoom mode to use.
|
|
|
|
The modes can be any of those defined in .Elm_Web_Zoom_Mode,
|
|
except .ELM_WEB_ZOOM_MODE_LAST. The default is
|
|
.ELM_WEB_ZOOM_MODE_MANUAL.
|
|
|
|
.ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be
|
|
controlled with the @.zoom.set function.
|
|
|
|
.ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom
|
|
level to make sure the entirety of the web object's contents
|
|
are shown.
|
|
|
|
.ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom
|
|
level to fit the contents in the web object's size, without
|
|
leaving any space unused.
|
|
]]
|
|
}
|
|
get {
|
|
[[Get the currently set zoom mode.]]
|
|
}
|
|
values {
|
|
mode: Elm.Web.Zoom_Mode; [[The mode to set.]]
|
|
}
|
|
}
|
|
@property zoom @virtual_pure {
|
|
set {
|
|
[[Sets the zoom level of the web object.
|
|
|
|
Zoom level matches the Webkit API, so 1.0 means normal zoom,
|
|
with higher values meaning zoom in and lower meaning zoom out.
|
|
This function will only affect the zoom level if the mode set
|
|
with @.zoom_mode.set is .ELM_WEB_ZOOM_MODE_MANUAL.
|
|
]]
|
|
}
|
|
get {
|
|
[[Get the current zoom level set on the web object
|
|
|
|
Note that this is the zoom level set on the web object and
|
|
not that of the underlying Webkit one. In the
|
|
.ELM_WEB_ZOOM_MODE_MANUAL mode, the two zoom levels should
|
|
match, but for the other two modes the Webkit zoom is
|
|
calculated internally to match the chosen mode without
|
|
changing the zoom level set for the web object.
|
|
]]
|
|
}
|
|
values {
|
|
zoom: double; [[The zoom level to set.]]
|
|
}
|
|
}
|
|
@property console_message_hook {
|
|
set @virtual_pure {
|
|
[[Sets the function to call when a console message is emitted
|
|
from JS.
|
|
|
|
This hook will be called when a console message is emitted
|
|
from JavaScript. There is no default implementation for
|
|
this feature.
|
|
]]
|
|
}
|
|
values {
|
|
func: Elm_Web_Console_Message; [[The callback function to be used.]]
|
|
data: void *; [[User data.]]
|
|
}
|
|
}
|
|
@property window_create_hook {
|
|
set @virtual_pure {
|
|
[[Sets the function to call when a new window is requested.
|
|
|
|
This hook will be called when a request to create a new
|
|
window is issued from the web page loaded.
|
|
There is no default implementation for this feature, so
|
|
leaving this unset or passing $null in $func will prevent
|
|
new windows from opening.
|
|
]]
|
|
}
|
|
values {
|
|
func: Elm_Web_Window_Open @nullable; [[The hook function to be called when a window is requested.]]
|
|
data: void * @optional; [[User data.]]
|
|
}
|
|
}
|
|
@property dialog_file_selector_hook {
|
|
set @virtual_pure {
|
|
[[Sets the function to call when an file selector dialog.
|
|
|
|
This hook will be called when a JavaScript file selector
|
|
dialog is requested.
|
|
If no function is set or $null is passed in $func, the default
|
|
implementation will take place.
|
|
]]
|
|
}
|
|
values {
|
|
func: Elm_Web_Dialog_File_Selector @nullable; [[The callback function to be used.]]
|
|
data: void * @optional; [[User data.]]
|
|
}
|
|
}
|
|
@property dialog_confirm_hook {
|
|
set @virtual_pure {
|
|
[[Sets the function to call when an confirm dialog.
|
|
|
|
This hook will be called when a JavaScript confirm dialog is
|
|
requested. If no function is set or $null is passed in $func,
|
|
the default implementation will take place.
|
|
]]
|
|
}
|
|
values {
|
|
func: Elm_Web_Dialog_Confirm @nullable; [[The callback function to be used.]]
|
|
data: void * @optional; [[User data.]]
|
|
}
|
|
}
|
|
@property popup_selected {
|
|
set @virtual_pure {
|
|
[[Tells the web object which index in the currently open popup
|
|
was selected.
|
|
|
|
When the user handles the popup creation from the
|
|
"popup,created" signal, it needs to tell the web object
|
|
which item was selected by calling this function with
|
|
the index corresponding to the item.
|
|
]]
|
|
}
|
|
values {
|
|
idx: int; [[The index selected.]]
|
|
}
|
|
}
|
|
@property dialog_prompt_hook {
|
|
set @virtual_pure {
|
|
[[Sets the function to call when an prompt dialog.
|
|
|
|
This hook will be called when a JavaScript prompt dialog is
|
|
requested. If no function is set or $null is passed in $func,
|
|
the default implementation will take place.
|
|
]]
|
|
}
|
|
values {
|
|
func: Elm_Web_Dialog_Prompt @nullable; [[The callback function to be used.]]
|
|
data: void * @optional; [[User data.]]
|
|
}
|
|
}
|
|
@property dialog_alert_hook {
|
|
set @virtual_pure {
|
|
[[Sets the function to call when an alert dialog.
|
|
|
|
This hook will be called when a JavaScript alert dialog is
|
|
requested. If no function is set or $null is passed in $func,
|
|
the default implementation will take place.
|
|
]]
|
|
}
|
|
values {
|
|
func: Elm_Web_Dialog_Alert @nullable; [[callback function to be used.]]
|
|
data: void * @optional; [[User data.]]
|
|
}
|
|
}
|
|
@property forward_possible {
|
|
get @virtual_pure {
|
|
[[Queries whether it's possible to go forward in history.]]
|
|
return: bool;
|
|
}
|
|
}
|
|
@property webkit_view {
|
|
get @virtual_pure {
|
|
[[Get internal ewk_view object from web object.
|
|
|
|
Elementary may not provide some low level features of EWebKit,
|
|
instead of cluttering the API with proxy methods we opted to
|
|
return the internal reference. Be careful using it as it may
|
|
interfere with elm_web behavior.
|
|
]]
|
|
return: Evas.Object *; [[The internal ewk_view object or $null
|
|
if it does not exist. (Failure to
|
|
create or Elementary compiled
|
|
without ewebkit)]]
|
|
}
|
|
}
|
|
@property back_possible {
|
|
get @virtual_pure {
|
|
[[Queries whether it's possible to go back in history.]]
|
|
return: bool;
|
|
}
|
|
}
|
|
@property load_progress {
|
|
get @virtual_pure {
|
|
[[Get the overall loading progress of the page.
|
|
|
|
Returns the estimated loading progress of the page, with a
|
|
value between 0.0 and 1.0. This is an estimated progress
|
|
accounting for all the frames included in the page.
|
|
]]
|
|
return: double; [[A value between 0.0 and 1.0 indicating the
|
|
progress, or -1.0 on failure.]]
|
|
}
|
|
}
|
|
@property selection {
|
|
get @virtual_pure {
|
|
[[Get a copy of the currently selected text.
|
|
|
|
The string returned must be freed by the user when it's done
|
|
with it.
|
|
]]
|
|
return: own(const(char)*) @warn_unused; [[A newly allocated string, or
|
|
$null if nothing is selected
|
|
or an error occurred.]]
|
|
}
|
|
}
|
|
@property title {
|
|
get @virtual_pure {
|
|
[[Get the current title.
|
|
|
|
The returned string must not be freed and is guaranteed to be
|
|
stringshared.
|
|
]]
|
|
return: free(own(const(char)*), eina_stringshare_del) @warn_unused; [[
|
|
A stringshared internal string with the current title, or $null on
|
|
failure.
|
|
]]
|
|
}
|
|
}
|
|
navigate @virtual_pure {
|
|
[[Jumps the given number of steps in the browsing history.
|
|
|
|
The $steps value can be a negative integer to back in history,
|
|
or a positive to move forward.
|
|
]]
|
|
return: bool; [[$true on success, $false on error or if not enough
|
|
history exists to jump the given number of steps]]
|
|
params {
|
|
@in steps: int; [[The number of steps to jump.]]
|
|
}
|
|
}
|
|
back @virtual_pure {
|
|
[[Goes back one step in the browsing history.
|
|
|
|
This is equivalent to calling elm_web_object_navigate(obj, -1);
|
|
]]
|
|
return: bool;
|
|
}
|
|
html_string_load @virtual_pure {
|
|
[[Loads the specified $html string as the content of the web
|
|
object.
|
|
|
|
External objects such as stylesheets or images referenced in
|
|
the HTML document are located relative to $base_url.
|
|
|
|
If an $unreachable_url is passed it is used as the url for the
|
|
loaded content. This is typically used to display error pages
|
|
for a failed load.
|
|
|
|
@since 1.9
|
|
]]
|
|
return: bool;
|
|
params {
|
|
@in html: const(char)*; [[HTML data to load.]]
|
|
@in base_url: const(char)* @optional; [[Base URL used for relative paths to external objects (optional).]]
|
|
@in unreachable_url: const(char)* @optional; [[URL that could not be reached (optional).]]
|
|
}
|
|
}
|
|
text_search @const @virtual_pure {
|
|
[[Searches the given string in a document.]]
|
|
return: bool; [[$true if the given string was found, $false if not
|
|
or failure.]]
|
|
params {
|
|
@in string: const(char)*; [[String to search.]]
|
|
@in case_sensitive: bool; [[If search should be case sensitive or not.]]
|
|
@in forward: bool; [[If search is from cursor and on or backwards.]]
|
|
@in wrap: bool; [[If search should wrap at the end.]]
|
|
}
|
|
}
|
|
popup_destroy @virtual_pure {
|
|
[[Dismisses an open dropdown popup
|
|
|
|
When the popup from a dropdown widget is to be dismissed, either
|
|
after selecting an option or to cancel it, this function must be
|
|
called, which will later emit an "popup,willdelete" signal to
|
|
notify the user that any memory and objects related to this
|
|
popup can be freed.
|
|
]]
|
|
return: bool; [[$true if the menu was successfully destroyed, or
|
|
$false if there was no menu to destroy.]]
|
|
}
|
|
region_show @virtual_pure {
|
|
[[Shows the given region in the web object.]]
|
|
params {
|
|
@in x: int; [[The x coordinate of the region to show.]]
|
|
@in y: int; [[The y coordinate of the region to show.]]
|
|
@in w: int; [[The width of the region to show.]]
|
|
@in h: int; [[The height of the region to show.]]
|
|
}
|
|
}
|
|
forward @virtual_pure {
|
|
[[Goes forward one step in the browsing history.
|
|
|
|
This is equivalent to calling elm_web_object_navigate(obj, 1);
|
|
|
|
See also @.history_enabled.set, @.forward_possible.get,
|
|
@.back, @.navigate.
|
|
]]
|
|
return: bool; [[$true on success, $false otherwise.]]
|
|
}
|
|
text_matches_mark @virtual_pure {
|
|
[[Marks matches of the given string in a document.]]
|
|
return: uint; [[Number of matched $string.]]
|
|
params {
|
|
@in string: const(char)*; [[String to match.]]
|
|
@in case_sensitive: bool; [[If match should be case sensitive or not.]]
|
|
@in highlight: bool; [[If matches should be highlighted.]]
|
|
@in limit: uint; [[Maximum amount of matches, or zero to unlimited.]]
|
|
}
|
|
}
|
|
region_bring_in @virtual_pure {
|
|
[[Brings in the region to the visible area.
|
|
|
|
Like @.region_show, but it animates the scrolling of the object
|
|
to show the area.
|
|
]]
|
|
params {
|
|
@in x: int; [[The x coordinate of the region to show.]]
|
|
@in y: int; [[The y coordinate of the region to show.]]
|
|
@in w: int; [[The width of the region to show.]]
|
|
@in h: int; [[The height of the region to show.]]
|
|
}
|
|
}
|
|
stop @virtual_pure {
|
|
[[Stops loading the current page.
|
|
|
|
Cancels the loading of the current page in the web object. This
|
|
will cause a "load,error" signal to be emitted, with the
|
|
is_cancellation flag set to $true.
|
|
]]
|
|
return: bool; [[$true if the cancel was successful, $false otherwise.]]
|
|
}
|
|
navigate_possible_get @virtual_pure {
|
|
[[Queries whether it's possible to jump the given number of steps.
|
|
|
|
The $steps value can be a negative integer to back in history,
|
|
or positive to move forward.
|
|
]]
|
|
return: bool; [[$true if enough history exists to perform the
|
|
given jump, $false otherwise.]]
|
|
params {
|
|
@in steps: int; [[The number of steps to check for.]]
|
|
}
|
|
}
|
|
reload_full @virtual_pure {
|
|
[[Requests a reload of the current document, avoiding any
|
|
existing caches.
|
|
]]
|
|
return: bool; [[$true on success, $false otherwise.]]
|
|
}
|
|
text_matches_unmark_all @virtual_pure {
|
|
[[Clears all marked matches in the document.]]
|
|
return: bool; [[$true on success, $false otherwise.]]
|
|
}
|
|
reload @virtual_pure {
|
|
[[Requests a reload of the current document in the object.]]
|
|
return: bool; [[$true on success, $false otherwise.]]
|
|
}
|
|
}
|
|
implements {
|
|
class.constructor;
|
|
Eo.Base.constructor;
|
|
}
|
|
events {
|
|
uri,changed;
|
|
url,changed;
|
|
windows,close,request;
|
|
}
|
|
}
|