AdwExpanderRow

AdwExpanderRow — A GtkListBox row used to reveal widgets.

Functions

GtkWidget * adw_expander_row_new ()
const char * adw_expander_row_get_subtitle ()
void adw_expander_row_set_subtitle ()
gboolean adw_expander_row_get_use_underline ()
void adw_expander_row_set_use_underline ()
const char * adw_expander_row_get_icon_name ()
void adw_expander_row_set_icon_name ()
gboolean adw_expander_row_get_expanded ()
void adw_expander_row_set_expanded ()
gboolean adw_expander_row_get_enable_expansion ()
void adw_expander_row_set_enable_expansion ()
gboolean adw_expander_row_get_show_enable_switch ()
void adw_expander_row_set_show_enable_switch ()
void adw_expander_row_add_action ()
void adw_expander_row_add_prefix ()
void adw_expander_row_add ()
void adw_expander_row_remove ()

Properties

gboolean enable-expansion Read / Write
gboolean expanded Read / Write
char * icon-name Read / Write
gboolean show-enable-switch Read / Write
char * subtitle Read / Write
gboolean use-underline Read / Write

Types and Values

#define ADW_TYPE_EXPANDER_ROW
struct AdwExpanderRowClass
  AdwExpanderRow

Object Hierarchy

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

Implemented Interfaces

AdwExpanderRow implements GtkAccessible, GtkBuildable, GtkConstraintTarget and GtkActionable.

Description

The AdwExpanderRow allows the user to reveal or hide widgets below it. It also allows the user to enable the expansion of the row, allowing to disable all that the row contains.

It also supports adding a child as an action widget by specifying “action” as the “type” attribute of a <child> element. It also supports setting a child as a prefix widget by specifying “prefix” as the “type” attribute of a <child> element.

CSS nodes

AdwExpanderRow has a main CSS node with name row, and the .expander style class. It has the .empty style class when it contains no children.

It contains the subnodes row.header for its main embedded row, list.nested for the list it can expand, and image.expander-row-arrow for its arrow.

When expanded, AdwExpanderRow will add the .checked-expander-row-previous-sibling style class to its previous sibling, and remove it when retracted.

Functions

adw_expander_row_new ()

GtkWidget *
adw_expander_row_new (void);

Creates a new AdwExpanderRow.

Returns

a new AdwExpanderRow

Since: 1.0

adw_expander_row_get_subtitle ()

const char *
adw_expander_row_get_subtitle (AdwExpanderRow *self);

Gets the subtitle for self .

Parameters

self

a AdwExpanderRow

  

Returns

the subtitle for self , or NULL.

[transfer none][nullable]

Since: 1.0

adw_expander_row_set_subtitle ()

void
adw_expander_row_set_subtitle (AdwExpanderRow *self,
                               const char *subtitle);

Sets the subtitle for self .

Parameters

self

a AdwExpanderRow

  

subtitle

the subtitle.

[nullable]

Since: 1.0

adw_expander_row_get_use_underline ()

gboolean
adw_expander_row_get_use_underline (AdwExpanderRow *self);

Gets whether an embedded underline in the text of the title and subtitle labels indicates a mnemonic. See adw_expander_row_set_use_underline().

Parameters

self

a AdwExpanderRow

  

Returns

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

Since: 1.0

adw_expander_row_set_use_underline ()

void
adw_expander_row_set_use_underline (AdwExpanderRow *self,
                                    gboolean use_underline);

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

Parameters

self

a AdwExpanderRow

  

use_underline

TRUE if underlines in the text indicate mnemonics

  

Since: 1.0

adw_expander_row_get_icon_name ()

const char *
adw_expander_row_get_icon_name (AdwExpanderRow *self);

Gets the icon name for self .

Parameters

self

a AdwExpanderRow

  

Returns

the icon name for self .

Since: 1.0

adw_expander_row_set_icon_name ()

void
adw_expander_row_set_icon_name (AdwExpanderRow *self,
                                const char *icon_name);

Sets the icon name for self .

Parameters

self

a AdwExpanderRow

  

icon_name

