Champlain.License

g Atk.ImplementorIface Atk.ImplementorIface Clutter.Actor Clutter.Actor Atk.ImplementorIface->Clutter.Actor Champlain.License Champlain.License Clutter.Actor->Champlain.License 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->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)
Name Type Flags Short Description
alignment Pango.Alignment r/w The license’s alignment
extra-text str r/w Additional license text

Fields

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

Class Details

class Champlain.License(**kwargs)
Bases:Clutter.Actor
Abstract:No
Structure:Champlain.LicenseClass

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

New in version 0.10.

classmethod new()
Returns:a new Champlain.License.
Return type:Clutter.Actor

Creates an instance of Champlain.License.

New in version 0.10.

connect_view(view)
Parameters:view (Champlain.View) – a Champlain.View

This method connects to the necessary signals of Champlain.View to make the license change automatically when the map source changes.

New in version 0.10.

disconnect_view()

This method disconnects from the signals previously connected by Champlain.License.connect_view().

New in version 0.10.

get_alignment()
Returns:the license’s text alignment.
Return type:Pango.Alignment

Get the license’s text alignment.

New in version 0.10.

get_extra_text()
Returns:the additional license text
Return type:str

Gets the additional license text.

New in version 0.10.

set_alignment(alignment)
Parameters:alignment (Pango.Alignment) – The license’s text alignment

Set the license’s text alignment.

New in version 0.10.

set_extra_text(text)
Parameters:text (str) – the additional license text

Show the additional license text on the map view. The text will preceed the map’s licence when displayed. Use “\n” to separate the lines.

New in version 0.10.

Property Details

Champlain.License.props.alignment
Name:alignment
Type:Pango.Alignment
Default Value:Pango.Alignment.LEFT
Flags:READABLE, WRITABLE

The license’s alignment

New in version 0.10.

Champlain.License.props.extra_text
Name:extra-text
Type:str
Default Value:''
Flags:READABLE, WRITABLE

Sets additional text to be displayed in the license area. The map’s license will be added below it. Your text can have multiple lines, just use “\n” in between.

New in version 0.10.