Gfls.UnsavedDocumentTitles¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_default` ()
class	`new` ()
	`allocate_number` ()
	`get_title` (number)
	`release_number` (number)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Gfls.UnsavedDocumentTitles(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Gfls.UnsavedDocumentTitlesClass

classmethod get_default()¶

Returns:: the default instance of Gfls.UnsavedDocumentTitles.
Return type:: Gfls.UnsavedDocumentTitles

New in version 0.1.

classmethod new()¶

Returns:: a new Gfls.UnsavedDocumentTitles object.
Return type:: Gfls.UnsavedDocumentTitles

New in version 0.1.

allocate_number()¶

Returns:: the allocated number.
Return type:: int

Allocates a number for an unsaved document. When the document is saved on disk, you need to give back the number with Gfls.UnsavedDocumentTitles.release_number().

The returned number is the lowest available value, starting at 1.

New in version 0.1.

get_title(number)¶

Parameters:: number (int) – a number.
Returns:: a suitable title for the unsaved document with the given number.
Return type:: str

Generates the title of an unsaved document. To customize the returned string, you can use gfls_unsaved_document_titles_set_title_callback().

New in version 0.1.

release_number(number)¶

Parameters:: number (int) – the number to release.

Call this function to give back number to self, so that it becomes available for a next unsaved document. This is usually done when the document is saved on disk.

New in version 0.1.