rime_api_deprecated.h File Reference

#include "rime_api.h"

Include dependency graph for rime_api_deprecated.h:

Go to the source code of this file.

Macros
#define	RIME_MAX_NUM_CANDIDATES   10
	Define the max number of candidates.

Functions
RIME_DEPRECATED void	RimeSetup (RimeTraits *traits)
	Call this function before accessing any other API.
RIME_DEPRECATED void	RimeSetupLogging (const char *app_name)
	Pass a C-string constant in the format "rime.x" where 'x' is the name of your application.
RIME_DEPRECATED void	RimeSetNotificationHandler (RimeNotificationHandler handler, void *context_object)
	Receive notifications.
RIME_DEPRECATED void	RimeInitialize (RimeTraits *traits)
RIME_DEPRECATED void	RimeFinalize (void)
RIME_DEPRECATED Bool	RimeStartMaintenance (Bool full_check)
RIME_DEPRECATED Bool	RimeStartMaintenanceOnWorkspaceChange (void)
RIME_DEPRECATED Bool	RimeIsMaintenancing (void)
RIME_DEPRECATED void	RimeJoinMaintenanceThread (void)
RIME_DEPRECATED void	RimeDeployerInitialize (RimeTraits *traits)
RIME_DEPRECATED Bool	RimePrebuildAllSchemas (void)
RIME_DEPRECATED Bool	RimeDeployWorkspace (void)
RIME_DEPRECATED Bool	RimeDeploySchema (const char *schema_file)
RIME_DEPRECATED Bool	RimeDeployConfigFile (const char *file_name, const char *version_key)
RIME_DEPRECATED Bool	RimeSyncUserData (void)
RIME_DEPRECATED RimeSessionId	RimeCreateSession (void)
RIME_DEPRECATED Bool	RimeFindSession (RimeSessionId session_id)
RIME_DEPRECATED Bool	RimeDestroySession (RimeSessionId session_id)
RIME_DEPRECATED void	RimeCleanupStaleSessions (void)
RIME_DEPRECATED void	RimeCleanupAllSessions (void)
RIME_DEPRECATED Bool	RimeProcessKey (RimeSessionId session_id, int keycode, int mask)
RIME_DEPRECATED Bool	RimeCommitComposition (RimeSessionId session_id)
	return True if there is unread commit text
