CustomWidget:destroy

This function destroying Custom Widget.

Syntax

nil CustomWidget:destroy()

Information

After destroying object, variable still has methods, but GUI is destroying. Suppose that developer will never use variable of destroyed object, and set it to nil after destroying. Any methods working on destroyed object, but it will sends error in debug, because objects is doesn't exists.

Example

This example creating window with button, and then destroys window:

local Window = CustomWindow.create(100, 100, 200, 200, "Example", false)
local Button = CustomButton.create(50, 25, 100, 30, "Button", false, Window)

local Event = Window:addEvent("onClientGUIClick", function()
	outputChatBox("You've clicked on window")
end)

Window:removeEvent("onClientGUIClick", Event)

Window:destroy()
Window = nil --Suppose that developer will never use this variable as object, what destroyed in previous step

See Also

Resource Wiki with content located here: Resource:CustomWidgets

Custom Widgets

This methods working for all elements except CustomDialogs and CustomTooltips

Set Functions

• CustomWidget:setPosition
• CustomWidget:setSize
• CustomWidget:setVisible
• CustomWidget:setEnabled
• CustomWidget:setColorScheme
• CustomWidget:setFont
• CustomWidget:setFontSize
• CustomWidget:setSystemFont

Get Functions

• CustomWidget:getPosition
• CustomWidget:getSize
• CustomWidget:getRealSize
• CustomWidget:getVisible
• CustomWidget:getEnabled
• CustomWidget:getColorScheme
• CustomWidget:getFont
• CustomWidget:getFontSize
• getCWType

Event Functions

• CustomWidget:bringToFront
• CustomWidget:moveToBack
• CustomWidget:addEvent
• CustomWidget:removeEvent
• CustomWidget:destroy
• proceedColor

Custom Windows

Create Function

• CustomWindow.create

Set Functions

• CustomWindow:setTitle
• CustomWindow:setText
• CustomWindow:setMovable
• CustomWindow:setSizable
• CustomWindow:setCloseEnabled
• CustomWindow:setSideBarLength
• CustomWindow:setSideBarPosition
• CustomWindow:setMinimalWidth
• CustomWindow:setMinimalHeight
• CustomWindow:setMinimalSize
• CustomWindow:setMaximalWidth
• CustomWindow:setMaximalHeight
• CustomWindow:setMaximalSize

Get Functions

• CustomWindow:getTitle
• CustomWindow:getText
• CustomWindow:getMovable
• CustomWindow:getSizable
• CustomWindow:getCloseEnabled
• CustomWindow:getSideBarLength
• CustomWindow:getSideBarPosition
• CustomWindow:getMinimalWidth
• CustomWindow:getMinimalHeight
• CustomWindow:getMinimalSize
• CustomWindow:getMaximalWidth
• CustomWindow:getMaximalHeight
• CustomWindow:getMaximalSize

Event Functions

• CustomWindow:open
• CustomWindow:close
• CustomWindow:addElement
• CustomWindow:addElements
• CustomWindow:showDialog
• CustomWindow:showBar
• CustomWindow:getMainElement
• CustomWindow:getHeader
• CustomWindow:getDialog

Custom Buttons

Create Function

• CustomButton.create

Set Functions

• CustomButton:setText
• CustomButton:setImage

Get Functions

• CustomButton:getText
• CustomButton:getImage

Event Functions

• CustomButton:getMainElement

Custom Progress Bars

Create Function

• CustomProgressBar.create

Set Functions

• CustomProgressBar:setProgress

Get Functions

• CustomProgressBar:getProgress

Event Functions

• CustomProgressBar:getMainElement

Custom Scroll Bars

Create Function

• CustomScrollBar.create

Set Functions

• CustomScrollBar:setScrollPosition
• CustomScrollBar:setScrollLength
• CustomScrollBar:setScrollSpeed

Get Functions

• CustomScrollBar:getScrollPosition
• CustomScrollBar:getScrollLength
• CustomScrollBar:getScrollSpeed

