AdwStatusPage

AdwStatusPage — A page used for empty/error states and similar use-cases.

Functions

GtkWidget * adw_status_page_new ()
const char * adw_status_page_get_icon_name ()
void adw_status_page_set_icon_name ()
const char * adw_status_page_get_title ()
void adw_status_page_set_title ()
const char * adw_status_page_get_description ()
void adw_status_page_set_description ()
GtkWidget * adw_status_page_get_child ()
void adw_status_page_set_child ()

Properties

GtkWidget * child Read / Write
char * description Read / Write
char * icon-name Read / Write
char * title Read / Write

Types and Values

#define ADW_TYPE_STATUS_PAGE
  AdwStatusPage

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── AdwStatusPage

Implemented Interfaces

AdwStatusPage implements GtkAccessible, GtkBuildable and GtkConstraintTarget.

Description

The AdwStatusPage widget can have an icon, a title, a description and a custom widget which is displayed below them.

CSS nodes

AdwStatusPage has a main CSS node with name statuspage.

Functions

adw_status_page_new ()

GtkWidget *
adw_status_page_new (void);

Creates a new AdwStatusPage.

Returns

a new AdwStatusPage

Since: 1.0

adw_status_page_get_icon_name ()

const char *
adw_status_page_get_icon_name (AdwStatusPage *self);

Gets the icon name for self .

Parameters

self

a AdwStatusPage

  

Returns

the icon name for self .

[transfer none][nullable]

Since: 1.0

adw_status_page_set_icon_name ()

void
adw_status_page_set_icon_name (AdwStatusPage *self,
                               const char *icon_name);

Sets the icon name for self .

Parameters

self

a AdwStatusPage

  

icon_name

the icon name.

[nullable]

Since: 1.0

adw_status_page_get_title ()

const char *
adw_status_page_get_title (AdwStatusPage *self);

Gets the title for self .

Parameters

self

a AdwStatusPage

  

Returns

the title for self , or NULL.

[transfer none][nullable]

Since: 1.0

adw_status_page_set_title ()

void
adw_status_page_set_title (AdwStatusPage *self,
                           const char *title);

Sets the title for self .

Parameters

self

a AdwStatusPage

  

title

the title.

[nullable]

Since: 1.0

adw_status_page_get_description ()

const char *
adw_status_page_get_description (AdwStatusPage *self);

Gets the description for self .

Parameters

self

a AdwStatusPage

  

Returns

the description for self , or NULL.

[transfer none][nullable]

Since: 1.0

adw_status_page_set_description ()

void
adw_status_page_set_description (AdwStatusPage *self,
                                 const char *description);

Sets the description for self .

Parameters

self

a AdwStatusPage

  

description

the description.

[nullable]

Since: 1.0

adw_status_page_get_child ()

GtkWidget *
adw_status_page_get_child (AdwStatusPage *self);

Gets the child widget of self .

Parameters

self

a AdwStatusPage

  

Returns

the child widget of self .

[nullable][transfer none]

Since: 1.0

adw_status_page_set_child ()

void
adw_status_page_set_child (AdwStatusPage *self,
                           GtkWidget *child);

Sets the child widget of self .

Parameters

self

a AdwStatusPage

  

child

the child widget.

[allow-none]

Since: 1.0

Types and Values

ADW_TYPE_STATUS_PAGE

#define ADW_TYPE_STATUS_PAGE (adw_status_page_get_type())

AdwStatusPage

typedef struct _AdwStatusPage AdwStatusPage;

Property Details

The “child” property

  “child”                    GtkWidget *

The child widget.

Owner: AdwStatusPage

Flags: Read / Write

The “description” property

  “description”              char *

The description to be displayed below the title.

Owner: AdwStatusPage

Flags: Read / Write

Default value: ""

Since: 1.0

The “icon-name” property

  “icon-name”                char *

The name of the icon to be used.

Owner: AdwStatusPage

Flags: Read / Write

Default value: NULL

Since: 1.0

The “title” property

  “title”                    char *

The title to be displayed below the icon.

Owner: AdwStatusPage

Flags: Read / Write

Default value: ""

Since: 1.0

Generated by GTK-Doc V1.33.1