Tepl.FoldRegion¶

Subclasses:: None

Methods¶

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

class	`new` (buffer, start, end)
	`get_bounds` ()
	`get_buffer` ()
	`get_folded` ()
	`set_bounds` (start, end)
	`set_folded` (folded)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`buffer`	`Gtk.TextBuffer`	r/w/co
`folded`	`bool`	r/w

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Tepl.FoldRegion(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Tepl.FoldRegionClass

classmethod new(buffer, start, end)¶

Parameters:

buffer (Gtk.TextBuffer) – a Gtk.TextBuffer.
start (Gtk.TextIter) – a Gtk.TextIter.
end (Gtk.TextIter) – a Gtk.TextIter.

Returns:

a new Tepl.FoldRegion.

Return type:

Tepl.FoldRegion

New in version 1.0.

get_bounds()¶

Returns:

True on success, False otherwise.

start:: iterator to initialize.
end:: iterator to initialize.

Return type:

(bool, start: Gtk.TextIter, end: Gtk.TextIter)

Obtains iterators pointing to the start and end of the Tepl.FoldRegion.

New in version 1.0.

get_buffer()¶

Returns:: the Gtk.TextBuffer where the fold region is applied.
Return type:: Gtk.TextBuffer or None

New in version 1.0.

get_folded()¶

Returns:: whether the Tepl.FoldRegion is folded.
Return type:: bool

New in version 1.0.

set_bounds(start, end)¶

Parameters:

start (Gtk.TextIter) – a Gtk.TextIter.
end (Gtk.TextIter) – a Gtk.TextIter.

Sets the start and end of the Tepl.FoldRegion.

New in version 1.0.

set_folded(folded)¶

Parameters:: folded (bool) – the new value.

Folds or unfolds the region.

New in version 1.0.

Property Details¶

Tepl.FoldRegion.props.buffer¶

Name:: buffer
Type:: Gtk.TextBuffer
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The Gtk.TextBuffer where the fold region is applied. The Tepl.FoldRegion object has a weak reference to the buffer.

New in version 1.0.

Tepl.FoldRegion.props.folded¶

Name:: folded
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the Tepl.FoldRegion is folded or not.

New in version 1.0.