Struct webkit6::GeolocationManager

pub struct GeolocationManager { /* private fields */ }

Geolocation manager.

WebKitGeolocationManager provides API to get the geographical position of the user. Once a #WebKitGeolocationPermissionRequest is allowed, when WebKit needs to know the user location #WebKitGeolocationManager::start signal is emitted. If the signal is handled and returns true, the application is responsible for providing the position every time it’s updated by calling webkit_geolocation_manager_update_position(). The signal #WebKitGeolocationManager::stop will be emitted when location updates are no longer needed.

Properties

enable-high-accuracy

Whether high accuracy is enabled. This is a read-only property that will be set to true when a #WebKitGeolocationManager needs to get accurate position updates. You can connect to notify::enable-high-accuracy signal to monitor it.

Readable

Signals

start

The signal is emitted to notify that @manager needs to start receiving position updates. After this signal is emitted the user should provide the updates using webkit_geolocation_manager_update_position() every time the position changes, or use webkit_geolocation_manager_failed() in case it isn’t possible to determine the current position.

If the signal is not handled, WebKit will try to determine the position using GeoClue if available.

stop

The signal is emitted to notify that @manager doesn’t need to receive position updates anymore.

GLib type: GObject with reference counted clone semantics.

Implementations

impl GeolocationManager

pub fn failed(&self, error_message: &str)

Notify @self that determining the position failed.

error_message

the error message

pub fn enables_high_accuracy(&self) -> bool

Get whether high accuracy is enabled.

Returns

Whether the setting is enabled.

pub fn update_position(&self, position: &mut GeolocationPosition)

Notify @self that position has been updated to @position.

position

a #WebKitGeolocationPosition

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

The signal is emitted to notify that @manager needs to start receiving position updates. After this signal is emitted the user should provide the updates using webkit_geolocation_manager_update_position() every time the position changes, or use webkit_geolocation_manager_failed() in case it isn’t possible to determine the current position.

If the signal is not handled, WebKit will try to determine the position using GeoClue if available.

Returns

true to stop other handlers from being invoked for the event. false to propagate the event further.

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

The signal is emitted to notify that @manager doesn’t need to receive position updates anymore.

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

Trait Implementations

impl Clone for GeolocationManager

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 GeolocationManager

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

Formats the value using the given formatter.

impl HasParamSpec for GeolocationManager

type ParamSpec = ParamSpecObject

type SetValue = GeolocationManager

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GeolocationManager

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 GeolocationManager

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 + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for GeolocationManager

type Parent = Object

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

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for GeolocationManager

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GeolocationManager