Struct MarkerLayer

pub struct MarkerLayer { /* private fields */ }

Displays markers on the map. It is responsible for positioning markers correctly, marker selections and group marker operations.

Properties

selection-mode

Determines the type of selection that will be performed.

Readable | Writeable

Layer

viewport

Readable | Writeable | Construct Only

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

marker-selected

Emitted when a marker in the layer is selected.

marker-unselected

Emitted when a marker in the layer is unselected.

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

LayerExt, [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 MarkerLayer

pub fn new(viewport: &Viewport) -> MarkerLayer

Creates a new instance of MarkerLayer.

viewport

the @ShumateViewport

Returns

a new MarkerLayer ready to be used as a container for the markers.

pub fn new_full(viewport: &Viewport, mode: SelectionMode) -> MarkerLayer

Creates a new instance of MarkerLayer with the specified selection mode.

viewport

the @ShumateViewport

mode

Selection mode

Returns

a new MarkerLayer ready to be used as a container for the markers.

pub fn builder() -> MarkerLayerBuilder

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

This method returns an instance of MarkerLayerBuilder which can be used to create MarkerLayer objects.

pub fn add_marker(&self, marker: &impl IsA<Marker>)

Adds the marker to the layer.

marker

a Marker

pub fn markers(&self) -> Vec<Marker>

Gets a copy of the list of all markers inserted into the layer. You should free the list but not its contents.

Returns

the list

pub fn selected(&self) -> Vec<Marker>

Gets a list of selected markers in the layer.

Returns

the list

pub fn selection_mode(&self) -> SelectionMode

Gets the selection mode of the layer.

Returns

the selection mode of the layer.

pub fn remove_all(&self)

Removes all markers from the layer.

pub fn remove_marker(&self, marker: &impl IsA<Marker>)

Removes the marker from the layer.

marker

a Marker

pub fn select_all_markers(&self)

Selects all selectable markers in the layer.

pub fn select_marker(&self, marker: &impl IsA<Marker>) -> bool

Selects a marker in this layer.

If MarkerLayer:selection-mode is [gtk::SelectionMode::Single][crate::gtk::SelectionMode::Single] or [gtk::SelectionMode::Browse][crate::gtk::SelectionMode::Browse], all other markers will be unselected. If the mode is [gtk::SelectionMode::None][crate::gtk::SelectionMode::None] or @marker is not selectable, nothing will happen.

marker

a Marker that is a child of @self

Returns

true if the marker is now selected, otherwise false

pub fn set_selection_mode(&self, mode: SelectionMode)

Sets the selection mode of the layer.

NOTE: changing selection mode to [gtk::SelectionMode::None][crate::gtk::SelectionMode::None], [gtk::SelectionMode::Single][crate::gtk::SelectionMode::Single] or [gtk::SelectionMode::Browse][crate::gtk::SelectionMode::Browse] will clear all previously selected markers.

mode

a [gtk::SelectionMode][crate::gtk::SelectionMode] value

pub fn unselect_all_markers(&self)

Unselects all markers in the layer.

pub fn unselect_marker(&self, marker: &impl IsA<Marker>)

Unselects a marker in this layer.

This works even if MarkerLayer:selection-mode is [gtk::SelectionMode::Browse][crate::gtk::SelectionMode::Browse]. Browse mode only prevents user interaction, not the program, from unselecting a marker.

marker

a Marker that is a child of @self

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

Emitted when a marker in the layer is selected.

marker

The marker that was selected

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

Emitted when a marker in the layer is unselected.

marker

The marker that was unselected

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

Trait Implementations

impl Clone for MarkerLayer

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 MarkerLayer

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

Formats the value using the given formatter.

impl Default for MarkerLayer

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for MarkerLayer

type ParamSpec = ParamSpecObject

type SetValue = MarkerLayer

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MarkerLayer

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 MarkerLayer

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 MarkerLayer

type Parent = Layer

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

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 MarkerLayer

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 MarkerLayer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MarkerLayer

impl IsA<Accessible> for MarkerLayer

impl IsA<Buildable> for MarkerLayer

impl IsA<ConstraintTarget> for MarkerLayer

impl IsA<Layer> for MarkerLayer

impl IsA<Widget> for MarkerLayer