Adw – 1
Description: Reference for Adw-1

### Namespace

# Adw – 1

Building blocks for modern GNOME applications

Version | 1.10.beta.1
Authors | Libadwaita contributors
License | LGPL-2.1-or-later
Website | https://gnome.pages.gitlab.gnome.org/libadwaita
Source | https://gitlab.gnome.org/GNOME/libadwaita/

#### Build

C headers | `adwaita.h`
pkg-config files | `libadwaita-1`

#### Dependencies

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

#### Additional documentation

- Compiling with Libadwaita
- Initialization
- Boxed Lists
- Adaptive Layouts
- Styles & Appearance
- CSS Variables
- Style Classes
- Migrating from Libhandy 1.4 to Libadwaita
- Migrating to Breakpoints
- Migrating to Adaptive Dialogs
- Widget Gallery
- Classes Hierarchy

#### Classes

AboutDialog | A dialog showing information about the application. since: 1.5
AboutWindow | A window showing information about the application. deprecated: 1.6 since: 1.2
ActionRow | A `GtkListBoxRow` used to present actions.
AlertDialog | A dialog presenting a message or a question. since: 1.5
Animation | A base class for animations.
AnimationTarget | Represents a value `AdwAnimation` can animate.
Application | A base class for Adwaita applications.
ApplicationWindow | A freeform application window.
Avatar | A widget displaying an image, with a generated fallback.
Banner | A bar with contextual information. since: 1.3
Bin | A widget with one child.
BottomSheet | A bottom sheet with an optional bottom bar. since: 1.6
Breakpoint | Describes a breakpoint for `AdwWindow` or `AdwDialog`. since: 1.4
BreakpointBin | A widget that changes layout based on available size. since: 1.4
ButtonContent | A helper widget for creating buttons.
ButtonRow | A `GtkListBoxRow` that looks like a button. since: 1.6
CallbackAnimationTarget | An `AdwAnimationTarget` that calls a given callback during the animation.
Carousel | A paginated scrolling widget.
CarouselIndicatorDots | A dots indicator for `AdwCarousel`.
CarouselIndicatorLines | A lines indicator for `AdwCarousel`.
Clamp | A widget constraining its child to a given size.
ClampLayout | A layout manager constraining its children to a given size.
ClampScrollable | A scrollable `AdwClamp`.
ComboRow | A `GtkListBoxRow` used to choose from a list of items.
CssClassBinding | A binding between a `GObject` property and a CSS class on a `GtkWidget`. unstable since: 1.10
Dialog | An adaptive dialog container. since: 1.5
EntryRow | A `GtkListBoxRow` with an embedded text entry. since: 1.2
EnumListItem | `AdwEnumListItem` is the type of items in a `AdwEnumListModel`. deprecated: 1.10
EnumListModel | A `GListModel` representing values of a given enum. deprecated: 1.10
ExpanderRow | A `GtkListBoxRow` used to reveal widgets.
Flap | An adaptive container acting like a box or an overlay. deprecated: 1.4
HeaderBar | A title bar widget.
InlineViewSwitcher | A view switcher that uses a toggle group. since: 1.7
Layout | An individual layout in `AdwMultiLayoutView`. since: 1.6
LayoutSlot | A child slot within `AdwLayout`. since: 1.6
Leaflet | An adaptive container acting like a box or a stack. deprecated: 1.4
LeafletPage | An auxiliary class used by `AdwLeaflet`. deprecated: 1.4
MessageDialog | A dialog presenting a message or a question. deprecated: 1.6 since: 1.2
MultiLayoutView | A widget for switching between different layouts. since: 1.6
NavigationPage | A page within `AdwNavigationView` or `AdwNavigationSplitView`. since: 1.4
NavigationSplitView | A widget presenting sidebar and content side by side or as a navigation view. since: 1.4
NavigationView | A page-based navigation container. since: 1.4
NoneAnimationTarget | An `AdwAnimationTarget` that doesn’t do anything. since: 1.9
OverlaySplitView | A widget presenting sidebar and content side by side or as an overlay. since: 1.4
PasswordEntryRow | A `AdwEntryRow` tailored for entering secrets. since: 1.2
PreferencesDialog | A dialog showing application’s preferences. since: 1.5
PreferencesGroup | A group of preference rows.
PreferencesPage | A page from `AdwPreferencesDialog`.
PreferencesRow | A `GtkListBoxRow` used to present preferences.
PreferencesWindow | A window to present an application’s preferences. deprecated: 1.6
PropertyAnimationTarget | An `AdwAnimationTarget` changing the value of a property of a `GObject` instance. since: 1.2
ShortcutLabel | A widget that displays a keyboard shortcut. since: 1.8
ShortcutsDialog | A dialog that displays application’s keyboard shortcuts. since: 1.8
ShortcutsItem | An object representing an individual shortcut in `AdwShortcutsSection`. since: 1.8
ShortcutsSection | An object representing a section in `AdwShortcutsDialog`. since: 1.8
Sidebar | Adaptive sidebar widget. since: 1.9
SidebarItem | An item within `AdwSidebarSection`. since: 1.9
SidebarSection | A section within `AdwSidebar`. since: 1.9
Spinner | A widget showing a loading spinner. since: 1.6
SpinnerPaintable | A paintable showing a loading spinner. since: 1.6
SpinRow | An `AdwActionRow` with an embedded spin button. since: 1.4
SplitButton | A combined button and dropdown widget.
SpringAnimation | A spring-based `AdwAnimation`.
Squeezer | A best fit container. deprecated: 1.4
SqueezerPage | An auxiliary class used by `AdwSqueezer`. deprecated: 1.4
StatusPage | A page used for empty/error states and similar use-cases.
StyleManager | A class for managing application-wide styling.
SwipeTracker | A swipe tracker used in `AdwCarousel`, `AdwNavigationView` and `AdwOverlaySplitView`.
SwitchRow | A `GtkListBoxRow` used to represent two states. since: 1.4
TabBar | A tab bar for `AdwTabView`.
TabButton | A button that displays the number of `AdwTabView` pages. since: 1.3
TabOverview | A tab overview for `AdwTabView`. since: 1.3
TabPage | An auxiliary class used by `AdwTabView`.
TabView | A dynamic tabbed container.
TimedAnimation | A time-based `AdwAnimation`.
Toast | A helper object for `AdwToastOverlay`.
ToastOverlay | A widget showing toasts above its content.
Toggle | A toggle within `AdwToggleGroup`. since: 1.7
ToggleGroup | A group of exclusive toggles. since: 1.7
ToolbarView | A widget containing a page, as well as top and/or bottom bars. since: 1.4
ViewStack | A view container for `AdwViewSwitcher`.
ViewStackPage | An auxiliary class used by `AdwViewStack`.
ViewStackPages | An auxiliary class used by `AdwViewStack`. since: 1.4
ViewSwitcher | An adaptive view switcher.
ViewSwitcherBar | A view switcher action bar.
ViewSwitcherSidebar | An adaptive sidebar that controls an `AdwViewStack`. since: 1.9
ViewSwitcherTitle | A view switcher title. deprecated: 1.4
Window | A freeform window.
WindowTitle | A helper widget for setting a window’s title and subtitle.
WrapBox | A box-like widget that can wrap into multiple lines. since: 1.7
WrapLayout | A box-like layout that can wrap into multiple lines. since: 1.7

