HGamer3D.Bindings.CEGUI.ClassEditbox

Documentation

hasInputFocus

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

return true if the Editbox

isReadOnly

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

return value - true if the

return true if the Editbox

isTextMasked

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

return value - true if the

return true if the text for the Editbox

isTextValid

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

return the currently set validation string - Details: Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation.

return true if the Editbox - Details: It is possible to programmatically set invalid text for the Editbox Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation.

getValidationString

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO String

return value - String object containing the current validation regex data

getCaratIndex

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

return value - Index of the insert carat relative to the start of the text.

return the current position of the carat.

getSelectionStartIndex

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

return value - Index of the selection start point relative to the start of the text. If no selection is defined this function returns the position of the carat.

return the current selection start point.

getSelectionEndIndex

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

return value - Index of the selection end point relative to the start of the text. If no selection is defined this function returns the position of the carat.

return the current selection end point.

getSelectionLength

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

return value - Number of code points (or characters) contained within the currently defined selection.

return the length of the current selection (in code points / characters).

getMaskCodePoint

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

return value - utf32 code point value representing the Unicode code point that will be rendered instead of the

return the utf32 code point used when rendering masked text.

getMaxTextLength

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

return value - The maximum number of code points (characters) that can be entered into this

return the maximum text length set for this Editbox - Details: Depending on the validation string set, the actual length of text that can be entered may be less than the value returned here (it will never be more).

setReadOnly

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

setting - true if the Editbox is read only and can't be edited by the user, false if the Editbox is not read only and may be edited by the user.

-> IO ()

return value - Nothing.

Specify whether the text for the Editbox

Specify whether the Editbox

setTextMasked

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

setting -

-> IO ()

return value - Nothing.

Set the text validation string. - Details: Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation.

setValidationString

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> String

validation_string - String object containing the validation regex data to be used.

-> IO ()

return value - Nothing.

Set the current position of the carat.

setCaratIndex

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

carat_pos - New index for the insert carat relative to the start of the text. If the value specified is greater than the number of characters in the Editbox, the carat is positioned at the end of the text.

-> IO ()

return value - Nothing.

Define the current selection for the Editbox

setSelection

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

start_pos - Index of the starting point for the selection. If this value is greater than the number of characters in the Editbox, the selection start will be set to the end of the text.

-> Int

end_pos - Index of the ending point for the selection. If this value is greater than the number of characters in the Editbox, the selection end will be set to the end of the text.

-> IO ()

return value - Nothing.

set the utf32 code point used when rendering masked text.

setMaskCodePoint

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

code_point - utf32 code point value representing the Unicode code point that should be rendered instead of the Editbox text when rendering in masked mode.

-> IO ()

return value - Nothing.

set the maximum text length for this Editbox - Details: Depending on the validation string set, the actual length of text that can be entered may be less than the value set here (it will never be more).

setMaxTextLength

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

max_len - The maximum number of code points (characters) that can be entered into this Editbox.

-> IO ()

return value - Nothing.

Constructor for Editbox

new

Arguments

:: String

type

-> String

name

-> IO HG3DClass

delete

Arguments

:: HG3DClass

classpointer - pointer of Class instance which is going to be deleted.

-> IO ()

Destructor for Editbox

hasInputFocus'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

isReadOnly'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

isTextMasked'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

isTextValid'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getValidationString'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

getCaratIndex'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getSelectionStartIndex'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getSelectionEndIndex'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getSelectionLength'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getMaskCodePoint'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getMaxTextLength'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

setReadOnly'_ :: HG3DClassPtr -> CInt -> IO ()

setTextMasked'_ :: HG3DClassPtr -> CInt -> IO ()

setValidationString'_ :: HG3DClassPtr -> Ptr CChar -> IO ()

setCaratIndex'_ :: HG3DClassPtr -> CInt -> IO ()

setSelection'_ :: HG3DClassPtr -> CInt -> CInt -> IO ()

setMaskCodePoint'_ :: HG3DClassPtr -> CInt -> IO ()

setMaxTextLength'_ :: HG3DClassPtr -> CInt -> IO ()

new'_ :: Ptr CChar -> Ptr CChar -> HG3DClassPtr -> IO ()

delete'_ :: HG3DClassPtr -> IO ()