Dgs-dxgridlist

From Multi Theft Auto: Wiki
Revision as of 12:09, 1 September 2018 by Thisdp (talk | contribs)
Jump to navigation Jump to search

DGS Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxgridlist that you could use.

Main Functions

Properties

bgColor

This property determines the background color of the grid list. 

dgsSetProperty(gridlist,"bgColor",bgColor)
  • bgColor : An integer of the color that can be converted by tocolor.

bgImage

This property determines the background image of the grid list. 

dgsSetProperty(gridlist,"bgImage",bgImage)
  • bgImage : A material element that serves as the background image of the grid list (texture/shader/screen source/renderTarget).

columnImage

This property determines the background image of the column of the grid list. 

dgsSetProperty(gridlist,"columnImage",columnImage)
  • bgImage : A material element that serves as the background image of the column of the grid list (texture/shader/screen source/renderTarget).

columnColor

This property determines the background color of the column of the grid list. 

dgsSetProperty(gridlist,"columnColor",columnColor)
  • columnColor : An integer of the color that can be converted by tocolor.

columnTextColor

This property determines the color of the column text of the grid list. 

dgsSetProperty(gridlist,"columnTextColor",columnTextColor)
  • columnTextColor : An integer of the color that can be converted by tocolor.

columnTextSize

This property determines the scale of the column text of the grid list. 

dgsSetProperty(gridlist,"columnTextSize",{scaleX,scaleY})
  • scaleX : A float of the 2D X scale of the text of the column.
  • scaleY : A float of the 2D Y scale of the text of the column.

columnOffset

This property determines the global offset between the left border and column text. 

dgsSetProperty(gridlist,"columnOffset",columnOffset)
  • columnOffset : An integer of offset of the column.

columnData

This property stores column data. 

dgsSetProperty(gridlist,"columnData",columnData)
  • columnData : A table stores all column data.

Data Structure 

{
	{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
	{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
	{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
	...
}

columnRelative

This property determines whether the column length is relative or not. See dgsGridListSetColumnRelative/dgsGridListGetColumnRelative 

dgsSetProperty(gridlist,"columnRelative",columnRelative)
  • columnRelative : A bool of the relative state of the column length.

columnShadow

The shadow text of the column. 

dgsSetProperty(gridlist,"columnShadow",{offsetX,offsetY,color})
  • offsetX : A float of the 2D X offset of the shadow text of the column.
  • offsetY : A float of the 2D Y offset of the shadow text of the column.
  • color : An integer of the color of the shadow text of the column.

columnHeight

This property determines the column height of the grid list. 

dgsSetProperty(gridlist,"columnHeight",columnHeight)
  • columnHeight : An integer of column height of the grid list.

selectedColumn

This property stores the index of which column the cursor is hovering. See dgsGridListGetEnterColumn 

dgsSetProperty(gridlist,"selectedColumn",selectedColumn)
  • columnHeight : Column Index.

rowColor

This property determines the default 3 states' colors of row. See dgsGridListSetRowBackGroundColor/dgsGridListGetRowBackGroundColor 

dgsSetProperty(gridlist,"rowColor",{colorDefault,colorHoving,colorSelected})
  • colorDefault: An integer of the color of the row (Default State).
  • colorHoving: An integer of the color of the row (Hoving State).
  • colorSelected: An integer of the color of the row (Selected State).

rowImage

This property determines the default 3 states' background image of row. See dgsGridListGetRowBackGroundImage/dgsGridListSetRowBackGroundImage 

dgsSetProperty(gridlist,"rowImage",{imageDefault,cimageHoving,imageSelected})
  • imageDefault: A texture of the image of the row (Default State).
  • cimageHoving: A texture of the image of the row (Hoving State).
  • imageSelected: A texture of the image of the row (Selected State).

rowTextColor

This property determines the default color of the row text of the grid list. 

dgsSetProperty(gridlist,"rowTextColor",rowTextColor)
  • rowTextColor : An integer of the color that can be converted by tocolor.

rowTextSize

This property determines the default scale of the row text of the grid list. 

dgsSetProperty(gridlist,"rowTextSize",{scaleX,scaleY})
  • scaleX : A float of the 2D X scale of the text of the row.
  • scaleY : A float of the 2D Y scale of the text of the row.

rowData

This property stores row data. 

dgsSetProperty(gridlist,"rowData",rowData)
  • rowData : A table stores all row data.

Data Structure 

{

	[1] = {
		[-4] = columnOffset,				--columnOffset
		[-3] = {normal,hovering,selected},		--bgImage
		[-2] = true/false,				--selectable
		[-1] = true/false,				--clickable
		[0] = {normal,hovering,selected},		--bgColor
		[1] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable},	--Column 1
		[2] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable},	--Column 2
		...
	},		--Row 1
	[2] = {
		[-4] = columnOffset,				--columnOffset
		[-3] = {normal,hovering,selected},		--bgImage
		[-2] = true/false,				--selectable
		[-1] = true/false,				--clickable
		[0] = {normal,hovering,selected},		--bgColor
		[1] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable},	--Column 1
		[2] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable},	--Column 2
		...
	},		--Row 2
}

