Develop an simple input method/zh-cn - Revision history

Weng Xuetian at 08:44, 5 January 2026

2026-01-05T08:44:39Z

← Older revision		Revision as of 08:44, 5 January 2026
Line 5:		Line 5:
	Fcitx 5 提供了一个用于添加新插件类型的可扩展框架，但共享库支持是内置的，并且是所有其他插件类型的基础。所以我们只会在本文档中介绍共享库插件。		Fcitx 5 提供了一个用于添加新插件类型的可扩展框架，但共享库支持是内置的，并且是所有其他插件类型的基础。所以我们只会在本文档中介绍共享库插件。

	~~<div class="mw-translate-fuzzy">~~		<nowiki>
	<nowiki>
	[fcitx install prefix]		[fcitx install prefix]
	\|		\|
	\|- share/fcitx5		\|- share/fcitx5
	\| \|		\| \|
	\| \|- ~~addons~~/[addon name].conf		\| \|- addon/[addon name].conf
	\| \|- inputmethod/[input method name 1].conf		\| \|- inputmethod/[input method name 1].conf
	\| \| ...		\| \| ...
Line 20:		Line 19:
	\|- [library name].so		\|- [library name].so
	</nowiki>		</nowiki>
	~~</div>~~

	以上是输入法插件的文件结构。对于其他类型的插件，不需要 <code>inputmethod/</code> 下的文件。<code>[addon name].conf</code> 的文件名很重要，将用于唯一引用此特定插件。Fcitx 也遵循 XDG 目录标准，所以 XDG_DATA_DIR/fcitx5 下的文件也会被检查。同样，<code>inputmethod/</code>下的配置文件的文件名也很重要，将是某个输入法的唯一名称。		以上是输入法插件的文件结构。对于其他类型的插件，不需要 <code>inputmethod/</code> 下的文件。<code>[addon name].conf</code> 的文件名很重要，将用于唯一引用此特定插件。Fcitx 也遵循 XDG 目录标准，所以 XDG_DATA_DIR/fcitx5 下的文件也会被检查。同样，<code>inputmethod/</code>下的配置文件的文件名也很重要，将是某个输入法的唯一名称。

Weng Xuetian at 23:30, 11 January 2025

2025-01-11T23:30:41Z

← Older revision		Revision as of 23:30, 11 January 2025
Line 1:		Line 1:
	<languages />		<languages />
	这是编写 Fcitx 5 ~~输入法的分步说明。同样的指令可以用于开发其他类型的插件，只是输入法引擎是最复杂的。~~		这是编写 Fcitx 5 输入法的分步说明。同样的步骤也可以用于开发其他类型的插件，只是输入法引擎是最复杂的。

	= 了解 Fcitx 共享库插件的文件结构 =		= 了解 Fcitx 共享库插件的文件结构 =

FuzzyBot: Updating to match new version of source page

2025-01-11T23:29:54Z

Updating to match new version of source page

← Older revision		Revision as of 23:29, 11 January 2025
Line 5:		Line 5:
	Fcitx 5 提供了一个用于添加新插件类型的可扩展框架，但共享库支持是内置的，并且是所有其他插件类型的基础。所以我们只会在本文档中介绍共享库插件。		Fcitx 5 提供了一个用于添加新插件类型的可扩展框架，但共享库支持是内置的，并且是所有其他插件类型的基础。所以我们只会在本文档中介绍共享库插件。

	<nowiki>		<div class="mw-translate-fuzzy">
			<nowiki>
	[fcitx install prefix]		[fcitx install prefix]
	\|		\|
Line 19:		Line 20:
	\|- [library name].so		\|- [library name].so
	</nowiki>		</nowiki>
			</div>

	以上是输入法插件的文件结构。对于其他类型的插件，不需要 <code>inputmethod/</code> 下的文件。<code>[addon name].conf</code> 的文件名很重要，将用于唯一引用此特定插件。Fcitx 也遵循 XDG 目录标准，所以 XDG_DATA_DIR/fcitx5 下的文件也会被检查。同样，<code>inputmethod/</code>下的配置文件的文件名也很重要，将是某个输入法的唯一名称。		以上是输入法插件的文件结构。对于其他类型的插件，不需要 <code>inputmethod/</code> 下的文件。<code>[addon name].conf</code> 的文件名很重要，将用于唯一引用此特定插件。Fcitx 也遵循 XDG 目录标准，所以 XDG_DATA_DIR/fcitx5 下的文件也会被检查。同样，<code>inputmethod/</code>下的配置文件的文件名也很重要，将是某个输入法的唯一名称。