#### Interfaces

Swipeable | An interface for swipeable widgets.

#### Structs

BreakpointCondition | Describes condition for an `AdwBreakpoint`. since: 1.4
SpringParams | Physical parameters of a spring for `AdwSpringAnimation`.

#### Enumerations

AccentColor | Describes the available system accent colors. since: 1.6
AnimationState | Describes the possible states of an `AdwAnimation`.
BannerButtonStyle | Describes the available button styles for `AdwBanner`. since: 1.7
BreakpointConditionLengthType | Describes length types for `AdwBreakpointCondition`. since: 1.4
BreakpointConditionRatioType | Describes ratio types for `AdwBreakpointCondition`. since: 1.4
CenteringPolicy | Describes title centering behavior of a `AdwHeaderBar` widget.
ColorScheme | Application color schemes for `AdwStyleManager:color-scheme`.
DialogPresentationMode | Describes the available presentation modes for `AdwDialog`. since: 1.5
Easing | Describes the available easing functions for use with `AdwTimedAnimation`.
FlapFoldPolicy | Describes the possible folding behavior of a `AdwFlap` widget. deprecated: 1.4
FlapTransitionType | Describes transitions types of a `AdwFlap` widget. deprecated: 1.4
FoldThresholdPolicy | Determines when `AdwFlap` and `AdwLeaflet` will fold. deprecated: 1.4
InlineViewSwitcherDisplayMode | Describes what `AdwInlineViewSwitcher` toggles display. since: 1.7
JustifyMode | Describes line justify behaviors in a `AdwWrapLayout` or `AdwWrapBox`. since: 1.7
LeafletTransitionType | Describes the possible transitions in a `AdwLeaflet` widget. deprecated: 1.4
LengthUnit | Describes length units. since: 1.4
NavigationDirection | Describes the direction of a swipe navigation gesture.
PackDirection | Describes child packing behavior in a `AdwWrapLayout` or `AdwWrapBox`. since: 1.7
ResponseAppearance | Describes the possible styles of `AdwAlertDialog` response buttons. since: 1.2
SidebarMode | Determines how an `AdwSidebar` should look and behave. since: 1.9
SqueezerTransitionType | Describes the possible transitions in a `AdwSqueezer` widget. deprecated: 1.4
ToastPriority | `AdwToast` behavior when another toast is already displayed.
ToolbarStyle | Describes the possible top or bottom bar styles in an `AdwToolbarView` widget. since: 1.4
ViewSwitcherPolicy | Describes the adaptive modes of `AdwViewSwitcher`.
WrapPolicy | Describes line wrapping behavior in a `AdwWrapLayout` or `AdwWrapBox`. since: 1.7

