package ocgtk

  1. Overview
  2. Docs
OCaml bindings for GTK 4

Install

dune-project
 Dependency

Authors

Maintainers

Sources

v0.1-preview2.tar.gz
sha256=4e50fdb5093136a10fc8ffbe388e44cbcb70d52f8afdd48863ec7e22580ff054

doc/ocgtk.gtk/Ocgtk_gtk/Gtk/Wrappers/List_store/index.html

Module Wrappers.List_store

type t = [ `list_store | `object_ ] Gobject.obj
val newv : int -> Gobject.Type.t array -> t

Create a new ListStore

val swap : t -> [ `tree_iter ] Gobject.obj -> [ `tree_iter ] Gobject.obj -> unit

Swaps @a and @b in @store. Note that this function only works with unsorted stores.

val set_valuesv : t -> [ `tree_iter ] Gobject.obj -> int array -> Gobject.Value.t array -> int -> unit

A variant of gtk_list_store_set_valist() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings and in case the number of columns to change is not known until run-time.

val set_value : t -> [ `tree_iter ] Gobject.obj -> int -> Gobject.Value.t -> unit

Sets the data in the cell specified by @iter and @column. The type of @value must be convertible to the type of the column.

val set_column_types : t -> int -> Gobject.Type.t array -> unit

Sets the types of the columns of a list store.

This function is meant primarily for objects that inherit from `GtkListStore`, and should only be used when constructing a new instance.

This function cannot be called after a row has been added, or a method on the `GtkTreeModel` interface is called.

val remove : t -> [ `tree_iter ] Gobject.obj -> bool

Removes the given row from the list store. After being removed, @iter is set to be the next valid row, or invalidated if it pointed to the last row in @list_store.

val prepend : t -> [ `tree_iter ] Gobject.obj

Prepends a new row to @list_store. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().

val move_before : t -> [ `tree_iter ] Gobject.obj -> [ `tree_iter ] Gobject.obj option -> unit

Moves @iter in @store to the position before @position. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the end of the list.

val move_after : t -> [ `tree_iter ] Gobject.obj -> [ `tree_iter ] Gobject.obj option -> unit

Moves @iter in @store to the position after @position. Note that this function only works with unsorted stores. If @position is %NULL, @iter will be moved to the start of the list.

val iter_is_valid : t -> [ `tree_iter ] Gobject.obj -> bool

Checks if the given iter is a valid iter for this `GtkListStore`.

This function is slow. Only use it for debugging and/or testing purposes.

val insert_with_valuesv : t -> int -> int array -> Gobject.Value.t array -> int -> [ `tree_iter ] Gobject.obj

A variant of gtk_list_store_insert_with_values() which takes the columns and values as two arrays, instead of varargs.

This function is mainly intended for language-bindings.

val insert_before : t -> [ `tree_iter ] Gobject.obj option -> [ `tree_iter ] Gobject.obj

Inserts a new row before @sibling. If @sibling is %NULL, then the row will be appended to the end of the list. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().

val insert_after : t -> [ `tree_iter ] Gobject.obj option -> [ `tree_iter ] Gobject.obj

Inserts a new row after @sibling. If @sibling is %NULL, then the row will be prepended to the beginning of the list. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().

val insert : t -> int -> [ `tree_iter ] Gobject.obj

Creates a new row at @position. @iter will be changed to point to this new row. If @position is -1 or is larger than the number of rows on the list, then the new row will be appended to the list. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().

val clear : t -> unit

Removes all rows from the list store.

val append : t -> [ `tree_iter ] Gobject.obj

Appends a new row to @list_store. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().