flutter::SettingsPlugin Class Reference

#include <settings_plugin.h>

Public Types
enum struct	PlatformBrightness {   kDark ,   kLight }

Public Member Functions
	SettingsPlugin (BinaryMessenger *messenger, TaskRunner *task_runner)
virtual	~SettingsPlugin ()
void	SendSettings ()
virtual void	StartWatching ()
virtual void	StopWatching ()
virtual void	UpdateHighContrastMode (bool is_high_contrast)

Protected Member Functions
virtual bool	GetAlwaysUse24HourFormat ()
virtual float	GetTextScaleFactor ()
virtual PlatformBrightness	GetPreferredBrightness ()
virtual void	WatchPreferredBrightnessChanged ()
virtual void	WatchTextScaleFactorChanged ()

Protected Attributes
bool	is_high_contrast_ = false

Detailed Description

Definition at line 25 of file settings_plugin.h.

Member Enumeration Documentation

PlatformBrightness

enum struct flutter::SettingsPlugin::PlatformBrightness

strong

Enumerator
kDark
kLight

Definition at line 27 of file settings_plugin.h.

{ kDark, kLight };

Constructor & Destructor Documentation

SettingsPlugin()

flutter::SettingsPlugin::SettingsPlugin ( BinaryMessenger *  messenger, TaskRunner *  task_runner  )

explicit

Definition at line 57 of file settings_plugin.cc.

    : channel_(std::make_unique<BasicMessageChannel<rapidjson::Document>>(
          messenger,
          kChannelName,
          &JsonMessageCodec::GetInstance())),
      task_runner_(task_runner) {}

~SettingsPlugin()

flutter::SettingsPlugin::~SettingsPlugin ( )

virtual

Definition at line 65 of file settings_plugin.cc.

                                {
  StopWatching();
}

References StopWatching().

Member Function Documentation

GetAlwaysUse24HourFormat()

bool flutter::SettingsPlugin::GetAlwaysUse24HourFormat ( )

protectedvirtual

Definition at line 112 of file settings_plugin.cc.

                                              {
  return Prefer24HourTime(GetUserTimeFormat());
}

References flutter::GetUserTimeFormat(), and flutter::Prefer24HourTime().

Referenced by SendSettings().

GetPreferredBrightness()

SettingsPlugin::PlatformBrightness flutter::SettingsPlugin::GetPreferredBrightness ( )

protectedvirtual

Definition at line 131 of file settings_plugin.cc.

                                                                        {
  if (is_high_contrast_) {
    DWORD window_color = GetSysColor(COLOR_WINDOW);
    int luminance = GetLuminance(window_color);
    return luminance >= 127 ? SettingsPlugin::PlatformBrightness::kLight
                            : SettingsPlugin::PlatformBrightness::kDark;
  } else {
    return GetThemeBrightness();
  }
}

References is_high_contrast_, kDark, and kLight.

Referenced by SendSettings().

GetTextScaleFactor()

float flutter::SettingsPlugin::GetTextScaleFactor ( )

protectedvirtual

Definition at line 116 of file settings_plugin.cc.

                                         {
  DWORD text_scale_factor;
  DWORD text_scale_factor_size = sizeof(text_scale_factor);
  LONG result = RegGetValue(
      HKEY_CURRENT_USER, kGetTextScaleFactorRegKey, kGetTextScaleFactorRegValue,
      RRF_RT_REG_DWORD, nullptr, &text_scale_factor, &text_scale_factor_size);
 
  if (result == 0) {
    return text_scale_factor / 100.0;
  } else {
    // The current OS does not have text scale factor.
    return 1.0;
  }
}

References HKEY_CURRENT_USER.

Referenced by SendSettings().

SendSettings()

void flutter::SettingsPlugin::SendSettings

(

)

Definition at line 69 of file settings_plugin.cc.

                                  {
  rapidjson::Document settings(rapidjson::kObjectType);
  auto& allocator = settings.GetAllocator();
  settings.AddMember(kAlwaysUse24HourFormat, GetAlwaysUse24HourFormat(),
                     allocator);
  settings.AddMember(kTextScaleFactor, GetTextScaleFactor(), allocator);
 
  if (GetPreferredBrightness() == PlatformBrightness::kDark) {
    settings.AddMember(kPlatformBrightness, kPlatformBrightnessDark, allocator);
  } else {
    settings.AddMember(kPlatformBrightness, kPlatformBrightnessLight,
                       allocator);
  }
  channel_->Send(settings);
}