#### Bitfields

TabViewShortcuts | Describes available shortcuts in an `AdwTabView`. since: 1.2

#### Callbacks

AnimationTargetFunc | Prototype for animation targets based on user callbacks.
CssClassBindingMapToClassFunc | Prototype for mapping properties to CSS classes for a `AdwCssClassBinding`. unstable since: 1.10
CssClassBindingMapToPropertyFunc | Prototype for mapping CSS classes to properties for a `AdwCssClassBinding`. unstable since: 1.10
SidebarSectionCreateItemFunc | Called for sidebars that are bound to a `GListModel` with `adw_sidebar_section_bind_model()` for each item that gets added to the model. since: 1.9

#### Functions

bind_property_to_css_class | Creates a binding between a property on `source` and a CSS class on `target`. unstable since: 1.10
bind_property_to_css_class_full | Creates a binding between a property on `source` and a CSS class on `target` with a custom mapping. unstable since: 1.10
bind_property_to_css_class_with_closures | Creates a binding between a property on `source` and a CSS class on `target` with a custom mapping using closures. unstable since: 1.10
get_enable_animations | Checks whether animations are enabled for `widget`.
get_major_version | Returns the major version number of the Adwaita library.
get_micro_version | Returns the micro version number of the Adwaita library.
get_minor_version | Returns the minor version number of the Adwaita library.
init | Initializes Libadwaita.
is_initialized | Use this function to check if libadwaita has been initialized with `adw_init()`.
lerp | Computes the linear interpolation between `a` and `b` for `t`.
rgba_to_standalone | Adjusts `rgba` to be suitable as a standalone color. since: 1.6
show_about_dialog | A convenience function for showing an application’s about dialog. since: 1.5
show_about_dialog_from_appdata | A convenience function for showing an application’s about dialog from AppStream metadata. since: 1.5
show_about_window | A convenience function for showing an application’s about window. deprecated: 1.6 since: 1.2
show_about_window_from_appdata | A convenience function for showing an application’s about window from AppStream metadata. deprecated: 1.6 since: 1.4

#### Function Macros

CHECK_VERSION | Compile-time version checking. Evaluates to `TRUE` if the version of Adwaita is greater than the required one.

#### Constants

DURATION_INFINITE | Indicates an `AdwAnimation` with an infinite duration.
MAJOR_VERSION | Adwaita major version component (e.g. 1 if the version is 1.2.3).
MICRO_VERSION | Adwaita micro version component (e.g. 3 if the version is 1.2.3).
MINOR_VERSION | Adwaita minor version component (e.g. 2 if the version is 1.2.3).
VERSION_S | Adwaita version, encoded as a string, useful for printing and concatenation.