Struct sciter::dom::Element

pub struct Element { /* fields omitted */ }

DOM element wrapper. See the module-level documentation also.

Methods

impl Element

pub fn from(he: HELEMENT) -> Element

Construct Element object from HELEMENT handle.

pub fn create(tag: &str) -> Result<Element>

Create new element, it is disconnected initially from the DOM.

pub fn with_parent(tag: &str, parent: &mut Element) -> Result<Element>

Create new element as child of parent.

pub fn create_at(tag: &str, parent: &mut Element) -> Result<Element>

Deprecated since 0.5.0

: please use Element::with_parent() instead.

Create new element as child of parent. Deprecated.

pub fn with_text(tag: &str, text: &str) -> Result<Element>

Create new element with specified text, it is disconnected initially from the DOM.

pub fn with_type(tag: &str, el_type: &str) -> Result<Element>

Create new element with specified type, which is useful for controls and widgets (initially disconnected).

pub fn from_window(hwnd: HWINDOW) -> Result<Element>

Get root DOM element of the Sciter document.

pub fn from_focus(hwnd: HWINDOW) -> Result<Element>

Get focus DOM element of the Sciter document.

pub fn from_highlighted(hwnd: HWINDOW) -> Result<Element>

Get highlighted element.

pub fn from_point(hwnd: HWINDOW, pt: POINT) -> Result<Element>

Find DOM element of the Sciter document by coordinates.

pub fn from_uid(hwnd: HWINDOW, uid: u32) -> Result<Element>

Get element handle by its UID.

pub fn as_ptr(&self) -> HELEMENT

Access element pointer.

pub fn get_uid(&self) -> u32

Get element UID - identifier suitable for storage.

pub fn get_tag(&self) -> String

Return element tag as string (e.g. 'div', 'body').

pub fn get_text(&self) -> String

Get inner text of the element as string.

pub fn set_text(&mut self, text: &str) -> Result<()>

Set inner text of the element.

pub fn get_html(&self, with_outer_html: bool) -> Vec<u8>

Get html representation of the element as utf-8 bytes.

pub fn set_html(
    &mut self,
    html: &[u8],
    how: Option<SET_ELEMENT_HTML>
) -> Result<()>

Set inner or outer html of the element.

pub fn get_value(&self) -> Value

Get value of the element.

pub fn set_value<T: Into<Value>>(&mut self, val: T) -> Result<()>

Set value of the element.

pub fn get_hwnd(&self, for_root: bool) -> HWINDOW

Get HWINDOW of containing window.

pub fn get_location(&self, kind: u32) -> Result<RECT>

Get bounding rectangle of the element. See the ELEMENT_AREAS enum for kind flags.

pub fn send_event(
    &self,
    code: BEHAVIOR_EVENTS,
    reason: Option<CLICK_REASON>,
    source: Option<HELEMENT>
) -> Result<bool>

Sends sinking/bubbling event to the child/parent chain of element.

pub fn post_event(
    &self,
    code: BEHAVIOR_EVENTS,
    reason: Option<CLICK_REASON>,
    source: Option<HELEMENT>
) -> Result<()>

Post asynchronously a sinking/bubbling event to the child/parent chain of element.

pub fn fire_event(
    &self,
    code: BEHAVIOR_EVENTS,
    reason: Option<CLICK_REASON>,
    source: Option<HELEMENT>,
    post: bool,
    data: Option<Value>
) -> Result<bool>

Send or posts event to the child/parent chain of element.

pub fn fire_event_params(
    evt: &BEHAVIOR_EVENT_PARAMS,
    post: bool
) -> Result<bool>

Send or posts event with specified params to the child/parent chain of element.

pub fn eval_script(&self, script: &str) -> Result<Value>

Evaluate the given script in context of the element.

pub fn call_function(&self, name: &str, args: &[Value]) -> Result<Value>

Call scripting function defined in the namespace of the element (a.k.a. global function).

You can use the make_args!(args...) macro which helps you to construct script arguments from Rust types.

pub fn call_method(&self, name: &str, args: &[Value]) -> Result<Value>

Call scripting method defined for the element.

You can use the make_args!(args...) macro which helps you to construct script arguments from Rust types.

pub fn attribute_count(&self) -> usize

Get number of the attributes.

pub fn attribute_name(&self, index: usize) -> String

Get attribute name by its index.

pub fn attribute(&self, index: usize) -> String

Get attribute value by its index.

pub fn get_attribute(&self, name: &str) -> Option<String>

Get attribute value by its name.

pub fn set_attribute(&mut self, name: &str, value: &str) -> Result<()>

Add or replace attribute.

pub fn remove_attribute(&mut self, name: &str) -> Result<()>

Remove attribute.

