Top | ![]() |
![]() |
![]() |
![]() |
RBHistory * | rb_history_new () |
void | rb_history_set_destroy_notify () |
void | rb_history_set_truncate_on_play () |
void | rb_history_set_maximum_size () |
guint | rb_history_length () |
RhythmDBEntry * | rb_history_first () |
RhythmDBEntry * | rb_history_previous () |
RhythmDBEntry * | rb_history_current () |
RhythmDBEntry * | rb_history_next () |
RhythmDBEntry * | rb_history_last () |
void | rb_history_go_first () |
void | rb_history_go_previous () |
void | rb_history_go_next () |
void | rb_history_go_last () |
void | rb_history_set_playing () |
void | rb_history_append () |
gint | rb_history_get_current_index () |
void | rb_history_insert_at_index () |
void | rb_history_remove_entry () |
void | rb_history_clear () |
GPtrArray * | rb_history_dump () |
gboolean | rb_history_contains_entry () |
RBHistory is a GSequence that maintains a "current" pointer and can delete an arbitrary element in amortized O(log(N)) time. It can call a deletion callback when it removes one of its entries.
All operations take amortized O(log(N)) (worst-case O(N)) time unless noted otherwise.
RBHistory * rb_history_new (gboolean truncate_on_play
,GFunc destroyer
,gpointer destroy_userdata
);
Creates a new history instance.
truncate_on_play |
Whether |
|
destroyer |
function to call when removing an entry from the history. |
[scope async] |
destroy_userdata |
data to pass to |
void rb_history_set_destroy_notify (RBHistory *hist
,GFunc destroyer
,gpointer destroy_userdata
);
Sets a new function to call when removing entries from the history.
hist |
||
destroyer |
function to call when removing an entry from the history. |
[scope async] |
destroy_userdata |
data to pass to |
void rb_history_set_truncate_on_play (RBHistory *hist
,gboolean truncate_on_play
);
Sets the 'truncate-on-play' property.
void rb_history_set_maximum_size (RBHistory *hist
,guint maximum_size
);
Sets the maximum-size property
guint
rb_history_length (RBHistory *hist
);
Returns the number of entries in the history.
RhythmDBEntry *
rb_history_first (RBHistory *hist
);
Returns the first entry in the history.
RhythmDBEntry *
rb_history_previous (RBHistory *hist
);
Returns the RhythmDBEntry before the current position.
RhythmDBEntry *
rb_history_current (RBHistory *hist
);
Returns the current RhythmDBEntry, or NULL if there is no current position
RhythmDBEntry *
rb_history_next (RBHistory *hist
);
Returns the RhythmDBEntry after the current position
RhythmDBEntry *
rb_history_last (RBHistory *hist
);
Returns the last RhythmDBEntry in the history
void
rb_history_go_first (RBHistory *hist
);
Moves the current position to the first entry in the history
void
rb_history_go_previous (RBHistory *hist
);
Moves the current position to the previous entry. If the current position is already at the start of the history, nothing happens.
void
rb_history_go_next (RBHistory *hist
);
Moves the current position to the next entry. If the current position is already at the end of the history, nothing happens.
void
rb_history_go_last (RBHistory *hist
);
Moves the current position to the last entry in the history
void rb_history_set_playing (RBHistory *hist
,RhythmDBEntry *entry
);
Updates the current position to point to the specified entry. If the truncate-on-play property is set, this will remove all entries after that.
void rb_history_append (RBHistory *hist
,RhythmDBEntry *entry
);
Adds a new entry to the end of the history list. If a size limit is set, an entry may be removed from the start to keep the history list within the limit.
gint
rb_history_get_current_index (RBHistory *hist
);
Gets the index of the current entry. This is guaranteed to be < the history's size, so if the history is empty, it returns -1.
void rb_history_insert_at_index (RBHistory *hist
,RhythmDBEntry *entry
,guint index
);
Inserts entry
at index
within the history list. 0<=index
<=size
void rb_history_remove_entry (RBHistory *hist
,RhythmDBEntry *entry
);
Removes the specified entry from the history list.
GPtrArray *
rb_history_dump (RBHistory *hist
);
Constructs a copy of the whole history in order. Caller must free the result. The caller does not own any references on the entries in the returned array. Takes O(Nlog(N)) time.
“maximum-size”
property“maximum-size” guint
Maximum number of entries to store in the history. If 0, no limit is applied.
Flags: Read / Write
Default value: 0
“truncate-on-play”
property“truncate-on-play” gboolean
If set, rb_history_set_playing()
truncates the rest of the history
Flags: Read / Write / Construct
Default value: FALSE