Represents an icon box widget (2D scrollable). More...

Inheritance diagram for menu::MIconBox:

Public Member Functions
	MIconBox ()
	constructor taking no param More...

Int	moveLeft (Int count=1)

Int	moveRight (Int count=1)

Int	moveUp (Int count=1)

Int	moveDown (Int count=1)

void	setPageItemCount (Int x, Int y)

void	setItemTemplate (MRenderContext context, MWidget item)

Int	getItemCount ()

void	setItemCount (Int count)

MWidget	getItemWidget (Int index, MRenderContext=nil)

void	setItemWidget (Int index, MRenderContext context, MWidget widget)

Bool	getItemVisible (Int index)

void	setItemVisible (Int index, Bool visible)

Bool	getItemVisibleValue (Int index)

void	setItemVisibleValue (Int index, Bool value)

Bool	getItemVisibleEvent (Int index)

void	setItemVisibleEvent (Int index, Bool value)

Int	getItemUpdate (Int index)

void	setItemUpdate (Int index, Int value)

Bool	getItemActive (Int index)

void	setItemActive (Int index, Bool active)

Bool	getItemInsensitive (Int index)

void	setItemInsensitive (Int index, Bool insensitive)

void	enterDragMode (MRenderContext context, MWidget widget)

void	leaveDragMode (MRenderContext context)

void	postRedraw ()

Public Member Functions inherited from System::Object
	Object ()
	constructor taking no param More...

Bool	isInstanceOf (Class classType)
	Returns whether an object is of a specific class/type. More...

Object	getDeepCopy ()
	Gets a deep copy of this object. More...

void	setDeepCopy (Object obj)
	Unk. More...

String	dump ()
	Dumps all info about an object. More...

Object	getObjectAttribute (string path)

void	setObjectAttribute (string path, Object value)

Bool	hasPrimitiveInterface ()
	Returns whether this object has a primitive interface. More...

Bool	toBool ()
	Casts this object to Bool. More...

Byte	toByte ()
	Casts this object to Byte. More...

Short	toShort ()
	Casts this object to Short. More...

Int	toInt ()
	Casts this object to Int. More...

Long	toLong ()
	Casts this object to Long. More...

UByte	toUByte ()
	Casts this object to UByte. More...

UShort	toUShort ()
	Casts this object to UShort. More...

UInt	toUInt ()
	Casts this object to UInt. More...

ULong	toULong ()
	Casts this object to ULong. More...

Float	toFloat ()
	Casts this object to Float. More...

Double	toDouble ()
	Casts this object to Double. More...

String	toString ()
	Casts this object to String. More...

Symbol	toSymbol ()
	Casts this object to Symbol. More...

Bool	hasArrayInterface ()
	Returns whether this object has an Array interface. More...

Int	getArrayCount ()
	Gets the Array item count for this object. More...

void	setArrayCount ()
	Sets the Array item count for this object. More...

Object	getArrayElement (Object arg0)
	Gets an Array item for this object. More...

void	setArrayElement (Object arg0, Object arg1)
	Sets the Array item for this object. More...

Bool	hasMapInterface ()
	Returns whether this object has a Map interface. More...

int	getMapCount ()
	Returns the count of items in the map. More...

void	setMapElement (Object arg0, Object arg1)
	Returns whether the Map has a specific object key. Bool hasMapElement(Object arg0);. More...

Object	getMapElement (Object arg0)
	Gets a Map element by key. More...

void	hasGeneratorInterface ()
	Returns whether this object has a generator interface. More...

Iterator	generator ()
	Returns generator (?) More...

void	hasIteratorInterface ()
	Returns whether this object has an iterator. More...

Iterator	iterator ()
	Gets the iterator for this object. More...

void	hasVariableInterface ()
	Returns whether this object is a variable. More...

void	hasFunctionInterface ()
	Returns whether this object has a function interface. More...

Object	call ()
	Calls this object as a function. More...

