Namespace

He – 1

The Application Framework for tauOS apps.

Version1.8.0
AuthorsFyra Labs
LicenseGPL-3.0-or-later
Websitehttps://docs.developers.tauos.co/libhelium/
Sourcehttps://github.com/tau-OS/libhelium/

Build

C headerslibhelium-1.h
pkg-config fileslibhelium-1

Dependencies

GObject—2.0 The base type system library
Browse documentation
Gtk—4.0 The GTK toolkit
Browse documentation

Additional documentation

Classes

AboutWindow

An AboutWindow is a window that displays information about the application.

AppBar

An AppBar is the header bar of an Window. It usually provides controls to manage the window, as well as optional children for more granular control.

Application

An application.

ApplicationWindow

An ApplicationWindow is a Window for holding the main content of an application.

Avatar

An Avatar is an element that displays an image that represents a person.

Badge

A Badge is a small status indicator that can be used to provide additional information about an object.

Banner

A Banner is a widget that displays a message to the user and provides a way for the user to act on the message.

Bin

A helper class for subclassing custom widgets.

BottomBar

A BottomBar is a toolbar made to make actions on content more visible. It may have up to 5 actions on each side. It has title and description labels, which can be part of a menu's label.

Button

A helper class to derive Buttons from.

ButtonContent

A helper class to derive Buttons from.

Chip

A Chip is an element that can facilitate entering information, making selections, filtering content, or triggering actions.

ChipGroup

A ChipGroup is a holder widget for Chips.

ContentBlock

A ContentBlock displays a single block of content, which contains an icon, text and optional buttons.

ContentBlockImage

A ContentBlockImage component is used to render an image inside a ContentBlock.

ContentBlockImageCluster

A ContentBlockImageCluster is a cluster of images that are rendered together in the same content block.

ContentList

A Content List is a list of content blocks with an optional title and description.

ContentScheme

DatePicker

DefaultScheme

Desktop

Helper class to deal with desktop-specific settings.

Dialog

A Dialog is a modal window that asks the user for input or shows a message.

DisclosureButton

A Disclosure Button is a view-based button that acts on said view.

Divider

A Divider is a thin line that groups content in a view, can be full-width (default) or inset

EmptyPage

An EmptyPage is a page that is used to display a message and a button when there is no data to display.

FillButton

A FillButton is a solid button with a label.

IconicButton

An Iconic Button is used in a HeBottomBar to display an action.

MiniContentBlock

A MiniContentBlock is a content block that is used to display content in a small area.

ModifierBadge

A ModiferBadge is a badge that can be used to show that the state of something has changed.

MonochromaticScheme

MutedScheme

NavigationRail

A NavigationRail is a vertical switcher that helps navigate a stack.

NavigationSection

OutlineButton

An Outline button is a transparent FillButton with a border.

OverlayButton

An OverlayButton is a widget that can be used to show action buttons above the widget that is being overlaid.

PillButton

A PillButton is a solid button with a label. It is more round and larger than a FillButton.

ProgressBar

A Progressbar indicates the progress of some process and contains a disable-able Stop Indicator for accessibility purposes.

Quantizer

QuantizerCelebi

QuantizerMap

Creates a dictionary with keys of colors, and values of count of the color

QuantizerResult

QuantizerWsmeans

QuantizerWu

An image quantizer that divides the image's pixels into clusters by recursively cutting an RGB cube, based on the weight of pixels in each area of the cube. <p>The algorithm was described by Xiaolin Wu in Graphic Gems II, published in 1991.

Score

ScoreAnnotatedColor

SegmentedButton

A SegmentedButton is a group of buttons that selects a setting. The developer supplies the buttons as children for further coding in their app.

SettingsList

A SettingsList is a list of content blocks with an optional title and description.

SettingsPage

Auxilary Class for handling the contents of Settings Windows

SettingsRow

A SettingsRow is a settings row that is used to display content in a small area that is activatable if desired.

SettingsWindow

A modal window that accepts SettingsLists or SettingsPages

SideBar

A SideBar is a complementary component containing its own AppBar, title, subtitle, and elements.

