AdwPreferencesPage: Adwaita Reference Manual

AdwPreferencesPage

AdwPreferencesPage — A page from the preferences window.

Functions

GtkWidget *	adw_preferences_page_new ()
const char *	adw_preferences_page_get_icon_name ()
void	adw_preferences_page_set_icon_name ()
const char *	adw_preferences_page_get_title ()
void	adw_preferences_page_set_title ()
gboolean	adw_preferences_page_get_use_underline ()
void	adw_preferences_page_set_use_underline ()
void	adw_preferences_page_add ()
void	adw_preferences_page_remove ()

Properties

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

Types and Values

#define	ADW_TYPE_PREFERENCES_PAGE
struct	AdwPreferencesPageClass
	AdwPreferencesPage

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── AdwPreferencesPage

Implemented Interfaces

AdwPreferencesPage implements GtkAccessible, GtkBuildable and GtkConstraintTarget.

Description

The AdwPreferencesPage widget gathers preferences groups into a single page of a preferences window.

CSS nodes

AdwPreferencesPage has a single CSS node with name preferencespage.

Functions

adw_preferences_page_new ()

GtkWidget *
adw_preferences_page_new (void);

Creates a new AdwPreferencesPage.

Returns

a new AdwPreferencesPage

Since: 1.0

adw_preferences_page_get_icon_name ()

const char *
adw_preferences_page_get_icon_name (AdwPreferencesPage *self);

Gets the icon name for self , or NULL.

Parameters

self

a AdwPreferencesPage

Returns

the icon name for self , or NULL.

[transfer none][nullable]

Since: 1.0

adw_preferences_page_set_icon_name ()

void
adw_preferences_page_set_icon_name (AdwPreferencesPage *self,
                                    const char *icon_name);

Sets the icon name for self .

Parameters

self	a AdwPreferencesPage
icon_name	the icon name, or `NULL`.	[nullable]

Since: 1.0

adw_preferences_page_get_title ()

const char *
adw_preferences_page_get_title (AdwPreferencesPage *self);

Gets the title of self , or NULL.

Parameters

self

a AdwPreferencesPage

Returns

the title of the self , or NULL.

[transfer none][nullable]

Since: 1.0

adw_preferences_page_set_title ()

void
adw_preferences_page_set_title (AdwPreferencesPage *self,
                                const char *title);

Sets the title of self .

Parameters

self	a AdwPreferencesPage
title	the title of the page, or `NULL`.	[nullable]

Since: 1.0

adw_preferences_page_get_use_underline ()

gboolean
adw_preferences_page_get_use_underline
                               (AdwPreferencesPage *self);

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

Parameters

self

a AdwPreferencesPage

Returns

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

Since: 1.0

adw_preferences_page_set_use_underline ()

void
adw_preferences_page_set_use_underline
                               (AdwPreferencesPage *self,
                                gboolean use_underline);

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

Parameters

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

Since: 1.0

adw_preferences_page_add ()

void
adw_preferences_page_add (AdwPreferencesPage *self,
                          AdwPreferencesGroup *group);

adw_preferences_page_remove ()

void
adw_preferences_page_remove (AdwPreferencesPage *self,
                             AdwPreferencesGroup *group);

Types and Values

ADW_TYPE_PREFERENCES_PAGE

#define ADW_TYPE_PREFERENCES_PAGE (adw_preferences_page_get_type())

struct AdwPreferencesPageClass

struct AdwPreferencesPageClass {
  GtkWidgetClass parent_class;
};

Members