Bool	hasByteDataInterface ()
	Returns whether this object has a byte data interface. More...

Int	getByteDataCount ()
	Returns the ByteData size for this object. More...

void	setByteDataCount (Int count)
	Sets the ByteData size for this object. More...

Int	getByteDataCapacity ()
	Returns the ByteData capacity for this object. More...

void	setByteDataCapacity (Int capacity)
	Sets the ByteData capacity for this object. More...

ByteData	getByteData ()
	Gets the underlaying ByteData. More...

void	setByteData (ByteData bytedata)
	Sets the underlaying ByteData. More...

void	hasObjectSelectorInterface ()
	Returns whether this object has an object selector interface. More...

void	self ()
	Gets the get for this object if it has a get interface. More...

void	getArchiveTree ()

void	setArchiveTree ()

ByteData	serialize ()
	Serializes this object. More...

void	deserialize (ByteData serializedData)
	Deserializes this object. More...

void	defined (Object obj)
	Returns whether a certain object is defined within this object. More...

Array	find_all (FunctionObject func)
	Finds all the elements in this object that matches the predicates. More...

void	each_all (FunctionObject func)
	Applies callback to all elements in this object. More...

Array	map_all (FunctionObject< Object > func)
	Maps all the elements in this object. More...

Bool	operator!= ()
	Returns whether this object is not equal to another. More...

Bool	operator== ()
	Returns whether this object is equal to another. More...

Public Attributes
Int	focus_index
	Item index currently being focused. More...

Int	drag_index

Int	step_min
	Defaults to 1. More...

Int	step_max
	Defaults to 1. More...

Float	interpolate_ratio
	Interpolate Ratio. Defaults to 0.2. More...

Float	h_magnify
	Horizontal magnification. Defaults to 1.0. More...

Float	v_magnify
	Vertical magnification. Defaults to 1.0. More...

Float	x_scroll_point
	Defaults to 0.5. More...

Float	y_scroll_point
	Defaults to 0.5. More...

Float	x_alignment
	Defaults to 0.5. More...

Float	y_alignment
	Defaults to 0.5. More...

Bool	focus_active
	Whether focusing is active. Defaults to true. More...

Bool	repeat
	Whether to repeat at the start or end of the listbox. Defaults to false. More...

Bool	keep_scroll_point
	Defaults to false. More...

Bool	adjust_scale
	Whether to adjust scale. Defaults to false. More...

Bool	linear_interpolate
	Linear interpolation. Defaults to false. More...

String	layout_name
	Layout name. Defaults to "TB_LR". More...

MethodObject	update_notify

MethodObject	visible_notify

MethodObject	focus_notify

MethodObject	update_callback
	Callback for when an item is updated. More...

MethodObject	visible_callback
	Callback for when an item is visible. More...

MethodObject	focus_callback
	Callback for when an item is focused. More...

Public Attributes inherited from menu::MScrollArea
Object	inner_pad_left

Object	inner_pad_right

Object	inner_pad_top

Object	inner_pad_bottom

Object	h_scacing

Object	v_scacing

Public Attributes inherited from System::Object
Int	rc_size
	Getter-only. Reference counter size of this object. More...

Object	rc_class
	Getter-only. Type name of the object. More...

Int	rc_count
	Getter-only. Reference count of this object. More...

Int	weak_count
	Getter-only. Weak reference count of this object. More...

Class	class_id
	Class (type) object for this object. More...

Detailed Description

Represents an icon box widget (2D scrollable).

Definition at line 6 of file MIconBox.cpp.

Constructor & Destructor Documentation

◆ MIconBox()

menu::MIconBox::MIconBox ( )

inline

constructor taking no param

Definition at line 10 of file MIconBox.cpp.

Member Function Documentation

◆ enterDragMode()

void menu::MIconBox::enterDragMode	(	MRenderContext	context,
		MWidget	widget
	)

◆ getItemActive()

Bool menu::MIconBox::getItemActive ( Int index )