Matrikslee at 09:24, 8 November 2023

2023-11-08T09:24:46Z

← Older revision		Revision as of 09:24, 8 November 2023
Line 78:		Line 78:

	= 快速入门：区位码 =		= 快速入门：区位码 =
	[[wikipedia:区位码_(国标)\|区位码]] ~~输入法是一种输入法，基本上允许您输入GB2312的数字并产生与该代码匹配的汉字。它曾经被~~ Fcitx 4 支持，但不再被 Fcitx 5 包含。虽然它很难使用，但它可以作为一个很好的例子来说明如何为 Fcitx 5 实现一个简单的输入法。		[[wikipedia:区位码_(国标)\|区位码]] 输入法是一种输入法，允许您简单的输入GB2312的数字并产生与该代码匹配的汉字。它曾经被 Fcitx 4 支持，但不再被 Fcitx 5 包含。虽然它很难使用，但它可以作为一个很好的例子来说明如何为 Fcitx 5 实现一个简单的输入法。

	== 项目框架 ==		== 项目框架 ==

Matrikslee at 03:46, 19 April 2023

2023-04-19T03:46:22Z

← Older revision		Revision as of 03:46, 19 April 2023
Line 352:		Line 352:
	}</nowiki>		}</nowiki>

	readAsIni ~~and~~ safeSaveAsIni ~~are helper functions to read/save Configuration object from/to the~~ Fcitx ini~~-format. The file is saved under~~ $XDG_CONFIG_HOME.		readAsIni 和 safeSaveAsIni 是辅助函数，用于从 Fcitx ini 格式读取/保存配置对象。该文件保存在 $XDG_CONFIG_HOME 下。

Matrikslee: Created page with "通常，您将使用 FCITX_CONFIGURATION 宏定义 Configuration 的子类。第一个参数是类的名称，然后您只需添加 [https://codedocs.xyz/fcitx/fcitx5/classfc..."

2023-04-19T03:45:51Z

Created page with "通常，您将使用 FCITX_CONFIGURATION 宏定义 Configuration 的子类。第一个参数是类的名称，然后您只需添加 [https://codedocs.xyz/fcitx/fcitx5/classfc..."

← Older revision		Revision as of 03:45, 19 April 2023
Line 340:		Line 340:
	IntConstrain(3, 30)};);</nowiki>		IntConstrain(3, 30)};);</nowiki>

	~~Usually, you will define a sub class of~~ Configuration ~~with the FCITX_CONFIGURATION macro. First argument is the name of the class, and then you just simply add~~ [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1Option.html Option] ~~as member. Following is a common implemenation of~~ setConfig/getConfig/reloadConfig.		通常，您将使用 FCITX_CONFIGURATION 宏定义 Configuration 的子类。第一个参数是类的名称，然后您只需添加 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1Option.html Option] 作为成员。以下是 setConfig/getConfig/reloadConfig 的常见实现。

Matrikslee: Created page with "如果在插件注册文件中将 Configurable 字段设置为 True，则会调用此类方法来检索信息，Configtool 会为其生成 UI。"

2023-04-19T03:45:32Z

Created page with "如果在插件注册文件中将 Configurable 字段设置为 True，则会调用此类方法来检索信息，Configtool 会为其生成 UI。"

