FORMS_Container

A constructor defined in FORMS_Container.gml

Extends FORMS_Canvas

new FORMS_Container([_x, _y, _width, _height])

Description

A scrollable container.

Arguments

Name Type Description
_x Real The x position to create the container at.
_y Real The y position to create the container at.
_width Real The width of the container.
_height Real The width of the container.

Properties

Name Description
Content
ScrollbarHor
ScrollbarVer

Inherited properties

Name Description
Background
Depth The widget's depth. User for sorting widgets within its parent.
Height The widget's height.
Id The id of the widget.
Items
KeyboardShortcuts Keyboard shortcuts usable when the widget is active.
Parent The widget's parent or undefined.
Redraw If true then the widget's content needs to be redrawed.
Surface
Tooltip The widget's tooltip displayed on mouse over or undefined.
Type The type of the widget.
Width The widget's width.
X The widget's position on the X axis.
Y The widget's position on the Y axis.

Methods

Name Description
GetContentHeight Gets the height of the container's content.
GetContentWidth Gets the width of the container's content.
SetContent Sets content of the container.
SetContentHeight Sets height of the content of the container to the given value.
SetContentWidth Sets width of the content of the container to the given value.

Inherited methods

Name Description
AddItem Adds item to the compound widget while preserving depth order.
AddKeyboardShortcut Adds keyboard shortcut to the widget.
BeginFill Sets the canvas surface as the render target.
EndFill Finishes drawing into the canvas and resets the render target.
GetPositionAbsolute Retreives the widget's absolute position on the screen.
IsActive Gets whether the widget is active.
IsAncestor Finds out whether the widget is an ancestor of an item.
IsHovered Gets whether the widget is hovered.
IsSelected Gets whether the widget is selected.
SetHeight Sets the height of the widget.
SetPosition Sets the x and y position of the widget relative to its parent.
SetRectangle Sets the x and y position of the widget relative to its parent and its size.
SetSize Sets the width and height of the widget.
SetWidth Sets the width of the widget.

Child structs

FORMS_ContextMenu

See also

FORMS_Content


Copyright © 2024, BlueBurn. Built on September 03, 2024 using GMDoc.