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

Safe HaskellNone

HGamer3D.Bindings.CEGUI.ClassPropertySet

Synopsis

Documentation

newSource

Arguments

:: IO HG3DClass 

Constructs a new PropertySet

deleteSource

Arguments

:: HG3DClass

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

-> IO () 

Removes a Property from the PropertySet

Destructor for PropertySet

removePropertySource

Arguments

:: HG3DClass

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

-> String

name - String containing the name of the Property to be removed. If Property name is not in the set, nothing happens.

-> IO ()

return value - Nothing.

Removes all Property objects from the PropertySet

clearPropertiesSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing.

Checks to see if a Property with the given name is in the PropertySet

isPropertyPresentSource

Arguments

:: HG3DClass

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

-> String

name - String containing the name of the Property to check for.

-> IO Bool

return value - true if a Property named

getPropertyHelpSource

Arguments

:: HG3DClass

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

-> String

name - String holding the name of the Property who's help text is to be returned.

-> IO String

return value - String object containing the help text for the Property

Return the help text for the specified Property.

getPropertySource

Arguments

:: HG3DClass

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

-> String

name - String containing the name of the Property who's value is to be returned.

-> IO String

return value - String object containing a textual representation of the requested Property.

Gets the current value of the specified Property.

setPropertySource

Arguments

:: HG3DClass

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

-> String

name - String containing the name of the Property who's value is to be set.

-> String

value - String containing a textual representation of the new value for the Property

-> IO ()

return value - Nothing

Returns whether a Property is at it's default value.

Sets the current value of a Property.

isPropertyDefaultSource

Arguments

:: HG3DClass

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

-> String

name - String containing the name of the Property who's default state is to be tested.

-> IO Bool 

getPropertyDefaultSource

Arguments

:: HG3DClass

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

-> String

name - String containing the name of the Property who's default string is to be returned.

-> IO String

return value - String object containing a textual representation of the default value for this property.

Returns the default value of a Property as a String.