15. systemPreferences

原文:https://github.com/electron/electron/blob/master/docs/api/system-preferences.md
译者:Lin

获取系统偏好设置

进程:主进程

const {systemPreferences} = require('electron')
console.log(systemPreferences.isDarkMode())

事件

systemPreferences对象分发下面事件:

事件: 'accent-color-changed' Windows

返回值:

  • event Event类型
  • newColor String类型 - 用户指定作为他们系统颜色的新的RGBA格式的颜色。

事件: 'color-changed' Windows

返回值:

  • event Event类型

事件: 'inverted-color-scheme-changed' Windows

返回值:

  • event Event类型
  • invertedColorScheme Boolean类型 - 如果是反向配色方案,例如一个高对比度的主题将要被使用,则这个值为true。否则这个值为false

方法

systemPreferences.isDarkMode() MacOS

返回值为Boolean类型 - 系统是否是深色模式。

systemPreferences.isSwipeTrackingFromScrollEventsEnabled() MacOS

返回值为Boolean类型 - 是否开启页面之间的切换。

systemPreferences.postNotification(event, userInfo) MacOS

  • event String类型
  • userInfo Object类型

event作为MacOS的本地通知发送。userInfo是一个和通知一起发送的包含了用户信息字典的对象。

systemPreferences.postLocalNotification(event, userInfo) MacOS

  • event String类型
  • userInfo Object类型

event作为MacOS的本地通知发送。userInfo是一个和通知一起发送的包含了用户信息字典的对象。

systemPreferences.subscribeNotification(event, callback) MacOS

  • event String类型
  • callback Function类型
    • event String类型
    • userInfo Object类型

订阅MacOS的本地通知,当对应的event发生的时候callback将会使用callback(event, userInfo)被调用。userInfo是一个和通知一起发送的包含了用户信息字典的对象。

返回订阅器的id,可以用来取消订阅event

这个接口的本质是订阅NSDistributedNotificationCenter,例如event的值可以是:

  • AppleInterfaceThemeChangedNotification
  • AppleAquaColorVariantChanged
  • AppleColorPreferencesChangedNotification
  • AppleShowScrollBarsSettingChanged

systemPreferences.unsubscribeNotification(id) MacOS

  • id Integer类型

通过id移除订阅器。

systemPreferences.subscribeLocalNotification(event, callback) MacOS

  • event String类型
  • callback Function类型
    • event String类型
    • userInfo Object类型

subscribeNotification一样,不过本地是默认使用NSNotificationCenter。这个对于事件是必要的,例如NSUserDefaultsDidChangeNotification

systemPreferences.unsubscribeLocalNotification(id) MacOS

  • id Integer类型

unsubscribeNotification一样,不过是从NSNotificationCenter中移除订阅器。

systemPreferences.getUserDefault(key, type) MacOS

  • key String类型
  • type String类型 - 可以是stringbooleanintegerfloatdoubleurlarraydictionary

通过key来获取系统偏好设置里面对应的值。

这个接口在MacOS中使用NSUserDefaults。一些常用的keytype有:

  • AppleInterfaceStyle: string
  • AppleAquaColorVariant: integer
  • AppleHighlightColor: string
  • AppleShowScrollBars: string
  • NSNavRecentPlaces: array
  • NSPreferredWebServices: dictionary
  • NSUserDictionaryReplacementItems: array

systemPreferences.setUserDefault(key, type, value) MacOS

  • key String类型
  • type String类型 - 查看getUserDefault
  • value String类型

通过key来设置系统偏好设置里面对应的值。

请注意,type应该和value的实际类型匹配。如果不匹配将会抛出一个错误。An exception is thrown if they don't.

这个接口在MacOS中使用NSUserDefaults。一些常用的keytype有:

  • ApplePressAndHoldEnabled: boolean

systemPreferences.isAeroGlassEnabled() Windows

如果DWM composition(毛玻璃效果)被激活,那么这个方法将返回true,否则将返回false

一个使用这个接口的例子,来决定是否你需要创建一个透明窗口(当DWM composition被禁用的时候透明窗口将不能正常的工作):

