キーボードクラス More...

#include <GxInputImeText.h>

Inheritance diagram for GxImeText:

[legend]

Collaboration diagram for GxImeText:

[legend]

Classes
struct	GxImeData
	イベント構造体 More...

struct	GxImeRenderData
	IME 描画データ構造体(UTF8) More...

Public Member Functions
初期化
	GxImeText (void)
	コンストラクタ

	~GxImeText (void) override
	デストラクタ

GX_FORCE_INLINE void	clear (void) override
	クリア

b32	initialize (void) override
	初期化

void	setBufferSizeNum (u32 sizeNum)
	入力イベントのバッファのサイズ (initialize() 前に呼ぶこと。初期値は 1024 個)

操作
GX_FORCE_INLINE void	getInputDataDevice (void) override
	デバイスから入力を取得

void	update (void) override
	更新

GX_FORCE_INLINE void	saveInput (void) override
	入力状態を保存

GX_FORCE_INLINE void	loadInput (void) override
	入力状態を復元

Public Member Functions inherited from GxInputDevice
	GxInputDevice (void)
	コンストラクタ

	~GxInputDevice (void) override
	デストラクタ

constexpr s32	getRepeatStart (void) const
	リピート開始時間を取得

constexpr void	setRepeatStart (s32 time)
	リピート開始時間を設定

constexpr s32	getRepeatInterval (void) const
	リピート間隔を取得

constexpr void	setRepeatInterval (s32 intervalTime)
	リピート間隔を設定

constexpr u32	getNumber (void) const
	番号を取得

constexpr void	setNumber (u32 number)
	番号を設定

constexpr void	setKind (KIND kind)
	種類を設定

constexpr KIND	getKind (void) const
	種類を設定

virtual GX_FORCE_INLINE s32	getUserId (void) const
	ユーザーIDを取得

virtual void	setUserId (s32)
	ユーザーIDを設定

Public Member Functions inherited from GxClassBase
constexpr	GxClassBase (void)
	コンストラクタ

constexpr	GxClassBase (const GxClassBase &base)
	コピーコンストラクタ

	~GxClassBase (void) override
	デストラクタ

Public Member Functions inherited from GxClassBaseRoot
constexpr	GxClassBaseRoot (void)
	コンストラクタ

constexpr	GxClassBaseRoot (const GxClassBaseRoot &)
	コピーコンストラクタ

virtual	~GxClassBaseRoot (void)
	デストラクタ

constexpr GxClassBaseRoot &	operator= (const GxClassBaseRoot &)
	代入演算子

virtual GxRtti &	getRtti (void) const =0
	Rttiの取得

virtual GX_FORCE_INLINE const GxTypedObject *	getDefaultObject (void)
	デフォルトオブジェクトを取得

GX_FORCE_INLINE b32	isDefaultObject (void)
	デフォルトオブジェクト判定

定義
enum class	UPDATE { READY = 0 , FINALIZE_STRING_REQUEST , FINALIZE_STRING_DONE }
	_updateState の状態 More...

static constexpr u32	MAX_CANDLIST = 10
	最大候補数

static constexpr u32	MAX_CANDIDATE_LENGTH = GxMath::VALUE_256
	各候補の単語の最大文字数

static constexpr u32	MAX_COMPOSITION_LENGTH = GxMath::VALUE_256
	変換中のの単語の最大文字数

アクセサ
b32	isEnable (void) const override
	有効判定

GX_FORCE_INLINE b32	isOk (void) override
	決定ボタンの判定

GX_FORCE_INLINE b32	isCancel (void) override
	キャンセルボタンの判定

GxImeData *	map (void)
	入力された文字列を取得

void	unmap (void)
	入力された文字列を破棄

s32	decode (GX_STR dst, GX_STR dstWork, u32 bufSize, u32 &cursorStart, u32 &cursorEnd, GxCallback::GxHandlerBase *pFunction=nullptr)
	コマンドを解釈してバッファを編集する

GxImeRenderData *	mapRenderData (void)
	IME 描画データを取得開始

void	unmapRenderData (void)
	IME 描画データを取得終了

void	copyClipboard (GX_STR src)
	クリップボードにコピー

GX_STR	pasteClipboard (GX_STR src, u32 maxBytes)
	クリップボードからペースト

GX_FORCE_INLINE b32	getIsEnableImeSystem (void) const
	システム的に IME が利用可能かを取得

GX_FORCE_INLINE b32	getIsEnableIme (void) const
	IME の利用を許可しているかを取得。enterFocus() で決まる。

GX_FORCE_INLINE b32	getIsImeOpened (void) const
	IME がオープン ("あ"の状態) されているかを得る

b32	enterFocus (b32 useIme, void *pOwner)
	フォーカスに入るときに pOwner をセットして呼ぶ。テキスト入力記録開始する。

b32	isFocus (void *pOwner)
	自身にフォーカスがあるか調べる

Additional Inherited Members
Public Types inherited from GxInputDevice
enum class	KIND { NONE = 0 , UNKNOWN , PAD_NETWORK }
	デバイスの種類 More...

Static Public Member Functions inherited from GxClassBaseRoot
static GX_FORCE_INLINE GxRtti &	__getStaticRtti (void)
	Rttiの取得

