Namespace

Handy – 1

Building blocks for modern adaptive GNOME apps

Version1.5.0
AuthorsPurism SPC
LicenseGPL-2.1-or-later
Websitehttps://gnome.pages.gitlab.gnome.org/libhandy
Sourcehttps://gitlab.gnome.org/GNOME/libhandy/

Build

C headershandy.h
pkg-config fileslibhandy-1

Dependencies

GObject The base type system library
Browse documentation
GTK The GTK toolkit
Browse documentation

Classes

ActionRow

A GtkListBox row used to present actions.

ApplicationWindow

A freeform application window.

Avatar

A widget displaying an image, with a generated fallback.

Carousel

A paginated scrolling widget.

CarouselIndicatorDots

A dots indicator for HdyCarousel.

CarouselIndicatorLines

A lines indicator for HdyCarousel.

Clamp

A container constraining its child to a given size.

ComboRow

A GtkListBox row used to choose from a list of items.

Deck

A swipeable widget showing one of the visible children at a time.

EnumValueObject

An object representing a GEnumValue.

ExpanderRow

A GtkListBox row used to reveal widgets.

Flap

An adaptive container acting like a box or an overlay.

HeaderBar

A box with a centered child.

HeaderGroup

An object handling composite title bars.

HeaderGroupChild

A child object for HdyHeaderGroup.

Keypad

A keypad for dialing numbers.

Leaflet

An adaptive container acting like a box or a stack.

PreferencesGroup

Group gathering preferences rows.

PreferencesPage

A page from the preferences window.

PreferencesRow

A GtkListBox row used to present preferences.

PreferencesWindow

A window to present an application’s preferences.

SearchBar

A toolbar to integrate a search entry with.

Squeezer

A best fit container.

StatusPage

A page used for empty/error states and similar use-cases.

StyleManager

A class for managing application-wide styling.

SwipeGroup

An object for syncing swipeable widgets.

SwipeTracker

Swipe tracker used in HdyCarousel and HdyLeaflet.

TabBar

A tab bar for HdyTabView.

TabPage

An auxiliary class used by HdyTabView.

TabView

A dynamic tabbed container.

TitleBar

A simple title bar container.

ValueObject

An object representing a GValue.

ViewSwitcher

An adaptive view switcher.

ViewSwitcherBar

A view switcher action bar.

ViewSwitcherTitle

A view switcher title.

Window

A freeform window.

WindowHandle

A bin that acts like a titlebar.

Interfaces

Swipeable

An interface for swipeable widgets. See also: HdyCarousel, HdyDeck, HdyLeaflet, HdySwipeGroup.

Enumerations

CenteringPolicy

Describes title centering behavior of a HdyHeaderBar widget.

ColorScheme

Application color schemes for HdyStyleManager:color-scheme.

DeckTransitionType

This enumeration value describes the possible transitions between children in a HdyDeck widget.

FlapFoldPolicy

These enumeration values describe the possible folding behavior in a HdyFlap widget.

FlapTransitionType

These enumeration values describe the possible transitions between children in a HdyFlap widget, as well as which areas can be swiped via HdyFlap:swipe-to-open and HdyFlap:swipe-to-close.

HeaderGroupChildType

This enumeration value describes the child types handled by HdyHeaderGroup.

LeafletTransitionType

This enumeration value describes the possible transitions between modes and children in a HdyLeaflet widget.

NavigationDirection

Represents direction of a swipe navigation gesture in HdyDeck and HdyLeaflet.

SqueezerTransitionType

These enumeration values describe the possible transitions between children in a HdySqueezer widget.

ViewSwitcherPolicy

Describes the adaptive modes of HdyViewSwitcher.

Callbacks

AvatarImageLoadFunc

The returned GdkPixbuf is expected to be square with width and height set to size. The image is cropped to a circle without any scaling or transformation.

ComboRowGetEnumValueNameFunc

Called for combo rows that are bound to an enumeration with hdy_combo_row_set_for_enum() for each value from that enumeration.

ComboRowGetNameFunc

Called for combo rows that are bound to a GListModel with hdy_combo_row_bind_name_model() for each item that gets added to the model.

Functions

ease_out_cubic

Computes the ease out for t.

enum_value_row_name

This is a default implementation of ComboRowGetEnumValueNameFunc to be used with hdy_combo_row_set_for_enum(). If the enumeration has a nickname, it will return it, otherwise it will return its name.

get_enable_animations

Returns whether animations are enabled for that widget. This should be used when implementing an animated widget to know whether to animate it or not.

init

Call this function just after initializing GTK, if you are using GtkApplication it means it must be called when the GApplication::startup signal is emitted. If libhandy has already been initialized, the function will simply return.