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

Safe HaskellNone

HGamer3D.Bindings.CEGUI.ClassWindow

Synopsis

Documentation

newSource

Arguments

:: String

type - String object holding Window type (usually provided by WindowFactory).

-> String

name - String object holding unique name for the Window.

-> IO HG3DClass 

Constructor for Window

deleteSource

Arguments

:: HG3DClass

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

-> IO () 

return a String object holding the type name for this Window

Destructor for Window

getTypeSource

Arguments

:: HG3DClass

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

-> IO String

return value - String object holding the

getNameSource

Arguments

:: HG3DClass

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

-> IO String

return value - String object holding the unique

return a String object holding the name of this Window

isDestroyedByParentSource

Arguments

:: HG3DClass

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

-> IO Bool 

returns whether or not this Window

isAlwaysOnTopSource

Arguments

:: HG3DClass

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

-> IO Bool 

returns whether or not this WindowWindow

isDisabledSource

Arguments

:: HG3DClass

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

-> Bool

localOnly - States whether to only return the state set for this window, and not to factor in inherited state from ancestor windows.

-> IO Bool 

return whether the Window

isVisibleSource

Arguments

:: HG3DClass

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

-> Bool

localOnly

-> IO Bool 

return true if this is the active Window - Details: Mouse events are always sent to the window containing the mouse cursor regardless of what this function reports (unless a window has captured inputs). The active state mainly determines where send other, for example keyboard, inputs.

return true if the Window - Details: When true is returned from this function does not mean that the window is not completely obscured by other windows, just that the window will be processed when rendering, and is not explicitly marked as hidden.

isActiveSource

Arguments

:: HG3DClass

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

-> IO Bool 

return true if this WindowWindow

isClippedByParentSource

Arguments

:: HG3DClass

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

-> IO Bool 

getIDSource

Arguments

:: HG3DClass

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

-> IO Int

return value - uint value equal to the currently assigned ID code for this

return the ID code currently assigned to this Window

getChildCountSource

Arguments

:: HG3DClass

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

-> IO Int

return value - size_t value equal to the number of

return the number of child WindowWindow

isChildSource

Arguments

:: HG3DClass

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

-> String

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

-> IO Bool 

returns whether a WindowWindow

isChild2Source

Arguments

:: HG3DClass

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

-> Int

ID - uint ID code to look for.

-> IO Bool 

returns whether at least one window with the given ID code is attached to this Window - Details: ID codes are client assigned and may or may not be unique, and as such, the return from this function will only have meaning to the client code.

isChildRecursiveSource

Arguments

:: HG3DClass

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

-> Int

ID

-> IO Bool 

returns whether at least one window with the given ID code is attached to this Window - Details: ID codes are client assigned and may or may not be unique, and as such, the return from this function will only have meaning to the client code.

isChild3Source

Arguments

:: HG3DClass

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

-> HG3DClass

window - Pointer to the Window object to look for.

-> IO Bool 

return true if the given Window

getChildSource

Arguments

:: HG3DClass

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

-> String

name

-> IO HG3DClass 

return a pointer to the first attached child window with the specified ID value. - Details: This function will throw an exception if no child object with the given ID is attached. This decision was made (over returning NULL if no window was found) so that client code can assume that if the call returns it has a valid window pointer. We provide the isChild() functions for checking if a given window is attached.

return a pointer to the child window with the specified name. - Details: This function will throw an exception if no child object with the given name is attached. This decision was made (over returning NULL if no window was found) so that client code can assume that if the call returns it has a valid window pointer. We provide the isChild() functions for checking if a given window is attached.

getChild2Source

Arguments

:: HG3DClass

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

-> Int

ID

-> IO HG3DClass 

return a pointer to the first attached child window with the specified name. Children are traversed recursively. - Details: Contrary to the non recursive version of this function, this one will not throw an exception, but return 0 in case no child was found.

getChildRecursiveSource

Arguments

:: HG3DClass

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

-> String

name

-> IO HG3DClass 

return a pointer to the first attached child window with the specified ID value. Children are traversed recursively. - Details: Contrary to the non recursive version of this function, this one will not throw an exception, but return 0 in case no child was found.

getChildRecursive2Source