Static Public Attributes inherited from GxInputDevice
static const s32	INVALID_HANDLE = -1
	無効ハンドル

static const s32	INVALID_USER_ID = -1
	無効ユーザーID

Detailed Description

キーボードクラス

Member Enumeration Documentation

◆ UPDATE

enum class GxImeText::UPDATE

strong

_updateState の状態

Enumerator
READY	リクエスト待ち
FINALIZE_STRING_REQUEST	リクエスト
FINALIZE_STRING_DONE	処理完了

Member Function Documentation

◆ clear()

GX_FORCE_INLINE void GxImeText::clear ( void )

inlineoverridevirtual

クリア

Implements GxInputDevice.

Here is the caller graph for this function:

◆ copyClipboard()

void GxImeText::copyClipboard ( GX_STR src )

クリップボードにコピー

Parameters

src	[in] コピー文字列

Here is the call graph for this function:

Here is the caller graph for this function:

◆ decode()

s32 GxImeText::decode	(	GX_STR	dst,
		GX_STR	dstWork,
		u32	bufferSize,
		u32 &	cursorStart,
		u32 &	cursorEnd,
		GxCallback::GxHandlerBase *	pFunction = nullptr )

コマンドを解釈してバッファを編集する

Parameters

dst	[out] 出力バッファ
dst	[out] 出力ワークバッファ
bufferSize	[in] バッファサイズ
cursorStart	[in] カーソル開始位置
cursorEnd	[in] カーソル終了位置
pFunction	[in] 関数

Returns: 関数の戻り値

Here is the call graph for this function:

◆ enterFocus()

b32 GxImeText::enterFocus	(	b32	useIme,
		void *	pOwner )

フォーカスに入るときに pOwner をセットして呼ぶ。テキスト入力記録開始する。

フォーカスに入る

Parameters

useIme	[in] IMEが利用可能ならtrue
pOwner	[in] 所持者

Returns: リクエスト処理中ならtrue

Here is the call graph for this function:

◆ getInputDataDevice()

GX_FORCE_INLINE void GxImeText::getInputDataDevice ( void )

inlineoverridevirtual

デバイスから入力を取得

Implements GxInputDevice.

◆ initialize()

b32 GxImeText::initialize ( void )

overridevirtual

初期化

Returns: 成功ならtrue

Implements GxInputDevice.

Here is the call graph for this function:

◆ isCancel()

GX_FORCE_INLINE b32 GxImeText::isCancel ( void )

inlineoverridevirtual

キャンセルボタンの判定

Implements GxInputDevice.

◆ isEnable()

b32 GxImeText::isEnable ( void ) const

overridevirtual

有効判定

Returns: 有効ならtrue

Implements GxInputDevice.

◆ isFocus()

b32 GxImeText::isFocus ( void * pOwner )

自身にフォーカスがあるか調べる

自身が所持者か判定

Parameters

pOwner [in] 所持者

Returns: 自身が所持者ならtrue

Here is the call graph for this function:

◆ isOk()

GX_FORCE_INLINE b32 GxImeText::isOk ( void )

inlineoverridevirtual

決定ボタンの判定

Implements GxInputDevice.

◆ loadInput()

GX_FORCE_INLINE void GxImeText::loadInput ( void )

inlineoverridevirtual

入力状態を復元

Implements GxInputDevice.

◆ map()

GxImeText::GxImeData * GxImeText::map ( void )

入力された文字列を取得

Returns: 入力イベント

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mapRenderData()

GxImeText::GxImeRenderData * GxImeText::mapRenderData ( void )

IME 描画データを取得開始

Returns: 描画情報

Here is the call graph for this function:

◆ pasteClipboard()

GX_CHAR * GxImeText::pasteClipboard	(	GX_STR	src,
		u32	maxBytes )

クリップボードからペースト

Parameters

dst	[in] コピー文字列
maxBytes	[in] 最大バイト数

Returns: コピー文字列

Here is the caller graph for this function:

◆ saveInput()

GX_FORCE_INLINE void GxImeText::saveInput ( void )

inlineoverridevirtual

入力状態を保存

Implements GxInputDevice.

◆ setBufferSizeNum()

void GxImeText::setBufferSizeNum ( u32 sizeNum )

入力イベントのバッファのサイズ (initialize() 前に呼ぶこと。初期値は 1024 個)

Parameters

sizeNum [in] バッファサイズの個数

◆ update()

void GxImeText::update ( void )

overridevirtual

更新

Implements GxInputDevice.

Here is the call graph for this function:

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

C:/Users/t-arai/Documents/workspace/orochi_package_windows/middleware/GxCore/src/GxInputImeText.h
C:/Users/t-arai/Documents/workspace/orochi_package_windows/middleware/GxCore/src/GxInputImeText.cpp

Classes

Public Member Functions

定義

アクセサ

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ UPDATE

Member Function Documentation

◆ clear()

◆ copyClipboard()

◆ decode()

◆ enterFocus()

◆ getInputDataDevice()

◆ initialize()

◆ isCancel()

◆ isEnable()

◆ isFocus()

◆ isOk()

◆ loadInput()

◆ map()

◆ mapRenderData()

◆ pasteClipboard()

◆ saveInput()

◆ setBufferSizeNum()

◆ update()