References GetAlwaysUse24HourFormat(), GetPreferredBrightness(), GetTextScaleFactor(), kDark, kPlatformBrightnessDark, and kPlatformBrightnessLight.

Referenced by UpdateHighContrastMode(), WatchPreferredBrightnessChanged(), and WatchTextScaleFactorChanged().

StartWatching()

void flutter::SettingsPlugin::StartWatching ( )

virtual

Definition at line 85 of file settings_plugin.cc.

                                   {
  RegOpenKeyEx(HKEY_CURRENT_USER, kGetPreferredBrightnessRegKey,
               RRF_RT_REG_DWORD, KEY_NOTIFY, &preferred_brightness_reg_hkey_);
  RegOpenKeyEx(HKEY_CURRENT_USER, kGetTextScaleFactorRegKey, RRF_RT_REG_DWORD,
               KEY_NOTIFY, &text_scale_factor_reg_hkey_);
 
  // Start watching when the keys exist.
  if (preferred_brightness_reg_hkey_ != nullptr) {
    WatchPreferredBrightnessChanged();
  }
  if (text_scale_factor_reg_hkey_ != nullptr) {
    WatchTextScaleFactorChanged();
  }
}

References HKEY_CURRENT_USER, KEY_NOTIFY, WatchPreferredBrightnessChanged(), and WatchTextScaleFactorChanged().

StopWatching()

void flutter::SettingsPlugin::StopWatching ( )

virtual

Definition at line 100 of file settings_plugin.cc.

                                  {
  preferred_brightness_changed_watcher_ = nullptr;
  text_scale_factor_changed_watcher_ = nullptr;
 
  if (preferred_brightness_reg_hkey_ != nullptr) {
    RegCloseKey(preferred_brightness_reg_hkey_);
  }
  if (text_scale_factor_reg_hkey_ != nullptr) {
    RegCloseKey(text_scale_factor_reg_hkey_);
  }
}

Referenced by ~SettingsPlugin().

UpdateHighContrastMode()

void flutter::SettingsPlugin::UpdateHighContrastMode ( bool  is_high_contrast )

virtual

Definition at line 169 of file settings_plugin.cc.

                                                                 {
  is_high_contrast_ = is_high_contrast;
  SendSettings();
}

References is_high_contrast_, and SendSettings().

WatchPreferredBrightnessChanged()

void flutter::SettingsPlugin::WatchPreferredBrightnessChanged ( )

protectedvirtual

Definition at line 142 of file settings_plugin.cc.

                                                     {
  preferred_brightness_changed_watcher_ =
      std::make_unique<EventWatcher>([this]() {
        task_runner_->PostTask([this]() {
          SendSettings();
          WatchPreferredBrightnessChanged();
        });
      });
 
  RegNotifyChangeKeyValue(
      preferred_brightness_reg_hkey_, FALSE, REG_NOTIFY_CHANGE_LAST_SET,
      preferred_brightness_changed_watcher_->GetHandle(), TRUE);
}

References flutter::TaskRunner::PostTask(), SendSettings(), TRUE, and WatchPreferredBrightnessChanged().

Referenced by StartWatching(), and WatchPreferredBrightnessChanged().

WatchTextScaleFactorChanged()

void flutter::SettingsPlugin::WatchTextScaleFactorChanged ( )

protectedvirtual

Definition at line 156 of file settings_plugin.cc.

                                                 {
  text_scale_factor_changed_watcher_ = std::make_unique<EventWatcher>([this]() {
    task_runner_->PostTask([this]() {
      SendSettings();
      WatchTextScaleFactorChanged();
    });
  });
 
  RegNotifyChangeKeyValue(
      text_scale_factor_reg_hkey_, FALSE, REG_NOTIFY_CHANGE_LAST_SET,
      text_scale_factor_changed_watcher_->GetHandle(), TRUE);
}

References flutter::TaskRunner::PostTask(), SendSettings(), TRUE, and WatchTextScaleFactorChanged().

Referenced by StartWatching(), and WatchTextScaleFactorChanged().

Member Data Documentation

is_high_contrast_

bool flutter::SettingsPlugin::is_high_contrast_ = false

protected

Definition at line 62 of file settings_plugin.h.

Referenced by GetPreferredBrightness(), and UpdateHighContrastMode().

---

The documentation for this class was generated from the following files:

• shell/platform/windows/settings_plugin.h
• shell/platform/windows/settings_plugin.cc