TreeSelection

The selection object for GtkTreeView

The gtk.tree_selection.TreeSelection object is a helper object to manage the selection for a gtk.tree_view.TreeView widget. The gtk.tree_selection.TreeSelection object is automatically created when a new gtk.tree_view.TreeView widget is created, and cannot exist independently of this widget. The primary reason the gtk.tree_selection.TreeSelection objects exists is for cleanliness of code and API. That is, there is no conceptual reason all these functions could not be methods on the gtk.tree_view.TreeView widget instead of a separate function.

The gtk.tree_selection.TreeSelection object is gotten from a gtk.tree_view.TreeView by calling gtk.tree_view.TreeView.getSelection. It can be manipulated to check the selection status of the tree, as well as select and deselect individual rows. Selection is done completely view side. As a result, multiple views of the same model can have completely different selections. Additionally, you cannot change the selection of a row on the model that is not currently displayed by the view without expanding its parents first.

One of the important things to remember when monitoring the selection of a view is that the gtk.tree_selection.TreeSelection::changed signal is mostly a hint. That is, it may only emit one signal when a range of rows is selected. Additionally, it may on occasion emit a gtk.tree_selection.TreeSelection::changed signal when nothing has happened (mostly as a result of programmers calling select_row on an already selected row).

More...

class TreeSelection : ObjectG {

int countSelectedRows();

gtk.types.SelectionMode getMode();

bool getSelected(gtk.tree_model.TreeModel model, gtk.tree_iter.TreeIter iter);

gtk.tree_path.TreePath[] getSelectedRows(gtk.tree_model.TreeModel model);

gtk.tree_view.TreeView getTreeView();

bool iterIsSelected(gtk.tree_iter.TreeIter iter);

bool pathIsSelected(gtk.tree_path.TreePath path);

void selectAll();

void selectIter(gtk.tree_iter.TreeIter iter);

void selectPath(gtk.tree_path.TreePath path);

void selectRange(gtk.tree_path.TreePath startPath, gtk.tree_path.TreePath endPath);

void selectedForeach(gtk.types.TreeSelectionForeachFunc func);

void setMode(gtk.types.SelectionMode type);

void setSelectFunction(gtk.types.TreeSelectionFunc func);

void unselectAll();

void unselectIter(gtk.tree_iter.TreeIter iter);

void unselectPath(gtk.tree_path.TreePath path);

void unselectRange(gtk.tree_path.TreePath startPath, gtk.tree_path.TreePath endPath);

ulong connectChanged(T callback, Flag!"After" after);

}

Members

Functions

connectChanged ulong connectChanged(T callback, Flag!"After" after): Connect to Changed signal.
countSelectedRows int countSelectedRows(): Returns the number of rows that have been selected in tree.
getMode gtk.types.SelectionMode getMode(): Gets the selection mode for selection. See gtk.tree_selection.TreeSelection.setMode.
getSelected bool getSelected(gtk.tree_model.TreeModel model, gtk.tree_iter.TreeIter iter): Sets iter to the currently selected node if selection is set to gtk.types.SelectionMode.Single or gtk.types.SelectionMode.Browse. iter may be NULL if you just want to test if selection has any selected nodes. model is filled with the current model as a convenience. This function will not work if you use selection is gtk.types.SelectionMode.Multiple.
getSelectedRows gtk.tree_path.TreePath[] getSelectedRows(gtk.tree_model.TreeModel model): Creates a list of path of all selected rows. Additionally, if you are planning on modifying the model after calling this function, you may want to convert the returned list into a list of gtk.tree_row_reference.TreeRowReferences. To do this, you can use gtk.tree_row_reference.TreeRowReference.new_.
getTreeView gtk.tree_view.TreeView getTreeView(): Returns the tree view associated with selection.
iterIsSelected bool iterIsSelected(gtk.tree_iter.TreeIter iter): Returns true if the row at iter is currently selected.
pathIsSelected bool pathIsSelected(gtk.tree_path.TreePath path): Returns true if the row pointed to by path is currently selected. If path does not point to a valid location, false is returned
selectAll void selectAll(): Selects all the nodes. selection must be set to gtk.types.SelectionMode.Multiple mode.
selectIter void selectIter(gtk.tree_iter.TreeIter iter): Selects the specified iterator.
selectPath void selectPath(gtk.tree_path.TreePath path): Select the row at path.
selectRange void selectRange(gtk.tree_path.TreePath startPath, gtk.tree_path.TreePath endPath): Selects a range of nodes, determined by start_path and end_path inclusive. selection must be set to gtk.types.SelectionMode.Multiple mode.
selectedForeach void selectedForeach(gtk.types.TreeSelectionForeachFunc func): Calls a function for each selected node. Note that you cannot modify the tree or selection from within this function. As a result, gtk.tree_selection.TreeSelection.getSelectedRows might be more useful.
setMode void setMode(gtk.types.SelectionMode type): Sets the selection mode of the selection. If the previous type was gtk.types.SelectionMode.Multiple, then the anchor is kept selected, if it was previously selected.
setSelectFunction void setSelectFunction(gtk.types.TreeSelectionFunc func): Sets the selection function.
unselectAll void unselectAll(): Unselects all the nodes.
unselectIter void unselectIter(gtk.tree_iter.TreeIter iter): Unselects the specified iterator.
unselectPath void unselectPath(gtk.tree_path.TreePath path): Unselects the row at path.
unselectRange void unselectRange(gtk.tree_path.TreePath startPath, gtk.tree_path.TreePath endPath): Unselects a range of nodes, determined by start_path and end_path inclusive.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

Detailed Description

Deprecated: Use gtk.selection_model.SelectionModel instead

gtk tree_selection classes

TreeSelection