Custom Edit Boxes

All functions, what has mark CustomEditBox available for CustomEdit, CustomMemo and CustomSpinner.

Create Functions

• CustomEdit.create
• CustomMemo.create
• CustomSpinner.create

Set Functions

• CustomEditBox:setReadOnly
• CustomEditBox:setText
• CustomEditBox:setCaretIndex
• CustomEditBox:setSidesColor

• CustomEdit:setMasked
• CustomEdit:setMaxLength

• CustomSpinner:setMinimal
• CustomSpinner:setMaximal
• CustomSpinner:setStepSize

Get Functions

• CustomEditBox:getReadOnly
• CustomEditBox:getText
• CustomEditBox:getCaretIndex
• CustomEditBox:isOnSide
• CustomEditBox:getSidesColor

• CustomEdit:getMasked
• CustomEdit:getMaxLength

• CustomSpinner:getMinimal
• CustomSpinner:getMaximal
• CustomSpinner:getStepSize

Event Functions

• CustomEditBox:putOnSide

Custom Check Boxes

Create Function

• CustomCheckBox.create

Set Functions

• CustomCheckBox:setText
• CustomCheckBox:setChecked

Get Functions

• CustomCheckBox:getText
• CustomCheckBox:getChecked

Event Functions

• CustomCheckBox:getMainElement

Custom Combo Boxes

Create Function

• CustomComboBox.create

Set Functions

• CustomComboBox:setSelectedItem
• CustomComboBox:setItemText
• CustomComboBox:setMaxHeight

Get Functions

• CustomComboBox:getSelectedItem
• CustomComboBox:getItemText
• CustomComboBox:getMaxHeight
• CustomComboBox:getItemsCount
• CustomComboBox:getItems

Event Functions

• CustomComboBox:addItem
• CustomComboBox:removeItem
• CustomComboBox:clear
• CustomComboBox:getMainElement

Custom Tabbed Panels

Create Function

• CustomTabPanel.create

Set Functions

• CustomTabPanel:setTabVisible
• CustomTabPanel:setTabEnabled
• CustomTabPanel:setTabText
• CustomTabPanel:setSelectedTab
• CustomTabPanel:setTabsMinLength

Get Functions

• CustomTabPanel:getTabVisible
• CustomTabPanel:getTabEnabled
• CustomTabPanel:getTabText
• CustomTabPanel:getTabFromText
• CustomTabPanel:getSelectedTab
• CustomTabPanel:getTabsMinLength
• CustomTabPanel:getTabHeader

Event Functions

• CustomTabPanel:addTab
• CustomTabPanel:removeTab
• CustomTabPanel:clearTabs
• CustomTabPanel:getMainElement

Custom Labels

Create Function

• CustomLabel.create

Set Functions

• CustomLabel:setText
• CustomLabel:setColor
• CustomLabel:setSchematicalColor
• CustomLabel:setHoverable
• CustomLabel:setVerticalAlign
• CustomLabel:setHorizontalAlign
• CustomLabel:setAlign

Get Functions

• CustomLabel:getText
• CustomLabel:getColor
• CustomLabel:getVerticalAlign
• CustomLabel:getHorizontalAlign
• CustomLabel:isSchematicalColor
• CustomLabel:isHoverable

Event Functions

• CustomLabel:getMainElement
• CustomLabel:addElement
• CustomLabel:removeElement

Custom Dialogs

Create Function

• CustomDialog.create

Event Functions

• CustomDialog:open
• CustomDialog:close

Custom Tool Tips

Create Function

• CustomTooltip.create

Set Function

• CustomTooltip:setShowTime
• CustomTooltip:setText

Get Function

• CustomTooltip:getShowTime
• CustomTooltip:getText

Custom Loadings

Create Function

• CustomLoading.create

Set Functions

• CustomLoading:setProgress
• CustomLoading:setAnimated

Get Functions

• CustomLoading:getProgress
• CustomLoading:getAnimated

Custom Scroll Panes

