AdwPreferencesWindow

AdwPreferencesWindow

Functions

Properties

gboolean can-swipe-back Read / Write
gboolean search-enabled Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkWindow
                ╰── AdwWindow
                    ╰── AdwPreferencesWindow

Implemented Interfaces

AdwPreferencesWindow implements GtkAccessible, GtkBuildable, GtkConstraintTarget, GtkNative, GtkShortcutManager and GtkRoot.

Description

Functions

adw_preferences_window_new ()

GtkWidget *
adw_preferences_window_new (void);

Creates a new AdwPreferencesWindow.

Returns

a new AdwPreferencesWindow

Since: 1.0


adw_preferences_window_get_search_enabled ()

gboolean
adw_preferences_window_get_search_enabled
                               (AdwPreferencesWindow *self);

Gets whether search is enabled for self .

Parameters

Returns

whether search is enabled for self .

Since: 1.0


adw_preferences_window_set_search_enabled ()

void
adw_preferences_window_set_search_enabled
                               (AdwPreferencesWindow *self,
                                gboolean search_enabled);

Sets whether search is enabled for self .

Parameters

self

a AdwPreferencesWindow

 

search_enabled

TRUE to enable search, FALSE to disable it

 

Since: 1.0


adw_preferences_window_get_can_swipe_back ()

gboolean
adw_preferences_window_get_can_swipe_back
                               (AdwPreferencesWindow *self);

Returns whether or not self allows switching from a subpage to the preferences via a swipe gesture.

Parameters

Returns

TRUE if back swipe is enabled.

Since: 1.0


adw_preferences_window_set_can_swipe_back ()

void
adw_preferences_window_set_can_swipe_back
                               (AdwPreferencesWindow *self,
                                gboolean can_swipe_back);

Sets whether or not self allows switching from a subpage to the preferences via a swipe gesture.

Parameters

self

a AdwPreferencesWindow

 

can_swipe_back

the new value

 

Since: 1.0


adw_preferences_window_present_subpage ()

void
adw_preferences_window_present_subpage
                               (AdwPreferencesWindow *self,
                                GtkWidget *subpage);

Sets subpage as the window's subpage and present it. The transition can be cancelled by the user, in which case visible child will change back to the previously visible child.

Parameters

self

a AdwPreferencesWindow

 

subpage

the subpage

 

Since: 1.0


adw_preferences_window_close_subpage ()

void
adw_preferences_window_close_subpage (AdwPreferencesWindow *self);

Closes the current subpage to return back to the preferences, if there is no presented subpage, this does nothing.

Parameters

Since: 1.0


adw_preferences_window_add ()

void
adw_preferences_window_add (AdwPreferencesWindow *self,
                            AdwPreferencesPage *page);

adw_preferences_window_remove ()

void
adw_preferences_window_remove (AdwPreferencesWindow *self,
                               AdwPreferencesPage *page);

Types and Values

ADW_TYPE_PREFERENCES_WINDOW

#define ADW_TYPE_PREFERENCES_WINDOW (adw_preferences_window_get_type())

struct AdwPreferencesWindowClass

struct AdwPreferencesWindowClass {
  AdwWindowClass parent_class;
};

Members


AdwPreferencesWindow

typedef struct _AdwPreferencesWindow AdwPreferencesWindow;

Property Details

The “can-swipe-back” property

  “can-swipe-back”           gboolean

Whether or not the window allows closing the subpage via a swipe gesture.

Owner: AdwPreferencesWindow

Flags: Read / Write

Default value: FALSE

Since: 1.0


The “search-enabled” property

  “search-enabled”           gboolean

Whether search is enabled.

Owner: AdwPreferencesWindow

Flags: Read / Write

Default value: TRUE

Since: 1.0