Struct AutomationSession 

pub struct AutomationSession { /* private fields */ }

Automation Session.

WebKitAutomationSession represents an automation session of a WebKitWebContext. When a new session is requested, a WebKitAutomationSession is created and the signal WebKitWebContext::automation-started is emitted with the WebKitAutomationSession as argument. Then, the automation client can request the session to create a new WebView to interact with it. When this happens the signal create-web-view is emitted.

Properties

id

The session unique identifier.

Readable | Writeable | Construct Only

Signals

create-web-view

This signal is emitted when the automation client requests a new browsing context to interact with it. The callback handler should return a WebView created with is-controlled-by-automation construct property enabled and automation-presentation-type construct property set if needed.

If the signal is emitted with “tab” detail, the returned WebView should be a new web view added to a new tab of the current browsing context window. If the signal is emitted with “window” detail, the returned WebView should be a new web view added to a new window. When creating a new web view and there’s an active browsing context, the new window or tab shouldn’t be focused.

Detailed

will-close

This signal is emitted when the given automation session is about to finish. It allows clients to perform any cleanup tasks before the session is destroyed.

GLib type: GObject with reference counted clone semantics.

Implementations

impl AutomationSession

pub fn application_info(&self) -> Option<ApplicationInfo>

Get the the previously set AutomationSession.

Get the AutomationSession previously set with set_application_info().

Returns

the AutomationSession of self, or None if no one has been set.

pub fn id(&self) -> Option<GString>

Get the unique identifier of a AutomationSession

Returns

the unique identifier of self

pub fn set_application_info(&self, info: &ApplicationInfo)

Set the application information to self.

This information will be used by the driver service to match the requested capabilities with the actual application information. If this information is not provided to the session when a new automation session is requested, the creation might fail if the client requested a specific browser name or version. This will not have any effect when called after the automation session has been fully created, so this must be called in the callback of automation-started signal.

info

a ApplicationInfo

pub fn connect_create_web_view<F: Fn(&Self) -> WebView + 'static>( &self, detail: Option<&str>, f: F, ) -> SignalHandlerId

This signal is emitted when the automation client requests a new browsing context to interact with it. The callback handler should return a WebView created with is-controlled-by-automation construct property enabled and automation-presentation-type construct property set if needed.

If the signal is emitted with “tab” detail, the returned WebView should be a new web view added to a new tab of the current browsing context window. If the signal is emitted with “window” detail, the returned WebView should be a new web view added to a new window. When creating a new web view and there’s an active browsing context, the new window or tab shouldn’t be focused.

Returns

a WebView widget.

pub fn connect_will_close<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v2_46 only.

This signal is emitted when the given automation session is about to finish. It allows clients to perform any cleanup tasks before the session is destroyed.

Trait Implementations

impl Clone for AutomationSession

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for AutomationSession

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

Formats the value using the given formatter.

impl HasParamSpec for AutomationSession

type ParamSpec = ParamSpecObject

type SetValue = AutomationSession

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, AutomationSession>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for AutomationSession

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AutomationSession

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for AutomationSession

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for AutomationSession

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for AutomationSession

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for AutomationSession

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AutomationSession