RIME_DEPRECATED void	RimeClearComposition (RimeSessionId session_id)
RIME_DEPRECATED Bool	RimeGetCommit (RimeSessionId session_id, RimeCommit *commit)
RIME_DEPRECATED Bool	RimeFreeCommit (RimeCommit *commit)
RIME_DEPRECATED Bool	RimeGetContext (RimeSessionId session_id, RIME_FLAVORED(RimeContext) *context)
RIME_DEPRECATED Bool	RimeFreeContext (RIME_FLAVORED(RimeContext) *context)
RIME_DEPRECATED Bool	RimeGetStatus (RimeSessionId session_id, RIME_FLAVORED(RimeStatus) *status)
RIME_DEPRECATED Bool	RimeFreeStatus (RIME_FLAVORED(RimeStatus) *status)
RIME_DEPRECATED Bool	RimeCandidateListBegin (RimeSessionId session_id, RimeCandidateListIterator *iterator)
RIME_DEPRECATED Bool	RimeCandidateListNext (RimeCandidateListIterator *iterator)
RIME_DEPRECATED void	RimeCandidateListEnd (RimeCandidateListIterator *iterator)
RIME_DEPRECATED Bool	RimeCandidateListFromIndex (RimeSessionId session_id, RimeCandidateListIterator *iterator, int index)
RIME_DEPRECATED Bool	RimeSelectCandidate (RimeSessionId session_id, size_t index)
RIME_DEPRECATED Bool	RimeSelectCandidateOnCurrentPage (RimeSessionId session_id, size_t index)
RIME_DEPRECATED Bool	RimeDeleteCandidate (RimeSessionId session_id, size_t index)
RIME_DEPRECATED Bool	RimeDeleteCandidateOnCurrentPage (RimeSessionId session_id, size_t index)
RIME_DEPRECATED void	RimeSetOption (RimeSessionId session_id, const char *option, Bool value)
RIME_DEPRECATED Bool	RimeGetOption (RimeSessionId session_id, const char *option)
RIME_DEPRECATED void	RimeSetProperty (RimeSessionId session_id, const char *prop, const char *value)
RIME_DEPRECATED Bool	RimeGetProperty (RimeSessionId session_id, const char *prop, char *value, size_t buffer_size)
RIME_DEPRECATED Bool	RimeGetSchemaList (RimeSchemaList *schema_list)
RIME_DEPRECATED void	RimeFreeSchemaList (RimeSchemaList *schema_list)
RIME_DEPRECATED Bool	RimeGetCurrentSchema (RimeSessionId session_id, char *schema_id, size_t buffer_size)
RIME_DEPRECATED Bool	RimeSelectSchema (RimeSessionId session_id, const char *schema_id)
RIME_DEPRECATED Bool	RimeSchemaOpen (const char *schema_id, RimeConfig *config)
RIME_DEPRECATED Bool	RimeConfigOpen (const char *config_id, RimeConfig *config)
RIME_DEPRECATED Bool	RimeUserConfigOpen (const char *config_id, RimeConfig *config)
RIME_DEPRECATED Bool	RimeConfigClose (RimeConfig *config)
RIME_DEPRECATED Bool	RimeConfigInit (RimeConfig *config)
RIME_DEPRECATED Bool	RimeConfigLoadString (RimeConfig *config, const char *yaml)
RIME_DEPRECATED Bool	RimeConfigGetBool (RimeConfig *config, const char *key, Bool *value)
RIME_DEPRECATED Bool	RimeConfigGetInt (RimeConfig *config, const char *key, int *value)
RIME_DEPRECATED Bool	RimeConfigGetDouble (RimeConfig *config, const char *key, double *value)
RIME_DEPRECATED Bool	RimeConfigGetString (RimeConfig *config, const char *key, char *value, size_t buffer_size)
RIME_DEPRECATED const char *	RimeConfigGetCString (RimeConfig *config, const char *key)
RIME_DEPRECATED Bool	RimeConfigSetBool (RimeConfig *config, const char *key, Bool value)
RIME_DEPRECATED Bool	RimeConfigSetInt (RimeConfig *config, const char *key, int value)
RIME_DEPRECATED Bool	RimeConfigSetDouble (RimeConfig *config, const char *key, double value)
RIME_DEPRECATED Bool	RimeConfigSetString (RimeConfig *config, const char *key, const char *value)
RIME_DEPRECATED Bool	RimeConfigGetItem (RimeConfig *config, const char *key, RimeConfig *value)
RIME_DEPRECATED Bool	RimeConfigSetItem (RimeConfig *config, const char *key, RimeConfig *value)
RIME_DEPRECATED Bool	RimeConfigClear (RimeConfig *config, const char *key)
RIME_DEPRECATED Bool	RimeConfigCreateList (RimeConfig *config, const char *key)
RIME_DEPRECATED Bool	RimeConfigCreateMap (RimeConfig *config, const char *key)
RIME_DEPRECATED size_t	RimeConfigListSize (RimeConfig *config, const char *key)
RIME_DEPRECATED Bool	RimeConfigBeginList (RimeConfigIterator *iterator, RimeConfig *config, const char *key)
RIME_DEPRECATED Bool	RimeConfigBeginMap (RimeConfigIterator *iterator, RimeConfig *config, const char *key)
RIME_DEPRECATED Bool	RimeConfigNext (RimeConfigIterator *iterator)
RIME_DEPRECATED void	RimeConfigEnd (RimeConfigIterator *iterator)
RIME_DEPRECATED Bool	RimeConfigUpdateSignature (RimeConfig *config, const char *signer)
RIME_DEPRECATED Bool	RimeSimulateKeySequence (RimeSessionId session_id, const char *key_sequence)
RIME_DEPRECATED Bool	RimeSetInput (RimeSessionId session_id, const char *input)
RIME_DEPRECATED Bool	RimeRunTask (const char *task_name)
	Run a registered task.
