fl_settings.h File Reference

#include <glib-object.h>

Go to the source code of this file.

Classes
struct	_FlSettingsInterface

Enumerations
enum	FlClockFormat { FL_CLOCK_FORMAT_12H , FL_CLOCK_FORMAT_24H }
enum	FlColorScheme { FL_COLOR_SCHEME_LIGHT , FL_COLOR_SCHEME_DARK }

Functions
FlSettings *	fl_settings_new ()
FlClockFormat	fl_settings_get_clock_format (FlSettings *settings)
FlColorScheme	fl_settings_get_color_scheme (FlSettings *settings)
gboolean	fl_settings_get_enable_animations (FlSettings *settings)
gboolean	fl_settings_get_high_contrast (FlSettings *settings)
gdouble	fl_settings_get_text_scaling_factor (FlSettings *settings)
void	fl_settings_emit_changed (FlSettings *settings)

Enumeration Type Documentation

FlClockFormat

enum FlClockFormat

FlClockFormat: @FL_CLOCK_FORMAT_12H: 12-hour clock format. @FL_CLOCK_FORMAT_24H: 24-hour clock format.

Available clock formats.

Enumerator
FL_CLOCK_FORMAT_12H
FL_CLOCK_FORMAT_24H

Definition at line 21 of file fl_settings.h.

             {
  // NOLINTBEGIN(readability-identifier-naming)
  FL_CLOCK_FORMAT_12H,
  FL_CLOCK_FORMAT_24H,
  // NOLINTEND(readability-identifier-naming)
} FlClockFormat;

FlColorScheme

enum FlColorScheme

FlColorScheme: @FL_COLOR_SCHEME_LIGHT: Prefer light theme. @FL_COLOR_SCHEME_DARK: Prefer dark theme.

Available color schemes.

Enumerator
FL_COLOR_SCHEME_LIGHT
FL_COLOR_SCHEME_DARK

Definition at line 35 of file fl_settings.h.

             {
  // NOLINTBEGIN(readability-identifier-naming)
  FL_COLOR_SCHEME_LIGHT,
  FL_COLOR_SCHEME_DARK,
  // NOLINTEND(readability-identifier-naming)
} FlColorScheme;

Function Documentation

fl_settings_emit_changed()

void fl_settings_emit_changed

(

FlSettings *

settings

)

fl_settings_emit_changed: @settings: an #FlSettings.

Emits the "changed" signal. Used by FlSettings implementations to notify when the desktop settings have changed.

Definition at line 50 of file fl_settings.cc.

                                                {
  g_return_if_fail(FL_IS_SETTINGS(self));
  g_signal_emit(self, signals[kSignalChanged], 0);
}

fl_settings_get_clock_format()

FlClockFormat fl_settings_get_clock_format

(

FlSettings *

settings

)

fl_settings_get_clock_format: @settings: an #FlSettings.

Whether the clock displays in 24-hour or 12-hour format.

This corresponds to org.gnome.desktop.interface.clock-format in GNOME.

Returns: an FlClockFormat.

Definition at line 30 of file fl_settings.cc.

                                                             {
  return FL_SETTINGS_GET_IFACE(self)->get_clock_format(self);
}

fl_settings_get_color_scheme()

FlColorScheme fl_settings_get_color_scheme

(

FlSettings *

settings

)

fl_settings_get_color_scheme: @settings: an #FlSettings.

The preferred color scheme for the user interface.

This corresponds to org.gnome.desktop.interface.color-scheme in GNOME.

Returns: an FlColorScheme.

Definition at line 34 of file fl_settings.cc.

                                                             {
  return FL_SETTINGS_GET_IFACE(self)->get_color_scheme(self);
}

fl_settings_get_enable_animations()

gboolean fl_settings_get_enable_animations

(

FlSettings *

settings

)

fl_settings_get_enable_animations: @settings: an #FlSettings.

Whether animations should be enabled.

This corresponds to org.gnome.desktop.interface.enable-animations in GNOME.

Returns: TRUE if animations are enabled.

Definition at line 38 of file fl_settings.cc.

                                                             {
  return FL_SETTINGS_GET_IFACE(self)->get_enable_animations(self);
}

fl_settings_get_high_contrast()

gboolean fl_settings_get_high_contrast

(

FlSettings *

settings

)

fl_settings_get_high_contrast: @settings: an #FlSettings.

Whether to use high contrast theme.

This corresponds to org.gnome.desktop.a11y.interface.high-contrast in GNOME.

Returns: TRUE if high contrast is used.

Definition at line 42 of file fl_settings.cc.

                                                         {
  return FL_SETTINGS_GET_IFACE(self)->get_high_contrast(self);
}

fl_settings_get_text_scaling_factor()

gdouble fl_settings_get_text_scaling_factor

(

FlSettings *

settings

)

fl_settings_get_text_scaling_factor: @settings: an #FlSettings.

Factor used to enlarge or reduce text display, without changing font size.

This corresponds to org.gnome.desktop.interface.text-scaling-factor in GNOME.

Returns: a floating point number.

Definition at line 46 of file fl_settings.cc.

                                                              {
  return FL_SETTINGS_GET_IFACE(self)->get_text_scaling_factor(self);
}

fl_settings_new()

FlSettings * fl_settings_new

(

)

fl_settings_new:

Creates a new settings instance.

Returns: a new #FlSettings.

Definition at line 55 of file fl_settings.cc.

                              {
  g_autoptr(FlSettingsPortal) portal = fl_settings_portal_new();
 
  g_autoptr(GError) error = nullptr;
  if (!fl_settings_portal_start(portal, &error)) {
    g_debug("XDG desktop portal settings unavailable: %s", error->message);
    return fl_gnome_settings_new();
  }
 
  return FL_SETTINGS(g_object_ref(portal));
}