Shumate.Marker¶

Subclasses:: Shumate.Point

Methods¶

Inherited:: Gtk.Widget (183), GObject.Object (37), Gtk.Accessible (17), Gtk.Buildable (1), Shumate.Location (4)
Structs:: Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	`new` ()
	`animate_in` ()
	`animate_in_with_delay` (delay)
	`animate_out` ()
	`animate_out_with_delay` (delay)
	`get_child` ()
	`get_draggable` ()
	`get_hotspot` ()
	`get_selectable` ()
	`is_selected` ()
	`set_child` (child)
	`set_draggable` (value)
	`set_hotspot` (x_hotspot, y_hotspot)
	`set_selectable` (value)

Virtual Methods¶

Inherited:: Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9), Shumate.Location (3)

Properties¶

Inherited:: Gtk.Widget (35), Gtk.Accessible (1), Shumate.Location (2)

Name	Type	Flags	Short Description
`child`	`Gtk.Widget`	r/w	The child widget of the marker
`selectable`	`bool`	r/w	The draggable state of the marker
`x-hotspot`	`float`	r/w/en
`y-hotspot`	`float`	r/w/en

Signals¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Fields¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Gtk.Widget`	r

Class Details¶

class Shumate.Marker(**kwargs)¶

Bases:: Gtk.Widget, Shumate.Location
Abstract:: No
Structure:: Shumate.MarkerClass

Markers represent points of interest on a map. Markers need to be placed on a layer (a [class`MarkerLayer`]). Layers have to be added to a [class`Map`] for the markers to show on the map.

A marker is nothing more than a regular [class`Gtk`.Widget]. You can draw on it what ever you want. Set the marker’s position on the map using [method`Location`.set_location].

This is a base class of all markers. A typical usage of a marker is for instance to add a [class`Gtk`.Image] with a pin image and add the [class`Gtk`.GestureClick] controller to listen to click events and show a [class`Gtk`.Popover] with the description of the marker.

CSS nodes

ShumateMarker has a single CSS node with the name “map-marker”.

classmethod new()¶

Returns:: a new Shumate.Marker.
Return type:: Shumate.Marker

Creates an instance of Shumate.Marker.

animate_in()¶

animate_in_with_delay(delay)¶

Parameters:: delay (int) –

animate_out()¶

animate_out_with_delay(delay)¶

Parameters:: delay (int) –

get_child()¶

Returns:: a Gtk.Widget.
Return type:: Gtk.Widget or None

Retrieves the current child of self.

get_draggable()¶

Return type:: bool

get_hotspot()¶

Returns:

x_hotspot:: return value for the x hotspot
y_hotspot:: return value for the y hotspot

Return type:

(x_hotspot: float, y_hotspot: float)

Get the hotspot point for the given marker. The value is in pixel relative to the top-left corner. Any negative value means that the hotspot get computed with the [property`Gtk`.Widget:halign] or [property`Gtk`.Widget:valign] properties.

New in version 1.5.

get_selectable()¶

Returns:: the selectable or not state of the marker.
Return type:: bool

Checks whether the marker is selectable.

is_selected()¶

Returns:: True if the marker is selected, otherwise False
Return type:: bool

Checks whether the marker is selected.

set_child(child)¶

Parameters:: child (Gtk.Widget or None) – a Gtk.Widget

Sets the child widget of self.

set_draggable(value)¶

Parameters:: value (bool) –

set_hotspot(x_hotspot, y_hotspot)¶

Parameters:

x_hotspot (float) – the x hotspot
y_hotspot (float) – the y hotspot

Set the hotspot point for the given marker. The value is in pixel relative to the top-left corner. Use any negative value to fallback to the [property`Gtk`.Widget:halign] or [property`Gtk`.Widget:valign] properties.

New in version 1.5.

set_selectable(value)¶

Parameters:: value (bool) – the selectable state

Sets the marker as selectable or not.

Property Details¶

Shumate.Marker.props.child¶

Name:: child
Type:: Gtk.Widget
Default Value:: None
Flags:: READABLE, WRITABLE

The child widget of the marker

Shumate.Marker.props.selectable¶

Name:: selectable
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

The selectable state of the marker

Shumate.Marker.props.x_hotspot¶

Name:: x-hotspot
Type:: float
Default Value:: -1.0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The x hotspot of the marker, a negative value means that the actual x hotspot is calculated with the [property`Gtk`.Widget:halign] property. The x hotspot should not be more than the width of the widget.

New in version 1.5.

Shumate.Marker.props.y_hotspot¶

Name:: y-hotspot
Type:: float
Default Value:: -1.0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The y hotspot of the marker, a negative value means that the actual y hotspot is calculated with the [property`Gtk`.Widget:valign] property. The y hotspot should not be more than the height of the widget.

New in version 1.5.