TotemPlParser.Playlist¶

Subclasses:: None

Methods¶

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

class	`new` ()
	`append` ()
	`get_value` (iter, key, value)
	`insert` (position)
	`iter_first` ()
	`iter_next` (iter)
	`iter_prev` (iter)
	`prepend` ()
	`set_value` (iter, key, value)
	`size` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class TotemPlParser.Playlist(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: TotemPlParser.PlaylistClass

All the fields in the TotemPlParser.Playlist structure are private and should never be accessed directly.

classmethod new()¶

Returns:: The newly created TotemPlParser.Playlist
Return type:: TotemPlParser.Playlist

Creates a new TotemPlParser.Playlist object.

append()¶

Returns:: an unset TotemPlParser.PlaylistIter for returning the location
Return type:: iter: TotemPlParser.PlaylistIter

Appends a new empty element to self, and modifies iter so it points to it. To fill in values, you need to call totem_pl_playlist_set() or TotemPlParser.Playlist.set_value().

get_value(iter, key, value)¶

Parameters:

iter (TotemPlParser.PlaylistIter) – a TotemPlParser.PlaylistIter pointing to some item in self
key (str) – data key
value (GObject.Value) – an empty GObject.Value to set

Returns:

True if iter contains data for key.

Return type:

bool

Gets the value for key (Such as TotemPlParser.PARSER_FIELD_URI) in the playlist item pointed by iter.

insert(position)¶

Parameters:: position (int) – position in the playlist
Returns:: an unset TotemPlParser.PlaylistIter for returning the location
Return type:: iter: TotemPlParser.PlaylistIter

Inserts a new empty element to self at position, and modifies iter so it points to it. To fill in values, you need to call totem_pl_playlist_set() or TotemPlParser.Playlist.set_value().

position may be minor than 0 to prepend elements, or bigger than the current self size to append elements.

iter_first()¶

Returns:

True if there is such first element.

iter:: an unset TotemPlParser.PlaylistIter for returning the location

Return type:

(bool, iter: TotemPlParser.PlaylistIter)

Modifies iter so it points to the first element in self.

iter_next(iter)¶

Parameters:: iter (TotemPlParser.PlaylistIter) – a TotemPlParser.PlaylistIter pointing to some item in self
Returns:: True if there was next element.
Return type:: bool

Modifies iter so it points to the next element it previously pointed to. This function will return False if there was no next element, or iter didn’t actually point to any element in self.

iter_prev(iter)¶

Parameters:: iter (TotemPlParser.PlaylistIter) – a TotemPlParser.PlaylistIter pointing to some item in self
Returns:: True if there was previous element.
Return type:: bool

Modifies iter so it points to the previous element it previously pointed to. This function will return False if there was no previous element, or iter didn’t actually point to any element in self.

prepend()¶

Returns:: an unset TotemPlParser.PlaylistIter for returning the location
Return type:: iter: TotemPlParser.PlaylistIter

Prepends a new empty element to self, and modifies iter so it points to it. To fill in values, you need to call totem_pl_playlist_set() or TotemPlParser.Playlist.set_value().

set_value(iter, key, value)¶

Parameters:

iter (TotemPlParser.PlaylistIter) – a TotemPlParser.PlaylistIter pointing to some item in self
key (str) – key to set the value for
value (GObject.Value) – GObject.Value containing the key value

Returns:

True if the value could be stored in self

Return type:

bool

Sets the value for key in the element pointed by iter.

size()¶

Returns:: The number of elements
Return type:: int

Returns the number of elements in self.