HGamer3D-CEGUI-Binding-0.1.9: Windows Game Engine for the Haskell Programmer - CEGUI Bindings

Safe HaskellNone

HGamer3D.Bindings.CEGUI.ClassMultiLineEditbox

Synopsis

Documentation

hasInputFocusSource

Arguments

:: HG3DClass

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

-> IO Bool 

return true if the edit box has input focus.

isReadOnlySource

Arguments

:: HG3DClass

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

-> IO Bool 

return true if the edit box is read-only.

getCaratIndexSource

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.

getSelectionStartIndexSource

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.

getSelectionEndIndexSource

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.

getSelectionLengthSource

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).

getMaxTextLengthSource

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 edit box.

return the maximum text length set for this edit box.

isWordWrappedSource

Arguments

:: HG3DClass

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

-> IO Bool 

Return whether the text in the edit box will be word-wrapped.

getVertScrollbarSource

Arguments

:: HG3DClass

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

-> IO HG3DClass

return value - Pointer to a

Return a pointer to the vertical scrollbar component widget for this MultiLineEditbox

isVertScrollbarAlwaysShownSource

Arguments

:: HG3DClass

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

-> IO Bool 

Return whether the vertical scroll bar is always shown.

getHorzScrollbarSource

Arguments

:: HG3DClass

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

-> IO HG3DClass

return value - Pointer to a

Return a pointer to the horizontal scrollbar component widget for this MultiLineEditbox

getLineNumberFromIndexSource

Arguments

:: HG3DClass

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

-> Int

index

-> IO Int 

Return the line number a given index falls on with the current formatting. Will return last line if index is out of range.

initialiseComponentsSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

Specify whether the edit box is read-only.

Initialise the Window - Details: This must be called for every window created. Normally this is handled automatically by the WindowFactory for each Window

setReadOnlySource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set the current position of the carat.

setCaratIndexSource

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 edit box, the carat is positioned at the end of the text.

-> IO ()

return value - Nothing.

Define the current selection for the edit box.

setSelectionSource

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 edit box, 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 edit box, the selection start will be set to the end of the text.

-> IO ()

return value - Nothing.

set the maximum text length for this edit box.

setMaxTextLengthSource

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.

Scroll the view so that the current carat position is visible.

ensureCaratIsVisibleSource

Arguments

:: HG3DClass

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

-> IO () 

Set whether the text will be word wrapped or not.

setWordWrappingSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set whether the vertical scroll bar should always be shown.

setShowVertScrollbarSource

Arguments

:: HG3DClass

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

-> Bool

setting - true if the vertical scroll bar should be shown even when it is not required. false if the vertical scroll bar should only be shown when it is required.

-> IO ()

return value - Nothing.

Constructor for the MultiLineEditbox

newSource

Arguments

:: String

type

-> String

name

-> IO HG3DClass 

deleteSource

Arguments

:: HG3DClass

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

-> IO () 

Destructor for the MultiLineEditbox