| Safe Haskell | None |
|---|
HGamer3D.Bindings.CEGUI.ClassCombobox
- getSingleClickEnabled :: HG3DClass -> IO Bool
- isDropDownListVisible :: HG3DClass -> IO Bool
- getEditbox :: HG3DClass -> IO HG3DClass
- getPushButton :: HG3DClass -> IO HG3DClass
- getDropList :: HG3DClass -> IO HG3DClass
- hasInputFocus :: HG3DClass -> IO Bool
- isReadOnly :: HG3DClass -> IO Bool
- isTextValid :: HG3DClass -> IO Bool
- getValidationString :: HG3DClass -> IO String
- getCaratIndex :: HG3DClass -> IO Int
- getSelectionStartIndex :: HG3DClass -> IO Int
- getSelectionEndIndex :: HG3DClass -> IO Int
- getSelectionLength :: HG3DClass -> IO Int
- getMaxTextLength :: HG3DClass -> IO Int
- getItemCount :: HG3DClass -> IO Int
- getSelectedItem :: HG3DClass -> IO HG3DClass
- getListboxItemFromIndex :: HG3DClass -> Int -> IO HG3DClass
- getItemIndex :: HG3DClass -> HG3DClass -> IO Int
- isSortEnabled :: HG3DClass -> IO Bool
- isItemSelected :: HG3DClass -> Int -> IO Bool
- findItemWithText :: HG3DClass -> String -> HG3DClass -> IO HG3DClass
- isListboxItemInList :: HG3DClass -> HG3DClass -> IO Bool
- isVertScrollbarAlwaysShown :: HG3DClass -> IO Bool
- isHorzScrollbarAlwaysShown :: HG3DClass -> IO Bool
- initialiseComponents :: HG3DClass -> IO ()
- showDropList :: HG3DClass -> IO ()
- hideDropList :: HG3DClass -> IO ()
- setSingleClickEnabled :: HG3DClass -> Bool -> IO ()
- setReadOnly :: HG3DClass -> Bool -> IO ()
- setValidationString :: HG3DClass -> String -> IO ()
- setCaratIndex :: HG3DClass -> Int -> IO ()
- setSelection :: HG3DClass -> Int -> Int -> IO ()
- setMaxTextLength :: HG3DClass -> Int -> IO ()
- activateEditbox :: HG3DClass -> IO ()
- resetList :: HG3DClass -> IO ()
- addItem :: HG3DClass -> HG3DClass -> IO ()
- insertItem :: HG3DClass -> HG3DClass -> HG3DClass -> IO ()
- removeItem :: HG3DClass -> HG3DClass -> IO ()
- clearAllSelections :: HG3DClass -> IO ()
- setSortingEnabled :: HG3DClass -> Bool -> IO ()
- setShowVertScrollbar :: HG3DClass -> Bool -> IO ()
- setShowHorzScrollbar :: HG3DClass -> Bool -> IO ()
- setItemSelectState :: HG3DClass -> HG3DClass -> Bool -> IO ()
- setItemSelectState2 :: HG3DClass -> Int -> Bool -> IO ()
- handleUpdatedListItemData :: HG3DClass -> IO ()
- new :: String -> String -> IO HG3DClass
- delete :: HG3DClass -> IO ()
- getSingleClickEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- isDropDownListVisible'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- getEditbox'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()
- getPushButton'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()
- getDropList'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()
- hasInputFocus'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- isReadOnly'_ :: 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 ()
- getMaxTextLength'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- getItemCount'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- getSelectedItem'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()
- getListboxItemFromIndex'_ :: HG3DClassPtr -> CInt -> HG3DClassPtr -> IO ()
- getItemIndex'_ :: HG3DClassPtr -> HG3DClassPtr -> Ptr CInt -> IO ()
- isSortEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- isItemSelected'_ :: HG3DClassPtr -> CInt -> Ptr CInt -> IO ()
- findItemWithText'_ :: HG3DClassPtr -> Ptr CChar -> HG3DClassPtr -> HG3DClassPtr -> IO ()
- isListboxItemInList'_ :: HG3DClassPtr -> HG3DClassPtr -> Ptr CInt -> IO ()
- isVertScrollbarAlwaysShown'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- isHorzScrollbarAlwaysShown'_ :: HG3DClassPtr -> Ptr CInt -> IO ()
- initialiseComponents'_ :: HG3DClassPtr -> IO ()
- showDropList'_ :: HG3DClassPtr -> IO ()
- hideDropList'_ :: HG3DClassPtr -> IO ()
- setSingleClickEnabled'_ :: HG3DClassPtr -> CInt -> IO ()
- setReadOnly'_ :: HG3DClassPtr -> CInt -> IO ()
- setValidationString'_ :: HG3DClassPtr -> Ptr CChar -> IO ()
- setCaratIndex'_ :: HG3DClassPtr -> CInt -> IO ()
- setSelection'_ :: HG3DClassPtr -> CInt -> CInt -> IO ()
- setMaxTextLength'_ :: HG3DClassPtr -> CInt -> IO ()
- activateEditbox'_ :: HG3DClassPtr -> IO ()
- resetList'_ :: HG3DClassPtr -> IO ()
- addItem'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()
- insertItem'_ :: HG3DClassPtr -> HG3DClassPtr -> HG3DClassPtr -> IO ()
- removeItem'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()
- clearAllSelections'_ :: HG3DClassPtr -> IO ()
- setSortingEnabled'_ :: HG3DClassPtr -> CInt -> IO ()
- setShowVertScrollbar'_ :: HG3DClassPtr -> CInt -> IO ()
- setShowHorzScrollbar'_ :: HG3DClassPtr -> CInt -> IO ()
- setItemSelectState'_ :: HG3DClassPtr -> HG3DClassPtr -> CInt -> IO ()
- setItemSelectState2'_ :: HG3DClassPtr -> CInt -> CInt -> IO ()
- handleUpdatedListItemData'_ :: HG3DClassPtr -> IO ()
- new'_ :: Ptr CChar -> Ptr CChar -> HG3DClassPtr -> IO ()
- delete'_ :: HG3DClassPtr -> IO ()
Documentation
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Bool |
returns the mode of operation for the combo box.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Bool | return value - true if the drop down list is visible, false otherwise. |
returns true if the drop down list is visible.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO HG3DClass | return value - Pointer to an |
Return a pointer to the EditboxCombobox
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 PushButtonCombobox
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO HG3DClass | return value - Pointer to an |
Return a pointer to the ComboDropListCombobox
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
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
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Bool | return value - true if the current |
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.
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.
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.
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.
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).
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).
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Int | return value - the number of items currently attached to this list box. |
Return number of items attached to the list box.
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 currently selected item.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Int | index - Zero based index of the item to be returned. |
| -> IO HG3DClass | return value - Pointer to the |
Return the item at index position index
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> HG3DClass | item - Pointer to a ListboxItem whos zero based index is to be returned. |
| -> IO Int | return value - Zero based index indicating the position of |
Return the index of ListboxItemitem
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Bool | return value - true if the list is sorted, false if the list is not sorted |
return whether list sorting is enabled
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Int | index - Zero based index of the item to be examined. |
| -> IO Bool | return value - true if the item at |
return whether the string at index position index
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> String | text - String object containing the text to be searched for. |
| -> HG3DClass | start_item - ListboxItem where the search is to begin, the search will not include item. If item is NULL, the search will begin from the first item in the list. |
| -> IO HG3DClass | return value - Pointer to the first |
Search the list for an item with the specified text.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> HG3DClass | item |
| -> IO Bool | return value - true if |
Return whether the specified ListboxItem
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.
isHorzScrollbarAlwaysShownSource
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO Bool |
Return whether the horizontal scroll bar is always shown.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO () | return value - Nothing |
Show the drop-down list.
Initialise the Window - Details: This must be called for every window created. Normally this is handled automatically by the WindowFactory for each Window
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO () | return value - Nothing |
Hide the drop-down list.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO () | return value - Nothing. |
Set the mode of operation for the combo box.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Bool | setting - |
| -> IO () | return value - Nothing. |
Specify whether the Editbox
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. |
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.
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.
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
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 start will be set to the end of the text. |
| -> 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).
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. |
Activate the edit box component of the Combobox
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO () | return value - Nothing. |
Remove all items from the list. - Details: Note that this will cause AutoDelete items to be deleted.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO () |
Add the given ListboxItem
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> HG3DClass | item - Pointer to the ListboxItem to be added to the list. Note that it is the passed object that is added to the list, a copy is not made. If this parameter is NULL, nothing happens. |
| -> IO () | return value - Nothing. |
Insert an item into the list box after a specified item already in the list. - Details: Note that if the list is sorted, the item may not end up in the requested position.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> HG3DClass | item |
| -> HG3DClass | position |
| -> IO () |
Removes the given item from the list box.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> HG3DClass | item - Pointer to the ListboxItem that is to be removed. If item is not attached to this list box then nothing will happen. |
| -> IO () | return value - Nothing. |
Clear the selected state for all items.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO () | return value - Nothing. |
Set whether the list should be sorted.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Bool | setting - true if the list should be sorted, false if the list should not be sorted. |
| -> IO () | return value - Nothing. |
Set whether the vertical scroll bar should always be shown.
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. |
Set whether the horizontal scroll bar should always be shown.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Bool | setting - true if the horizontal scroll bar should be shown even when it is not required. false if the horizontal scroll bar should only be shown when it is required. |
| -> IO () | return value - Nothing. |
Set the select state of an attached ListboxItem - Details: This is the recommended way of selecting and deselecting items attached to a list box as it respects the multi-select mode setting. It is possible to modify the setting on ListboxItems directly, but that approach does not respect the settings of the list box.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> HG3DClass | item |
| -> Bool | state |
| -> IO () |
Set the select state of an attached ListboxItem - Details: This is the recommended way of selecting and deselecting items attached to a list box as it respects the multi-select mode setting. It is possible to modify the setting on ListboxItems directly, but that approach does not respect the settings of the list box.
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> Int | item_index |
| -> Bool | state |
| -> IO () |
Causes the list box to update it's internal state after changes have been made to one or more attached ListboxItem - Details: Client code must call this whenever it has made any changes to ListboxItem objects already attached to the list box. If you are just adding items, or removed items to update them prior to re-adding them, there is no need to call this method.
handleUpdatedListItemDataSource
Arguments
| :: HG3DClass | classpointer - pointer of Class instance from which this methods is called. |
| -> IO () |
Constructor for Combobox
Arguments
| :: HG3DClass | classpointer - pointer of Class instance which is going to be deleted. |
| -> IO () |
Destructor for Combobox
getSingleClickEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
isDropDownListVisible'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getEditbox'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source
getPushButton'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source
getDropList'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source
hasInputFocus'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
isReadOnly'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
isTextValid'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getValidationString'_ :: HG3DClassPtr -> Ptr CChar -> IO ()Source
getCaratIndex'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getSelectionStartIndex'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getSelectionEndIndex'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getSelectionLength'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getMaxTextLength'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getItemCount'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
getSelectedItem'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source
getListboxItemFromIndex'_ :: HG3DClassPtr -> CInt -> HG3DClassPtr -> IO ()Source
getItemIndex'_ :: HG3DClassPtr -> HG3DClassPtr -> Ptr CInt -> IO ()Source
isSortEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
isItemSelected'_ :: HG3DClassPtr -> CInt -> Ptr CInt -> IO ()Source
findItemWithText'_ :: HG3DClassPtr -> Ptr CChar -> HG3DClassPtr -> HG3DClassPtr -> IO ()Source
isListboxItemInList'_ :: HG3DClassPtr -> HG3DClassPtr -> Ptr CInt -> IO ()Source
isVertScrollbarAlwaysShown'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
isHorzScrollbarAlwaysShown'_ :: HG3DClassPtr -> Ptr CInt -> IO ()Source
initialiseComponents'_ :: HG3DClassPtr -> IO ()Source
showDropList'_ :: HG3DClassPtr -> IO ()Source
hideDropList'_ :: HG3DClassPtr -> IO ()Source
setSingleClickEnabled'_ :: HG3DClassPtr -> CInt -> IO ()Source
setReadOnly'_ :: HG3DClassPtr -> CInt -> IO ()Source
setValidationString'_ :: HG3DClassPtr -> Ptr CChar -> IO ()Source
setCaratIndex'_ :: HG3DClassPtr -> CInt -> IO ()Source
setSelection'_ :: HG3DClassPtr -> CInt -> CInt -> IO ()Source
setMaxTextLength'_ :: HG3DClassPtr -> CInt -> IO ()Source
activateEditbox'_ :: HG3DClassPtr -> IO ()Source
resetList'_ :: HG3DClassPtr -> IO ()Source
addItem'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source
insertItem'_ :: HG3DClassPtr -> HG3DClassPtr -> HG3DClassPtr -> IO ()Source
removeItem'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()Source
clearAllSelections'_ :: HG3DClassPtr -> IO ()Source
setSortingEnabled'_ :: HG3DClassPtr -> CInt -> IO ()Source
setShowVertScrollbar'_ :: HG3DClassPtr -> CInt -> IO ()Source
setShowHorzScrollbar'_ :: HG3DClassPtr -> CInt -> IO ()Source
setItemSelectState'_ :: HG3DClassPtr -> HG3DClassPtr -> CInt -> IO ()Source
setItemSelectState2'_ :: HG3DClassPtr -> CInt -> CInt -> IO ()Source
delete'_ :: HG3DClassPtr -> IO ()Source