Struct SymbolEvent

pub struct SymbolEvent { /* private fields */ }

An object containing the details of a map feature that has been clicked. It is the argument of the symbol-clicked and symbol-clicked signals.

When vector maps are rendered, they may contain labels and icons. When one of these symbols is clicked, these signals are emitted to give the application access to the original location and details of the map feature.

SymbolEvent implements Location so you can get the latitude and longitude of the feature that was clicked.

Properties

feature-id

The ID of the feature that this event pertains to, as it was given in the data source.

Readable

layer

The ID of the style layer of the symbol that this event pertains to.

Readable

n-press

The number of clicks/presses triggering the symbol event.

Readable | Writeable

source-layer

The ID of the source layer of the symbol that this event pertains to.

Readable

Location

latitude

The latitude coordonate in degrees

Readable | Writeable

longitude

The longitude coordonate in degrees

Readable | Writeable

Implements

[trait@glib::ObjectExt], LocationExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl SymbolEvent

pub fn builder() -> SymbolEventBuilder

Creates a new builder-pattern struct instance to construct SymbolEvent objects.

This method returns an instance of SymbolEventBuilder which can be used to create SymbolEvent objects.

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

Gets the feature ID as specified in the data source. The meaning of the ID, if any, is up to the source.

Feature IDs in Mapbox Vector Tile format are integers, but they are formatted as a string here for futureproofing.

Returns

the feature ID

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

Gets the name of the layer the clicked symbol is in, as named in the vector stylesheet.

Note that this is distinct from the name of the layer in the vector tile schema. Some styles have multiple symbol layers derived from the same data source layer.

Returns

the layer name

pub fn n_press(&self) -> i32

Gets the number of clicks/presses that initiated the event.

Returns

the number of presses

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

Gets the name of the source layer the clicked feature is in, as named in the vector tile schema.

Returns

the layer name

pub fn tag(&self, tag_name: &str) -> Option<GString>

Gets a tag from the source feature.

The available tags depend on the vector tile schema and the source layer. Check the documentation for the tiles you’re using to see what information is available.

tag_name

the tag to get

Returns

the tag value, formatted as a string

pub fn set_n_press(&self, n_press: u32)

The number of clicks/presses triggering the symbol event.

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

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

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

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

Trait Implementations

impl Clone for SymbolEvent

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 SymbolEvent

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

Formats the value using the given formatter.

impl HasParamSpec for SymbolEvent

type ParamSpec = ParamSpecObject

type SetValue = SymbolEvent

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SymbolEvent

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 SymbolEvent

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 SymbolEvent

type Parent = Object

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

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 SymbolEvent

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 SymbolEvent

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SymbolEvent

impl IsA<Location> for SymbolEvent