InfGtk.BrowserModel¶

Implementations:: InfGtk.BrowserModelFilter, InfGtk.BrowserModelSort, InfGtk.BrowserStore

Methods¶

	`browser_iter_to_tree_iter` (browser, iter)
	`resolve` (discovery, info)
	`set_browser` (path, iter, old_browser, new_browser)

Virtual Methods¶

	`do_browser_iter_to_tree_iter` (browser, iter)
	`do_resolve` (discovery, info)
	`do_set_browser` (path, iter, old_browser, new_browser)

Properties¶

None

Signals¶

Name	Short Description
`set-browser`	This signal is emitted every time the `Infinity.Browser` for one of the model’s top-level entries change.

Fields¶

None

Class Details¶

class InfGtk.BrowserModel¶

Bases:: GObject.GInterface
Structure:: InfGtk.BrowserModelInterface

InfGtk.BrowserModel is an opaque data type. You should only access it via the public API functions.

browser_iter_to_tree_iter(browser, iter)¶

Parameters:

browser (Infinity.Browser) – A Infinity.Browser.
iter (Infinity.BrowserIter) – A Infinity.BrowserIter pointing into browser, or None.

Returns:

Whether tree_iter was set.

tree_iter:: A Gtk.TreeIter that will be set by this function.

Return type:

(bool, tree_iter: Gtk.TreeIter)

Sets tree_iter to point to the same node iter refers to within the model. If browser is not known to self, i.e. its connection was never added to self, then the function returns False and tree_iter is left untouched.

If iter is None, the function sets tree_iter to point to the top level entry representing browser.

resolve(discovery, info)¶

Parameters:

discovery (Infinity.Discovery) – A Infinity.Discovery added to store.
info (Infinity.DiscoveryInfo) – A Infinity.DiscoveryInfo discovered by discovery.

Resolves info and adds the resulting connection to the model. If that connection is already contained, the original (newly resolved) entry is removed in favor of the existing entry whose browser might already have explored (parts of) the server’s directory.

set_browser(path, iter, old_browser, new_browser)¶

Parameters:

path (Gtk.TreePath) – A Gtk.TreePath to a top-level row.
iter (Gtk.TreeIter) – A Gtk.TreeIter pointing to the same row.
old_browser (Infinity.Browser) – The browser which was set at this row before.
new_browser (Infinity.Browser) – The new Infinity.Browser to set for this row.

Emits the InfGtk.BrowserModel ::set-browser signal. This is supposed to only be called by implementations of InfGtk.BrowserModel whenever they set or unset a browser on a row.

do_browser_iter_to_tree_iter(browser, iter) virtual¶

Parameters:

browser (Infinity.Browser) – A Infinity.Browser.
iter (Infinity.BrowserIter) – A Infinity.BrowserIter pointing into browser, or None.

Returns:

Whether tree_iter was set.

tree_iter:: A Gtk.TreeIter that will be set by this function.

Return type:

(bool, tree_iter: Gtk.TreeIter)

Sets tree_iter to point to the same node iter refers to within the model. If browser is not known to model, i.e. its connection was never added to model, then the function returns False and tree_iter is left untouched.

If iter is None, the function sets tree_iter to point to the top level entry representing browser.

do_resolve(discovery, info) virtual¶

Parameters:

discovery (Infinity.Discovery) – A Infinity.Discovery added to store.
info (Infinity.DiscoveryInfo) – A Infinity.DiscoveryInfo discovered by discovery.

Resolves info and adds the resulting connection to the model. If that connection is already contained, the original (newly resolved) entry is removed in favor of the existing entry whose browser might already have explored (parts of) the server’s directory.

do_set_browser(path, iter, old_browser, new_browser) virtual¶

Parameters:

path (Gtk.TreePath) – A Gtk.TreePath to a top-level row.
iter (Gtk.TreeIter) – A Gtk.TreeIter pointing to the same row.
old_browser (Infinity.Browser) – The browser which was set at this row before.
new_browser (Infinity.Browser) – The new Infinity.Browser to set for this row.

Emits the InfGtk.BrowserModel ::set-browser signal. This is supposed to only be called by implementations of InfGtk.BrowserModel whenever they set or unset a browser on a row.

Signal Details¶

InfGtk.BrowserModel.signals.set_browser(browser_model, path, iter, old_browser, new_browser)¶

Signal Name:

set-browser

Flags:

RUN_LAST

Parameters:

browser_model (InfGtk.BrowserModel) – The object which received the signal
path (Gtk.TreePath) – A Gtk.TreePath pointing to the item with a new browesr.
iter (Gtk.TreeIter) – A Gtk.TreeIter pointing to the item with a new browser.
old_browser (Infinity.Browser) – The previous Infinity.Browser.
new_browser (Infinity.Browser) – The new Infinity.Browser.

This signal is emitted every time the Infinity.Browser for one of the model’s top-level entries change. This means either that a completely new item was inserted, that an item providing only a discovery has been resolved (see InfGtk.BrowserModel.resolve()), or that a top-level entry has been removed.

During emission of the signal the actual value in the model might either be the old or the new browser.