/* * mod_aux.h * * Copyright (c) 2005, 2008 * libchewing Core Team. See ChangeLog for details. * * See the file "COPYING" for information on usage and redistribution * of this file. */ /* *INDENT-OFF* */ #ifndef CHEWING_MOD_AUX_H #define CHEWING_MOD_AUX_H /* *INDENT-ON* */ /*! \file mod_aux.h * \brief Auxiliary module * \author libchewing Core Team */ #ifdef WITH_RUST # include "chewing_rs.h" #else # include "global.h" #endif /** * @brief Chewing the state for input context during commit process * @param ctx handle to Chewing IM context * @retval TRUE if its currnet input state is at the "end-of-a-char" */ CHEWING_API int chewing_commit_Check(const ChewingContext *ctx); /** * @brief Get current commit string regardless of current input state * @param ctx handle to Chewing IM context * * Always returns a char pointer, caller must free it. */ CHEWING_API char *chewing_commit_String(const ChewingContext *ctx); CHEWING_API const char *chewing_commit_String_static(const ChewingContext *ctx); /*! \name Preedit string buffer */ /*@{*/ CHEWING_API char *chewing_buffer_String(const ChewingContext *ctx); CHEWING_API const char *chewing_buffer_String_static(const ChewingContext *ctx); CHEWING_API int chewing_buffer_Check(const ChewingContext *ctx); CHEWING_API int chewing_buffer_Len(const ChewingContext *ctx); /*@}*/ /*@{*/ CHEWING_API const char *chewing_bopomofo_String_static(const ChewingContext *ctx); CHEWING_API int chewing_bopomofo_Check(const ChewingContext *ctx); /*@}*/ CHEWING_API int chewing_cursor_Current(const ChewingContext *ctx); /*@{*/ CHEWING_API int chewing_cand_CheckDone(const ChewingContext *ctx); CHEWING_API int chewing_cand_TotalPage(const ChewingContext *ctx); CHEWING_API int chewing_cand_ChoicePerPage(const ChewingContext *ctx); CHEWING_API int chewing_cand_TotalChoice(const ChewingContext *ctx); CHEWING_API int chewing_cand_CurrentPage(const ChewingContext *ctx); CHEWING_API void chewing_cand_Enumerate(ChewingContext *ctx); CHEWING_API int chewing_cand_hasNext(ChewingContext *ctx); CHEWING_API char *chewing_cand_String(ChewingContext *ctx); CHEWING_API const char *chewing_cand_String_static(ChewingContext *ctx); CHEWING_API char *chewing_cand_string_by_index(ChewingContext *ctx, int index); CHEWING_API const char *chewing_cand_string_by_index_static(ChewingContext *ctx, int index); CHEWING_API int chewing_cand_choose_by_index(ChewingContext *ctx, int index); CHEWING_API int chewing_cand_open(ChewingContext *ctx); CHEWING_API int chewing_cand_close(ChewingContext *ctx); /*@}*/ /*@{*/ CHEWING_API void chewing_interval_Enumerate(ChewingContext *ctx); CHEWING_API int chewing_interval_hasNext(ChewingContext *ctx); CHEWING_API void chewing_interval_Get(ChewingContext *ctx, IntervalType * it); /*@}*/ /*@{*/ CHEWING_API int chewing_aux_Check(const ChewingContext *ctx); CHEWING_API int chewing_aux_Length(const ChewingContext *ctx); CHEWING_API char *chewing_aux_String(const ChewingContext *ctx); CHEWING_API const char *chewing_aux_String_static(const ChewingContext *ctx); /*@}*/ /*@{*/ CHEWING_API int chewing_keystroke_CheckIgnore(const ChewingContext *ctx); CHEWING_API int chewing_keystroke_CheckAbsorb(const ChewingContext *ctx); /*@}*/ /*@{*/ CHEWING_API int chewing_kbtype_Total(const ChewingContext *ctx); CHEWING_API void chewing_kbtype_Enumerate(ChewingContext *ctx); CHEWING_API int chewing_kbtype_hasNext(ChewingContext *ctx); CHEWING_API char *chewing_kbtype_String(ChewingContext *ctx); CHEWING_API const char *chewing_kbtype_String_static(ChewingContext *ctx); /*@}*/ /* *INDENT-OFF* */ #endif /* CHEWING_MOD_AUX_H */ /* *INDENT-ON* */