Arguments

:: HG3DClass

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

-> Int

ID

-> IO HG3DClass 

return a pointer to the child window that is attached to this at the given index.

getChildAtIdxSource

Arguments

:: HG3DClass

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

-> Int

idx - Index of the child window whos pointer should be returned. This value is not bounds checked, client code should ensure that this is less than the value returned by getChildCount().

-> IO HG3DClass

return value - Pointer to the child window currently attached at index position

getActiveChildSource

Arguments

:: HG3DClass

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

-> IO HG3DClass

return value - Pointer to the window that is active (has input focus) starting at this window. The function will return this if this

return a pointer to the WindowWindow

getActiveChild2Source

Arguments

:: HG3DClass

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

-> IO HG3DClass 

isAncestorSource

Arguments

:: HG3DClass

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

-> String

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

-> IO Bool 

return true if the specified WindowWindow

isAncestor2Source

Arguments

:: HG3DClass

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

-> Int

ID - uint value specifying the ID to look for.

-> IO Bool 

return true if any WindowWindow

isAncestor3Source

Arguments

:: HG3DClass

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

-> HG3DClass

window - Pointer to the Window object to look for.

-> IO Bool 

return true if the specified WindowWindow

getFontSource

Arguments

:: HG3DClass

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

-> Bool

useDefault - Sepcifies whether to return the default font if this Window has no preferred font set.

-> IO HG3DClass

return value - Pointer to the

return the active FontWindow

getTextSource

Arguments

:: HG3DClass

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

-> IO String

return value - The String object that holds the current text for this

return the current text for the Window

getTextVisualSource

Arguments

:: HG3DClass

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

-> IO String 

return text string with visual

inheritsAlphaSource

Arguments

:: HG3DClass

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

-> IO Bool 

return true if the Window

getAlphaSource

Arguments

:: HG3DClass

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

-> IO Float

return value - the currently set alpha value for this

return the current alpha value set for this Window - Details: The alpha value set for any given window may or may not be the final alpha value that is used when rendering. All window objects, by default, inherit alpha from thier parent window(s) - this will blend child windows, relatively, down the line of inheritance. This behaviour can be overridden via the setInheritsAlpha()getEffectiveAlpha()

getEffectiveAlphaSource

Arguments

:: HG3DClass

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

-> IO Float

return value - the effective alpha that will be applied to this

return the effective alpha value that will be used when rendering this window, taking into account inheritance of parent window(s) alpha.

isCapturedByThisSource

Arguments

:: HG3DClass

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

-> IO Bool 

return true if this Window

isCapturedByAncestorSource

Arguments

:: HG3DClass

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

-> IO Bool 

return true if an ancestor window has captured inputs.

isCapturedByChildSource

Arguments

:: HG3DClass

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

-> IO Bool 

return true if a child window has captured inputs.

getParentSource

Arguments

:: HG3DClass

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

-> IO HG3DClass

return value - Pointer to the

return the parent of this Window

restoresOldCaptureSource

Arguments

:: HG3DClass

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

-> IO Bool 

Return whether z-order changes are enabled or disabled for this Window - Details: This is distinguished from the is/setRiseOnClickEnabled setting in that if rise on click is disabled it only affects the users ability to affect the z order of the WindowWindowWindow

Return whether this window is set to restore old input capture when it loses input capture. - Details: This is only really useful for certain sub-components for widget writers.

isZOrderingEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool 

wantsMultiClickEventsSource

Arguments

:: HG3DClass

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

-> IO Bool 

Return whether this window will receive multi-click events or multiple down events instead.

isMouseAutoRepeatEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool 

Return whether mouse button down event autorepeat is enabled for this window.

getAutoRepeatDelaySource

Arguments

:: HG3DClass

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

-> IO Float

return value - float value indicating the delay, in seconds, defore the first repeat mouse button down event will be triggered when autorepeat is enabled.

Return the current auto-repeat delay setting for this window.

getAutoRepeatRateSource

Arguments

:: HG3DClass

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

-> IO Float

return value - float value indicating the rate, in seconds, at which repeat mouse button down events will be generated after the initial delay has expired.

Return the current auto-repeat rate setting for this window.

