Libadwaita

https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest
Admin
Libadwaita is a library providing building blocks and widgets for modern GNOME applications,...
Tokens:558,941
Snippets:7,029
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Build and install Libadwaita on macOS

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/build-howto.html

Clone the repository, set up the build directory, and compile and install the library. This is the standard Meson build process.

```bash
git clone https://gitlab.gnome.org/GNOME/libadwaita.git
cd libadwaita
meson setup _build
ninja -C _build
ninja -C _build install

```

--------------------------------

### Install build dependencies on macOS with brew

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/build-howto.html

Run this command to install the required build dependencies on macOS using Homebrew.

```bash
brew install pkg-config gtk4 meson gobject-introspection vala

```

--------------------------------

### AdwComboRow UI definition example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.ComboRow.html

Example of an AdwComboRow UI definition with a GtkStringList model containing three items.

```xml
<object class="AdwComboRow">
  <property name="title" translatable="yes">Combo Row</property>
  <property name="model">
    <object class="GtkStringList">
      <items>
        <item translatable="yes">Foo</item>
        <item translatable="yes">Bar</item>
        <item translatable="yes">Baz</item>
      </items>
    </object>
  </property>
</object>
```

--------------------------------

### Connecting to AdwBreakpoint apply/unapply signals

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/method.Breakpoint.add_setter.html

Example of connecting to the 'apply' and 'unapply' signals to handle properties with irreversible side effects, as recommended in the note. The example shows two callback functions and the signal connections.

```c
static void
breakpoint_apply_cb (MyWidget *self)
{
  gtk_button_set_icon_name (self->button, "go-previous-symbolic");
}

static void
breakpoint_apply_cb (MyWidget *self)
{
  gtk_button_set_label (self->button, _("_Back"));
}

// ...

g_signal_connect_swapped (breakpoint, "apply",
                          G_CALLBACK (breakpoint_apply_cb), self);
g_signal_connect_swapped (breakpoint, "unapply",
                          G_CALLBACK (breakpoint_unapply_cb), self);

```

--------------------------------

### adw_message_dialog_add_responses usage example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/method.MessageDialog.add_responses.html

Example showing how to call adw_message_dialog_add_responses with a NULL-terminated list of response IDs and labels. The example uses translated labels with mnemonics.

```c
adw_message_dialog_add_responses (dialog,
                                  "cancel",  _("_Cancel"),
                                  "discard", _("_Discard"),
                                  "save",    _("_Save"),
                                  NULL);
```

--------------------------------

### adw_alert_dialog_add_responses() example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/method.AlertDialog.add_responses.html

Example usage of adw_alert_dialog_add_responses() with three responses: cancel, discard, and save. The list is NULL-terminated.

```c
adw_alert_dialog_add_responses (dialog,
                                "cancel",  _("_Cancel"),
                                "discard", _("_Discard"),
                                "save",    _("_Save"),
                                NULL);

```

--------------------------------

### Usage examples for adw_about_window_add_legal_section

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/method.AboutWindow.add_legal_section.html

Four examples showing different combinations of copyright and license parameters: known license, custom license, copyright only, and custom license only. The first argument is the window cast to ADW_ABOUT_WINDOW.

```c
adw_about_window_add_legal_section (ADW_ABOUT_WINDOW (about),
                                    _("Copyright and a known license"),
                                    "© 2022 Example",
                                    GTK_LICENSE_LGPL_2_1,
                                    NULL);

adw_about_window_add_legal_section (ADW_ABOUT_WINDOW (about),
                                    _("Copyright and custom license"),
                                    "© 2022 Example",
                                    GTK_LICENSE_CUSTOM,
                                    "Custom license text");

adw_about_window_add_legal_section (ADW_ABOUT_WINDOW (about),
                                    _("Copyright only"),
                                    "© 2022 Example",
                                    GTK_LICENSE_UNKNOWN,
                                    NULL);

adw_about_window_add_legal_section (ADW_ABOUT_WINDOW (about),
                                    _("Custom license only"),
                                    NULL,
                                    GTK_LICENSE_CUSTOM,
                                    "Something completely custom here.");

```

--------------------------------

### AdwBreakpoint UI definition example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.Breakpoint.html

Example of an AdwBreakpoint UI definition in GtkBuilder format, showing how to specify a condition and setters.

```xml
<object class="AdwBreakpoint">
  <condition>max-width: 400px</condition>
  <setter object="button" property="visible">True</setter>
  <setter object="box" property="orientation">vertical</setter>
  <setter object="page" property="title" translatable="yes">Example</setter>
</object>
```

--------------------------------

### XML example using AdwWindowTitle for title-widget

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/property.HeaderBar.title-widget.html

An XML example showing how to set the title-widget property to an AdwWindowTitle object. This is used when a custom title is desired.

```xml
<object class="AdwHeaderBar">
  <property name="title-widget">
    <object class="AdwWindowTitle">
      <property name="title" translatable="yes">Title</property>
    </object>
  </property>
</object>
```