Slider

A Slider is a widget that is used to select a value by means of a dial running across a trough. Contains optional icons for the slider purpose, and a disable-able Stop Indicator for accessibility purposes. When using the Stop Indicator, it's advisable to add a mark with the value of 1.0 along the trough of the Slider so that the user can discern why the end point is marked.

StyleManager

A class that manages the style of the application in conjunction with the provided preferences. This is a low-level class that should not be used directly. Instead, let the He.Application class manage this for you.

Switch

A Switch is a widget that is used to toggle a setting on or off, or to indicate two modes via a toggle (ex. Light/Dark).

SwitchBar

A SwitchBar is a widget that is used to identify primarily a switchable view below it.

Tab

Standard tab designed for TabSwitcher, used to form a tabbed UI

TabPage

Auxilary Class for handling the contents of Tabs

TabSwitcher

TabBar widget designed for a variable number of tabs.

TextButton

A TextButton is a button that displays text. It has a transparent background.

TextField

TextField is a GtkEntry-like subclass that is meant to be used in forms where input must be validated before the form can be submitted. It provides feedback to users about the state of input validation and keeps track of its own validation state. By default, input is considered invalid. This widget can also be used in place of a GtkEntry for HIG compliance purposes. Example
var validated_entry = new He.TextField (); username_entry.changed.connect (() => { username_entry.is_valid = username_entry.text == “valid input”; });
If the TextField.from_regex () constructor is used then the entry automatically sets its validity status. A valid regex must be passed to this constructor. Example
GLib.Regex? regex = null; He.TextField only_lower_case_letters_entry; try { regex = new Regex (“^[a-z]*$”);

  only_lower_case_letters_entry = new He.TextField.from_regex (regex);

} catch (Error e) { critical (e.message); // Provide a fallback entry here }

TimePicker

TintButton

A TintButton is similar to a FillButton, except that the color of the button has a tinted appearance. In addition, the TintButton also support icons.

Toast

A Toast is a widget containing a quick little message for the user with an optional action button.

VibrantScheme

View

A helper widget that implements a View that displays items.

ViewAux

A ViewAux shows a view with an optional side pane.

ViewChooser

A ViewChooser is a chooser switcher that filters a stack's view.

ViewDual

A ViewDual is a view that displays two views side by side.

ViewingConditions

ViewMono

A ViewMono is a view that is a single-column layout.

ViewSubTitle

A ViewSubTitle is a view's subtitle.

deprecated: Unknown 

ViewSwitcher

A ViewSwitcher is a switcher that controls a stack's views.

ViewTitle

A ViewTitle is a widget that displays a view's title.

deprecated: Unknown 

WelcomeScreen

A WelcomeScreen is a screen that presents options and actions before displaying the main application.

Window

A Window is a container that has an HeAppBar and can be moved, resized, and closed. It may be a top-level window or a dialog. The title bar can be made always visible. Has an optional back button. The back button is only visible if has_back_button is true.

Interfaces

SchemeFactory

A SchemeFactory is a class which implements a method to generate a Scheme from an accent color and boolean representing whether the scheme is dark or light. Prior runs of the generate method should not affect the output of future runs.

Structs

ColorCAM16Color

ColorHCTColor

ColorLABColor

ColorLCHColor

ColorRGBColor

ColorXYZColor

Scheme

A struct that contains the color scheme of the app.

Enumerations

AboutWindowLicenses

An enum of commonly used licenses to be used in AboutWindow.

BannerStyle

An enum representing the style of the banner.

BottomBarPosition

An enum to define the position of the bottom bar actions.

Colors

An enum that maps colors to internal CSS classes as per HIG.

ContentBlockImageClusterImagePosition

The position of the cluster image in the cluster.

DesktopColorScheme

The color scheme preference enum, which is used to determine the color scheme of the desktop.

DesktopContrastScheme

The contrast scheme preference enum, which is used to determine the contrast scheme of the desktop.

DesktopEnsorScheme

The Ensor scheme preference enum, which is used to determine the Ensor scheme of the desktop.

ModifierBadgeAlignment

The alignment of the badge in a enum.

OverlayButtonAlignment

The alignment of the button.

OverlayButtonSize

The size of the button as an enum.

OverlayButtonTypeButton

The type of the button as an enum.

TabSwitcherTabBarBehavior

How the tab bar should behave

Functions

about_window_licenses_get_name

Returns the license name for the license.

about_window_licenses_get_url

Returns the license url for the license.

color_alpha_from_rgba_int

color_argb_from_linrgb

color_argb_from_rgb_int

color_argb_to_rgb

color_argb_to_xyz

color_blue_from_rgba_int

color_cam16_from_int

color_cam16_to_xyz

color_critical_plane_above

color_critical_plane_below

color_disliked

color_find_result_by_j

color_fix_disliked

If color is disliked, lighten it to make it likable.

color_from_argb_int

color_from_gdk_rgba

color_from_hex

color_from_params

color_get_rotated_hue

color_green_from_rgba_int

color_hct_blend

color_hct_to_argb

color_hct_to_hex

color_hct_to_lch

color_hexcode

color_hexcode_argb

color_lab_from_argb

color_lab_to_argb_int

color_lab_to_lch

color_lab_to_rgb

color_lab_to_xyz

color_lch_to_lab

color_lch_to_rgb

color_red_from_rgba_int

color_rgb_from_linrgb

color_rgb_to_argb_int

color_rgb_to_lab

color_rgb_to_lch

color_rgb_to_xyz

color_rgb_value_to_xyz

color_to_gdk_rgba

color_xyz_to_argb

color_xyz_to_cam16

color_xyz_to_lab

color_xyz_to_rgb

color_xyz_value_to_lab

colors_to_css_class

Returns the CSS class name for the color.

colors_to_string

Returns the color name.

content_block_image_cluster_image_position_get_column

Gets the column of the position.

content_block_image_cluster_image_position_get_row

Gets the row of the position.

desktop_ensor_scheme_to_factory

ensor_accent_from_pixels_async

ensor_accent_from_pixels_finish

init

math_utils_abs

math_utils_adapt

math_utils_are_in_cyclic_order

math_utils_argb_from_lstar

math_utils_bisect_to_limit

math_utils_bisect_to_segment

math_utils_chromatic_adaptation

math_utils_clamp_double

math_utils_convert

math_utils_delinearized

math_utils_difference_degrees

math_utils_double_delinearized

math_utils_elem_mul

math_utils_hue_of

math_utils_intercept

math_utils_inverse_chromatic_adaptation

math_utils_is_bounded_rgb

math_utils_lab_fovea

math_utils_lab_inverse_fovea

math_utils_lerp

math_utils_lerp_point

math_utils_linearized

math_utils_lstar_from_argb

math_utils_max

math_utils_midpoint

math_utils_min

math_utils_nth_vertex

math_utils_rotate_direction

math_utils_sanitize_degrees

math_utils_sanitize_degrees_int

math_utils_sanitize_radians

math_utils_set_coordinate

math_utils_signum

math_utils_y_from_lstar

misc_accel_label

Converts a gtk_accelerator_parse style accel string to a human-readable string.

misc_accel_string

Takes a description and an array of accels and returns Pango markup for use in a GtkTooltip. This method uses he_misc_accel_label . Example: Description Shortcut 1, Shortcut 2

misc_contrast_ratio

Gives the contrast ratio between two colors.

misc_find_ancestor_of_type

An useful method for finding an ancestor of a given widget.

misc_fix_fg_contrast

Gives a contrasting foreground color for a given background color.

modifier_badge_alignment_from_gtk_align

Sets the alignment from a Gtk.Align.

modifier_badge_alignment_to_gtk_align

Returns the alignment as a Gtk.Alignment.

overlay_button_alignment_from_gtk_align

Returns the string representation of the enum as an alignment.

overlay_button_alignment_to_gtk_align

Returns the string representation of the enum as an alignment to be used.

overlay_button_size_to_css_class

Returns the string representation of the enum as a CSS class to be used.

overlay_button_type_button_to_css_class

Returns the string representation of the enum as a CSS class to be used.