RIME_DEPRECATED const char *	RimeGetSharedDataDir (void)
RIME_DEPRECATED const char *	RimeGetUserDataDir (void)
RIME_DEPRECATED const char *	RimeGetSyncDir (void)
RIME_DEPRECATED const char *	RimeGetUserId (void)

Macro Definition Documentation

RIME_MAX_NUM_CANDIDATES

#define RIME_MAX_NUM_CANDIDATES   10

Define the max number of candidates.

Deprecated

There is no limit to the number of candidates in RimeMenu

Function Documentation

RimeCandidateListBegin()

RIME_DEPRECATED Bool RimeCandidateListBegin	(	RimeSessionId	session_id,
		RimeCandidateListIterator *	iterator )

RimeCandidateListEnd()

RIME_DEPRECATED void RimeCandidateListEnd

(

RimeCandidateListIterator *

iterator

)

RimeCandidateListFromIndex()

RIME_DEPRECATED Bool RimeCandidateListFromIndex	(	RimeSessionId	session_id,
		RimeCandidateListIterator *	iterator,
		int	index )

RimeCandidateListNext()

RIME_DEPRECATED Bool RimeCandidateListNext

(

RimeCandidateListIterator *

iterator

)

RimeCleanupAllSessions()

RIME_DEPRECATED void RimeCleanupAllSessions

(

void

)

RimeCleanupStaleSessions()

RIME_DEPRECATED void RimeCleanupStaleSessions

(

void

)

RimeClearComposition()

RIME_DEPRECATED void RimeClearComposition

(

RimeSessionId

session_id

)

RimeCommitComposition()

RIME_DEPRECATED Bool RimeCommitComposition

(

RimeSessionId

session_id

)

return True if there is unread commit text

RimeConfigBeginList()

RIME_DEPRECATED Bool RimeConfigBeginList	(	RimeConfigIterator *	iterator,
		RimeConfig *	config,
		const char *	key )

RimeConfigBeginMap()

RIME_DEPRECATED Bool RimeConfigBeginMap	(	RimeConfigIterator *	iterator,
		RimeConfig *	config,
		const char *	key )

RimeConfigClear()

RIME_DEPRECATED Bool RimeConfigClear	(	RimeConfig *	config,
		const char *	key )

RimeConfigClose()

RIME_DEPRECATED Bool RimeConfigClose

(

RimeConfig *

config

)

RimeConfigCreateList()

RIME_DEPRECATED Bool RimeConfigCreateList	(	RimeConfig *	config,
		const char *	key )

RimeConfigCreateMap()

RIME_DEPRECATED Bool RimeConfigCreateMap	(	RimeConfig *	config,
		const char *	key )

RimeConfigEnd()

RIME_DEPRECATED void RimeConfigEnd

(

RimeConfigIterator *

iterator

)

RimeConfigGetBool()

RIME_DEPRECATED Bool RimeConfigGetBool	(	RimeConfig *	config,
		const char *	key,
		Bool *	value )

RimeConfigGetCString()

RIME_DEPRECATED const char * RimeConfigGetCString	(	RimeConfig *	config,
		const char *	key )

RimeConfigGetDouble()

RIME_DEPRECATED Bool RimeConfigGetDouble	(	RimeConfig *	config,
		const char *	key,
		double *	value )

RimeConfigGetInt()

RIME_DEPRECATED Bool RimeConfigGetInt	(	RimeConfig *	config,
		const char *	key,
		int *	value )

RimeConfigGetItem()

RIME_DEPRECATED Bool RimeConfigGetItem	(	RimeConfig *	config,
		const char *	key,
		RimeConfig *	value )

RimeConfigGetString()

RIME_DEPRECATED Bool RimeConfigGetString	(	RimeConfig *	config,
		const char *	key,
		char *	value,
		size_t	buffer_size )

RimeConfigInit()

RIME_DEPRECATED Bool RimeConfigInit

(

RimeConfig *

config

)

RimeConfigListSize()

RIME_DEPRECATED size_t RimeConfigListSize	(	RimeConfig *	config,
		const char *	key )

RimeConfigLoadString()

RIME_DEPRECATED Bool RimeConfigLoadString	(	RimeConfig *	config,
		const char *	yaml )