--------------------------------

### AdwToolbarView UI definition example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.ToolbarView.html

Example of a UI definition for AdwToolbarView, showing a top bar with AdwHeaderBar and content with AdwPreferencesPage. The content property is set to the preferences page.

```xml
<object class="AdwToolbarView">
  <child type="top">
    <object class="AdwHeaderBar"/>
  </child>
  <property name="content">
    <object class="AdwPreferencesPage">
      <!-- ... -->
    </object>
  </property>
</object>
```

--------------------------------

### Example: Using an alert dialog

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.AlertDialog.html

Demonstrates creating an AdwAlertDialog, setting its body text, adding responses, configuring response appearance, default and close responses, connecting to the 'response' signal, and presenting the dialog.

```c
AdwDialog *dialog;

dialog = adw_alert_dialog_new (_("Replace File?"), NULL);

adw_alert_dialog_format_body (ADW_ALERT_DIALOG (dialog),
                              _("A file named “%s” already exists. Do you want to replace it?"),
                              filename);

adw_alert_dialog_add_responses (ADW_ALERT_DIALOG (dialog),
                                "cancel",  _("_Cancel"),
                                "replace", _("_Replace"),
                                NULL);

adw_alert_dialog_set_response_appearance (ADW_ALERT_DIALOG (dialog),
                                          "replace",
                                          ADW_RESPONSE_DESTRUCTIVE);

adw_alert_dialog_set_default_response (ADW_ALERT_DIALOG (dialog), "cancel");
adw_alert_dialog_set_close_response (ADW_ALERT_DIALOG (dialog), "cancel");

g_signal_connect (dialog, "response", G_CALLBACK (response_cb), self);

adw_dialog_present (dialog, parent);
```

--------------------------------

### adw_header_bar_get_show_start_title_buttons

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.HeaderBar.html

Gets whether to show title buttons at the start of `self`.

```APIDOC
## adw_header_bar_get_show_start_title_buttons

### Description
Gets whether to show title buttons at the start of `self`.

### Method
adw_header_bar_get_show_start_title_buttons

### Parameters
- **self** (AdwHeaderBar) - The header bar instance.

### Returns
- **gboolean** - TRUE if title buttons are shown at the start, FALSE otherwise.
```

--------------------------------

### adw_header_bar_get_show_start_title_buttons

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/method.HeaderBar.get_show_start_title_buttons.html

Gets whether to show title buttons at the start of the header bar.

```APIDOC
## adw_header_bar_get_show_start_title_buttons

### Description
Gets whether to show title buttons at the start of the header bar.

### Method
GET (property getter)

### Return Value
- **Type**: `gboolean` - `TRUE` if title buttons at the start are shown.
```

--------------------------------

### Initialize Libadwaita with AdwApplication (C)

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/initialization.html

Use AdwApplication instead of GtkApplication to automatically initialize Libadwaita. The example creates a window with a label and runs the application. After building and running, the application will display a window titled 'Hello'.

```c
#include <adwaita.h>

static void
activate_cb (GtkApplication *app)
{
  GtkWidget *window = gtk_application_window_new (app);
  GtkWidget *label = gtk_label_new ("Hello World");

  gtk_window_set_title (GTK_WINDOW (window), "Hello");
  gtk_window_set_default_size (GTK_WINDOW (window), 200, 200);
  gtk_window_set_child (GTK_WINDOW (window), label);
  gtk_window_present (GTK_WINDOW (window));
}

int
main (int   argc,
      char *argv[])
{
  g_autoptr (AdwApplication) app = NULL;

  app = adw_application_new ("org.example.Hello", G_APPLICATION_DEFAULT_FLAGS);

  g_signal_connect (app, "activate", G_CALLBACK (activate_cb), NULL);

  return g_application_run (G_APPLICATION (app), argc, argv);
}

```

--------------------------------

### adw_tab_overview_get_show_start_title_buttons

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.TabOverview.html

Gets whether start title buttons are shown in the header bar.

```APIDOC
## adw_tab_overview_get_show_start_title_buttons

### Description
Gets whether start title buttons are shown in `self`‘s header bar.

### Method
GET

### Endpoint
adw_tab_overview_get_show_start_title_buttons

### Parameters
#### Path Parameters
- **self** (AdwTabOverview) - Required - The tab overview instance.

### Response
#### Success Response
- **show_start_title_buttons** (gboolean) - Whether start title buttons are shown.

### Since
1.3
```

--------------------------------

### Initialize Libadwaita with adw_init() (C)

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/initialization.html

Use adw_init() instead of gtk_init() when AdwApplication is not possible. The example creates a window with a label and runs a manual main loop until all toplevel windows are closed.

