IMEManagerBase

Scaleform::GFx

Scaleform::GFx::State
    Scaleform::GFx::IMEManagerBase

Declaration

class IMEManagerBase : public State;

Description

IME manager interface class. IMEManagerBase class may be used as a base class for various IME implementations. It also provides utility functions to control composition, candidate list and so on.

Enumerations

Enumeration	Description
TextHighlightStyle	List of styles used for text highlighting.

Methods

Method	Description
GetCompositionString
CheckCandListExists	Checks whether the candidate list file exists in the directory of the current SWF or not.
ClearActiveMovie	Removes the movie from IME.
ClearCandidateListPath	Clears the candidate list movie path from the IME.
Init
ClearComposition	Clears the composition string.
DoFinalize	Finalizes the composition string and releases the text field.
EnableIME	Enables/disables IME.
FinalizeComposition	Finalizes the composition string by inserting the string into the actual text and thus the composition string becomes part of the actual text.
GetActiveMovie	Returns the current focused movie view of the IME manager.
GetASIMEManager	Returns the ASIMEManager.
GetCandidateListErrorMsg	Obtains the error messages generated if the candidate list failed to load.
GetCandidateListStyle	Obtains the style of the candidate list.
GetConversionMode	Retrieves the last set conversion mode.
GetEnabled	Retrieves IME state.
GetInputLanguage	Retrieves current input language.
GetLoader	Returns the loader for loading the IME.
GetMetrics	Returns view rectangle of currently focused text field and cursor rectangle, both in stage (root) coordinate space.
GetWindowsVersion	Returns the version of Windows.
HandleFocus
HandleIMEEvent	Handles IME events, calling callbacks and switching events.
HighlightText	Highlights the text in the composition string.
IMECommand	Handles "_global.imecommand(cmd, param)" . _global.imecommands are used to report to the containing movie view information about user events.
IMEManagerBase	Initializes IMEManagerBase.
Invoke
SetConversionMode	Sets the conversion mode.
IsCandidateListLoaded	Checks if the candidate list is loaded.
IsMovieActive	Determines whether the specified movie view has focus or not.
IsTextFieldFocused	Determines if the text field is currently focused.
OnCandidateListLoaded	Callback method invoked when loading of candidate list is completed.
OnCandidateListStyleChanged	Callback method which is invoked when the style of candidate list has been changed by ActionScript.
OnCandidateListStyleRequest	Callback method which is invoked when ActionScript requests style properties of candidate list.
OnEnableIME	Handles enabling/disabling of IME and is invoked from EnableIME method.
OnFinalize	Callback method invoked when required to finalize the composition string.
OnShutdown	Callback method invoked when required to cleanup and shutdown the IME.
ProcessIMEMessage
ReleaseComposition	Releases the the composition string, and no further composition string related functions may be used.
Reset	Resets the currently focused movie and the text field on the IME.
SetActiveMovie	Sets the currently focused movie view to IME manager.
SetCandidateListStyle	Sets the style of candidate list.
SetCompositionPosition	Relocates the composition string to the current caret position.
SetCompositionString	Sets the composition string which is composed with the IME.
SetCompositionText	Changes the text in the composition string.
SetCursorInComposition	Sets cursor inside the composition string.
SetEnabled	Enables/Disables IME by turning it on/off.
SetIMEMoviePath	Sets candidate list movie path.
SendLangBarMessage
SetLoader	Sets the loader for loading the movie file.
SetWideCursor	Turns on/off the wide cursor.
StartComposition	Creates a composition string if it is not created yet.

File

GFx_IMEManager.h