rowShadow

The shadow text of the row. 

dgsSetProperty(gridlist,"rowShadow",{offsetX,offsetY,color})
  • offsetX : A float of the 2D X offset of the shadow text of the row.
  • offsetY : A float of the 2D Y offset of the shadow text of the row.
  • color : An integer of the color of the shadow text of the row.

rowHeight

This property determines the row height of the grid list. 

dgsSetProperty(gridlist,"rowHeight",rowHeight)
  • rowHeight : An integer of row height of the grid list.

sortEnabled

This property determines whether sort is enabled. See dgsGridListSetSortEnabled/dgsGridListGetSortEnabled 

dgsSetProperty(gridlist,"sortEnabled",sortEnabled)
  • sortEnabled : A bool of sort state.

autoSort

This property determines whether auto sort is enabled. See dgsGridListSetAutoSortEnabled/dgsGridListGetAutoSortEnabled 

dgsSetProperty(gridlist,"autoSort",autoSort)
  • autoSort : A bool of auto sort state.

sortColumn

This property determines target sort column. See dgsGridListSetSortColumn 

dgsSetProperty(gridlist,"sortColumn",sortColumn)
  • sortColumn : An integer of the specific column to be sorted by.

sectionColumnOffset

This property determines offset of section row column (is different from but works with columnOffset). See dgsGridListSetRowAsSection 

dgsSetProperty(gridlist,"sectionColumnOffset",sectionColumnOffset)
  • sectionColumnOffset : An integer of the offset of section row column.

defaultColumnOffset

This property determines offset of normal row column (is different from but works with columnOffset). See dgsGridListSetRowAsSection 

dgsSetProperty(gridlist,"defaultColumnOffset",defaultColumnOffset)
  • defaultColumnOffset : An integer of the offset of normal row column.

scrollBarThick

This property determines the thickness of scroll bar. 

dgsSetProperty(gridlist,"scrollBarThick",scrollBarThick)
  • scrollBarThick : An integer of the thickness of scroll bar.

font

This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText 

dgsSetProperty(gridlist,"font",font)

sectionFont

This property determines the font of the text of which row is in section mode. Learn More dxDrawText 

dgsSetProperty(gridlist,"sectionFont",sectionFont)
  • sectionFont : A dx font element of the text of which row is in section mode.

colorcoded

Whether the color code is enabled or not. Learn More dxDrawText 

dgsSetProperty(gridlist,"colorcoded",colorcoded)
  • colorcoded : Set to true to enable embedded #FFFFFF color codes.

selectionMode

This property stores current selection mode of grid list. See dgsGridListSetSelectionMode/dgsGridListGetSelectionMode 

dgsSetProperty(gridlist,"selectionMode",selectionMode)
  • selectionMode : The mode of the selection. Can be the following values:
    • 1: row selection
    • 2: column selection
    • 3: cell selection

multiSelection

This property determines whether multi selection is enabled or not. See dgsGridListSetMultiSelectionEnabled/dgsGridListGetMultiSelectionEnabled 

dgsSetProperty(gridlist,"multiSelection",multiSelection)
  • multiSelection : A bool of the state of the multi selection.

mode

This property determines the render mode of grid list. 

dgsSetProperty(gridlist,"mode",mode)
  • mode : A bool of the state of render mode. Detail:
    • true : No render target mode (Crappy and have a lot of bugs but doesn't take video memory)
    • false : Render target mode (Great quality but takes video memory)

clip

Whether the clip property is enabled or not. Learn More dxDrawText 

dgsSetProperty(gridlist,"clip",clip)
  • clip : If set to true, the parts of the text that don't fit within the bounding box will be cut off.

scrollBarState

This property forces the visibility of scroll bar. See dgsGridListSetScrollBarState/dgsGridListGetScrollBarState 

dgsSetProperty(gridlist,"scrollBarState",{vertical,horizontal})
  • vertical : A bool of the state of the vertical scroll bar.
  • horizontal : A bool of the state of the horizontal scroll bar.
    • true : Force to be visible
    • false : Force to be invisible
    • nil : Auto

backgroundOffset

This property determines the offset between the left border and row background. 

dgsSetProperty(gridlist,"backgroundOffset",backgroundOffset)
  • backgroundOffset : An integer of the offset between the left border and row background.

rowSelect

This property stores the selected rows. 

dgsSetProperty(gridlist,"rowSelect",data)
  • data : the data.

Data Structure 

{
	[Column1] = {
		Row1,
		Row2,
		...
	},
	[Column2] = {
		Row1,
		Row2,
		...
	},
	...
}

preSelect

This property stores the item id the cursor is hovering on. 

dgsSetProperty(gridlist,"preSelect",{rowIndex,columnIndex})
  • rowIndex : Row Index
  • columnIndex: Column Index

leading

This property determines the space between rows. 

dgsSetProperty(gridlist,"leading",leading)
  • leading : How many pixels between rows

See Also

General Properties

Unique Properties For DGS Core Elements

Extra Properties For DGS Plugins

Retrieved from "https://wiki.multitheftauto.com/wiki/Dgs-dxgridlist?oldid=58780"