DgsCreateScrollPane - Revision history

Thisdp at 09:26, 17 January 2021

2021-01-17T09:26:49Z

← Older revision		Revision as of 09:26, 17 January 2021
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsCreateScrollPane( float x, float y, float width, float height, bool relative, [element parent = nil])		element dgsCreateScrollPane( float x, float y, float width, float height, bool relative [, element parent = nil ] )
	</syntaxhighlight>		</syntaxhighlight>

Thisdp: Thisdp moved page DgsDxCreateScrollPane to DgsCreateScrollPane

2018-01-20T11:04:33Z

Thisdp moved page DgsDxCreateScrollPane to DgsCreateScrollPane

← Older revision

Revision as of 11:04, 20 January 2018

Thisdp at 11:04, 20 January 2018

2018-01-20T11:04:11Z

← Older revision		Revision as of 11:04, 20 January 2018
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element ~~dgsDxCreateScrollPane~~( float x, float y, float width, float height, bool relative, [element parent = nil])		element dgsCreateScrollPane( float x, float y, float width, float height, bool relative, [element parent = nil])
	</syntaxhighlight>		</syntaxhighlight>

Line 28:		Line 28:
	function()		function()
	-- create a window and create a scrollpane on it		-- create a window and create a scrollpane on it
	local window = DGS:~~dgsDxCreateWindow~~(5,5,130,150,"",false)		local window = DGS:dgsCreateWindow(5,5,130,150,"",false)
	-- the width and height values here are largely irrelevant as the scrollpane will automatically resize when needed		-- the width and height values here are largely irrelevant as the scrollpane will automatically resize when needed
	scrollpane = DGS:~~dgsDxCreateScrollPane~~(0,0,130,150,false,window)		scrollpane = DGS:dgsCreateScrollPane(0,0,130,150,false,window)
	end		end
	)		)
Line 46:		Line 46:
	for i,v in ipairs(getElementsByType("player")) do		for i,v in ipairs(getElementsByType("player")) do
	-- create a label with their name on the scrollpane		-- create a label with their name on the scrollpane
	DGS:~~dgsDxCreateLabel~~(5,i*20,90,20,tostring(getPlayerName(v)),false,scrollpane)		DGS:dgsCreateLabel(5,i*20,90,20,tostring(getPlayerName(v)),false,scrollpane)
	end		end
	end		end

Thisdp: /* Syntax */

2017-08-16T03:43:26Z

Syntax

← Older revision		Revision as of 03:43, 16 August 2017
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element dgsDxCreateScrollPane( float x, float y, float width, float height, bool relative, [~~dgs-~~element parent = nil])		element dgsDxCreateScrollPane( float x, float y, float width, float height, bool relative, [element parent = nil])
	</syntaxhighlight>		</syntaxhighlight>

Thisdp: Thisdp moved page Dgs/DgsDxCreateScrollPane to DgsDxCreateScrollPane

2017-07-02T02:01:11Z

Thisdp moved page Dgs/DgsDxCreateScrollPane to DgsDxCreateScrollPane

← Older revision

Revision as of 02:01, 2 July 2017

Thisdp at 09:09, 25 June 2017

2017-06-25T09:09:30Z

← Older revision		Revision as of 09:09, 25 June 2017
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	This creates a DGS scroll pane.		This creates a DGS scroll pane.
	[[Image:~~gui-scrollpane~~.png\|~~frame~~\|~~Example GUI ScrollPane.~~]]		[[Image:DGS_Scroll_Pane.png\|thumb\|DGS Scroll Pane]]

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Thisdp: /* Required Arguments */

2017-06-25T08:56:58Z

Required Arguments

← Older revision		Revision as of 08:56, 25 June 2017
Line 11:		Line 11:
	===Required Arguments===		===Required Arguments===
	*'''x:''' the 2D x offset of the DGS scrollpane from its parent. This is affected by the relative argument.		*'''x:''' the 2D x offset of the DGS scrollpane from its parent. This is affected by the relative argument.
	*'''y:''' the 2D y offset of the DGS ~~scrollbar~~ from its parent. This is affected by the relative argument.		*'''y:''' the 2D y offset of the DGS scrollpane from its parent. This is affected by the relative argument.
	*'''width:''' the width of the DGS scrollpane. This is affected by the relative argument.		*'''width:''' the width of the DGS scrollpane. This is affected by the relative argument.
	*'''height:''' the height of the DGS scrollpane. This is affected by the relative argument.		*'''height:''' the height of the DGS scrollpane. This is affected by the relative argument.

Thisdp: Created page with "{{Client function}} NOTOC This creates a DGS scroll pane. Example GUI ScrollPane. ==Syntax== element dgsD..."

2017-06-25T08:55:55Z

Created page with "{{Client function}} __NOTOC__ This creates a DGS scroll pane. frame|Example GUI ScrollPane. ==Syntax== <syntaxhighlight lang="lua"> element dgsD..."

New page

{{Client function}}
__NOTOC__
This creates a DGS scroll pane.
[[Image:gui-scrollpane.png|frame|Example GUI ScrollPane.]]

==Syntax==
<syntaxhighlight lang="lua">
element dgsDxCreateScrollPane( float x, float y, float width, float height, bool relative, [dgs-element parent = nil])
</syntaxhighlight>

===Required Arguments===
*'''x:''' the 2D x offset of the DGS scrollpane from its parent. This is affected by the relative argument.
*'''y:''' the 2D y offset of the DGS scrollbar from its parent. This is affected by the relative argument.
*'''width:''' the width of the DGS scrollpane. This is affected by the relative argument.
*'''height:''' the height of the DGS scrollpane. This is affected by the relative argument.
*'''relative:''' whether sizes and positions are relative to their parent's. If this is true, then all measures must be between 0 and 1, representing sizes/positions as a fraction of the parent widget's size.

===Optional Arguments===
*'''parent:''' the dgs-element this scrollpane is attached to. By default, it is nil, meaning the widget is attached to the background.

===Returns===
The dgs-element if created, otherwise false.

==Example==
This example creates a small window with a scrollpane on. Using the /fill command you can populate the scrollpane with the names of every player in the server.
<syntaxhighlight lang="lua">
DGS = exports.dgs
addEventHandler("onClientResourceStart",resourceRoot,
function()
-- create a window and create a scrollpane on it
local window = DGS:dgsDxCreateWindow(5,5,130,150,"",false)
-- the width and height values here are largely irrelevant as the scrollpane will automatically resize when needed
scrollpane = DGS:dgsDxCreateScrollPane(0,0,130,150,false,window)
end
)

addCommandHandler("fill",
function()
-- if the scrollpane exists
if scrollpane then
-- delete all the existing labels
for i,v in ipairs(DGS:dgsGetChildren(scrollpane)) do
destroyElement(v)
end

-- for every player in the server
for i,v in ipairs(getElementsByType("player")) do
-- create a label with their name on the scrollpane
DGS:dgsDxCreateLabel(5,i*20,90,20,tostring(getPlayerName(v)),false,scrollpane)
end
end
end
)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}