package ocgtk

  1. Overview
  2. Docs
OCaml bindings for GTK 4

Install 

dune-project
 Dependency

github.com Edit opam file Versions (2)

Authors

  1. C
    Chris Armstrong

Maintainers

  1. H
    hello@chrisarmstrong.dev

Sources

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

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

Module Wrappers.Icon_theme

type t = [ `icon_theme | `object_ ] Gobject.obj
val new_ : unit -> t

Create a new IconTheme

val set_theme_name : t -> string option -> unit

Sets the name of the icon theme that the `GtkIconTheme` object uses overriding system configuration.

This function cannot be called on the icon theme objects returned from func@Gtk.IconTheme.get_for_display.

val set_search_path : t -> string array option -> unit

Sets the search path for the icon theme object.

When looking for an icon theme, GTK will search for a subdirectory of one or more of the directories in @path with the same name as the icon theme containing an index.theme file. (Themes from multiple of the path elements are combined to allow themes to be extended by adding icons in the user’s home directory.)

In addition if an icon found isn’t found either in the current icon theme or the default icon theme, and an image file with the right name is found directly in one of the elements of @path, then that image will be used for the icon name. (This is legacy feature, and new icons should be put into the fallback icon theme, which is called hicolor, rather than directly on the icon path.)

val set_resource_path : t -> string array option -> unit

Sets the resource paths that will be looked at when looking for icons, similar to search paths.

The resources are considered as part of the hicolor icon theme and must be located in subdirectories that are defined in the hicolor icon theme, such as `@path/16x16/actions/run.png` or `@path/scalable/actions/run.svg`.

Icons that are directly placed in the resource path instead of a subdirectory are also considered as ultimate fallback, but they are treated like unthemed icons.

val lookup_icon : t -> string -> string array option -> int -> int -> Gtk_enums.textdirection -> Gtk_enums.iconlookupflags -> [ `icon_paintable | `object_ ] Gobject.obj

Looks up a named icon for a desired size and window scale, returning a `GtkIconPaintable`.

The icon can then be rendered by using it as a `GdkPaintable`, or you can get information such as the filename and size.

If the available @icon_name is not available and @fallbacks are provided, they will be tried in order.

If no matching icon is found, then a paintable that renders the "missing icon" icon is returned. If you need to do something else for missing icons you need to use method@Gtk.IconTheme.has_icon.

Note that you probably want to listen for icon theme changes and update the icon. This is usually done by overriding the GtkWidgetClass.css-changed() function.

val lookup_by_gicon : t -> Ocgtk_gio.Gio.Wrappers.Icon.t -> int -> int -> Gtk_enums.textdirection -> Gtk_enums.iconlookupflags -> [ `icon_paintable | `object_ ] Gobject.obj

Looks up a icon for a desired size and window scale.

The icon can then be rendered by using it as a `GdkPaintable`, or you can get information such as the filename and size.

val has_icon : t -> string -> bool

Checks whether an icon theme includes an icon for a particular name.

val has_gicon : t -> Ocgtk_gio.Gio.Wrappers.Icon.t -> bool

Checks whether an icon theme includes an icon for a particular `GIcon`.

val get_theme_name : t -> string

Gets the current icon theme name.

Returns (transfer full): the current icon theme name,

val get_search_path : t -> string array option

Gets the current search path.

See method@Gtk.IconTheme.set_search_path.

val get_resource_path : t -> string array option

Gets the current resource path.

See method@Gtk.IconTheme.set_resource_path.

val get_icon_names : t -> string array

Lists the names of icons in the current icon theme.

val get_display : t -> Ocgtk_gdk.Gdk.Wrappers.Display.t option

Returns the display that the `GtkIconTheme` object was created for.

val add_search_path : t -> string -> unit

Appends a directory to the search path.

See method@Gtk.IconTheme.set_search_path.

val add_resource_path : t -> string -> unit

Adds a resource path that will be looked at when looking for icons, similar to search paths.

See method@Gtk.IconTheme.set_resource_path.

This function should be used to make application-specific icons available as part of the icon theme.

val on_changed : ?after:bool -> t -> callback:(unit -> unit) -> Gobject.Signal.handler_id