rb_entry_view_new ()

RBEntryView *
rb_entry_view_new (RhythmDB *db,
                   GObject *shell_player,
                   gboolean is_drag_source,
                   gboolean is_drag_dest);

Creates a new entry view. If it makes sense to allow the user to drag entries from this entry view to other sources, is_drag_source should be TRUE. If it makes sense to allow the user to drag entries from other sources to this view, is_drag_dest should be TRUE. Drag and drop in this sense is used for two purposes: to transfer tracks between the filesystem and removable devices, and to add tracks to playlists.

rb_entry_view_get_column ()

GtkTreeViewColumn *
rb_entry_view_get_column (RBEntryView *view,
                          RBEntryViewColumn coltype);

Retrieves a predefined column from the entry view. This can be used to insert additional cell renderers into the column.

rb_entry_view_append_column ()

void
rb_entry_view_append_column (RBEntryView *view,
                             RBEntryViewColumn coltype,
                             gboolean always_visible);

Appends a predefined column type to the set of columns already present in the entry view. If always_visible is TRUE, the column will ignore the user's coulmn visibility settings and will always be visible. This should only be used when it is vital for the purpose of the source that the column be visible.

rb_entry_view_append_column_custom ()

void
rb_entry_view_append_column_custom (RBEntryView *view,
                                    GtkTreeViewColumn *column,
                                    const char *title,
                                    const char *key,
                                    GCompareDataFunc sort_func,
                                    gpointer data,
                                    GDestroyNotify data_destroy);

Appends a custom column to the entry view.

rb_entry_view_insert_column_custom ()

void
rb_entry_view_insert_column_custom (RBEntryView *view,
                                    GtkTreeViewColumn *column,
                                    const char *title,
                                    const char *key,
                                    GCompareDataFunc sort_func,
                                    gpointer data,
                                    GDestroyNotify data_destroy,
                                    gint position);

Inserts a custom column at the specified position.

rb_entry_view_set_columns_clickable ()

void
rb_entry_view_set_columns_clickable (RBEntryView *view,
                                     gboolean clickable);

Makes the headers for sortable columns (those for which a sort function was provided) clickable, so the user can set the sort order.

rb_entry_view_set_model ()

void
rb_entry_view_set_model (RBEntryView *view,
                         RhythmDBQueryModel *model);

Replaces the model backing the entry view.

rb_entry_view_set_state ()

void
rb_entry_view_set_state (RBEntryView *view,
                         RBEntryViewState state);

Sets the icon to be drawn in the 'playing' column next to the current playing entry. RB_ENTRY_VIEW_PLAYING and RB_ENTRY_VIEW_PAUSED should be used when the source containing the entry view is playing, and RB_ENTRY_VIEW_NOT_PLAYING otherwise.

rb_entry_view_have_selection ()

gboolean
rb_entry_view_have_selection (RBEntryView *view);

Determines whether there is an active selection in the view.

rb_entry_view_have_complete_selection ()

gboolean
rb_entry_view_have_complete_selection (RBEntryView *view);

Determines whether all entries in the view are selected.

rb_entry_view_get_selected_entries ()

GList *
rb_entry_view_get_selected_entries (RBEntryView *view);

Gathers the selected entries from the view.

rb_entry_view_select_all ()

void
rb_entry_view_select_all (RBEntryView *view);

Selects all rows in the view

rb_entry_view_select_none ()

void
rb_entry_view_select_none (RBEntryView *view);

Deselects all rows in the view.

rb_entry_view_select_entry ()

void
rb_entry_view_select_entry (RBEntryView *view,
                            RhythmDBEntry *entry);

If the specified entry is present in the view, it is added to the selection.

rb_entry_view_get_entry_contained ()

gboolean
rb_entry_view_get_entry_contained (RBEntryView *view,
                                   RhythmDBEntry *entry);

Determines whether a specified entry is present in the view.

rb_entry_view_get_entry_visible ()

gboolean
rb_entry_view_get_entry_visible (RBEntryView *view,
                                 RhythmDBEntry *entry);

Determines whether a specified entry is present in the view and is currently visible.

rb_entry_view_scroll_to_entry ()

void
rb_entry_view_scroll_to_entry (RBEntryView *view,
                               RhythmDBEntry *entry);

If the specified entry is present in the view, the view will be scrolled so that the entry is visible.

rb_entry_view_enable_drag_source ()

void
rb_entry_view_enable_drag_source (RBEntryView *view,
                                  const GtkTargetEntry *targets,
                                  int n_targets);

Enables the entry view to act as a data source for drag an drop operations, using a specified set of data targets.

rb_entry_view_get_sorting_order ()

void
rb_entry_view_get_sorting_order (RBEntryView *view,
                                 char **column_name,
                                 gint *sort_order);

Retrieves the sort settings for the view.

rb_entry_view_set_sorting_order ()

void
rb_entry_view_set_sorting_order (RBEntryView *view,
                                 const char *column_name,
                                 gint sort_order);

Sets the sort order for the entry view.

rb_entry_view_get_sorting_type ()

char *
rb_entry_view_get_sorting_type (RBEntryView *view);