```c
#include <adwaita.h>

int
main (int   argc,
      char *argv[])
{
  GtkWidget *window, *label;

  adw_init ();

  window = gtk_window_new ();
  label = gtk_label_new ("Hello World");

  gtk_window_set_title (GTK_WINDOW (window), "Hello");
  gtk_window_set_default_size (GTK_WINDOW (window), 200, 200);
  gtk_window_set_child (GTK_WINDOW (window), label);
  gtk_window_present (GTK_WINDOW (window));

   while (g_list_model_get_n_items (gtk_window_get_toplevels ()) > 0)
    g_main_context_iteration (NULL, TRUE);

  return 0;
}

```

--------------------------------

### adw_view_stack_page_get_starts_section

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.ViewStackPage.html

Gets whether self starts a section. Available since version 1.9.

```APIDOC
## adw_view_stack_page_get_starts_section

### Description
Gets whether self starts a section. Available since version 1.9.

### Method
GET

### Endpoint
adw_view_stack_page_get_starts_section

### Parameters
#### Path Parameters
- **self** (AdwViewStackPage) - Required - The page instance.

### Response
#### Success Response (200)
- **starts_section** (boolean) - Whether self starts a section.

#### Response Example
{
  "starts_section": false
}
```

--------------------------------

### adw_swipeable_get_swipe_area

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.Flap.html

Gets the area the swipeable can start a swipe from for the given direction and gesture type.

```APIDOC
## adw_swipeable_get_swipe_area

### Description
Gets the area `self` can start a swipe from for the given direction and gesture type.

### Method
Instance method

### Signature
`void adw_swipeable_get_swipe_area (AdwSwipeable* self, AdwNavigationDirection direction, gboolean is_drag, GdkRectangle* rect)`

### Parameters
- **self** (AdwSwipeable*) - The swipeable object.
- **direction** (AdwNavigationDirection) - The direction of the swipe.
- **is_drag** (gboolean) - Whether the gesture is a drag.
- **rect** (GdkRectangle*) - Return location for the swipe area.

### Returns
None.
```

--------------------------------

### adw_show_about_window() example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.AboutWindow.html

Constructs and shows an AdwAboutWindow with application details, copyright, license, and credits. Use this function for a convenient way to display an about window.

```c
static void
show_about (GtkApplication *app)
{
  const char *developers[] = {
    "Angela Avery",
    NULL
  };

  const char *designers[] = {
    "GNOME Design Team",
    NULL
  };

  adw_show_about_window (gtk_application_get_active_window (app),
                         "application-name", _("Example"),
                         "application-icon", "org.example.App",
                         "version", "1.2.3",
                         "copyright", "© 2022 Angela Avery",
                         "issue-url", "https://gitlab.gnome.org/example/example/-/issues/",
                         "license-type", GTK_LICENSE_GPL_3_0,
                         "developers", developers,
                         "designers", designers,
                         "translator-credits", _("translator-credits"),
                         NULL);
}

```

--------------------------------

### AdwTabView::setup-menu

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/signal.TabView.setup-menu.html

Signal emitted when a context menu is opened or closed for a page. Use it to set up menu actions before showing the menu.

```APIDOC
## AdwTabView::setup-menu

### Description
Emitted when a context menu is opened or closed for `page`. If the menu has been closed, `page` will be set to `NULL`. It can be used to set up menu actions before showing the menu, for example disable actions not applicable to `page`.

### Declaration
```c
void
setup_menu (
  AdwTabView* self,
  AdwTabPage* page,
  gpointer user_data
)
```

### Parameters
- **self** (AdwTabView*) - The AdwTabView instance.
- **page** (AdwTabPage*) - A page of `self`. The argument can be `NULL`. The data is owned by the caller of the function.
- **user_data** (gpointer) - User data passed when the signal was connected.

### Default Handler
The default handler is called after the handlers added via `g_signal_connect()`.
```

--------------------------------

### adw_squeezer_get_xalign

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.Squeezer.html

Gets the horizontal alignment, from 0 (start) to 1 (end). Deprecated since 1.4.

```APIDOC
## adw_squeezer_get_xalign

### Description
Gets the horizontal alignment, from 0 (start) to 1 (end).

### Deprecated
Since 1.4

### Parameters
- `self` (AdwSqueezer) - The squeezer instance

### Returns
- (gfloat) - The horizontal alignment
```

--------------------------------

### Constructing an AdwAboutDialog with adw_show_about_dialog()

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.AboutDialog.html

Shows how to construct and display an AdwAboutDialog using the adw_show_about_dialog() function. The example sets various properties such as application name, icon, version, copyright, issue URL, license type, developers, designers, and translator credits.

```c
static void
show_about (GtkApplication *app)
{
  const char *developers[] = {
    "Angela Avery",
    NULL
  };

  const char *designers[] = {
    "GNOME Design Team",
    NULL
  };

  adw_show_about_dialog (GTK_WIDGET (gtk_application_get_active_window (app)),
                         "application-name", _("Example"),
                         "application-icon", "org.example.App",
                         "version", "1.2.3",
                         "copyright", "© 2022 Angela Avery",
                         "issue-url", "https://gitlab.gnome.org/example/example/-/issues/",
                         "license-type", GTK_LICENSE_GPL_3_0,
                         "developers", developers,
                         "designers", designers,
                         "translator-credits", _("translator-credits"),
                         NULL);
}

```

