HdyStatusPage: Handy Reference Manual

## HdyStatusPage HdyStatusPage — A page used for empty/error states and similar use-cases. |

## Functions

GtkWidget * | hdy_status_page_new ()
const gchar * | hdy_status_page_get_icon_name ()
void | hdy_status_page_set_icon_name ()
const gchar * | hdy_status_page_get_title ()
void | hdy_status_page_set_title ()
const gchar * | hdy_status_page_get_description ()
void | hdy_status_page_set_description ()

## Properties

char * | description | Read / Write
char * | icon-name | Read / Write
char * | title | Read / Write

## Types and Values

#define | HDY_TYPE_STATUS_PAGE
| HdyStatusPage

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBin
                        ╰── HdyStatusPage

## Implemented Interfaces

HdyStatusPage implements AtkImplementorIface and GtkBuildable.

## Description

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

### CSS nodes

HdyStatusPage has a main CSS node with name statuspage.

## Functions

### hdy_status_page_new ()

    GtkWidget *
    hdy_status_page_new (void);

Creates a new HdyStatusPage.

#### Returns

a new HdyStatusPage

Since: 1.2

### hdy_status_page_get_icon_name ()

    const gchar *
    hdy_status_page_get_icon_name (HdyStatusPage *self);

Gets the icon name for `self` .

#### Parameters

self | a HdyStatusPage |

#### Returns

the icon name for `self` .

[transfer none][nullable]

Since: 1.2

### hdy_status_page_set_icon_name ()

    void
    hdy_status_page_set_icon_name (HdyStatusPage *self,
                                   const gchar *icon_name);

Sets the icon name for `self` .

#### Parameters

self | a HdyStatusPage |
icon_name | the icon name. | [nullable]

Since: 1.2

### hdy_status_page_get_title ()

    const gchar *
    hdy_status_page_get_title (HdyStatusPage *self);

Gets the title for `self` .

#### Parameters

self | a HdyStatusPage |

#### Returns

the title for `self` , or `NULL`.

[transfer none][nullable]

Since: 1.2

### hdy_status_page_set_title ()

    void
    hdy_status_page_set_title (HdyStatusPage *self,
                               const gchar *title);

Sets the title for `self` .

#### Parameters

self | a HdyStatusPage |
title | the title. | [nullable]

Since: 1.2

### hdy_status_page_get_description ()

    const gchar *
    hdy_status_page_get_description (HdyStatusPage *self);

Gets the description for `self` .

#### Parameters

self | a HdyStatusPage |

#### Returns

the description for `self` , or `NULL`.

[transfer none][nullable]

Since: 1.2

### hdy_status_page_set_description ()

    void
    hdy_status_page_set_description (HdyStatusPage *self,
                                     const gchar *description);

Sets the description for `self` .

#### Parameters

self | a HdyStatusPage |
description | the description. | [nullable]

Since: 1.2

## Types and Values

### HDY_TYPE_STATUS_PAGE

    #define HDY_TYPE_STATUS_PAGE (hdy_status_page_get_type())

### HdyStatusPage

    typedef struct _HdyStatusPage HdyStatusPage;

## Property Details

### The `“description”` property

      “description”              char *

The description to be displayed below the title.

Owner: HdyStatusPage

Flags: Read / Write

Default value: ""

Since: 1.2

### The `“icon-name”` property

      “icon-name”                char *

The name of the icon to be used.

Owner: HdyStatusPage

Flags: Read / Write

Default value: NULL

Since: 1.2

### The `“title”` property

      “title”                    char *

The title to be displayed below the icon.

Owner: HdyStatusPage

Flags: Read / Write

Default value: ""

Since: 1.2