Champlain.MarkerLayer

g Atk.ImplementorIface Atk.ImplementorIface Clutter.Actor Clutter.Actor Atk.ImplementorIface->Clutter.Actor Champlain.Exportable Champlain.Exportable Champlain.MarkerLayer Champlain.MarkerLayer Champlain.Exportable->Champlain.MarkerLayer Champlain.Layer Champlain.Layer Champlain.Layer->Champlain.MarkerLayer Clutter.Actor->Champlain.Layer Clutter.Animatable Clutter.Animatable Clutter.Animatable->Clutter.Actor Clutter.Container Clutter.Container Clutter.Container->Clutter.Actor Clutter.Scriptable Clutter.Scriptable Clutter.Scriptable->Clutter.Actor GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface GObject.GInterface->Champlain.Exportable GObject.GInterface->Clutter.Animatable GObject.GInterface->Clutter.Container GObject.GInterface->Clutter.Scriptable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Clutter.Actor GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned

Subclasses:None

Properties

Inherited:Clutter.Actor (82), Champlain.Exportable (1)
Name Type Flags Short Description
selection-mode Champlain.SelectionMode r/w Determines the type of selection that will be performed.

Fields

Inherited:Clutter.Actor (26), GObject.Object (1), Clutter.Container (3)
Name Type Access Description
parent Champlain.Layer r  

Class Details

class Champlain.MarkerLayer(**kwargs)
Bases:Champlain.Layer, Champlain.Exportable
Abstract:No
Structure:Champlain.MarkerLayerClass

The Champlain.MarkerLayer structure contains only private data and should be accessed using the provided API

New in version 0.10.

classmethod new()
Returns:a new Champlain.MarkerLayer ready to be used as a container for the markers.
Return type:Champlain.MarkerLayer

Creates a new instance of Champlain.MarkerLayer.

New in version 0.10.

classmethod new_full(mode)
Parameters:mode (Champlain.SelectionMode) – Selection mode
Returns:a new Champlain.MarkerLayer ready to be used as a container for the markers.
Return type:Champlain.MarkerLayer

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

New in version 0.10.

add_marker(marker)
Parameters:marker (Champlain.Marker) – a Champlain.Marker

Adds the marker to the layer.

New in version 0.10.

animate_in_all_markers()

Fade in all markers in the layer with an animation

New in version 0.10.

animate_out_all_markers()

Fade out all markers in the layer with an animation

New in version 0.10.

get_markers()
Returns:the list
Return type:[Champlain.Marker]

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

New in version 0.10.

get_selected()
Returns:the list
Return type:[Champlain.Marker]

Gets a list of selected markers in the layer.

New in version 0.10.

get_selection_mode()
Returns:the selection mode of the layer.
Return type:Champlain.SelectionMode

Gets the selection mode of the layer.

New in version 0.10.

hide_all_markers()

Hides all the markers in the layer

New in version 0.10.

remove_all()

Removes all markers from the layer.

New in version 0.10.

remove_marker(marker)
Parameters:marker (Champlain.Marker) – a Champlain.Marker

Removes the marker from the layer.

New in version 0.10.

select_all_markers()

Selects all markers in the layer.

New in version 0.10.

set_all_markers_draggable()

Sets all markers draggable in the layer

New in version 0.10.

set_all_markers_undraggable()

Sets all markers undraggable in the layer

New in version 0.10.

set_selection_mode(mode)
Parameters:mode (Champlain.SelectionMode) – a Champlain.SelectionMode value

Sets the selection mode of the layer.

NOTE: changing selection mode to Champlain.SelectionMode.NONE or Champlain.SelectionMode.SINGLE will clear all previously selected markers.

New in version 0.10.

show_all_markers()

Shows all markers in the layer

New in version 0.10.

unselect_all_markers()

Unselects all markers in the layer.

New in version 0.10.

Property Details

Champlain.MarkerLayer.props.selection_mode
Name:selection-mode
Type:Champlain.SelectionMode
Default Value:Champlain.SelectionMode.NONE
Flags:READABLE, WRITABLE

Determines the type of selection that will be performed.

New in version 0.10.