Create Function

• CustomScrollPane.create

Set Functions

• CustomScrollPane:setScrollSpeed
• CustomScrollPane:setVerticalScrollPosition
• CustomScrollPane:setHorizontalScrollPosition
• CustomScrollPane:setVerticalScrollInversed
• CustomScrollPane:setHorizontalScrollInversed
• CustomScrollPane:setHorizontalScrolling
• CustomScrollPane:setScrollingWithCursor
• CustomScrollPane:setScrollingWithWheel
• CustomScrollPane:addVerticalPixelScrollPosition
• CustomScrollPane:addHorizontalPixelScrollPosition

Get Functions

• CustomScrollPane:getScrollSpeed
• CustomScrollPane:getVerticalScrollPosition
• CustomScrollPane:getHorizontalScrollPosition
• CustomScrollPane:isVerticalScrollInversed
• CustomScrollPane:isHorizontalScrollInversed
• CustomScrollPane:isHorizontalScrolling
• CustomScrollPane:getScrollingWithCursor
• CustomScrollPane:getScrollingWithWheel

Event Functions

• CustomScrollPane:getMainElement
• CustomScrollPane:addElement
• CustomScrollPane:removeElement
• CustomScrollPane:update

Custom Table Views

Create Function

• CustomTableView.create

Set Functions

• CustomTableView:setSelectedLine
• CustomTableView:setIndentation
• CustomTableView:setTitleBarVisible
• CustomTableView:setLineHeight
• CustomTableView:setColumnWidth
• CustomTableView:setColumnTitle
• CustomTableView:setCellText
• CustomTableView:setShadowsEnabled

Get Functions

• CustomTableView:getSelectedLine
• CustomTableView:getIndentation
• CustomTableView:getTitleBarVisible
• CustomTableView:getLineHeight
• CustomTableView:getColumnWidth
• CustomTableView:getColumnTitle
• CustomTableView:getCellText
• CustomTableView:getCell
• CustomTableView:getLinesCount
• CustomTableView:getColumnsCount
• CustomTableView:getShadowsEnabled

Event Functions

• CustomTableView:addLine
• CustomTableView:removeLine
• CustomTableView:clearLines
• CustomTableView:addColumn
• CustomTableView:removeColumn
• CustomTableView:update

Custom Static Images

Create Function

• CustomStaticImage.create

Set Function

• CustomStaticImage:setColor
• CustomStaticImage:setImage
• CustomStaticImage:setSchematicalColor

Get Function

• CustomStaticImage:getColor
• CustomStaticImage:getImage
• CustomStaticImage:getNativeSize
• CustomStaticImage:isSchematicalColor

Event Functions

• CustomStaticImage:getMainElement
• CustomStaticImage:addElement

Custom Text Boxes

Create Function

• CustomTextBox.create
• CustomMemoBox.create

Set Function

• CustomTextBox:setText
• CustomTextBox:setColor
• CustomTextBox:setCaretIndex
• CustomTextBox:setReadOnly
• CustomTextBox:setMasked
• CustomTextBox:setBordersEnabled
• CustomTextBox:setBackgroundEnabled

Get Function

• CustomTextBox:getText
• CustomTextBox:getColor
• CustomTextBox:getCaretIndex
• CustomTextBox:getCaretSelectionStart
• CustomTextBox:getCaretSelectionEnd
• CustomTextBox:getCaretSelectionLength
• CustomTextBox:isReadOnly
• CustomTextBox:isMasked
• CustomTextBox:isBordersEnabled
• CustomTextBox:isBackgroundEnabled

Custom Events

• onCustomScrollPaneScrolled
• onCustomScrollBarScrolled
• onCustomDialogClick
• onCustomWindowClose
• onCustomCheckBoxChecked
• onCustomComboBoxSelectItem
• onCustomTabPanelChangeTab

Other about Custom Widgets

• CustomWidgets.Variables
• CustomWidgets.Examples
• CustomWidgets.DemoWidgets