--------------------------------

### adw_overlay_split_view_get_sidebar_position

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/method.OverlaySplitView.get_sidebar_position.html

Gets the sidebar position for the AdwOverlaySplitView. Returns a GtkPackType indicating whether the sidebar is on the start or end side.

```APIDOC
## adw_overlay_split_view_get_sidebar_position

### Description
Gets the sidebar position for `self`.

### Method
GET

### Endpoint
adw_overlay_split_view_get_sidebar_position

### Parameters
#### Path Parameters
- **self** (AdwOverlaySplitView*) - Required - The overlay split view instance.

### Response
#### Success Response (200)
- **GtkPackType** - The sidebar position for `self`.

#### Response Example
```
GTK_PACK_START
```

### Notes
- Available since: 1.4
- Gets property `Adw.OverlaySplitView:sidebar-position`.
```

--------------------------------

### Create subprojects/libadwaita.wrap file

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/build-howto.html

Create this file to use Libadwaita as a Meson subproject. It points to the Git repository and revision.

```ini
[wrap-git]
directory=libadwaita
url=https://gitlab.gnome.org/GNOME/libadwaita.git
revision=main
depth=1

```

--------------------------------

### adw_sidebar_get_item

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/method.Sidebar.get_item.html

Gets the item at a given index within an AdwSidebar. The index starts from 0 at the top of the sidebar and matches the index returned by adw_sidebar_item_get_index(). Returns NULL if the index is out of range.

```APIDOC
## adw_sidebar_get_item

### Description
Gets the item at `index` within `self`. The index starts from 0 at the top of the sidebar, and is the same as the one returned by `adw_sidebar_item_get_index()`. Can return `NULL` if `index` is larger or equal to the number of items.

### Method
Function

### Signature
```c
AdwSidebarItem*
adw_sidebar_get_item (
  AdwSidebar* self,
  guint index
)
```

### Parameters
- **self** (AdwSidebar*) - The sidebar instance.
- **index** (guint) - Index of the item.

### Return Value
- **AdwSidebarItem*** - The item at `index`. The returned data is owned by the instance. Can be `NULL`.

### Since
Available since: 1.9
```

--------------------------------

### adw_shortcuts_item_get_action_name

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.ShortcutsItem.html

Gets the action name to get the accelerator from.

```APIDOC
## adw_shortcuts_item_get_action_name

### Description
Gets the action name to get the accelerator from.

### Method
Getter

### Parameters
- **self** (AdwShortcutsItem*) - Required - The shortcuts item.

### Returns
The action name of `self`.

### Since
1.8
```

--------------------------------

### Before: GtkWindow with titlebar and box

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/migrating-to-adaptive-dialogs.html

Original window structure using GtkWindow, AdwHeaderBar as titlebar, and a GtkBox with content and GtkActionBar. This is the starting point for migration.

```xml
<object class="GtkWindow">
  <property name="titlebar">
    <object class="AdwHeaderBar"/>
  </property>
  <property name="child">
    <object class="GtkBox">
      <property name="orientation">vertical</property>
      <child>
        <!-- content -->
      </child>
      <child>
        <object class="GtkActionBar"/>
      </child>
    </object>
  </property>
</object>

```

--------------------------------

### Create a toast with an action button

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.Toast.html

Creates a toast with an action button. The button label is set to "_Example" and the action name to "win.example". The toast is then added to the overlay.

```c
AdwToast *toast = adw_toast_new (_("Toast with Action"));

adw_toast_set_button_label (toast, _("_Example"));
adw_toast_set_action_name (toast, "win.example");

adw_toast_overlay_add_toast (overlay, toast);
```

--------------------------------

### AdwSidebar::setup-menu

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/signal.Sidebar.setup-menu.html

Signal emitted when a context menu is opened or closed for an item in an AdwSidebar. Use it to set up menu actions before showing the menu.

```APIDOC
## AdwSidebar::setup-menu

### Description
Emitted when a context menu is opened or closed for `item`. If the menu has been closed, `item` will be set to `NULL`. It can be used to set up menu actions before showing the menu, for example disable actions not applicable to `item`.

### Declaration
```
void
setup_menu (
  AdwSidebar* self,
  AdwSidebarItem* item,
  gpointer user_data
)
```

### Parameters
- **self** (AdwSidebar*) - The sidebar instance.
- **item** (AdwSidebarItem*) - An item in `self`. The argument can be `NULL`.
- **user_data** (gpointer) - User data passed when connecting the signal.

### Notes
- The default handler is called after the handlers added via `g_signal_connect()`.
- The data is owned by the caller of the function.
```

--------------------------------

### Remove shortcuts example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.TabView.html

Example of using adw_tab_view_remove_shortcuts() to remove the CONTROL_HOME and CONTROL_END shortcuts from a tab view.

