AdwPreferencesRow: Adwaita Reference Manual

AdwPreferencesRow

AdwPreferencesRow — A GtkListBox row used to present preferences.

Functions

GtkWidget *	adw_preferences_row_new ()
const char *	adw_preferences_row_get_title ()
void	adw_preferences_row_set_title ()
gboolean	adw_preferences_row_get_use_underline ()
void	adw_preferences_row_set_use_underline ()

Properties

char *	title	Read / Write
gboolean	use-underline	Read / Write

Types and Values

#define	ADW_TYPE_PREFERENCES_ROW
struct	AdwPreferencesRowClass
	AdwPreferencesRow

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkListBoxRow
                ╰── AdwPreferencesRow
                    ├── AdwActionRow
                    ╰── AdwExpanderRow

Implemented Interfaces

AdwPreferencesRow implements GtkAccessible, GtkBuildable, GtkConstraintTarget and GtkActionable.

Description

The AdwPreferencesRow widget has a title that AdwPreferencesWindow will use to let the user look for a preference. It doesn't present the title in any way and it lets you present the preference as you please.

AdwActionRow and its derivatives are convenient to use as preference rows as they take care of presenting the preference's title while letting you compose the inputs of the preference around it.

Functions

adw_preferences_row_new ()

GtkWidget *
adw_preferences_row_new (void);

Creates a new AdwPreferencesRow.

Returns

a new AdwPreferencesRow

Since: 1.0

adw_preferences_row_get_title ()

const char *
adw_preferences_row_get_title (AdwPreferencesRow *self);

Gets the title of the preference represented by self .

Parameters

self

a AdwPreferencesRow

Returns

the title of the preference represented by self , or NULL.

[transfer none][nullable]

Since: 1.0

adw_preferences_row_set_title ()

void
adw_preferences_row_set_title (AdwPreferencesRow *self,
                               const char *title);

Sets the title of the preference represented by self .

Parameters

self	a AdwPreferencesRow
title	the title, or `NULL`.	[nullable]

Since: 1.0

adw_preferences_row_get_use_underline ()

gboolean
adw_preferences_row_get_use_underline (AdwPreferencesRow *self);

Gets whether an embedded underline in the text of the title indicates a mnemonic. See adw_preferences_row_set_use_underline().

Parameters

self

a AdwPreferencesRow

Returns

TRUE if an embedded underline in the title indicates the mnemonic accelerator keys.

Since: 1.0

adw_preferences_row_set_use_underline ()

void
adw_preferences_row_set_use_underline (AdwPreferencesRow *self,
                                       gboolean use_underline);

If true, an underline in the text of the title indicates the next character should be used for the mnemonic accelerator key.

Parameters

self	a AdwPreferencesRow
use_underline	`TRUE` if underlines in the text indicate mnemonics

Since: 1.0

Types and Values

ADW_TYPE_PREFERENCES_ROW

#define ADW_TYPE_PREFERENCES_ROW (adw_preferences_row_get_type())

struct AdwPreferencesRowClass

struct AdwPreferencesRowClass {
  GtkListBoxRowClass parent_class;
};

Members