Struct Map

pub struct Map { /* private fields */ }

The Map widget is a [gtk::Widget][crate::gtk::Widget] that show and allows interaction with the user.

This is the base widget and doesn’t have advanced features. You can check the SimpleMap for a ready-to-use widget.

By default, a Viewport is created and can be accessed with viewport().

Unless created with new_simple(), the widget doesn’t hold any layer and won’t show anything. A Layer can be added or removed using the add_layer() or remove_layer() methods.

CSS nodes

ShumateMap has a single CSS node with the name “map-view”.

Properties

animate-zoom

Animate zoom change when zooming in/out.

Readable | Writeable

go-to-duration

The duration of an animation when going to a location, in milliseconds. A value of 0 means that the duration is calculated automatically for you.

Please note that animation of #shumate_map_ensure_visible also involves a ‘go-to’ animation.

Readable | Writeable

state

The view’s global state. Useful to inform using if the view is busy loading tiles or not.

Readable

viewport

The viewport, which contains information about the center, rotation, zoom, etc. of the map.

Readable

zoom-on-double-click

Should the view zoom in and recenter when the user double click on the map.

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the [query-tooltip][struct@crate::gtk::Widget#query-tooltip] signal on @widget.

A true value indicates that @widget can have a tooltip, in this case the widget will be queried using [query-tooltip][struct@crate::gtk::Widget#query-tooltip] to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Overrides for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The [gtk::LayoutManager][crate::gtk::LayoutManager] instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

limit-events

Makes this widget act like a modal dialog, with respect to event delivery.

Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See Gtk::EventController::set_propagation_limit().

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The GtkRoot widget of the widget tree containing this widget.

This will be NULL if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Gtk::Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: [has-tooltip][struct@crate::gtk::Widget#has-tooltip] will automatically be set to true and there will be taken care of [query-tooltip][struct@crate::gtk::Widget#query-tooltip] in the default signal handler.

Note that if both [tooltip-text][struct@crate::gtk::Widget#tooltip-text] and [tooltip-markup][struct@crate::gtk::Widget#tooltip-markup] are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Gtk::Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: [has-tooltip][struct@crate::gtk::Widget#has-tooltip] will automatically be set to true and there will be taken care of [query-tooltip][struct@crate::gtk::Widget#query-tooltip] in the default signal handler.

Note that if both [tooltip-text][struct@crate::gtk::Widget#tooltip-text] and [tooltip-markup][struct@crate::gtk::Widget#tooltip-markup] are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Overrides for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given [gtk::Accessible][crate::gtk::Accessible] implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Signals

animation-completed

The #ShumateMap::animation-completed signal is emitted when any animation in the view ends. This is a detailed signal. For example, if you want to be signaled only for go-to animation, you should connect to “animation-completed::go-to”. And for zoom, connect to “animation-completed::zoom”.

Detailed

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See [WidgetExtManual::keynav_failed()][crate::gtk::prelude::WidgetExtManual::keynav_failed()] for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with [visible][struct@crate::gtk::Widget#visible]) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of [unmap][struct@crate::gtk::Widget#unmap].

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

query-tooltip

Emitted when the widget’s tooltip is about to be shown.

This happens when the [has-tooltip][struct@crate::gtk::Widget#has-tooltip] property is true and the hover timeout has expired with the cursor hovering above @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a GdkSurface.

This means that [WidgetExtManual::realize()][crate::gtk::prelude::WidgetExtManual::realize()] has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See [WidgetExtManual::state_flags()][crate::gtk::prelude::WidgetExtManual::state_flags()].

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the GdkSurface associated with @widget is destroyed.

This means that [WidgetExtManual::unrealize()][crate::gtk::prelude::WidgetExtManual::unrealize()] has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

[trait@gtk::prelude::WidgetExt], [trait@glib::ObjectExt], [trait@gtk::prelude::AccessibleExt], [trait@gtk::prelude::BuildableExt], [trait@gtk::prelude::ConstraintTargetExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Map

pub fn new() -> Map

Creates an instance of #ShumateMap.

Returns

a new #ShumateMap ready to be used as a #GtkWidget.

pub fn new_simple() -> Map

pub fn builder() -> MapBuilder

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

This method returns an instance of MapBuilder which can be used to create Map objects.

pub fn add_layer(&self, layer: &impl IsA<Layer>)

Adds a new layer to the view

layer

a #ShumateLayer

pub fn center_on(&self, latitude: f64, longitude: f64)

Centers the map on these coordinates.

latitude

the longitude to center the map at

longitude

the longitude to center the map at

pub fn is_animate_zoom(&self) -> bool

Checks whether the view animates zoom level changes.

Returns

TRUE if the view animates zooms, FALSE otherwise.

pub fn go_to_duration(&self) -> u32

Get the ‘go-to-duration’ property.

Returns

the animation duration when calling go_to(), in milliseconds.

pub fn state(&self) -> State

Gets the view’s state.

Returns

the state.

pub fn viewport(&self) -> Option<Viewport>

Get the #ShumateViewport used by this view.

Returns

the #ShumateViewport

pub fn is_zoom_on_double_click(&self) -> bool

Checks whether the view zooms on double click.

Returns

TRUE if the view zooms on double click, FALSE otherwise.

pub fn go_to(&self, latitude: f64, longitude: f64)

Move from the current position to these coordinates. All tiles in the intermediate view WILL be loaded!

latitude

the longitude to center the map at

longitude

the longitude to center the map at

pub fn go_to_full(&self, latitude: f64, longitude: f64, zoom_level: f64)

Move from the current position to these coordinates and zoom to the given zoom level. All tiles in the intermediate view WILL be loaded!

latitude

the longitude to center the map at

longitude

the longitude to center the map at

zoom_level

the zoom level to end at

pub fn go_to_full_with_duration( &self, latitude: f64, longitude: f64, zoom_level: f64, duration_ms: u32, )

Move from the current position to these coordinates and zoom to the given zoom level. The given duration is used instead of the map’s default go-to-duration. All tiles in the intermediate view WILL be loaded!

latitude

the longitude to center the map at

longitude

the longitude to center the map at

zoom_level

the zoom level to end at

duration_ms

animation duration in milliseconds

pub fn insert_layer_above( &self, layer: &impl IsA<Layer>, next_sibling: Option<&impl IsA<Layer>>, )

Adds @layer to @self above @next_sibling or, if @next_sibling is None, at the bottom of the layer list.

layer

a #ShumateLayer

next_sibling

a #ShumateLayer that is a child of @self, or None

pub fn insert_layer_behind( &self, layer: &impl IsA<Layer>, next_sibling: Option<&impl IsA<Layer>>, )

Adds @layer to @self behind @next_sibling or, if @next_sibling is None, at the top of the layer list.

layer

a #ShumateLayer

next_sibling

a #ShumateLayer that is a child of @self, or None

pub fn remove_layer(&self, layer: &impl IsA<Layer>)

Removes the given layer from the view

layer

a #ShumateLayer

pub fn set_animate_zoom(&self, value: bool)

Should the view animate zoom level changes.

value

a #gboolean

pub fn set_go_to_duration(&self, duration: u32)

Set the duration of the transition of go_to().

duration

the animation duration, in milliseconds

pub fn set_map_source(&self, map_source: &impl IsA<MapSource>)

Changes the currently used map source. #g_object_unref() will be called on the previous one.

As a side effect, changing the primary map source will also clear all secondary map sources.

map_source

a #ShumateMapSource

pub fn set_zoom_on_double_click(&self, value: bool)

Should the view zoom in and recenter when the user double click on the map.

value

a #gboolean

pub fn stop_go_to(&self)

Stop the go to animation. The view will stay where it was when the animation was stopped.

pub fn zoom_in(&self)

Zooms the map in. If animate-zoom is TRUE, the change will be animated.

pub fn zoom_out(&self)

Zooms the map out. If animate-zoom is TRUE, the change will be animated.

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

The #ShumateMap::animation-completed signal is emitted when any animation in the view ends. This is a detailed signal. For example, if you want to be signaled only for go-to animation, you should connect to “animation-completed::go-to”. And for zoom, connect to “animation-completed::zoom”.

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

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

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

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

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

Trait Implementations

impl Clone for Map

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 Map

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

Formats the value using the given formatter.

impl Default for Map

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Map

type ParamSpec = ParamSpecObject

type SetValue = Map

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Map

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 Map

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 Map

type Parent = Widget

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

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 Map

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 Map

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Map

impl IsA<Accessible> for Map

impl IsA<Buildable> for Map

impl IsA<ConstraintTarget> for Map

impl IsA<Widget> for Map