Shumate.License¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Widget (183), GObject.Object (37), Gtk.Accessible (17), Gtk.Buildable (1)
Structs:: Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	`new` ()
	`append_map_source` (map_source)
	`get_extra_text` ()
	`get_xalign` ()
	`prepend_map_source` (map_source)
	`remove_map_source` (map_source)
	`set_extra_text` (text)
	`set_xalign` (xalign)

Virtual Methods¶

Inherited:: Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9)

Properties¶

Inherited:: Gtk.Widget (35), Gtk.Accessible (1)

Name	Type	Flags	Short Description
`extra-text`	`str`	r/w	Additional license text
`xalign`	`float`	r/w	X alignment of the child

Signals¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Fields¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Class Details¶

class Shumate.License(**kwargs)¶

Bases:: Gtk.Widget
Abstract:: No
Structure:: Shumate.LicenseClass

A widget that displays license text.

classmethod new()¶

Returns:: a new Shumate.License.
Return type:: Shumate.License

Creates an instance of Shumate.License.

append_map_source(map_source)¶

Parameters:: map_source (Shumate.MapSource) –

get_extra_text()¶

Returns:: the additional license text
Return type:: str

Gets the additional license text.

get_xalign()¶

Returns:: the license’s text horizontal alignment.
Return type:: float

Get the license’s text horizontal alignment.

prepend_map_source(map_source)¶

Parameters:: map_source (Shumate.MapSource) –

remove_map_source(map_source)¶

Parameters:: map_source (Shumate.MapSource) –

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.

set_xalign(xalign)¶

Parameters:: xalign (float) – The license’s text horizontal alignment

Set the license’s text horizontal alignment.

Property Details¶

Shumate.License.props.extra_text¶

Name:: extra-text
Type:: str
Default Value:: None
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.

Shumate.License.props.xalign¶

Name:: xalign
Type:: float
Default Value:: 0.5
Flags:: READABLE, WRITABLE

The license’s horizontal alignment