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

Safe HaskellNone

HGamer3D.Bindings.CEGUI.ClassFrameWindow

Synopsis

Documentation

initialiseComponentsSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

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

isSizingEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the window can be sized, false if the window can not be sized

Return whether this window is sizable. Note that this requires that the window have an enabled frame and that sizing itself is enabled.

isFrameEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the frame for this window is enabled, false if the frame for this window is disabled.

Return whether the frame for this window is enabled.

isTitleBarEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the window has a title bar and it is enabled, false if the window has no title bar or if the title bar is disabled.

Return whether the title bar for this window is enabled.

isCloseButtonEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the window has a close button and it is enabled, false if the window either has no close button or if the close button is disabled.

Return whether this close button for this window is enabled.

isRollupEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if roll up is enabled, false if roll up is disabled.

Return whether roll up (a.k.a shading) is enabled for this window.

isRolledupSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the window is rolled up, false if the window is not rolled up.

Return whether the window is currently rolled up (a.k.a shaded).

getSizingBorderThicknessSource

Arguments

:: HG3DClass

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

-> IO Float

return value - float value describing the thickness of the sizing border in screen pixels.

Return the thickness of the sizing border.

setSizingEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting - set to true to enable sizing (also requires frame to be enabled), or false to disable sizing.

-> IO ()

return value - nothing

Enables or disables the frame for this window.

Enables or disables sizing for this window.

setFrameEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting - set to true to enable the frame for this window, or false to disable the frame for this window.

-> IO ()

return value - Nothing.

Enables or disables the title bar for the frame window.

setTitleBarEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting - set to true to enable the title bar (if one is attached), or false to disable the title bar.

-> IO ()

return value - Nothing.

Enables or disables the close button for the frame window.

setCloseButtonEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting - Set to true to enable the close button (if one is attached), or false to disable the close button.

-> IO ()

return value - Nothing.

Enables or disables roll-up (shading) for this window.

setRollupEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting - Set to true to enable roll-up for the frame window, or false to disable roll-up.

-> IO ()

return value - Nothing.

Toggles the state of the window between rolled-up (shaded) and normal sizes. This requires roll-up to be enabled.

toggleRollupSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

Set the size of the sizing border for this window.

setSizingBorderThicknessSource

Arguments

:: HG3DClass

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

-> Float

pixels - float value specifying the thickness for the sizing border in screen pixels.

-> IO ()

return value - Nothing.

Return whether this FrameWindow

isDragMovingEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the

setDragMovingEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting - true if the Window should move when the user drags the title bar, false if the window should not move.

-> IO ()

return value - Nothing.

Set the image to be used for the north-south sizing mouse cursor.

Set whether this FrameWindow

setNSSizingCursorImage2Source

Arguments

:: HG3DClass

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

-> String

imageset - String holding the name of the Imageset containing the Image to be used.

-> String

image - String holding the name of the Image to be used.

-> IO ()

return value - Nothing.

Set the image to be used for the east-west sizing mouse cursor.

setEWSizingCursorImage2Source

Arguments

:: HG3DClass

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

-> String

imageset - String holding the name of the Imageset containing the Image to be used.

-> String

image - String holding the name of the Image to be used.

-> IO ()

return value - Nothing.

Set the image to be used for the northwest-southeast sizing mouse cursor.

setNWSESizingCursorImage2Source

Arguments

:: HG3DClass

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

-> String

imageset - String holding the name of the Imageset containing the Image to be used.

-> String

image - String holding the name of the Image to be used.

-> IO ()

return value - Nothing.

Set the image to be used for the northeast-southwest sizing mouse cursor.

setNESWSizingCursorImage2Source

Arguments

:: HG3DClass

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

-> String

imageset - String holding the name of the Imageset containing the Image to be used.

-> String

image - String holding the name of the Image to be used.

-> IO ()

return value - Nothing.

Return a pointer to the close button component widget for this FrameWindow

getCloseButtonSource

Arguments

:: HG3DClass

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

-> IO HG3DClass

return value - Pointer to a

newSource

Arguments

:: String

type

-> String

name

-> IO HG3DClass 

Constructor for FrameWindow

deleteSource

Arguments

:: HG3DClass

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

-> IO () 

Destructor for FramwWindow objects.