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

Safe HaskellNone

HGamer3D.Bindings.CEGUI.ClassWindowManager

Synopsis

Documentation

newSource

Arguments

:: IO HG3DClass 

Constructs a new WindowManager - Details: NB: Client code should not create WindowManagerWindowManagerSystem

deleteSource

Arguments

:: HG3DClass

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

-> IO () 

Creates a new Window

Destructor for WindowManager - Details: This will properly destry all remaining Window

createWindowSource

Arguments

:: HG3DClass

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

-> String

type - String that describes the type of Window to be created. A valid WindowFactory for the specified type must be registered.

-> String 
-> IO HG3DClass

return value - Pointer to the newly created

destroyWindowSource

Arguments

:: HG3DClass

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

-> HG3DClass

window - Pointer to the Window object to be destroyed. If the window is null, or is not recognised, nothing happens.

-> IO ()

return value - Nothing

Destroy the specified Window

Destroy the specified Window

destroyWindow2Source

Arguments

:: HG3DClass

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

-> String

window - String containing the name of the Window object to be destroyed. If window is not recognised, nothing happens.

-> IO ()

return value - Nothing.

Return a pointer to the specified Window

getWindowSource

Arguments

:: HG3DClass

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

-> String

name - String holding the name of the Window object to be returned.

-> IO HG3DClass

return value - Pointer to the

isWindowPresentSource

Arguments

:: HG3DClass

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

-> String

name - String holding the name of the Window object to look for.

-> IO Bool

return value - true if a

Examines the list of Window

destroyAllWindowsSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing.

Return whether the window dead pool is empty.

Destroys all Window

isDeadPoolEmptySource

Arguments

:: HG3DClass

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

-> IO Bool 

cleanDeadPoolSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing.

Save a full XML window layout, starting at the given Window

Permanently destroys any windows placed in the dead pool. - Details: It is probably not a good idea to call this from a Window

saveWindowLayoutSource

Arguments

:: HG3DClass

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

-> String

window - String holding the name of the Window object to become the root of the layout.

-> String

filename - The name of the file to which the XML will be written. Note that this does not use any part of the ResourceProvider system, but rather will write directly to disk. If this is not desirable, you should prefer the OutStream based writeWindowLayoutToStream functions.

-> Bool

writeParent - If the starting window has a parent window, specifies whether to write the parent name into the Parent attribute of the GUILayout XML element.

-> IO () 

Save a full XML window layout, starting at the given Window

saveWindowLayout2Source

Arguments

:: HG3DClass

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

-> HG3DClass

window - Window object to become the root of the layout.

-> String

filename - The name of the file to which the XML will be written. Note that this does not use any part of the ResourceProvider system, but rather will write directly to disk. If this is not desirable, you should prefer the OutStream based writeWindowLayoutToStream functions.

-> Bool

writeParent - If the starting window has a parent window, specifies whether to write the parent name into the Parent attribute of the GUILayout XML element.

-> IO () 

Rename a window.

renameWindowSource

Arguments

:: HG3DClass

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

-> String

window - String holding the current name of the window to be renamed.

-> String

new_name - String holding the new name for the window

-> IO () 

Rename a window.

renameWindow2Source

Arguments

:: HG3DClass

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

-> HG3DClass

window - Pointer to the window to be renamed.

-> String

new_name - String holding the new name for the window

-> IO () 

Put WindowManager - Details: While WindowManager is in the locked state all attempts to create a Window of any type will fail with an InvalidRequestException being thrown. Calls to lock/unlock are recursive; if multiple calls to lock are made, WindowManager is only unlocked after a matching number of calls to unlock.

lockSource

Arguments

:: HG3DClass

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

-> IO () 

Put WindowManager - Details: While WindowManager is in the locked state all attempts to create a Window of any type will fail with an InvalidRequestException being thrown. Calls to lock/unlock are recursive; if multiple calls to lock are made, WindowManager is only unlocked after a matching number of calls to unlock.

unlockSource

Arguments

:: HG3DClass

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

-> IO () 

Returns whether WindowManager - Details: While WindowManager is in the locked state all attempts to create a Window of any type will fail with an InvalidRequestException being thrown. Calls to lock/unlock are recursive; if multiple calls to lock are made, WindowManager is only unlocked after a matching number of calls to unlock.

getDefaultResourceGroupSource

Arguments

:: IO String

return value - String describing the default resource group identifier that will be used when loading layouts.

isLockedSource

Arguments

:: HG3DClass

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

-> IO Bool 

Returns the default resource group currently set for layouts.

setDefaultResourceGroupSource

Arguments

:: String

resourceGroup - String describing the default resource group identifier to be used.

-> IO ()

return value - Nothing.

Sets the default resource group to be used when loading layouts.