distributesCapturedInputsSource

Arguments

:: HG3DClass

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

-> IO Bool 

Return whether the window wants inputs passed to its attached child windows when the window has inputs captured.

isUsingDefaultTooltipSource

Arguments

:: HG3DClass

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

-> IO Bool 

Return whether this WindowTooltipTooltip

getTooltipSource

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 TooltipWindowTooltipWindowTooltip

getTooltipTypeSource

Arguments

:: HG3DClass

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

-> IO String

return value - String object holding the current custom tooltip window type, or an empty string if no custom tooltip is set.

Return the custom tooltip type.

getTooltipTextSource

Arguments

:: HG3DClass

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

-> IO String

return value - String object holding the current tooltip text set for this window.

Return the current tooltip text set for this Window

inheritsTooltipTextSource

Arguments

:: HG3DClass

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

-> IO Bool 

Return whether this window inherits Tooltip

isRiseOnClickEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool 

Return whether this window will rise to the top of the z-order when clicked with the left mouse button. - Details: This is distinguished from the is/setZOrderingEnabled setting in that if rise on click is disabled it only affects the users ability to affect the z order of the WindowWindowWindow

testClassNameSource

Arguments

:: HG3DClass

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

-> String

class_name - The class name that is to be checked.

-> IO Bool

return value - true if this window was inherited from

Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.

getVerticalAlignmentSource

Arguments

:: HG3DClass

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

-> IO EnumVerticalAlignment 

Get the horizontal alignment. - Details: Returns the horizontal alignment for the window. This setting affects how the windows position is interpreted relative to its parent.

Get the vertical alignment. - Details: Returns the vertical alignment for the window. This setting affects how the windows position is interpreted relative to its parent.

getHorizontalAlignmentSource

Arguments

:: HG3DClass

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

-> IO EnumHorizontalAlignment 

Get the name of the LookNFeel assigned to this window.

getLookNFeelSource

Arguments

:: HG3DClass

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

-> IO String

return value - String object holding the name of the look assigned to this window. Returns the empty string if no look is assigned.

getModalStateSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - Returns true if this

Get whether or not this Window

getUserStringSource

Arguments

:: HG3DClass

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

-> String

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

-> IO String

return value - String object holding the data stored for the requested user string.

Returns a named user string.

isUserStringDefinedSource

Arguments

:: HG3DClass

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

-> String

name - String object holding the name of the string to be checked.

-> IO Bool 

Return whether a user string with the specified name exists.

getParentPixelWidthSource

Arguments

:: HG3DClass

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

-> IO Float

return value - float value that is equal to the pixel width of this

getActiveSiblingSource

Arguments

:: HG3DClass

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

-> IO HG3DClass 

Returns the active sibling window. - Details: This searches the immediate children of this window's parent, and returns a pointer to the active window. The method will return this if we are the immediate child of our parent that is active. If our parent is not active, or if no immediate child of our parent is active then 0 is returned. If this window has no parent, and this window is not active then 0 is returned, else this is returned.

Return the pixel Width of the parent element. This always returns a valid number.

getParentPixelHeightSource

Arguments

:: HG3DClass

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

-> IO Float

return value - float value that is equal to the pixel height of this

Return the pixel Height of the parent element. This always returns a valid number.

isMousePassThroughEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if mouse pass through is enabled. false if mouse pass through is not enabled.

Returns whether this window should ignore mouse event and pass them through to and other windows behind it. In effect making the window transparent to the mouse.

isAutoWindowSource

Arguments

:: HG3DClass

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

-> IO Bool 

Returns whether this window is an auto-child window. All auto-child windows have __auto_ in their name, but this is faster.

isWritingXMLAllowedSource

Arguments

:: HG3DClass

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

-> IO Bool 

Returns whether this window is allowed to write XML.

isDragDropTargetSource

Arguments

:: HG3DClass

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

-> IO Bool 

Returns whether this Window

isUsingAutoRenderingSurfaceSource

Arguments

:: HG3DClass

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

-> IO Bool 

Returns whether automatic

getRootWindowSource

Arguments

:: HG3DClass

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

-> IO HG3DClass

return value - A pointer to the root window of the hierarchy that this window is attched to.

