### Class

# RB DisplayPageModel

#### Description [src]

    class RB.DisplayPageModel : Gtk.TreeModelFilter
      implements Gtk.TreeDragSource, Gtk.TreeModel {
      /* No available fields */
    }

The `RBDisplayPageTree` widget is backed by a `GtkTreeStore` containing the sources and a set of attributes used to structure and display them, and a `GtkTreeModelFilter` that hides sources with the visibility property set to FALSE. This class implements the filter model and also creates the actual model.

The display page model supports drag and drop in a variety of formats. The simplest of these are text/uri-list and application/x-rhythmbox-entry, which convey URIs and IDs of existing database entries. When dragged to an existing source, these just add the URIs or entries to the target source. When dragged to an empty space in the tree widget, this results in the creation of a static playlist.

text/x-rhythmbox-artist, text/x-rhythmbox-album, and text/x-rhythmbox-genre are used when dragging items from the library browser. When dragged to the display page tree, these result in the creation of a new auto playlist with the dragged items as criteria.

#### Ancestors

- GtkTreeModelFilter
- GObject

#### Implements

- GtkTreeDragSource
- GtkTreeModel

#### Constructors

###### rb_display_page_model_new

This constructs both the GtkTreeStore holding the display page data and the filter model that hides invisible pages.

#### Instance methods

###### rb_display_page_model_add_page

Adds a page to the model, either below a specified page (if it’s a source or something else) or at the top level (if it’s a group).

###### rb_display_page_model_find_page

Finds a `GtkTreeIter` for a specified page in the model. This will only find pages that are currently visible. The returned `GtkTreeIter` can be used with the `RBDisplayPageModel`.

###### rb_display_page_model_find_page_full

Finds a `GtkTreeIter` for a specified page in the model. This function searches the full page model, so it will find pages that are not currently visible, and the returned iterator can only be used with the child model (see #gtk_tree_model_filter_get_model).

###### rb_display_page_model_remove_page

Removes a page from the model.

###### rb_display_page_model_set_dnd_targets

Sets up the drag and drop targets for the display page tree.

###### rb_display_page_model_set_playing_source

Updates the model with the new playing source.

##### Methods inherited from GtkTreeModelFilter (10)

###### gtk_tree_model_filter_clear_cache

This function should almost never be called. It clears the `filter` of any cached iterators that haven’t been reffed with gtk_tree_model_ref_node(). This might be useful if the child model being filtered is static (and doesn’t change often) and there has been a lot of unreffed access to nodes. As a side effect of this function, all unreffed iters will be invalid.

###### gtk_tree_model_filter_convert_child_iter_to_iter

Sets `filter_iter` to point to the row in `filter` that corresponds to the row pointed at by `child_iter`. If `filter_iter` was not set, `FALSE` is returned.

###### gtk_tree_model_filter_convert_child_path_to_path

Converts `child_path` to a path relative to `filter`. That is, `child_path` points to a path in the child model. The rerturned path will point to the same row in the filtered model. If `child_path` isn’t a valid path on the child model or points to a row which is not visible in `filter`, then `NULL` is returned.

###### gtk_tree_model_filter_convert_iter_to_child_iter

Sets `child_iter` to point to the row pointed to by `filter_iter`.

###### gtk_tree_model_filter_convert_path_to_child_path

Converts `filter_path` to a path on the child model of `filter`. That is, `filter_path` points to a location in `filter`. The returned path will point to the same location in the model not being filtered. If `filter_path` does not point to a location in the child model, `NULL` is returned.

###### gtk_tree_model_filter_get_model

Returns a pointer to the child model of `filter`.

###### gtk_tree_model_filter_refilter

Emits ::row_changed for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not.

###### gtk_tree_model_filter_set_modify_func

With the `n_columns` and `types` parameters, you give an array of column types for this model (which will be exposed to the parent model/view). The `func`, `data` and `destroy` parameters are for specifying the modify function. The modify function will get called for each data access, the goal of the modify function is to return the data which should be displayed at the location specified using the parameters of the modify function.

###### gtk_tree_model_filter_set_visible_column

Sets `column` of the child_model to be the column where `filter` should look for visibility information. `columns` should be a column of type `G_TYPE_BOOLEAN`, where `TRUE` means that a row is visible, and `FALSE` if not.

###### gtk_tree_model_filter_set_visible_func

Sets the visible function used when filtering the `filter` to be `func`. The function should return `TRUE` if the given row should be visible and `FALSE` otherwise.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GtkTreeDragSource (3)

###### gtk_tree_drag_source_drag_data_delete

Asks the `GtkTreeDragSource` to delete the row at `path`, because it was moved somewhere else via drag-and-drop. Returns `FALSE` if the deletion fails because `path` no longer exists, or for some model-specific reason. Should robustly handle a `path` no longer found in the model!

###### gtk_tree_drag_source_drag_data_get

Asks the `GtkTreeDragSource` to fill in `selection_data` with a representation of the row at `path`. `selection_data`->target gives the required type of the data. Should robustly handle a `path` no longer found in the model!

###### gtk_tree_drag_source_row_draggable

Asks the `GtkTreeDragSource` whether a particular row can be used as the source of a DND operation. If the source doesn’t implement this interface, the row is assumed draggable.

##### Methods inherited from GtkTreeModel (28)

Please see GtkTreeModel for a full list of methods.

#### Properties

##### Properties inherited from GtkTreeModelFilter (2)

###### Gtk.TreeModelFilter:child-model

No description available.

###### Gtk.TreeModelFilter:virtual-root

No description available.

#### Signals

###### RB.DisplayPageModel::drop-received

Emitted when a drag and drop operation to the display page tree completes.

###### RB.DisplayPageModel::page-inserted

Emitted when a new page is inserted into the model. Use this instead of GtkTreeModel::row-inserted as this doesn’t get complicated by visibility filtering.

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

##### Signals inherited from GtkTreeModel (5)

###### GtkTreeModel::row-changed

This signal is emitted when a row in the model has changed.

###### GtkTreeModel::row-deleted

This signal is emitted when a row has been deleted.

###### GtkTreeModel::row-has-child-toggled

This signal is emitted when a row has gotten the first child row or lost its last child row.

###### GtkTreeModel::row-inserted

This signal is emitted when a new row has been inserted in the model.

###### GtkTreeModel::rows-reordered

This signal is emitted when the children of a node in the `GtkTreeModel` have been reordered.

#### Class structure

    struct RBDisplayPageModelClass {
      GtkTreeModelFilterClass parent_class;
      void (* drop_received) (
        RBDisplayPageModel* model,
        RBDisplayPage* target,
        GtkTreeViewDropPosition pos,
        GtkSelectionData* data
      );
      void (* page_inserted) (
        RBDisplayPageModel* model,
        RBDisplayPage* page,
        GtkTreeIter* iter
      );

    }

No description available.

###### Class members

`parent_class: GtkTreeModelFilterClass`

  No description available.

`drop_received: void (* drop_received) ( RBDisplayPageModel* model, RBDisplayPage* target, GtkTreeViewDropPosition pos, GtkSelectionData* data )`

  No description available.

`page_inserted: void (* page_inserted) ( RBDisplayPageModel* model, RBDisplayPage* page, GtkTreeIter* iter )`

  No description available.

#### Virtual methods

###### RB.DisplayPageModelClass.drop_received

No description available.

###### RB.DisplayPageModelClass.page_inserted

No description available.