```c
adw_tab_view_remove_shortcuts (view, ADW_TAB_VIEW_SHORTCUT_CONTROL_HOME |
                                     ADW_TAB_VIEW_SHORTCUT_CONTROL_END);
```

--------------------------------

### AdwApplicationWindow UI definition

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.ApplicationWindow.html

Example UI definition for an AdwApplicationWindow, showing a toolbar view with a header bar and a content placeholder. Note that using GtkApplication:menubar is not supported and may cause visual glitches.

```xml
<object class="AdwApplicationWindow">
  <property name="content">
    <object class="AdwToolbarView">
      <child type="top">
        <object class="AdwHeaderBar"/>
      </child>
      <property name="content">
        <!-- put your content here -->
      </property>
    </object>
  </property>
</object>
```

--------------------------------

### AdwMessageDialog Usage Example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.MessageDialog.html

Demonstrates creating an AdwMessageDialog, formatting its body, adding responses, setting response appearance, default response, and close response, and connecting to the response signal.

```APIDOC
## AdwMessageDialog Usage Example

### Description
This example shows how to create an AdwMessageDialog, set its body text, add responses, configure response appearance, set default and close responses, and connect to the response signal.

### Methods Used
- `adw_message_dialog_new(parent, heading, body)`
- `adw_message_dialog_format_body(dialog, format, ...)`
- `adw_message_dialog_add_responses(dialog, ...)`
- `adw_message_dialog_set_response_appearance(dialog, response, appearance)`
- `adw_message_dialog_set_default_response(dialog, response)`
- `adw_message_dialog_set_close_response(dialog, response)`

### Example Code
```c
GtkWidget *dialog;

dialog = adw_message_dialog_new (parent, _("Replace File?"), NULL);

adw_message_dialog_format_body (ADW_MESSAGE_DIALOG (dialog),
                                _("A file named \"%s\" already exists. Do you want to replace it?"),
                                filename);

adw_message_dialog_add_responses (ADW_MESSAGE_DIALOG (dialog),
                                  "cancel",  _("_Cancel"),
                                  "replace", _("_Replace"),
                                  NULL);

adw_message_dialog_set_response_appearance (ADW_MESSAGE_DIALOG (dialog), "replace", ADW_RESPONSE_DESTRUCTIVE);

adw_message_dialog_set_default_response (ADW_MESSAGE_DIALOG (dialog), "cancel");
adw_message_dialog_set_close_response (ADW_MESSAGE_DIALOG (dialog), "cancel");

g_signal_connect (dialog, "response", G_CALLBACK (response_cb), self);

gtk_window_present (GTK_WINDOW (dialog));
```
```

--------------------------------

### CSS for custom suggested-action button using .opaque style class

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/style-classes.html

CSS example showing how to create a button with custom colors similar to .suggested-action using the .opaque style class. Deprecated since 1.6.

```CSS
#custom-suggested-action-button {
  background-color: var(--accent-bg-color);
  color: var(--accent-fg-color);
}

```

--------------------------------

### adw_init()

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/func.init.html

Initializes Libadwaita. This function can be used instead of gtk_init() as it initializes GTK implicitly. There's no need to call this function if you're using AdwApplication. If Libadwaita has already been initialized, the function will simply return.

```APIDOC
## adw_init()

### Description
Initializes Libadwaita. This function can be used instead of `gtk_init()` as it initializes GTK implicitly. There's no need to call this function if you're using `AdwApplication`. If Libadwaita has already been initialized, the function will simply return. This makes sure translations, types, themes, and icons for the Adwaita library are set up properly.

### Declaration
```c
void
adw_init (
  void
)
```

### Parameters
None.

### Returns
None.
```

--------------------------------

### AdwSwitchRow UI definition example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.SwitchRow.html

Example of an AdwSwitchRow UI definition in XML, showing a title property and a notify::active signal handler.

```xml
<object class="AdwSwitchRow">
  <property name="title" translatable="yes">Switch Row</property>
  <signal name="notify::active" handler="switch_row_notify_active_cb"/>
</object>
```

--------------------------------

### overview.open action

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.TabOverview.html

Action that opens the tab overview.

```APIDOC
## overview.open action

### Description
Action that opens the tab overview. Can be used together with `AdwTabButton`.

### Action Name
`overview.open`

### Since
1.3
```

--------------------------------

### adw_about_dialog_add_legal_section usage examples

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/method.AboutDialog.add_legal_section.html

Four examples showing how to add legal sections with different combinations of copyright and license. The first uses a known license (GTK_LICENSE_LGPL_2_1), the second uses a custom license (GTK_LICENSE_CUSTOM), the third uses copyright only (GTK_LICENSE_UNKNOWN), and the fourth uses a custom license only (GTK_LICENSE_CUSTOM).