◆ getItemCount()

Int menu::MIconBox::getItemCount ( )

◆ getItemInsensitive()

Bool menu::MIconBox::getItemInsensitive ( Int index )

◆ getItemUpdate()

Int menu::MIconBox::getItemUpdate ( Int index )

◆ getItemVisible()

Bool menu::MIconBox::getItemVisible ( Int index )

◆ getItemVisibleEvent()

Bool menu::MIconBox::getItemVisibleEvent ( Int index )

◆ getItemVisibleValue()

Bool menu::MIconBox::getItemVisibleValue ( Int index )

◆ getItemWidget()

MWidget menu::MIconBox::getItemWidget	(	Int	index,
		MRenderContext	= `nil`
	)

◆ leaveDragMode()

void menu::MIconBox::leaveDragMode ( MRenderContext context )

◆ moveDown()

Int menu::MIconBox::moveDown ( Int count = 1 )

◆ moveLeft()

Int menu::MIconBox::moveLeft ( Int count = 1 )

◆ moveRight()

Int menu::MIconBox::moveRight ( Int count = 1 )

◆ moveUp()

Int menu::MIconBox::moveUp ( Int count = 1 )

◆ postRedraw()

void menu::MIconBox::postRedraw ( )

◆ setItemActive()

void menu::MIconBox::setItemActive	(	Int	index,
		Bool	active
	)

◆ setItemCount()

void menu::MIconBox::setItemCount ( Int count )

◆ setItemInsensitive()

void menu::MIconBox::setItemInsensitive	(	Int	index,
		Bool	insensitive
	)

◆ setItemTemplate()

void menu::MIconBox::setItemTemplate	(	MRenderContext	context,
		MWidget	item
	)

◆ setItemUpdate()

void menu::MIconBox::setItemUpdate	(	Int	index,
		Int	value
	)

◆ setItemVisible()

void menu::MIconBox::setItemVisible	(	Int	index,
		Bool	visible
	)

◆ setItemVisibleEvent()

void menu::MIconBox::setItemVisibleEvent	(	Int	index,
		Bool	value
	)

◆ setItemVisibleValue()

void menu::MIconBox::setItemVisibleValue	(	Int	index,
		Bool	value
	)

◆ setItemWidget()

void menu::MIconBox::setItemWidget	(	Int	index,
		MRenderContext	context,
		MWidget	widget
	)

◆ setPageItemCount()

void menu::MIconBox::setPageItemCount	(	Int	x,
		Int	y
	)

Member Data Documentation

◆ adjust_scale

Bool menu::MIconBox::adjust_scale

Whether to adjust scale. Defaults to false.

Definition at line 54 of file MIconBox.cpp.

◆ drag_index

Int menu::MIconBox::drag_index

Definition at line 15 of file MIconBox.cpp.

◆ focus_active

Bool menu::MIconBox::focus_active

Whether focusing is active. Defaults to true.

Definition at line 45 of file MIconBox.cpp.

◆ focus_callback

MethodObject menu::MIconBox::focus_callback

Callback for when an item is focused.

Definition at line 111 of file MIconBox.cpp.

◆ focus_index

Int menu::MIconBox::focus_index

Item index currently being focused.

Definition at line 13 of file MIconBox.cpp.

◆ focus_notify

MethodObject menu::MIconBox::focus_notify

Definition at line 73 of file MIconBox.cpp.

◆ h_magnify

Float menu::MIconBox::h_magnify

Horizontal magnification. Defaults to 1.0.

Definition at line 27 of file MIconBox.cpp.

◆ interpolate_ratio

Float menu::MIconBox::interpolate_ratio

Interpolate Ratio. Defaults to 0.2.

Definition at line 24 of file MIconBox.cpp.

◆ keep_scroll_point

Bool menu::MIconBox::keep_scroll_point

Defaults to false.

Definition at line 51 of file MIconBox.cpp.

◆ layout_name

