DgsGetParent: Difference between revisions
Jump to navigation
Jump to search
(DGS OOP Syntax changing) |
|||
(8 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{Client function}} | ||
__NOTOC__ | __NOTOC__ | ||
This function is used to determine the parent of a DGS ''element''. | This function is used to determine the parent of a DGS ''element''. | ||
{{Note|dgsGetParent only works with DGS elements.}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
element dgsGetParent( element theElement ) | element dgsGetParent( element theElement ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{DGS/OOP| | |||
Method = DGSElement:getParent| | |||
Variable = parent| | |||
Counterpart = dgsSetParent | |||
}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
Line 15: | Line 20: | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
DGS = exports.dgs | DGS = exports.dgs | ||
local window = DGS: | local window = DGS:dgsCreateWindow(500, 500, 300, 300, "test window", false) -- create a window | ||
local child = DGS: | local child = DGS:dgsCreateLabel(0, 0, 300, 20, "test label", false, window) -- create a label on the window | ||
local parent = DGS:dgsGetParent(child) -- get the parent of the label | local parent = DGS:dgsGetParent( child ) -- get the parent of the label | ||
outputChatBox(DGS:dgsGetType(parent)) -- output the type of the parent ( dgs-dxwindow ) | outputChatBox( DGS:dgsGetType( parent ) ) -- output the type of the parent ( dgs-dxwindow ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{ | |||
===<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>=== | |||
{{DGS General Functions}} | |||
===<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>=== | |||
{{DGS Events/General}} |
Latest revision as of 18:59, 3 May 2021
This function is used to determine the parent of a DGS element.
Syntax
element dgsGetParent( element theElement )
DGS OOP Syntax Help! I don't understand this!
- Method: DGSElement:getParent(...)
- Variable: .parent
- Counterpart: dgsSetParent
Required Arguments
- theElement: The child of the parent element you want returned.
Returns
This returns the parent as a DGS element. It returns false if theElement is invalid, or false (You can think of it as the screen or root).
Example
DGS = exports.dgs local window = DGS:dgsCreateWindow(500, 500, 300, 300, "test window", false) -- create a window local child = DGS:dgsCreateLabel(0, 0, 300, 20, "test label", false, window) -- create a label on the window local parent = DGS:dgsGetParent( child ) -- get the parent of the label outputChatBox( DGS:dgsGetType( parent ) ) -- output the type of the parent ( dgs-dxwindow )
See Also
General Functions
- dgsGetPosition
- dgsSetPosition
- dgsSetParent
- dgsGetParent
- dgsGetChild
- dgsGetChildren
- dgsGetSize
- dgsSetSize
- dgsGetType
- dgsSetLayer
- dgsGetLayer
- dgsSetCurrentLayerIndex
- dgsGetCurrentLayerIndex
- dgsGetLayerElements
- dgsGetProperty
- dgsSetProperty
- dgsSetPropertyInherit
- dgsGetProperties
- dgsSetProperties
- dgsGetVisible
- dgsSetVisible
- dgsGetEnabled
- dgsSetEnabled
- dgsGetPositionAlignment
- dgsSetPositionAlignment
- dgsGetAlpha
- dgsSetAlpha
- dgsGetFont
- dgsSetFont
- dgsGetText
- dgsSetText
- dgsGetPostGUI
- dgsSetPostGUI
- dgsGetInputEnabled
- dgsSetInputEnabled
- dgsGetInputMode
- dgsSetInputMode
- dgsAttachToAutoDestroy
- dgsDetachFromAutoDestroy
- dgsFocus
- dgsBlur
- dgsCreateFont
- dgsBringToFront
- dgsMoveToBack
- dgsGetScreenSize
- dgsGetCursorPosition
- dgsGetMouseEnterGUI
- dgsGetMouseLeaveGUI
- dgsIsMouseWithinGUI
- dgsSetSystemFont
- dgsGetSystemFont
- dgsGetElementsInLayer
- dgsGetElementsFromResource
- dgsGetFocusedGUI
- dgsImportFunction
- dgsImportOOPClass
- dgsG2DLoadHooker
- dgsSetRenderSetting
- dgsGetRenderSetting
- dgsSimulateClick
- dgsGetRootElement
- dgsAddMoveHandler
- dgsRemoveMoveHandler
- dgsIsMoveHandled
- dgsAddSizeHandler
- dgsRemoveSizeHandler
- dgsIsSizeHandled
- dgsAttachElements
- dgsDetachElements
- dgsElementIsAttached
- dgsAddPropertyListener
- dgsRemovePropertyListener
- dgsGetListenedProperties
- dgsSetMultiClickInterval
- dgsGetMultiClickInterval
- dgsSetMouseStayDelay
- dgsGetMouseStayDelay
- dgsCenterElement
- dgsSetElementKeeperEnabled
- dgsGetElementKeeperEnabled
- dgsSetClickingSound
- dgsGetClickingSound
- dgsSetClickingSoundVolume
- dgsGetClickingSoundVolume
General Events
- onDgsBlur
- onDgsCreate
- onDgsCursorTypeChange
- onDgsCursorStateChange
- onDgsDestroy
- onDgsElementRender
- onDgsElementMove
- onDgsElementSize
- onDgsElementEnter
- onDgsElementLeave
- onDgsFocus
- onDgsKey
- onDgsPositionChange
- onDgsPreRender
- onDgsRender
- onDgsElementScroll
- onDgsSizeChange
- onDgsTextChange
- onDgsWindowClose
- onDgsPropertyChange