RimeConfigNext()

RIME_DEPRECATED Bool RimeConfigNext

(

RimeConfigIterator *

iterator

)

RimeConfigOpen()

RIME_DEPRECATED Bool RimeConfigOpen	(	const char *	config_id,
		RimeConfig *	config )

RimeConfigSetBool()

RIME_DEPRECATED Bool RimeConfigSetBool	(	RimeConfig *	config,
		const char *	key,
		Bool	value )

RimeConfigSetDouble()

RIME_DEPRECATED Bool RimeConfigSetDouble	(	RimeConfig *	config,
		const char *	key,
		double	value )

RimeConfigSetInt()

RIME_DEPRECATED Bool RimeConfigSetInt	(	RimeConfig *	config,
		const char *	key,
		int	value )

RimeConfigSetItem()

RIME_DEPRECATED Bool RimeConfigSetItem	(	RimeConfig *	config,
		const char *	key,
		RimeConfig *	value )

RimeConfigSetString()

RIME_DEPRECATED Bool RimeConfigSetString	(	RimeConfig *	config,
		const char *	key,
		const char *	value )

RimeConfigUpdateSignature()

RIME_DEPRECATED Bool RimeConfigUpdateSignature	(	RimeConfig *	config,
		const char *	signer )

RimeCreateSession()

RIME_DEPRECATED RimeSessionId RimeCreateSession

(

void

)

RimeDeleteCandidate()

RIME_DEPRECATED Bool RimeDeleteCandidate	(	RimeSessionId	session_id,
		size_t	index )

RimeDeleteCandidateOnCurrentPage()

RIME_DEPRECATED Bool RimeDeleteCandidateOnCurrentPage	(	RimeSessionId	session_id,
		size_t	index )

RimeDeployConfigFile()

RIME_DEPRECATED Bool RimeDeployConfigFile	(	const char *	file_name,
		const char *	version_key )

RimeDeployerInitialize()

RIME_DEPRECATED void RimeDeployerInitialize

(

RimeTraits *

traits

)

RimeDeploySchema()

RIME_DEPRECATED Bool RimeDeploySchema

(

const char *

schema_file

)

RimeDeployWorkspace()

RIME_DEPRECATED Bool RimeDeployWorkspace

(

void

)

RimeDestroySession()

RIME_DEPRECATED Bool RimeDestroySession

(

RimeSessionId

session_id

)

RimeFinalize()

RIME_DEPRECATED void RimeFinalize

(

void

)

RimeFindSession()

RIME_DEPRECATED Bool RimeFindSession

(

RimeSessionId

session_id

)

RimeFreeCommit()

RIME_DEPRECATED Bool RimeFreeCommit

(

RimeCommit *

commit

)

RimeFreeContext()

RIME_DEPRECATED Bool RimeFreeContext

(

RIME_FLAVORED(RimeContext) *

context

)

RimeFreeSchemaList()

RIME_DEPRECATED void RimeFreeSchemaList

(

RimeSchemaList *

schema_list

)

RimeFreeStatus()

RIME_DEPRECATED Bool RimeFreeStatus

(

RIME_FLAVORED(RimeStatus) *

status

)

RimeGetCommit()

RIME_DEPRECATED Bool RimeGetCommit	(	RimeSessionId	session_id,
		RimeCommit *	commit )

RimeGetContext()

RIME_DEPRECATED Bool RimeGetContext	(	RimeSessionId	session_id,
		RIME_FLAVORED(RimeContext) *	context )

RimeGetCurrentSchema()

RIME_DEPRECATED Bool RimeGetCurrentSchema	(	RimeSessionId	session_id,
		char *	schema_id,
		size_t	buffer_size )

RimeGetOption()

RIME_DEPRECATED Bool RimeGetOption	(	RimeSessionId	session_id,
		const char *	option )

RimeGetProperty()

RIME_DEPRECATED Bool RimeGetProperty	(	RimeSessionId	session_id,
		const char *	prop,
		char *	value,
		size_t	buffer_size )

RimeGetSchemaList()

RIME_DEPRECATED Bool RimeGetSchemaList