Constructs a string that describes the sort settings for the entry view. This consists of a column name and an order ('ascending' or 'descending') separated by a comma.

rb_entry_view_set_sorting_type ()

void
rb_entry_view_set_sorting_type (RBEntryView *view,
                                const char *sorttype);

Changes the sort order for the entry view. The sort order description must be a column name, followed by a comma, followed by an order description ('ascending' or 'descending').

rb_entry_view_set_fixed_column_width ()

void
rb_entry_view_set_fixed_column_width (RBEntryView *view,
                                      GtkTreeViewColumn *column,
                                      GtkCellRenderer *renderer,
                                      const gchar **strings);

Helper function for calling rb_set_tree_view_column_fixed_width on a column. This is important for performance reasons, as having the tree view measure the strings in each of 20000 rows is very slow.

rb_entry_view_set_column_editable ()

void
rb_entry_view_set_column_editable (RBEntryView *view,
                                   RBEntryViewColumn column,
                                   gboolean editable);

Enables in-place editing of the values in a column. The underlying RhythmDBEntry is updated when editing is complete.

rb_entry_view_get_time_date_column_sample ()

const char *
rb_entry_view_get_time_date_column_sample
                               (void);

Returns a sample string for use in columns displaying times and dates in 'friendly' form (see rb_utf_friendly_time ). For use with rb_entry_view_set_fixed_column_width .

rb_entry_view_resort_model ()

void
rb_entry_view_resort_model (RBEntryView *view);

Resorts the entries in the entry view. Mostly to be used when a new model is associated with the view.

enum RBEntryViewColumn

Predefined column types to use in RBEntryViews. Use rb_entry_view_append_column to add these to an entry view. The predefined column names map directly to the RhythmDBEntry properties the columns display.

enum RBEntryViewState

struct RBEntryView

struct RBEntryView;

struct RBEntryViewClass

struct RBEntryViewClass {
	GtkScrolledWindowClass parent;

	void (*entry_added)		(RBEntryView *view, RhythmDBEntry *entry);
	void (*entry_deleted)		(RBEntryView *view, RhythmDBEntry *entry);
	void (*entries_replaced) (RBEntryView *view);

	void (*entry_activated)         (RBEntryView *view, RhythmDBEntry *entry);

	void (*have_selection_changed) (RBEntryView *view, gboolean have_selection);
	void (*selection_changed)       (RBEntryView *view);

	void (*show_popup)             (RBEntryView *view, gboolean over_entry);
};

The “db” property

  “db”                       RhythmDB *

RhythmDB instance

Flags: Read / Write / Construct Only

The “is-drag-dest” property

  “is-drag-dest”             gboolean

If TRUE, the view acts as a destination for drag and drop operations.

Flags: Read / Write / Construct Only

Default value: FALSE

The “is-drag-source” property

  “is-drag-source”           gboolean

If TRUE, the view acts as a data source for drag and drop operations.

Flags: Read / Write / Construct Only

Default value: FALSE

The “model” property

  “model”                    RhythmDBQueryModel *

The RhythmDBQueryModel backing the view

Flags: Read / Write

The “playing-state” property

  “playing-state”            gint

Determines the icon to show in the 'playing' column next to the current playing entry.

Flags: Read / Write

Allowed values: [0,2]

Default value: 0

The “shell-player” property

  “shell-player”             RBShellPlayer *

RBShellPlayer instance

Flags: Read / Write / Construct Only

The “sort-order” property

  “sort-order”               gchar *

The sort order for the track listing.

Flags: Read / Write

Default value: NULL

The “visible-columns” property

  “visible-columns”          GStrv

An array containing the names of the visible columns.

Flags: Read / Write

The “entries-replaced” signal

void
user_function (RBEntryView *view,
               gpointer     user_data)

Emitted when the model backing the entry view is replaced.

Flags: Run Last

The “entry-activated” signal

void
user_function (RBEntryView   *view,
               RhythmDBEntry *entry,
               gpointer       user_data)

Emitted when an entry in the view is activated (by double clicking or by various key presses)

Flags: Run Last

The “entry-added” signal

void
user_function (RBEntryView   *view,
               RhythmDBEntry *entry,
               gpointer       user_data)

Emitted when an entry is added to the view

Flags: Run Last

The “entry-deleted” signal

void
user_function (RBEntryView   *view,
               RhythmDBEntry *entry,
               gpointer       user_data)

Emitted when an entry has been removed from the view

Flags: Run Last

The “have-selection-changed” signal

void
user_function (RBEntryView *view,
               gboolean     have_selection,
               gpointer     user_data)

Emitted when the user first selects a row, or when no rows are selected any more.

Flags: Run Last

The “selection-changed” signal

void
user_function (RBEntryView *view,
               gpointer     user_data)

Emitted when the set of selected entries changes

Flags: Run Last

The “show-popup” signal

void
user_function (RBEntryView *view,
               gboolean     over_entry,
               gpointer     user_data)

Emitted when the user performs an action that should result in a popup menu appearing. If the action was a mouse button click, over_entry is FALSE if the mouse pointer was in the blank space after the last row in the view. If the action was a key press, over_entry is FALSE if no rows in the view are selected.

Flags: Run Last