const {BrowserWindow, systemPreferences} = require('electron')
let browserOptions = {width: 1000, height: 800}

// Make the window transparent only if the platform supports it.
if (process.platform !== 'win32' || systemPreferences.isAeroGlassEnabled()) {
    browserOptions.transparent = true
    browserOptions.frame = false
}

// Create the window.
let win = new BrowserWindow(browserOptions)

// Navigate.
if (browserOptions.transparent) {
    win.loadURL(`file://${__dirname}/index.html`)
} else {
    // No transparency, so we load a fallback that uses basic styles.
    win.loadURL(`file://${__dirname}/fallback.html`)
}

systemPreferences.getAccentColor() Windows

返回值为String类型 - 十六进制RGBA格式的用户当前系统颜色偏好。

const color = systemPreferences.getAccentColor() // `"aabbccdd"`
const red = color.substr(0, 2) // "aa"
const green = color.substr(2, 2) // "bb"
const blue = color.substr(4, 2) // "cc"
const alpha = color.substr(6, 2) // "dd"

systemPreferences.getColor(color) Windows

  • color String类型 - 使用以下值之一:
    • 3d-dark-shadow - 显示的3D元素的深色阴影颜色。
    • 3d-face - 显示的3D元素和对话框背景的表面颜色。
    • 3d-highlight - 显示的3D元素的高亮颜色。
    • 3d-light - 显示的3D元素的光亮的颜色。
    • 3d-shadow - 显示的3D元素的阴影的颜色。
    • active-border - 活动窗口的边框的颜色。
    • active-caption - 活动窗口的标题栏。如果开启了颜色梯度变化,那么这个值是活动窗口标题栏最左侧的颜色。
    • active-caption-gradient - 活动窗口标题栏最右侧的颜色。
    • app-workspace - 多文档界面(MDI)应用的背景颜色。
    • button-text - 推送按钮的文字的颜色。
    • caption-text - 标题栏的文字、缩放框和滚动条剪头框的颜色。
    • desktop - 桌面背景颜色。
    • disabled-text - 灰色(无效的)文本的颜色。
    • highlight - 控件中选中项的颜色。
    • highlight-text - 控件中选中项的文本的颜色。
    • hotlight - 超链接或热跟踪项的颜色。
    • inactive-border - 非活动窗口边框的颜色。
    • inactive-caption - 非活动窗口的标题栏的颜色。如果开启了颜色梯度变化,那么这个值是活动窗口标题栏最左侧的颜色。
    • inactive-caption-gradient - 非活动窗口标题栏最右侧的颜色。
    • inactive-caption-text - 非活动标题栏的文字的颜色。
    • info-background - 工具提示控件的背景颜色。
    • info-text - 工具提示控件的文本颜色。
    • menu - 菜单背景颜色。
    • menu-highlight - 菜单栏为平面菜单时的菜单项的高亮颜色。
    • menubar - 菜单栏为平面菜单时的背景颜色。
    • menu-text - 菜单的文字颜色。
    • scrollbar - 滚动条灰色区域的颜色。
    • window - 窗口背景色。
    • window-frame - 窗口框架颜色。
    • window-text - 窗口内的文本颜色。

返回值为String类型 - 十六进制的RGB格式(#ABCDEF)的系统颜色设置。查看Windows docs获取更详细信息。

systemPreferences.isInvertedColorScheme() Windows

返回值为Boolean类型 - 如果是反向配色方案,例如一个高对比度的主题将要被使用,则这个值为true。否则这个值为false

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容

  • 原文:https://github.com/electron/electron/blob/master/docs/...
    Shmily落墨阅读 18,992评论 1 5
  • 原文:https://github.com/electron/electron/blob/master/docs/...
    Shmily落墨阅读 6,089评论 0 1
  • 原文:https://github.com/electron/electron/blob/master/docs/...
    Shmily落墨阅读 2,618评论 0 1
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,597评论 18 139
  • 你是山野吹来的风 带着泥土的气息 满含鲜花的香气 你是山野吹来的风 拂过连绵的山头 来自高耸的丛林之中 你是山野吹...
    弓文锐阅读 595评论 0 8