```c
adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Copyright and a known license"),
                                    "© 2022 Example",
                                    GTK_LICENSE_LGPL_2_1,
                                    NULL);

adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Copyright and custom license"),
                                    "© 2022 Example",
                                    GTK_LICENSE_CUSTOM,
                                    "Custom license text");

adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Copyright only"),
                                    "© 2022 Example",
                                    GTK_LICENSE_UNKNOWN,
                                    NULL);

adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about),
                                    _("Custom license only"),
                                    NULL,
                                    GTK_LICENSE_CUSTOM,
                                    "Something completely custom here.");

```

--------------------------------

### adw_breakpoint_add_setters usage example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/method.Breakpoint.add_setters.html

Example call to adw_breakpoint_add_setters that sets orientation, halign, and valign properties on two widgets. The list must be terminated with NULL.

```c
adw_breakpoint_add_setters (breakpoint,
                            G_OBJECT (box), "orientation", GTK_ORIENTATION_VERTICAL,
                            G_OBJECT (button), "halign", GTK_ALIGN_FILL,
                            G_OBJECT (button), "valign", GTK_ALIGN_END,
                            NULL);

```

--------------------------------

### AdwSidebarSection UI definition example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.SidebarSection.html

Example of an AdwSidebarSection UI definition in GtkBuilder XML, showing how to add AdwSidebarItem children with titles and icon names.

```xml
<object class="AdwSidebarSection">
  <property name="title" translatable="yes">Places</property>
  <child>
    <object class="AdwSidebarItem">
      <property name="title" translatable="yes">Music</property>
      <property name="icon-name">folder-music-symbolic</property>
    </object>
  </child>
  <child>
    <object class="AdwSidebarItem">
      <property name="title" translatable="yes">Pictures</property>
      <property name="icon-name">folder-pictures-symbolic</property>
    </object>
  </child>
  <child>
    <object class="AdwSidebarItem">
      <property name="title" translatable="yes">Videos</property>
      <property name="icon-name">folder-videos-symbolic</property>
    </object>
  </child>
</object>
```

--------------------------------

### Compile a program with Libadwaita using pkg-config

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/build-howto.html

Use this command to compile a C program that links against GTK4 and Libadwaita. It uses pkg-config to get the necessary compiler and linker flags.

```bash
gcc $(pkg-config --cflags --libs gtk4) $(pkg-config --cflags --libs libadwaita-1) main.c -o main

```

--------------------------------

### AdwSpinRow UI definition example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.SpinRow.html

Example of an AdwSpinRow UI definition using an embedded GtkAdjustment with lower, upper, value, page-increment, and step-increment properties.

```xml
<object class="AdwSpinRow">
  <property name="title" translatable="yes">Spin Row</property>
  <property name="adjustment">
    <object class="GtkAdjustment">
      <property name="lower">0</property>
      <property name="upper">100</property>
      <property name="value">50</property>
      <property name="page-increment">10</property>
      <property name="step-increment">1</property>
    </object>
  </property>
</object>
```

--------------------------------

### AdwWrapBox example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/adaptive-layouts.html

Shows how to use AdwWrapBox with line and child spacing. Children wrap like words in a label when they don't fit.

```XML
<object class="AdwWrapBox">
  <property name="line-spacing">6</property>
  <property name="child-spacing">6</property>
  <!-- children -->
</object>
```

--------------------------------

### Property: value-to

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/property.TimedAnimation.value-to.html

The value to animate to. The animation will start at AdwTimedAnimation:value-from and end at this value. If AdwTimedAnimation:reverse is TRUE, the animation will start at this value instead.

```APIDOC
## Property: value-to

### Description
The value to animate to. The animation will start at `AdwTimedAnimation:value-from` and end at this value. If `AdwTimedAnimation:reverse` is `TRUE`, the animation will start at this value instead.

### Declaration
```
property value-to: double [ read, write, construct ]
```

### Type
`gdouble`

### Default Value
`0.000000`

### Accessor Methods
- Getter: `adw_timed_animation_get_value_to()`
- Setter: `adw_timed_animation_set_value_to()`

### Flags
- Readable: yes
- Writable: yes
- Construct: yes
- Construct only: no
```

--------------------------------

### AdwViewStackPage:starts-section

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/property.ViewStackPage.starts-section.html

Property documentation for AdwViewStackPage:starts-section, including declaration, description, flags, and accessor methods.

```APIDOC
## Property: AdwViewStackPage:starts-section

### Description
Whether this page starts a section. If set to `TRUE`, `AdwViewStack:pages` will have a section starting from this page. If `AdwViewStackPage:section-title` is set, it should be used as a title for the section.

### Declaration
```
property starts-section: gboolean [ read, write ]
```

### Type
`gboolean`

### Available since
1.9

### Default value
`FALSE`

### Flags
- Readable: yes
- Writable: yes
- Construct: no
- Construct only: no

### Accessor Methods
- Getter method: `adw_view_stack_page_get_starts_section()`
- Setter method: `adw_view_stack_page_set_starts_section()`
```

--------------------------------