pub fn toggle_attribute(
    &mut self,
    name: &str,
    isset: bool,
    value: Option<&str>
) -> Result<()>

Toggle attribute.

pub fn clear_attributes(&mut self) -> Result<()>

Remove all attributes from the element.

pub fn get_style_attribute(&self, name: &str) -> String

Get style attribute of the element by its name.

pub fn set_style_attribute(&mut self, name: &str, value: &str) -> Result<()>

Set style attribute.

pub fn index(&self) -> usize

Get index of this element in its parent collection.

pub fn root(&self) -> Element

Get root of the element.

pub fn parent(&self) -> Option<Element>

Get parent element.

pub fn first_sibling(&self) -> Option<Element>

Get first sibling element.

pub fn last_sibling(&self) -> Option<Element>

Get last sibling element.

pub fn next_sibling(&self) -> Option<Element>

Get next sibling element.

pub fn prev_sibling(&self) -> Option<Element>

Get previous sibling element.

pub fn first_child(&self) -> Option<Element>

Get first child element.

pub fn last_child(&self) -> Option<Element>

Get last child element.

pub fn get(&self, index: usize) -> Option<Element>

Get element's child at specified index.

Important traits for Children<'a>

impl<'a> Iterator for Children<'a> type Item = Element;

pub fn children(&self) -> Children

An iterator over the direct children of a DOM element.

pub fn child(&self, index: usize) -> Option<Element>

Get element's child at specified index.

pub fn children_count(&self) -> usize

Get number of child elements.

pub fn len(&self) -> usize

Get number of child elements.

pub fn is_empty(&self) -> bool

Returns true is self has zero elements.

pub fn clear(&mut self) -> Result<()>

Clear content of the element.

pub fn clone_element(&self) -> Element

Create new element as copy of existing element.

The new element is a full (deep) copy of the element and is initially disconnected from the DOM. Note that Element.clone() does not clone DOM element, just increments its reference count.

pub fn insert(&mut self, index: usize, child: &Element) -> Result<()>

Insert element at index position of this element.

Note that we cannot follow Rust semantic here because the newly created Element is unusable before it will be inserted at DOM.

pub fn append(&mut self, child: &Element) -> Result<()>

Append element as last child of this element.

pub fn push(&mut self, element: Element)

Append element as last child of this element.

pub fn pop(&mut self) -> Option<Element>

Remove the last child from this element and returns it, or None if this element is empty.

pub fn detach(&mut self) -> Result<()>

Take element out of its container (and DOM tree).

pub fn destroy(&mut self) -> Result<()>

Take element out of its container (and DOM tree) and force destruction of all behaviors.

pub fn swap(&mut self, other: &mut Element) -> Result<()>

Swap element positions.

pub fn test(&self, selector: &str) -> bool

Test this element against CSS selector(s).

pub fn find_nearest_parent(&self, selector: &str) -> Result<Option<Element>>

Will find first parent element starting from this satisfying given css selector(s).

pub fn find_first(&self, selector: &str) -> Result<Option<Element>>

Will find first element starting from this satisfying given css selector(s).

pub fn find_all(&self, selector: &str) -> Result<Option<Vec<Element>>>

Will find all elements starting from this satisfying given css selector(s).

pub fn update(&self, render_now: bool) -> Result<()>

Apply changes and refresh element area in its window.

pub fn start_timer(&self, period_ms: u32, timer_id: u64) -> Result<()>

Start Timer for the element. Element will receive on_timer event.

Note that timer events are not bubbling, so you need attach handler to the target element directly.

pub fn stop_timer(&self, timer_id: u64) -> Result<()>

Stop Timer for the element.

pub fn attach_handler<Handler: EventHandler>(
    &mut self,
    handler: Handler
) -> Result<u64>

Attach the native event handler to this element.

pub fn detach_handler<Handler: EventHandler>(
    &mut self,
    token: u64
) -> Result<()>

Detach your handler from the element. Handlers identified by token from attach_handler() result.

Trait Implementations

impl PartialEq for Element

fn eq(&self, __arg_0: &Element) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Element) -> bool

This method tests for !=.

impl Send for Element

sciter::Element can be transferred across thread boundaries.

impl Sync for Element

It is safe to share sciter::Element between threads - underlaying API is thread-safe.

impl Drop for Element

Release element pointer.

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for Element

Increment reference count of the dom element.

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Display for Element

Human element representation.

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Debug for Element

Machine-like element visualization.

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Element

Allows for child in &el {} enumeration.

type Item = Element

The type of the elements being iterated over.

type IntoIter = Children<'a>

Which kind of iterator are we turning this into?

Important traits for Children<'a>

impl<'a> Iterator for Children<'a> type Item = Element;

fn into_iter(self) -> Children<'a>

Creates an iterator from a value.