String menu::MIconBox::layout_name

Layout name. Defaults to "TB_LR".

Available options:

"TB_LR" - Top-Bottom, Left-Right
"TB_RL" - Top-Bottom, Right-Left
"BT_LR" - Bottom-Top, Left-Right
"BT_RL" - Bottom-Top, Right-Left
"LR_TB" - Left-Right, Top-Bottom
"LR_BT" - Left-Right, Bottom-Top
"RL_TB" - Right-Left, Top-Bottom
"RL_BT" - Right-Left, Bottom-Top

Definition at line 69 of file MIconBox.cpp.

◆ linear_interpolate

Bool menu::MIconBox::linear_interpolate

Linear interpolation. Defaults to false.

Definition at line 57 of file MIconBox.cpp.

◆ repeat

Bool menu::MIconBox::repeat

Whether to repeat at the start or end of the listbox. Defaults to false.

Definition at line 48 of file MIconBox.cpp.

◆ step_max

Int menu::MIconBox::step_max

Defaults to 1.

Definition at line 21 of file MIconBox.cpp.

◆ step_min

Int menu::MIconBox::step_min

Defaults to 1.

Definition at line 18 of file MIconBox.cpp.

◆ update_callback

MethodObject menu::MIconBox::update_callback

Callback for when an item is updated.

Definition at line 105 of file MIconBox.cpp.

◆ update_notify

MethodObject menu::MIconBox::update_notify

Definition at line 71 of file MIconBox.cpp.

◆ v_magnify

Float menu::MIconBox::v_magnify

Vertical magnification. Defaults to 1.0.

Definition at line 30 of file MIconBox.cpp.

◆ visible_callback

MethodObject menu::MIconBox::visible_callback

Callback for when an item is visible.

Definition at line 108 of file MIconBox.cpp.

◆ visible_notify

MethodObject menu::MIconBox::visible_notify

Definition at line 72 of file MIconBox.cpp.

◆ x_alignment

Float menu::MIconBox::x_alignment

Defaults to 0.5.

Definition at line 39 of file MIconBox.cpp.

◆ x_scroll_point

Float menu::MIconBox::x_scroll_point

Defaults to 0.5.

Definition at line 33 of file MIconBox.cpp.

◆ y_alignment

Float menu::MIconBox::y_alignment

Defaults to 0.5.

Definition at line 42 of file MIconBox.cpp.

◆ y_scroll_point

Float menu::MIconBox::y_scroll_point

Defaults to 0.5.

Definition at line 36 of file MIconBox.cpp.

The documentation for this class was generated from the following file:

headers/menu/Scrollables/MIconBox.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MIconBox()

Member Function Documentation

◆ enterDragMode()

◆ getItemActive()

◆ getItemCount()

◆ getItemInsensitive()

◆ getItemUpdate()

◆ getItemVisible()

◆ getItemVisibleEvent()

◆ getItemVisibleValue()

◆ getItemWidget()

◆ leaveDragMode()

◆ moveDown()

◆ moveLeft()

◆ moveRight()

◆ moveUp()

◆ postRedraw()

◆ setItemActive()

◆ setItemCount()

◆ setItemInsensitive()

◆ setItemTemplate()

◆ setItemUpdate()

◆ setItemVisible()

◆ setItemVisibleEvent()

◆ setItemVisibleValue()

◆ setItemWidget()

◆ setPageItemCount()

Member Data Documentation

◆ adjust_scale

◆ drag_index

◆ focus_active

◆ focus_callback

◆ focus_index

◆ focus_notify

◆ h_magnify

◆ interpolate_ratio

◆ keep_scroll_point

◆ layout_name

◆ linear_interpolate

◆ repeat

◆ step_max

◆ step_min

◆ update_callback

◆ update_notify

◆ v_magnify

◆ visible_callback

◆ visible_notify

◆ x_alignment

◆ x_scroll_point

◆ y_alignment

◆ y_scroll_point