← Older revision		Revision as of 03:45, 19 April 2023
Line 326:		Line 326:
	虽然区位码并不真正需要这个功能，因为它是一个非常常见的用例，所以它会在本节中介绍。该插件有几个与配置相关的不同接口，例如 getConfig、setConfig、getConfigForInputMethod、setConfigForInputMethod、reloadConfig。getter 函数需要返回一个 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1Configuration.html Configuration] 对象，而 setConfig 接受一个 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1RawConfig.html RawConfig]目的。reloadConfig 将被调用以从磁盘重新加载配置，您可能也想在插件的构造函数中调用 reloadConfig()。		虽然区位码并不真正需要这个功能，因为它是一个非常常见的用例，所以它会在本节中介绍。该插件有几个与配置相关的不同接口，例如 getConfig、setConfig、getConfigForInputMethod、setConfigForInputMethod、reloadConfig。getter 函数需要返回一个 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1Configuration.html Configuration] 对象，而 setConfig 接受一个 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1RawConfig.html RawConfig]目的。reloadConfig 将被调用以从磁盘重新加载配置，您可能也想在插件的构造函数中调用 reloadConfig()。

	If Configurable ~~field is set to True in the addon registration file, such method would be called to retrieve the information and Configtool would generate UI for it.~~		如果在插件注册文件中将 Configurable 字段设置为 True，则会调用此类方法来检索信息，Configtool 会为其生成 UI。

	<nowiki>FCITX_CONFIGURATION(		<nowiki>FCITX_CONFIGURATION(

Matrikslee: Created page with "= 配置 = 虽然区位码并不真正需要这个功能，因为它是一个非常常见的用例，所以它会在本节中介绍。该插件有几个与配置相关的不..."

2023-04-19T03:45:24Z

Created page with "= 配置 = 虽然区位码并不真正需要这个功能，因为它是一个非常常见的用例，所以它会在本节中介绍。该插件有几个与配置相关的不..."

← Older revision		Revision as of 03:45, 19 April 2023
Line 323:		Line 323:
	这种机制使得重用其他插件实现的功能和共享代码变得容易。比如 classicui 从 xcb addon 和 wayland addon 查询 X11/wayland 连接。		这种机制使得重用其他插件实现的功能和共享代码变得容易。比如 classicui 从 xcb addon 和 wayland addon 查询 X11/wayland 连接。

	= ~~Configuration~~ =		= 配置 =
	While Quwei does not really need this feature, since it is a really common use case so it will be covered in this section. The addon has a few different interface relevant to configuration, such as getConfig, setConfig, getConfigForInputMethod, setConfigForInputMethod, reloadConfig. The getter function would need to return a [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1Configuration.html Configuration] ~~object, while~~ setConfig ~~accepts a~~ [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1RawConfig.html RawConfig] ~~object. reloadConfig will be called to reload the configuration from disk, you may want to call~~ reloadConfig() ~~in the constructor of the addon too.~~		虽然区位码并不真正需要这个功能，因为它是一个非常常见的用例，所以它会在本节中介绍。该插件有几个与配置相关的不同接口，例如 getConfig、setConfig、getConfigForInputMethod、setConfigForInputMethod、reloadConfig。getter 函数需要返回一个 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1Configuration.html Configuration] 对象，而 setConfig 接受一个 [https://codedocs.xyz/fcitx/fcitx5/classfcitx_1_1RawConfig.html RawConfig]目的。reloadConfig 将被调用以从磁盘重新加载配置，您可能也想在插件的构造函数中调用 reloadConfig()。

	If Configurable field is set to True in the addon registration file, such method would be called to retrieve the information and Configtool would generate UI for it.		If Configurable field is set to True in the addon registration file, such method would be called to retrieve the information and Configtool would generate UI for it.

Matrikslee: Created page with "这种机制使得重用其他插件实现的功能和共享代码变得容易。比如 classicui 从 xcb addon 和 wayland addon 查询 X11/wayland 连接。"

2023-04-19T03:44:38Z

Created page with "这种机制使得重用其他插件实现的功能和共享代码变得容易。比如 classicui 从 xcb addon 和 wayland addon 查询 X11/wayland 连接。"

← Older revision		Revision as of 03:44, 19 April 2023
Line 321:		Line 321:
	第一个参数应与插件名称相同，第二个参数是获取 AddonManager 对象的表达式。		第一个参数应与插件名称相同，第二个参数是获取 AddonManager 对象的表达式。

	~~This mechanism make it easy to reuse the functionality implemented by other addons and shared the code. For example,~~ classicui ~~queries the X11/wayland connection from~~ xcb addon ~~and~~ wayland addon.		这种机制使得重用其他插件实现的功能和共享代码变得容易。比如 classicui 从 xcb addon 和 wayland addon 查询 X11/wayland 连接。

	= Configuration =		= Configuration =

Matrikslee: Created page with "第一个参数应与插件名称相同，第二个参数是获取 AddonManager 对象的表达式。"

2023-04-19T03:44:21Z

Created page with "第一个参数应与插件名称相同，第二个参数是获取 AddonManager 对象的表达式。"

← Older revision		Revision as of 03:44, 19 April 2023
Line 319:		Line 319:
	FCITX_ADDON_DEPENDENCY_LOADER(fullwidth, instance_->addonManager());</nowiki>		FCITX_ADDON_DEPENDENCY_LOADER(fullwidth, instance_->addonManager());</nowiki>

	~~The first parameter should be same as the addon name, second parameter is the expression to get the~~ AddonManager ~~object.~~		第一个参数应与插件名称相同，第二个参数是获取 AddonManager 对象的表达式。

	This mechanism make it easy to reuse the functionality implemented by other addons and shared the code. For example, classicui queries the X11/wayland connection from xcb addon and wayland addon.		This mechanism make it easy to reuse the functionality implemented by other addons and shared the code. For example, classicui queries the X11/wayland connection from xcb addon and wayland addon.