Returns the window at the root of the hierarchy starting at this Window

getRootWindow2Source

Arguments

:: HG3DClass

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

-> IO HG3DClass 

isNonClientWindowSource

Arguments

:: HG3DClass

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

-> IO Bool 

Renames the window.

Return whether the Window - Details: A non-client window is clipped, positioned and sized according to the parent window's full area as opposed to just the inner rect area used for normal client windows.

renameSource

Arguments

:: HG3DClass

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

-> String

new_name - String object holding the new name for the window.

-> IO () 

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

initialiseComponentsSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

Set whether or not this WindowWindow

setDestroyedByParentSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing

Set whether this window is always on top, or not.

setAlwaysOnTopSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing

Set whether this window is enabled or disabled. A disabled window normally can not be interacted with, and may have different rendering.

setEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing

enable the Window

enableSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

disable the Window

disableSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

Set whether the Window - Details: Hiding the active window will cause that window to become deactivated. Showing a window does not, however, automatically cause that window to become the active window (call Window::activate

setVisibleSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing

show the Window - Details: Showing a window does not automatically activate the window. If you want the window to also become active you will need to call the Window::activate

showSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

hide the Window - Details: If the window is the active window, it will become deactivated as a result of being hidden.

hideSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

Activate the WindowWindow

activateSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

Deactivate the window. No further inputs will be received by the window until it is re-activated either programmatically or by the user interacting with the gui.

deactivateSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing.

Set whether this Window

setClippedByParentSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing

Set the current ID for the Window

setIDSource

Arguments

:: HG3DClass

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

-> Int

ID - Client assigned ID code for this Window. The GUI system assigns no meaning to any IDs, they are a device purely for client code usage.

-> IO ()

return value - Nothing

Set the current text string for the Window

setTextSource

Arguments

:: HG3DClass

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

-> String

text - String object containing the text that is to be set as the Window text.

-> IO ()

return value - Nothing

Append the string textWindow

appendTextSource

Arguments

:: HG3DClass

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

-> String

text - String object holding the text that is to be appended to the Window object's current text string.

-> IO () 

Set the font used by this Window

setFontSource

Arguments

:: HG3DClass

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

-> HG3DClass

font - Pointer to the Font object to be used by this Window. If font is NULL, the default font will be used.

-> IO ()

return value - Nothing

Set the font used by this Window

setFont2Source

Arguments

:: HG3DClass

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

-> String 
-> IO ()

return value - Nothing

Add the named WindowWindowWindownameWindowWindow

addChildWindowSource

Arguments

:: HG3DClass

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

-> String

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

-> IO ()

return value - Nothing.

Add the specified WindowWindowWindowwindowWindowWindow

addChildWindow2Source

Arguments

:: HG3DClass

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

-> HG3DClass

window - Pointer to the Window object to be added.

-> IO ()

return value - Nothing

Remove the named Window

removeChildWindowSource

Arguments

:: HG3DClass

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

-> String

name - String object holding the name of the Window to be removed. If the Window specified is not attached to this Window, nothing happens.

-> IO ()

return value - Nothing.

Remove the specified Window

removeChildWindow2Source

Arguments

:: HG3DClass

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

-> HG3DClass

window - Pointer to the Window object to be removed. If the window is not attached to this Window, then nothing happens.

-> IO ()

return value - Nothing.

Remove the first child WindowWindow

removeChildWindow3Source

Arguments

:: HG3DClass

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

-> Int

ID - ID number assigned to the Window to be removed. If no Window with ID code ID is attached, nothing happens.

-> IO ()

return value - Nothing.

Move the Window - Details: - If the Window is a non always-on-top window it is moved the the top of all other non always-on-top sibling windows, and the process repeated for all ancestors.

moveToFrontSource

Arguments

:: HG3DClass

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

-> IO () 

Move the Window - Details: - If the window is non always-on-top the Window is sent to the very bottom of its sibling windows and the process repeated for all ancestors.

captureInputSource

Arguments

:: HG3DClass

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

-> IO Bool 

moveToBackSource

Arguments

:: HG3DClass

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

-> IO () 

Captures input to this window.

releaseInputSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

Set whether this window will remember and restore the previous window that had inputs captured. - Details:

Releases input capture from this WindowWindow

setRestoreCaptureSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO () 

Set the current alpha value for this window. - Details: The alpha value set for any given window may or may not be the final alpha value that is used when rendering. All window objects, by default, inherit alpha from thier parent window(s) - this will blend child windows, relatively, down the line of inheritance. This behaviour can be overridden via the setInheritsAlpha()getEffectiveAlpha()

setAlphaSource

Arguments

:: HG3DClass

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

-> Float

alpha - The new alpha value for the window. Value should be between 0.0f and 1.0f.

-> IO ()

return value - Nothing

Sets whether this Window

setInheritsAlphaSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing

Invalidate this window causing at least this window to be redrawn during the next rendering pass.

invalidateSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

Invalidate this window and - dependant upon recursive

invalidate2Source

Arguments

:: HG3DClass

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

-> Bool

recursive - Boolean value indicating whether attached child content should also be invalidated.

-> IO ()

return value - Nothing

Set the mouse cursor image to be used when the mouse enters this window.

setMouseCursor3Source

Arguments

:: HG3DClass

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

-> String

imageset - String object that contains the name of the Imageset that contains the image to be used.

-> String

image_name - String object that contains the name of the Image on imageset that is to be used.

-> IO ()

return value - Nothing.

Set whether z-order changes are enabled or disabled for this Window - Details: This is distinguished from the is/setRiseOnClickEnabled setting in that if rise on click is disabled it only affects the users ability to affect the z order of the WindowWindowWindow

setZOrderingEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set whether this window will receive multi-click events or multiple down events instead.

setWantsMultiClickEventsSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set whether mouse button down event autorepeat is enabled for this window.

setMouseAutoRepeatEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set the current auto-repeat delay setting for this window.

setAutoRepeatDelaySource

Arguments

:: HG3DClass

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

-> Float

delay - float value indicating the delay, in seconds, defore the first repeat mouse button down event should be triggered when autorepeat is enabled.

-> IO ()

return value - Nothing.

Set the current auto-repeat rate setting for this window.

setAutoRepeatRateSource

Arguments

:: HG3DClass

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

-> Float

rate - float value indicating the rate, in seconds, at which repeat mouse button down events should be generated after the initial delay has expired.

-> IO ()

return value - Nothing.

Set whether the window wants inputs passed to its attached child windows when the window has inputs captured.

setDistributesCapturedInputsSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO () 

Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer

notifyDragDropItemEntersSource

Arguments

:: HG3DClass

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

-> HG3DClass

item

-> IO () 

Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer

notifyDragDropItemLeavesSource

Arguments

:: HG3DClass

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

-> HG3DClass

item

-> IO () 

Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer

notifyDragDropItemDroppedSource

Arguments

:: HG3DClass

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

-> HG3DClass

item

-> IO () 

Internal destroy method which actually just adds the window and any parent destructed child windows to the dead pool. - Details: This is virtual to allow for specialised cleanup which may be required in some advanced cases. If you override this for the above reason, you MUST call this base class version.

destroySource

Arguments

:: HG3DClass

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

-> IO () 

Set the custom TooltipWindowWindowTooltip

setTooltipSource

Arguments

:: HG3DClass

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

-> HG3DClass

tooltip - Pointer to a valid Tooltip based object which should be used as the tooltip for this Window, or 0 to indicate that the Window should use the system default Tooltip object. Note that when passing a pointer to a Tooltip object, ownership of the Tooltip does not pass to this Window object.

-> IO ()

return value - Nothing.

Set the custom TooltipWindowWindow - Details: The Window will internally attempt to create an instance of the specified window type (which must be derived from the base Tooltip class). If the Tooltip creation fails, the error is logged and the Window will revert to using either the existing custom Tooltip or the system default Tooltip.

setTooltipTypeSource

Arguments

:: HG3DClass

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

-> String

tooltipType

-> IO () 

Set the tooltip text for this window.

setTooltipTextSource

Arguments

:: HG3DClass

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

-> String

tip - String object holding the text to be displayed in the tooltip for this Window.

-> IO ()

return value - Nothing.

Set whether this window inherits Tooltip

setInheritsTooltipTextSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set whether this window will rise to the top of the z-order when clicked with the left mouse button. - Details: This is distinguished from the is/setZOrderingEnabled setting in that if rise on click is disabled it only affects the users ability to affect the z order of the WindowWindowWindow

setRiseOnClickEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set the vertical alignment. - Details: Modifies the vertical alignment for the window. This setting affects how the windows position is interpreted relative to its parent.

setVerticalAlignmentSource

Arguments

:: HG3DClass

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

-> EnumVerticalAlignment

alignment

-> IO () 

Set the horizontal alignment. - Details: Modifies the horizontal alignment for the window. This setting affects how the windows position is interpreted relative to its parent.

setHorizontalAlignmentSource

Arguments

:: HG3DClass

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

-> EnumHorizontalAlignment

alignment

-> IO () 

Set the LookNFeel that shoule be used for this window. - Details: Once a looknfeel has been assigned it is locked - as in cannot be changed.

setLookNFeelSource

Arguments

:: HG3DClass

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

-> String

look - String object holding the name of the look to be assigned to the window.

-> IO ()

return value - Nothing.

Set the modal state for this Window

setModalStateSource

Arguments

:: HG3DClass

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

-> Bool

state - Boolean value defining if this Window should be the modal target.

-> IO ()

return value - Nothing.

method called to perform extended laying out of attached child windows. - Details: The system may call this at various times (like when it is resized for example), and it may be invoked directly where required.

performChildWindowLayoutSource

Arguments

:: HG3DClass

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

-> IO () 

Sets the value a named user string, creating it as required.

setUserStringSource

Arguments

:: HG3DClass

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

-> String

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

-> String

value - String object holding the value to be assigned to the user string.

-> IO ()

return value - Nothing.

Causes the Window

renderSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing

Cause window to update itself and any attached children. Client code does not need to call this method; to ensure full, and proper updates, call the injectTimePulse methodname method provided by the System - Details: The update order is such that this window is updated prior to any child windows, this is so that child windows that access the parent in their update code get the correct updated state.

updateSource

Arguments

:: HG3DClass

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

-> Float

elapsed - float value indicating the number of seconds passed since the last update.

-> IO ()

return value - Nothing.

Sets the internal initialising flag to true. This can be use to optimize initialisation of some widgets, and is called automatically by the layout XML handler when it has created a window. That is just after the window has been created, but before any children or properties are read.

beginInitialisationSource

Arguments

:: HG3DClass

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

-> IO () 

Sets the internal initialising flag to false. This is called automatically by the layout XML handler when it is done creating a window. That is after all properties and children have been loaded and just before the next sibling gets created.

endInitialisationSource

Arguments

:: HG3DClass

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

-> IO () 

Sets whether this window should ignore mouse events and pass them through to any windows behind it. In effect making the window transparent to the mouse.

setMousePassThroughEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting - true if mouse pass through is enabled. false if mouse pass through is not enabled.

-> IO () 

Assign the WindowRenderer to specify the LookNFeel specification to be used. - Details: Once a window renderer has been assigned it is locked - as in cannot be changed.

setWindowRendererSource

Arguments

:: HG3DClass

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

-> String

name - The factory name of the WindowRenderer to use.

-> IO () 

Get the factory name of the currently assigned WindowRenderer. (LookNFeel specification).

getWindowRendererNameSource

Arguments

:: HG3DClass

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

-> IO String

return value - The factory name of the currently assigned WindowRenderer. If no WindowRenderer is assigned an empty string is returned.

setWritingXMLAllowedSource

Arguments

:: HG3DClass

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

-> Bool

allow

-> IO () 

Inform the window, and optionally all children, that screen area rectangles have changed.

Sets whether this window is allowed to write XML.

notifyScreenAreaChangedSource

Arguments

:: HG3DClass

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

-> Bool

recursive -

-> IO () 

Changes the widget's falagard type, thus changing its looknfeel and optionally its renderer in the process.

setFalagardTypeSource

Arguments

:: HG3DClass

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

-> String

type - New renderer of the widget

-> String

rendererType

-> IO () 

Specifies whether this Window

setDragDropTargetSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO () 

Invalidate the chain of rendering surfaces from this window backwards to ensure they get properly redrawn - but doing the minimum amount of work possibe - next render.

invalidateRenderingSurfaceSource

Arguments

:: HG3DClass

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

-> IO () 

Sets whether automatic - Details: Note that this setting really only controls whether the WindowuseWindowEnabling this option will cause the WindowWindowWindowbut not destroyedDisabling this option will cause any automatically created RenderingSurface to be released. It is possible that the renderer in use may not support facilities for RenderingSurfaces that are suitable for full imagery caching. If this is the case, then calling getRenderingSurface after enabling this option will return 0. In these cases this option will still show as being enabled, this is because WindowsettingsWindowIf this option is enabled, and the client subsequently assigns a different RenderingSurface to the Window

setUsingAutoRenderingSurfaceSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO () 

Set whether the Window - Details: A non-client window is clipped, positioned and sized according to the parent window's full area as opposed to just the inner rect area used for normal client windows.

setNonClientWindowSource

Arguments

:: HG3DClass

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

-> Bool

setting

-> IO () 

return whether text parsing is enabled for this window.

isTextParsingEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool 

setTextParsingEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting

-> IO () 

Add the named property to the XML ban list for this window.

set whether text parsing is enabled for this window.

banPropertyFromXMLSource

Arguments

:: HG3DClass

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

-> String

property_name

-> IO () 

Remove the named property from the XML ban list for this window.

unbanPropertyFromXMLSource

Arguments

:: HG3DClass

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

-> String

property_name

-> IO () 

Return whether the named property is banned from XML.

isPropertyBannedFromXMLSource

Arguments

:: HG3DClass

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

-> String

property_name

-> IO Bool 

setUpdateModeSource

Arguments

:: HG3DClass

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

-> EnumWindowUpdateMode

mode - One of the WindowUpdateMode enumerated values indicating the mode to set for this Window.

-> IO () 

Return the current window update mode that is set for this WindowWindow::update - Details: Disabling updates can have negative effects on the behaviour of CEGUI

Set the window update mode. This mode controls the behaviour of the Window::update - Details: Disabling updates can have negative effects on the behaviour of CEGUI

getUpdateModeSource

Arguments

:: HG3DClass

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

-> IO EnumWindowUpdateMode

return value - One of the WindowUpdateMode enumerated values indicating the current mode set for this

setMouseInputPropagationEnabledSource

Arguments

:: HG3DClass

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

-> Bool

enabled -

-> IO () 

Return whether mouse input that is not directly handled by this WindowWindow

Set whether mouse input that is not directly handled by this WindowWindow

isMouseInputPropagationEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool 

cloneSource

Arguments

:: HG3DClass

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

-> String

newName - new name of the cloned window

-> Bool

deepCopy - if true, even children are copied (the old name prefix will be replaced with new name prefix)

-> IO HG3DClass

return value - the cloned

Clones this Window

clonePropertiesToSource

Arguments

:: HG3DClass

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

-> HG3DClass

target

-> IO () 

copies this widget's child widgets to given target widget

copies this widget's properties to given target widget

cloneChildWidgetsToSource

Arguments

:: HG3DClass

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

-> HG3DClass

target

-> IO () 

Return the (visual) z index of the window on it's parent. - Details: The z index is a number that indicates the order that windows will be drawn (but is not a 'z co-ordinate', as such). Higher numbers are in front of lower numbers.

getZIndexSource

Arguments

:: HG3DClass

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

-> IO Int 

isInFrontSource

Arguments

:: HG3DClass

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

-> HG3DClass

wnd

-> IO Bool 

Return whether /a this Window - Details: Here 'in front' just means that one window is drawn after the other, it is not meant to imply that the windows are overlapping nor that one window is obscured by the other.

isBehindSource

Arguments

:: HG3DClass

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

-> HG3DClass

wnd

-> IO Bool 

Return whether /a this Window - Details: Here behind just means that one window is drawn before the other, it is not meant to imply that the windows are overlapping nor that one window is obscured by the other.

getCaptureWindowSource

Arguments

:: IO HG3DClass

return value - Pointer to the

return the Window