Champlain.Marker

g Atk.ImplementorIface Atk.ImplementorIface Clutter.Actor Clutter.Actor Atk.ImplementorIface->Clutter.Actor Champlain.Location Champlain.Location Champlain.Marker Champlain.Marker Champlain.Location->Champlain.Marker Clutter.Actor->Champlain.Marker 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.Location 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:

Champlain.CustomMarker, Champlain.Label, Champlain.Point

Methods

Inherited:

Clutter.Actor (238), GObject.Object (37), Clutter.Animatable (5), Clutter.Container (17), Clutter.Scriptable (4), Champlain.Location (3)

Structs:

GObject.ObjectClass (5)

class

get_selection_color ()

class

get_selection_text_color ()

class

new ()

class

set_selection_color (color)

class

set_selection_text_color (color)

animate_in ()

animate_in_with_delay (delay)

animate_out ()

animate_out_with_delay (delay)

get_draggable ()

get_selectable ()

get_selected ()

set_draggable (value)

set_selectable (value)

set_selected (value)

Virtual Methods

Inherited:

Clutter.Actor (35), GObject.Object (7), Clutter.Animatable (5), Clutter.Container (13), Clutter.Scriptable (4), Champlain.Location (3)

Properties

Inherited:

Clutter.Actor (82), Champlain.Location (2)

Name

Type

Flags

Short Description

draggable

bool

r/w

The draggable state of the marker

selectable

bool

r/w

The draggable state of the marker

selected

bool

r/w

The sighlighted state of the marker

Signals

Inherited:

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

Name

Short Description

button-press

Emitted when button is pressed.

button-release

Emitted when button is released.

drag-finish

Emitted when marker dragging ends (i.e.

drag-motion

Emmitted when the marker is dragged by mouse.

Fields

Inherited:

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

Name

Type

Access

Description

parent

Clutter.Actor

r

Class Details

class Champlain.Marker(**kwargs)
Bases:

Clutter.Actor, Champlain.Location

Abstract:

No

Structure:

Champlain.MarkerClass

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

New in version 0.10.

classmethod get_selection_color()
Returns:

the selection color. Should not be freed.

Return type:

Clutter.Color

Gets the selection color.

New in version 0.10.

classmethod get_selection_text_color()
Returns:

the selection text color. Should not be freed.

Return type:

Clutter.Color

Gets the selection text color.

New in version 0.10.

classmethod new()
Returns:

a new Champlain.Marker.

Return type:

Clutter.Actor

Creates an instance of Champlain.Marker.

New in version 0.12.4.

classmethod set_selection_color(color)
Parameters:

color (Clutter.Color) – a Clutter.Color

Changes the selection color, this is to ensure a better integration with the desktop, this is automatically done by GtkChamplainEmbed.

New in version 0.10.

classmethod set_selection_text_color(color)
Parameters:

color (Clutter.Color) – a Clutter.Color

Changes the selection text color, this is to ensure a better integration with the desktop, this is automatically done by GtkChamplainEmbed.

New in version 0.10.

animate_in()

Animates the marker as if it were falling from the sky onto the map.

New in version 0.10.

animate_in_with_delay(delay)
Parameters:

delay (int) – The delay in milliseconds

Animates the marker as if it were falling from the sky onto the map after delay.

New in version 0.10.

animate_out()

Animates the marker as if it were drawn through the sky.

New in version 0.10.

animate_out_with_delay(delay)
Parameters:

delay (int) – The delay in milliseconds

Animates the marker as if it were drawn through the sky after delay.

New in version 0.10.

get_draggable()
Returns:

the draggable or not state of the marker.

Return type:

bool

Checks whether the marker is draggable.

New in version 0.10.

get_selectable()
Returns:

the selectable or not state of the marker.

Return type:

bool

Checks whether the marker is selectable.

New in version 0.10.

get_selected()
Returns:

the selected or not state of the marker.

Return type:

bool

Checks whether the marker is selected.

New in version 0.10.

set_draggable(value)
Parameters:

value (bool) – the draggable state

Sets the marker as draggable or not.

New in version 0.10.

set_selectable(value)
Parameters:

value (bool) – the selectable state

Sets the marker as selectable or not.

New in version 0.10.

set_selected(value)
Parameters:

value (bool) – the selected state

Sets the marker as selected or not. This will affect the “Selected” look of the marker.

New in version 0.10.

Signal Details

Champlain.Marker.signals.button_press(marker, event)
Signal Name:

button-press

Flags:

RUN_LAST

Parameters:

Emitted when button is pressed.

New in version 0.10.

Champlain.Marker.signals.button_release(marker, event)
Signal Name:

button-release

Flags:

RUN_LAST

Parameters:

Emitted when button is released. This signal is not emmitted at the end of dragging.

New in version 0.10.

Champlain.Marker.signals.drag_finish(marker, event)
Signal Name:

drag-finish

Flags:

RUN_LAST

Parameters:

Emitted when marker dragging ends (i.e. the button is released at the end of dragging).

New in version 0.10.

Champlain.Marker.signals.drag_motion(marker, dx, dy, event)
Signal Name:

drag-motion

Flags:

RUN_LAST

Parameters:

  • marker (Champlain.Marker) – The object which received the signal

  • dx (float) – by how much the marker has been moved in the x direction

  • dy (float) – by how much the marker has been moved in the y direction

  • event (Clutter.Event) – the underlying Clutter.Event

Emmitted when the marker is dragged by mouse. dx and dy specify by how much the marker has been dragged since last time.

New in version 0.10.

Property Details

Champlain.Marker.props.draggable
Name:

draggable

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE

The draggable state of the marker

New in version 0.10.

Champlain.Marker.props.selectable
Name:

selectable

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE

The selectable state of the marker

New in version 0.10.

Champlain.Marker.props.selected
Name:

selected

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE

The selected state of the marker

New in version 0.10.