### AdwToggleGroup UI definition example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.ToggleGroup.html

Example of an AdwToggleGroup UI definition with two AdwToggle children, each with an icon, tooltip, and name. The active-name property is set to 'picture'.

```xml
<object class="AdwToggleGroup">
  <property name="active-name">picture</property>
  <child>
    <object class="AdwToggle">
      <property name="icon-name">camera-photo-symbolic</property>
      <property name="tooltip" translatable="yes">Picture Mode</property>
      <property name="name">picture</property>
    </object>
  </child>
  <child>
    <object class="AdwToggle">
      <property name="icon-name">camera-video-symbolic</property>
      <property name="tooltip" translatable="yes">Recording Mode</property>
      <property name="name">recording</property>
    </object>
  </child>
</object>
```

--------------------------------

### adw_bind_property_to_css_class usage example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/func.bind_property_to_css_class.html

Example call that binds the 'active' property of an action to the 'active-widget' CSS class on a widget. The class is applied when 'active' is TRUE and removed when FALSE.

```c
adw_bind_property_to_css_class (action, "active", widget, "active-widget", 0);
```

--------------------------------

### Example boxed list with GtkListBox and AdwActionRow

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/boxed-lists.html

Shows a basic boxed list using GtkListBox with selection-mode set to none and the .boxed-list style class, containing three AdwActionRow children.

```XML
<object class="GtkListBox">
  <property name="selection-mode">none</property>
  <style>
    <class name="boxed-list"/>
  </style>
  <child>
    <object class="AdwActionRow">
      <property name="title">Item 1</property>
    </object>
  </child>
  <child>
    <object class="AdwActionRow">
      <property name="title">Item 2</property>
    </object>
  </child>
  <child>
    <object class="AdwActionRow">
      <property name="title">Item 3</property>
    </object>
  </child>
</object>
```

--------------------------------

### AdwSidebar UI definition with sections and items

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.Sidebar.html

Example of an AdwSidebar UI definition in GtkBuilder format, showing how to add sections and items as children. The example includes three sections: one with 'Recent' and 'Starred' items, one titled 'Places' with 'Music', 'Pictures', and 'Videos' items, and one with a 'Trash' item.

```xml
<object class="AdwSidebar">
  <child>
    <object class="AdwSidebarSection">
      <child>
        <object class="AdwSidebarItem">
          <property name="title" translatable="yes">Recent</property>
          <property name="icon-name">document-open-recent-symbolic</property>
        </object>
      </child>
      <child>
        <object class="AdwSidebarItem">
          <property name="title" translatable="yes">Starred</property>
          <property name="icon-name">starred-symbolic</property>
        </object>
      </child>
    </object>
  </child>
  <child>
    <object class="AdwSidebarSection">
      <property name="title" translatable="yes">Places</property>
      <child>
        <object class="AdwSidebarItem">
          <property name="title" translatable="yes">Music</property>
          <property name="icon-name">folder-music-symbolic</property>
        </object>
      </child>
      <child>
        <object class="AdwSidebarItem">
          <property name="title" translatable="yes">Pictures</property>
          <property name="icon-name">folder-pictures-symbolic</property>
        </object>
      </child>
      <child>
        <object class="AdwSidebarItem">
          <property name="title" translatable="yes">Videos</property>
          <property name="icon-name">folder-videos-symbolic</property>
        </object>
      </child>
    </object>
  </child>
  <child>
    <object class="AdwSidebarSection">
      <child>
        <object class="AdwSidebarItem">
          <property name="title" translatable="yes">Trash</property>
          <property name="icon-name">user-trash-symbolic</property>
        </object>
      </child>
    </object>
  </child>
</object>
```

--------------------------------

### AdwBreakpointBin breakpoint example

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.BreakpointBin.html

Creates an AdwBreakpointBin with a label child and a breakpoint that changes the label text from 'Wide' to 'Narrow' when the bin width is 200px or less. Requires setting size request to 150x150 and using adw_breakpoint_condition_parse with 'max-width: 200px'.

```c
GtkWidget *bin, *child;
AdwBreakpoint *breakpoint;

bin = adw_breakpoint_bin_new ();
gtk_widget_set_size_request (bin, 150, 150);

child = gtk_label_new ("Wide");
gtk_label_set_ellipsize (GTK_LABEL (label), PANGO_ELLIPSIZE_END);
gtk_widget_add_css_class (child, "title-1");
adw_breakpoint_bin_set_child (ADW_BREAKPOINT_BIN (bin), child);

breakpoint = adw_breakpoint_new (adw_breakpoint_condition_parse ("max-width: 200px"));
adw_breakpoint_add_setters (breakpoint,
                            G_OBJECT (child), "label", "Narrow",
                            NULL);
adw_breakpoint_bin_add_breakpoint (ADW_BREAKPOINT_BIN (bin), breakpoint);

```

--------------------------------

### adw_wrap_box_get_line_spacing

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.WrapBox.html

