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

Safe HaskellNone

HGamer3D.Bindings.CEGUI.ClassListHeader

Synopsis

Documentation

getColumnCountSource

Arguments

:: HG3DClass

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

-> IO Int

return value - uint value equal to the number of columns / segments currently in the header.

Return the number of columns or segments attached to the header.

getSegmentFromColumnSource

Arguments

:: HG3DClass

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

-> Int

column - zero based column index of the ListHeaderSegment to be returned.

-> IO HG3DClass 

Return the ListHeaderSegment

getSegmentFromIDSource

Arguments

:: HG3DClass

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

-> Int

id - id code of the ListHeaderSegment to be returned.

-> IO HG3DClass 

Return the ListHeaderSegment

getSortSegmentSource

Arguments

:: HG3DClass

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

-> IO HG3DClass 

Return the ListHeaderSegment

getColumnFromSegmentSource

Arguments

:: HG3DClass

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

-> HG3DClass

segment - ListHeaderSegment whos zero based index is to be returned.

-> IO Int

return value - Zero based column index of the

Return the zero based column index of the specified segment.

getColumnFromIDSource

Arguments

:: HG3DClass

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

-> Int

id - ID code of the segment whos column index is to be returned.

-> IO Int

return value - Zero based column index of the first

Return the zero based column index of the segment with the specified ID.

getSortColumnSource

Arguments

:: HG3DClass

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

-> IO Int

return value - Zero based column index that is the current sort column.

Return the zero based index of the current sort column. There must be at least one segment/column to successfully call this method.

getColumnWithTextSource

Arguments

:: HG3DClass

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

-> String

text - String object containing the text to be searched for.

-> IO Int

return value - Zero based column index of the segment with the specified text.

Return the zero based column index of the segment with the specified text.

getPixelOffsetToSegmentSource

Arguments

:: HG3DClass

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

-> HG3DClass

segment - ListHeaderSegment object that the offset to is to be returned.

-> IO Float

return value - The number of pixels up-to the begining of the

Return the pixel offset to the given ListHeaderSegment

getPixelOffsetToColumnSource

Arguments

:: HG3DClass

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

-> Int

column - Zero based column index of the ListHeaderSegment whos pixel offset it to be returned.

-> IO Float

return value - The number of pixels up-to the begining of the

Return the pixel offset to the ListHeaderSegment

getTotalSegmentsPixelExtentSource

Arguments

:: HG3DClass

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

-> IO Float

return value - Sum of the pixel widths of all attached

Return the total pixel width of all attached segments.

getSortDirectionSource

Arguments

:: HG3DClass

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

-> IO EnumSortDirection

return value - One of the

Return the currently set sort direction.

isSortingEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the user may interactively modify the sort column and direction. false if the user may not modify the sort column and direction (these can still be set programmatically).

Return whether user manipulation of the sort column & direction are enabled.

isColumnSizingEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the user may interactively modify the width of column segments, false if they may not.

Return whether the user may size column segments.

isColumnDraggingEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the user may interactively modify the order of the column segments, false if they may not.

Return whether the user may modify the order of the segments.

getSegmentOffsetSource

Arguments

:: HG3DClass

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

-> IO Float

return value - float value specifying the current segment offset value in whatever metrics system is active for the

Return the current segment offset value. This value is used to implement scrolling of the header segments within the ListHeader

setSortingEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set the current sort direction.

Set whether user manipulation of the sort column and direction is enabled.

setSortDirectionSource

Arguments

:: HG3DClass

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

-> EnumSortDirection

direction - One of the ListHeaderSegment::SortDirection enumerated values indicating the sort direction to be used.

-> IO ()

return value - Nothing.

Set the column segment to be used as the sort column.

setSortSegmentSource

Arguments

:: HG3DClass

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

-> HG3DClass

segment - ListHeaderSegment object indicating the column to be sorted.

-> IO ()

return value - Nothing.

Set the column to be used as the sort column.

setSortColumnSource

Arguments

:: HG3DClass

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

-> Int

column - Zero based column index indicating the column to be sorted.

-> IO ()

return value - Nothing.

Set the column to to be used for sorting via its ID code.

setSortColumnFromIDSource

Arguments

:: HG3DClass

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

-> Int

id - ID code of the column segment that is to be used as the sort column.

-> IO ()

return value - Nothing.

Set whether columns may be sized by the user.

setColumnSizingEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set whether columns may be reordered by the user via drag and drop.

setColumnDraggingEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Removes a column segment from the ListHeader

removeColumnSource

Arguments

:: HG3DClass

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

-> Int

column - Zero based column index indicating the segment to be removed.

-> IO ()

return value - Nothing.

Remove the specified segment from the ListHeader

removeSegmentSource

Arguments

:: HG3DClass

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

-> HG3DClass

segment - ListHeaderSegment object that is to be removed from the ListHeader.

-> IO ()

return value - Nothing.

Moves a column segment into a new position.

moveColumnSource

Arguments

:: HG3DClass

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

-> Int

column - Zero based column index indicating the column segment to be moved.

-> Int

position - Zero based column index indicating the new position for the segment. If this is greater than the current number of segments, the segment is moved to the end of the header.

-> IO ()

return value - Nothing.

Move a column segment to a new position.

moveColumn2Source

Arguments

:: HG3DClass

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

-> Int

column - Zero based column index indicating the column segment to be moved.

-> HG3DClass

position - ListHeaderSegment object indicating the new position for the segment. The segment at column will be moved behind segment position (that is, segment column will appear to the right of segment position).

-> IO ()

return value - Nothing.

Moves a segment into a new position.

moveSegmentSource

Arguments

:: HG3DClass

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

-> HG3DClass

segment - ListHeaderSegment object that is to be moved.

-> Int

position - Zero based column index indicating the new position for the segment. If this is greater than the current number of segments, the segment is moved to the end of the header.

-> IO ()

return value - Nothing.

Move a segment to a new position.

moveSegment2Source

Arguments

:: HG3DClass

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

-> HG3DClass

segment - ListHeaderSegment object that is to be moved.

-> HG3DClass

position - ListHeaderSegment object indicating the new position for the segment. The segment segment will be moved behind segment position (that is, segment segment will appear to the right of segment position).

-> IO ()

return value - Nothing.

Set the current base segment offset. (This implements scrolling of the header segments within the header area).

setSegmentOffsetSource

Arguments

:: HG3DClass

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

-> Float

offset - New base offset for the first segment. The segments will of offset to the left by the amount specified. offset should be specified using the active metrics system for the ListHeader.

-> IO ()

return value - Nothing.

Constructor for the list header base class.

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 list header base class.