(

RimeSchemaList *

schema_list

)

RimeGetSharedDataDir()

RIME_DEPRECATED const char * RimeGetSharedDataDir

(

void

)

Deprecated

use RimeApi::get_shared_data_dir_s instead.

RimeGetStatus()

RIME_DEPRECATED Bool RimeGetStatus	(	RimeSessionId	session_id,
		RIME_FLAVORED(RimeStatus) *	status )

RimeGetSyncDir()

RIME_DEPRECATED const char * RimeGetSyncDir

(

void

)

Deprecated

use RimeApi::get_sync_dir_s instead.

RimeGetUserDataDir()

RIME_DEPRECATED const char * RimeGetUserDataDir

(

void

)

Deprecated

use RimeApi::get_user_data_dir_s instead.

RimeGetUserId()

RIME_DEPRECATED const char * RimeGetUserId

(

void

)

RimeInitialize()

RIME_DEPRECATED void RimeInitialize

(

RimeTraits *

traits

)

RimeIsMaintenancing()

RIME_DEPRECATED Bool RimeIsMaintenancing

(

void

)

RimeJoinMaintenanceThread()

RIME_DEPRECATED void RimeJoinMaintenanceThread

(

void

)

RimePrebuildAllSchemas()

RIME_DEPRECATED Bool RimePrebuildAllSchemas

(

void

)

RimeProcessKey()

RIME_DEPRECATED Bool RimeProcessKey	(	RimeSessionId	session_id,
		int	keycode,
		int	mask )

RimeRunTask()

RIME_DEPRECATED Bool RimeRunTask

(

const char *

task_name

)

Run a registered task.

RimeSchemaOpen()

RIME_DEPRECATED Bool RimeSchemaOpen	(	const char *	schema_id,
		RimeConfig *	config )

RimeSelectCandidate()

RIME_DEPRECATED Bool RimeSelectCandidate	(	RimeSessionId	session_id,
		size_t	index )

RimeSelectCandidateOnCurrentPage()

RIME_DEPRECATED Bool RimeSelectCandidateOnCurrentPage	(	RimeSessionId	session_id,
		size_t	index )

RimeSelectSchema()

RIME_DEPRECATED Bool RimeSelectSchema	(	RimeSessionId	session_id,
		const char *	schema_id )

RimeSetInput()

RIME_DEPRECATED Bool RimeSetInput	(	RimeSessionId	session_id,
		const char *	input )

RimeSetNotificationHandler()

RIME_DEPRECATED void RimeSetNotificationHandler	(	RimeNotificationHandler	handler,
		void *	context_object )

Receive notifications.

RimeSetOption()

RIME_DEPRECATED void RimeSetOption	(	RimeSessionId	session_id,
		const char *	option,
		Bool	value )

RimeSetProperty()

RIME_DEPRECATED void RimeSetProperty	(	RimeSessionId	session_id,
		const char *	prop,
		const char *	value )

RimeSetup()

RIME_DEPRECATED void RimeSetup

(

RimeTraits *

traits

)

Call this function before accessing any other API.

RimeSetupLogging()

RIME_DEPRECATED void RimeSetupLogging

(

const char *

app_name

)

Pass a C-string constant in the format "rime.x" where 'x' is the name of your application.

Add prefix "rime." to ensure old log files are automatically cleaned.

Deprecated

Use RimeSetup() instead.

RimeSimulateKeySequence()

RIME_DEPRECATED Bool RimeSimulateKeySequence	(	RimeSessionId	session_id,
		const char *	key_sequence )

RimeStartMaintenance()

RIME_DEPRECATED Bool RimeStartMaintenance

(

Bool

full_check

)

RimeStartMaintenanceOnWorkspaceChange()

RIME_DEPRECATED Bool RimeStartMaintenanceOnWorkspaceChange

(

void

)

Deprecated

Use RimeStartMaintenance(full_check = False) instead.

RimeSyncUserData()

RIME_DEPRECATED Bool RimeSyncUserData

(

void

)

RimeUserConfigOpen()

RIME_DEPRECATED Bool RimeUserConfigOpen	(	const char *	config_id,
		RimeConfig *	config )