Champlain.MarkerLayer¶

Subclasses:: None

Methods¶

Inherited:: Champlain.Layer (2), Clutter.Actor (238), GObject.Object (37), Clutter.Animatable (5), Clutter.Container (17), Clutter.Scriptable (4), Champlain.Exportable (2)
Structs:: GObject.ObjectClass (5)

class	`new` ()
class	`new_full` (mode)
	`add_marker` (marker)
	`animate_in_all_markers` ()
	`animate_out_all_markers` ()
	`get_markers` ()
	`get_selected` ()
	`get_selection_mode` ()
	`hide_all_markers` ()
	`remove_all` ()
	`remove_marker` (marker)
	`select_all_markers` ()
	`set_all_markers_draggable` ()
	`set_all_markers_undraggable` ()
	`set_selection_mode` (mode)
	`show_all_markers` ()
	`unselect_all_markers` ()

Virtual Methods¶

Inherited:: Champlain.Layer (2), Clutter.Actor (35), GObject.Object (7), Clutter.Animatable (5), Clutter.Container (13), Clutter.Scriptable (4), Champlain.Exportable (2)

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.

Signals¶

Inherited:: Clutter.Actor (26), GObject.Object (1), Clutter.Container (3)

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.