Gets the spacing between lines.

```APIDOC
## adw_wrap_box_get_line_spacing

### Description
Gets the spacing between lines.

### Method
Instance method

### Signature
`int adw_wrap_box_get_line_spacing (AdwWrapBox* self)`

### Parameters
- **self** (AdwWrapBox*) - The wrap box instance.

### Returns
The spacing between lines.

### Since
1.7
```

--------------------------------

### Create AdwAlertDialog with formatted body

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/ctor.AlertDialog.new.html

Example showing how to create an AdwAlertDialog with a NULL body and then use adw_alert_dialog_format_body to set a formatted body. This is useful when the body needs markup or formatting.

```c
AdwDialog *dialog;

dialog = adw_alert_dialog_new (_("Replace File?"), NULL);
adw_alert_dialog_format_body (ADW_ALERT_DIALOG (dialog),
                              _("A file named “%s” already exists.  Do you want to replace it?"),
                              filename);
```

--------------------------------

### adw_view_stack_page_get_title

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.ViewStackPage.html

Gets the page title.

```APIDOC
## adw_view_stack_page_get_title

### Description
Gets the page title.

### Method
GET

### Endpoint
adw_view_stack_page_get_title

### Parameters
#### Path Parameters
- **self** (AdwViewStackPage) - Required - The page instance.

### Response
#### Success Response (200)
- **title** (string) - The page title.

#### Response Example
{
  "title": "string"
}
```

--------------------------------

### .view CSS equivalent

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/style-classes.html

Gives any widget the default view background and foreground colors.

```css
.view {
  background-color: var(--view-bg-color);
  color: var(--view-fg-color);
}
```

--------------------------------

### adw_view_switcher_new

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.ViewSwitcher.html

Creates a new `AdwViewSwitcher` widget. This is the constructor for the view switcher.

### Parameters
None.

### Returns
A newly created `AdwViewSwitcher` widget.

```APIDOC
## adw_view_switcher_new

### Description
Creates a new `AdwViewSwitcher`. The constructor returns a new view switcher widget.

### Method
Constructor

### Signature
```c
AdwViewSwitcher* adw_view_switcher_new(void);
```

### Returns
- **AdwViewSwitcher*** - A newly created `AdwViewSwitcher` widget.
```

--------------------------------

### adw_view_stack_page_get_name

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.ViewStackPage.html

Gets the name of the page.

```APIDOC
## adw_view_stack_page_get_name

### Description
Gets the name of the page.

### Method
GET

### Endpoint
adw_view_stack_page_get_name

### Parameters
#### Path Parameters
- **self** (AdwViewStackPage) - Required - The page instance.

### Response
#### Success Response (200)
- **name** (string) - The name of the page.

#### Response Example
{
  "name": "string"
}
```

--------------------------------

### adw_application_window_new

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.ApplicationWindow.html

Creates a new AdwApplicationWindow for the given application.

```APIDOC
## adw_application_window_new

### Description
Creates a new `AdwApplicationWindow` for `app`.

### Method
Constructor

### Parameters
- `app` (GtkApplication) - The application for which to create the window.

### Returns
A new `AdwApplicationWindow`.
```

--------------------------------

### adw_toolbar_view_get_content

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.ToolbarView.html

Gets the content widget.

```APIDOC
## adw_toolbar_view_get_content

### Description
Gets the content widget for `self`.

### Method
Instance method

### Signature
`GtkWidget* adw_toolbar_view_get_content (AdwToolbarView* self)`

### Parameters
- **self** (AdwToolbarView*) - The toolbar view.

### Returns
The content widget.

### Since
1.4
```

--------------------------------

### adw_toast_get_timeout

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.Toast.html

Gets timeout for the toast.

```APIDOC
## adw_toast_get_timeout

### Description
Gets timeout for `self`.

### Method
Instance method

### Signature
`double adw_toast_get_timeout (AdwToast* self)`

### Parameters
- **self** (AdwToast*) - Required - The toast.

### Returns
- **double** - The timeout in seconds.

```

--------------------------------

### AdwAlertDialog UI definition with <responses>

Source: https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1-latest/class.AlertDialog.html

Example of an AdwAlertDialog UI definition using GtkBuildable. It shows how to add responses with the <responses> element, including attributes like id, translatable, appearance, and enabled.

```xml
<object class="AdwAlertDialog" id="dialog">
  <property name="heading" translatable="yes">Save Changes?</property>
  <property name="body" translatable="yes">Open documents contain unsaved changes. Changes which are not saved will be permanently lost.</property>
  <property name="default-response">save</property>
  <property name="close-response">cancel</property>
  <signal name="response" handler="response_cb"/>
  <responses>
    <response id="cancel" translatable="yes">_Cancel</response>
    <response id="discard" translatable="yes" appearance="destructive">_Discard</response>
    <response id="save" translatable="yes" appearance="suggested" enabled="false">_Save</response>
  </responses>
</object>
```
Tokens:
Raw