the icon name

  

Since: 1.0

adw_expander_row_get_expanded ()

gboolean
adw_expander_row_get_expanded (AdwExpanderRow *self);

adw_expander_row_set_expanded ()

void
adw_expander_row_set_expanded (AdwExpanderRow *self,
                               gboolean expanded);

adw_expander_row_get_enable_expansion ()

gboolean
adw_expander_row_get_enable_expansion (AdwExpanderRow *self);

Gets whether the expansion of self is enabled.

Parameters

self

a AdwExpanderRow

  

Returns

whether the expansion of self is enabled.

Since: 1.0

adw_expander_row_set_enable_expansion ()

void
adw_expander_row_set_enable_expansion (AdwExpanderRow *self,
                                       gboolean enable_expansion);

Sets whether the expansion of self is enabled.

Parameters

self

a AdwExpanderRow

  

enable_expansion

TRUE to enable the expansion

  

Since: 1.0

adw_expander_row_get_show_enable_switch ()

gboolean
adw_expander_row_get_show_enable_switch
                               (AdwExpanderRow *self);

Gets whether the switch enabling the expansion of self is visible.

Parameters

self

a AdwExpanderRow

  

Returns

whether the switch enabling the expansion of self is visible.

Since: 1.0

adw_expander_row_set_show_enable_switch ()

void
adw_expander_row_set_show_enable_switch
                               (AdwExpanderRow *self,
                                gboolean show_enable_switch);

Sets whether the switch enabling the expansion of self is visible.

Parameters

self

a AdwExpanderRow

  

show_enable_switch

TRUE to show the switch enabling the expansion

  

Since: 1.0

adw_expander_row_add_action ()

void
adw_expander_row_add_action (AdwExpanderRow *self,
                             GtkWidget *widget);

Adds an action widget to self .

Parameters

self

a AdwExpanderRow

  

widget

the action widget

  

Since: 1.0

adw_expander_row_add_prefix ()

void
adw_expander_row_add_prefix (AdwExpanderRow *self,
                             GtkWidget *widget);

Adds a prefix widget to self .

Parameters

self

a AdwExpanderRow

  

widget

the prefix widget

  

Since: 1.0

adw_expander_row_add ()

void
adw_expander_row_add (AdwExpanderRow *self,
                      GtkWidget *child);

adw_expander_row_remove ()

void
adw_expander_row_remove (AdwExpanderRow *self,
                         GtkWidget *child);

Types and Values

ADW_TYPE_EXPANDER_ROW

#define ADW_TYPE_EXPANDER_ROW (adw_expander_row_get_type())

struct AdwExpanderRowClass

struct AdwExpanderRowClass {
  AdwPreferencesRowClass parent_class;
};

Members

AdwExpanderRow

typedef struct _AdwExpanderRow AdwExpanderRow;

Property Details

The “enable-expansion” property

  “enable-expansion”         gboolean

TRUE if the expansion is enabled.

Owner: AdwExpanderRow

Flags: Read / Write

Default value: TRUE

Since: 1.0

The “expanded” property

  “expanded”                 gboolean

TRUE if the row is expanded.

Owner: AdwExpanderRow

Flags: Read / Write

Default value: FALSE

Since: 1.0

The “icon-name” property

  “icon-name”                char *

The icon name for this row.

Owner: AdwExpanderRow

Flags: Read / Write

Default value: ""

Since: 1.0

The “show-enable-switch” property

  “show-enable-switch”       gboolean

TRUE if the switch enabling the expansion is visible.

Owner: AdwExpanderRow

Flags: Read / Write

Default value: FALSE

Since: 1.0

The “subtitle” property

  “subtitle”                 char *

The subtitle for this row.

Owner: AdwExpanderRow

Flags: Read / Write

Default value: ""

Since: 1.0

The “use-underline” property

  “use-underline”            gboolean

Whether an embedded underline in the text of the title and subtitle labels indicates a mnemonic.

Owner: AdwExpanderRow

Flags: Read / Write

Default value: FALSE

Since: 1.0

Generated by GTK-Doc V1.33.1