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/Header_bar/index.html

Module Wrappers.Header_bar

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

Create a new HeaderBar

val set_title_widget : t -> [ `widget | `initially_unowned | `object_ ] Gobject.obj option -> unit

Sets the title for the `GtkHeaderBar`.

When set to %NULL, the headerbar will display the title of the window it is contained in.

The title should help a user identify the current view. To achieve the same style as the builtin title, use the “title” style class.

You should set the title widget to %NULL, for the window title label to be visible again.

val set_show_title_buttons : t -> bool -> unit

Sets whether this header bar shows the standard window title buttons.

val set_decoration_layout : t -> string option -> unit

Sets the decoration layout for this header bar.

This property overrides the property@Gtk.Settings:gtk-decoration-layout setting.

There can be valid reasons for overriding the setting, such as a header bar design that does not allow for buttons to take room on the right, or only offers room for a single close button. Split header bars are another example for overriding the setting.

The format of the string is button names, separated by commas. A colon separates the buttons that should appear on the left from those on the right. Recognized button names are minimize, maximize, close and icon (the window icon).

For example, “icon:minimize,maximize,close” specifies an icon on the left, and minimize, maximize and close buttons on the right.

val remove : t -> [ `widget | `initially_unowned | `object_ ] Gobject.obj -> unit

Removes a child from the `GtkHeaderBar`.

The child must have been added with method@Gtk.HeaderBar.pack_start, method@Gtk.HeaderBar.pack_end or method@Gtk.HeaderBar.set_title_widget.

val pack_start : t -> [ `widget | `initially_unowned | `object_ ] Gobject.obj -> unit

Adds @child to @bar, packed with reference to the start of the @bar.

val pack_end : t -> [ `widget | `initially_unowned | `object_ ] Gobject.obj -> unit

Adds @child to @bar, packed with reference to the end of the @bar.

val get_title_widget : t -> [ `widget | `initially_unowned | `object_ ] Gobject.obj option

Retrieves the title widget of the header.

See method@Gtk.HeaderBar.set_title_widget.

val get_show_title_buttons : t -> bool

Returns whether this header bar shows the standard window title buttons.

val get_decoration_layout : t -> string option

Gets the decoration layout of the `GtkHeaderBar`.