CT COMBO: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Redirected page to DialogControls-Combo)
 
(page overhaul)
Tag: Removed redirect
Line 1: Line 1:
#REDIRECT [[DialogControls-Combo]]
{{CT|intro
|macro = CT_COMBO
|value = 4
|description = A drop down menu.<br><br>
[[File:CT COMBO.jpg]]
|commands =
* [[:Category:Command_Group:_GUI_Control_-_ListBox|Commands: Listbox]]
|events =
* [[User_Interface_Event_Handlers#Listbox_events|Events: Listbox]]
}}
 
{{CT|abc start}}
=== A ===
{{CT|attribute
|name=arrowEmpty
|type1=String
|value1="\A3\ui_f\data\GUI\RscCommon\rsccombo\arrow_combo_ca.paa"
|description=Texture of the collapsed control.
}}
 
{{CT|attribute
|name=arrowFull
|type1=String
|value1="\A3\ui_f\data\GUI\RscCommon\rsccombo\arrow_combo_active_ca.paa"
|description=Texture of the expanded control.
}}
 
=== C ===
{{CT|attribute
|name=colorActive
|type1=Array
|value1={1,0,0,1}
|description=
}}
 
{{CT|attribute
|name=colorPicture
|type1=Array
|value1={1,1,1,1}
|description=
}}
 
{{CT|attribute
|name=colorPictureDisabled
|type1=Array
|value1={1,1,1,0.25}
|description=
}}
 
{{CT|attribute
|name=colorPictureRight
|type1=Array
|value1={1,1,1,1}
|description=
}}
 
{{CT|attribute
|name=colorPictureRightDisabled
|type1=Array
|value1={1,1,1,0.25}
|description=
}}
 
{{CT|attribute
|name=colorPictureRightSelected
|type1=Array
|value1={1,1,1,1}
|description=
}}
 
{{CT|attribute
|name=colorPictureSelect
|type1=Array
|value1={1,1,1,1}
|description=
}}
 
{{CT|attribute
|name=colorPictureSelected
|type1=Array
|value1={1,1,1,1}
|description=
}}
 
{{CT|attribute
|name=colorScrollbar
|type1=Array
|value1={1,0,0,1}
|description=
}}
 
{{CT|attribute
|name=colorSelect
|type1=Array
|value1={0,0,0,1}
|description=
}}
 
{{CT|attribute
|name=colorSelect2Right
|type1=Array
|value1={0,0,0,1}
|description=
}}
 
{{CT|attribute
|name=colorSelectBackground
|type1=Array
|value1={1,1,1,0.7}
|description=
}}
 
{{CT|attribute
|name=colorSelectRight
|type1=Array
|value1={0,0,0,1}
|description=
}}
 
{{CT|attribute
|name=colorTextRight
|type1=Array
|value1={1,1,1,1}
|description=
}}
 
{{CT|attribute
|name=ComboScrollBar
|type1=Class
|value1=class ComboScrollBar
{
color[] = {1,1,1,1};
colorActive[] = {1,1,1,1};
colorDisabled[] = {1,1,1,0.3};
thumb = "\A3\ui_f\data\gui\cfg\scrollbar\thumb_ca.paa";
arrowEmpty = "\A3\ui_f\data\gui\cfg\scrollbar\arrowEmpty_ca.paa";
arrowFull = "\A3\ui_f\data\gui\cfg\scrollbar\arrowFull_ca.paa";
border = "\A3\ui_f\data\gui\cfg\scrollbar\border_ca.paa";
shadow = 0;
scrollSpeed = 0.06;
width = 0;
height = 0;
autoScrollEnabled = 0;
autoScrollSpeed = -1;
autoScrollDelay = 5;
autoScrollRewind = 0;
};
|description=The scrollbar that is visible when there are more elements than wholeHeight can display.
}}
 
=== E ===
{{CT|attribute
|name=ExtendedTooltip
|type1=Class
|value1=class ExtendedTooltip
{
size = "0.028 * SafezoneH";
colorPremium[] = {1,0.502,0,1};
deletable = 0;
fade = 0;
access = 0;
type = 13;
idc = -1;
style = 0;
colorText[] = {1,1,1,1};
class Attributes
{
font = "RobotoCondensed";
color = "#ffffff";
colorLink = "#D09B43";
align = "left";
shadow = 1;
};
x = 0;
y = 0;
h = 0.035;
w = 0.1;
text = "";
shadow = 1;
};
|description=
}}
 
=== F ===
{{CT|attribute
|name=from
|type1=Number
|value1=1982
|description=Probably used in conjunction with {{Inline code|to}}
}}
 
=== G ===
{{CT|attribute
|name=gridType
|type1=String
|value1="scaling"
|description=
}}
 
=== I ===
{{CT|attribute
|name=Items
|type1=Class
|value1=class Items
{
class Alphabet
{
text = "Sort alphabetically";
default = 1;
};
class Mod
{
text = "Sort by mod";
};
};
|description=List of entries.
{{{!}}class="wikitable" border="1" align="left" cellpadding="3" cellspacing="0" {{!}}
! colspan="3" bgcolor="#bbbbff" {{!}} Items
{{!}}-
! bgcolor="#ddddff" {{!}} Name
! bgcolor="#ddddff" {{!}} Type
! bgcolor="#ddddff" {{!}} Remark
{{!}}-
{{!}} '''text'''
{{!}} [[String]]
{{!}} Displayed text (equal to [[lbAdd]])
{{!}}-
{{!}} '''value'''
{{!}} [[Number]]
{{!}} Value of the entry (equal to [[lbSetValue]])
{{!}}-
{{!}} '''data'''
{{!}} [[String]]
{{!}} Data of the entry (equal to [[lbSetData]])
{{!}}-
{{!}} '''picture'''
{{!}} [[String]]
{{!}} Picture displayed on the left (equal to [[lbSetPicture]])
{{!}}-
{{!}} '''pictureRight'''
{{!}} [[String]]
{{!}} Picture displayed on the right (equal to [[lbSetPictureRight]])
{{!}}-
{{!}} '''default'''
{{!}} [[Number]]
{{!}} Sets this entry as the by default selected (equal to [[lbSetCurSel]])
{{!}}-
{{!}} '''color'''
{{!}} [[Color{{!}}Color (RGBA)]]
{{!}} Text color of the entry (equal to [[lbSetColor]])
{{!}}-
{{!}} '''tooltip'''
{{!}} [[String]]
{{!}} Tooltip of the entry (equal to [[lbSetTooltip]])
{{!}}-
{{!}}}<br clear="all">
}}
 
=== M ===
{{CT|attribute
|name=maxHistoryDelay
|type1=Number
|value1=1
|description=
}}
 
=== R ===
{{CT|attribute
|name=rows
|type1=Number
|value1=2
|description=
}}
 
=== S ===
{{CT|attribute
|name=soundCollapse
|type1=Array
|value1={"\A3\ui_f\data\sound\RscCombo\soundCollapse",0.1,1}
|description=Sound played when the combobox is collapsed.
}}
 
{{CT|attribute
|name=soundExpand
|type1=Array
|value1={"\A3\ui_f\data\sound\RscCombo\soundExpand",0.1,1}
|description=Sound played when the combobox is expanded
}}
 
{{CT|attribute
|name=soundSelect
|type1=Array
|value1={"\A3\ui_f\data\sound\RscCombo\soundSelect",0.1,1}
|description=Sound played when an item from the combobox is selected.
}}
 
=== T ===
{{CT|attribute
|name=to
|type1=Number
|value1=2050
|description=Probably used in conjunction with {{Inline code|from}}
}}
 
=== W ===
{{CT|attribute
|name=wholeHeight
|type1=Number
|value1=0.45
|type2=String
|value2="12 * 5 * (pixelH * pixelGrid * 0.50)"
|description=Limits the height of the expanded combobox.
}}
 
{{CT|abc end}}
 
{{CT|examples}}
=== RscExample ===
<syntaxhighlight lang="cpp">
class RscCombo
{
deletable = 0;
fade = 0;
access = 0;
type = CT_COMBO;
colorSelect[] = {0,0,0,1};
colorText[] = {1,1,1,1};
colorBackground[] = {0,0,0,1};
colorScrollbar[] = {1,0,0,1};
colorDisabled[] = {1,1,1,0.25};
colorPicture[] = {1,1,1,1};
colorPictureSelected[] = {1,1,1,1};
colorPictureDisabled[] = {1,1,1,0.25};
colorPictureRight[] = {1,1,1,1};
colorPictureRightSelected[] = {1,1,1,1};
colorPictureRightDisabled[] = {1,1,1,0.25};
colorTextRight[] = {1,1,1,1};
colorSelectRight[] = {0,0,0,1};
colorSelect2Right[] = {0,0,0,1};
tooltipColorText[] = {1,1,1,1};
tooltipColorBox[] = {1,1,1,1};
tooltipColorShade[] = {0,0,0,0.65};
soundSelect[] =
{
"\A3\ui_f\data\sound\RscCombo\soundSelect",
0.1,
1
};
soundExpand[] =
{
"\A3\ui_f\data\sound\RscCombo\soundExpand",
0.1,
1
};
soundCollapse[] =
{
"\A3\ui_f\data\sound\RscCombo\soundCollapse",
0.1,
1
};
maxHistoryDelay = 1;
class ComboScrollBar: ScrollBar
{
color[] = {1,1,1,1};
};
style = ST_MULTI + ST_NO_RECT;
font = "RobotoCondensed";
sizeEx = GUI_TEXT_SIZE_MEDIUM;
shadow = 0;
x = 0;
y = 0;
w = 0.12;
h = 0.035;
colorSelectBackground[] = {1,1,1,0.7};
arrowEmpty = "\A3\ui_f\data\GUI\RscCommon\rsccombo\arrow_combo_ca.paa";
arrowFull = "\A3\ui_f\data\GUI\RscCommon\rsccombo\arrow_combo_active_ca.paa";
wholeHeight = 0.45;
colorActive[] = {1,0,0,1};
};
</syntaxhighlight>

Revision as of 13:51, 29 November 2020

Introduction

A drop down menu.

CT COMBO.jpg


Related commands & functions

Related User Interface Eventhandlers

Alphabetical Order

TokenNames common to most controls, such as x, y, w, h, text, idc... can be found here.
Not all of the listed attributes might have an effect nor might the list be complete. All attributes were gathered with this config crawler.
#define CT_COMBO 4


A

arrowEmpty

Type
String
Description
Texture of the collapsed control.
arrowEmpty = "\A3\ui_f\data\GUI\RscCommon\rsccombo\arrow_combo_ca.paa";


arrowFull

Type
String
Description
Texture of the expanded control.
arrowFull = "\A3\ui_f\data\GUI\RscCommon\rsccombo\arrow_combo_active_ca.paa";


C

colorActive

Type
Array
Description
n/a
colorActive[] = {1,0,0,1};


colorPicture

Type
Array
Description
n/a
colorPicture[] = {1,1,1,1};


colorPictureDisabled

Type
Array
Description
n/a
colorPictureDisabled[] = {1,1,1,0.25};


colorPictureRight

Type
Array
Description
n/a
colorPictureRight[] = {1,1,1,1};


colorPictureRightDisabled

Type
Array
Description
n/a
colorPictureRightDisabled[] = {1,1,1,0.25};


colorPictureRightSelected

Type
Array
Description
n/a
colorPictureRightSelected[] = {1,1,1,1};


colorPictureSelect

Type
Array
Description
n/a
colorPictureSelect[] = {1,1,1,1};


colorPictureSelected

Type
Array
Description
n/a
colorPictureSelected[] = {1,1,1,1};


colorScrollbar

Type
Array
Description
n/a
colorScrollbar[] = {1,0,0,1};


colorSelect

Type
Array
Description
n/a
colorSelect[] = {0,0,0,1};


colorSelect2Right

Type
Array
Description
n/a
colorSelect2Right[] = {0,0,0,1};


colorSelectBackground

Type
Array
Description
n/a
colorSelectBackground[] = {1,1,1,0.7};


colorSelectRight

Type
Array
Description
n/a
colorSelectRight[] = {0,0,0,1};


colorTextRight

Type
Array
Description
n/a
colorTextRight[] = {1,1,1,1};


ComboScrollBar

Type
Class
Description
The scrollbar that is visible when there are more elements than wholeHeight can display.
class ComboScrollBar
{
	color[] = {1,1,1,1};
	colorActive[] = {1,1,1,1};
	colorDisabled[] = {1,1,1,0.3};
	thumb = "\A3\ui_f\data\gui\cfg\scrollbar\thumb_ca.paa";
	arrowEmpty = "\A3\ui_f\data\gui\cfg\scrollbar\arrowEmpty_ca.paa";
	arrowFull = "\A3\ui_f\data\gui\cfg\scrollbar\arrowFull_ca.paa";
	border = "\A3\ui_f\data\gui\cfg\scrollbar\border_ca.paa";
	shadow = 0;
	scrollSpeed = 0.06;
	width = 0;
	height = 0;
	autoScrollEnabled = 0;
	autoScrollSpeed = -1;
	autoScrollDelay = 5;
	autoScrollRewind = 0;
};


E

ExtendedTooltip

Type
Class
Description
n/a
class ExtendedTooltip
{
	size = "0.028 * SafezoneH";
	colorPremium[] = {1,0.502,0,1};
	deletable = 0;
	fade = 0;
	access = 0;
	type = 13;
	idc = -1;
	style = 0;
	colorText[] = {1,1,1,1};
	class Attributes
	{
		font = "RobotoCondensed";
		color = "#ffffff";
		colorLink = "#D09B43";
		align = "left";
		shadow = 1;
	};
	x = 0;
	y = 0;
	h = 0.035;
	w = 0.1;
	text = "";
	shadow = 1;
};


F

from

Type
Number
Description
Probably used in conjunction with to
from = 1982;


G

gridType

Type
String
Description
n/a
gridType = "scaling";


I

Items

Type
Class
Description
List of entries.
Items
Name Type Remark
text String Displayed text (equal to lbAdd)
value Number Value of the entry (equal to lbSetValue)
data String Data of the entry (equal to lbSetData)
picture String Picture displayed on the left (equal to lbSetPicture)
pictureRight String Picture displayed on the right (equal to lbSetPictureRight)
default Number Sets this entry as the by default selected (equal to lbSetCurSel)
color Color (RGBA) Text color of the entry (equal to lbSetColor)
tooltip String Tooltip of the entry (equal to lbSetTooltip)

class Items
{
	class Alphabet
	{
		text = "Sort alphabetically";
		default = 1;
	};
	class Mod
	{
		text = "Sort by mod";
	};
};


M

maxHistoryDelay

Type
Number
Description
n/a
maxHistoryDelay = 1;


R

rows

Type
Number
Description
n/a
rows = 2;


S

soundCollapse

Type
Array
Description
Sound played when the combobox is collapsed.
soundCollapse[] = {"\A3\ui_f\data\sound\RscCombo\soundCollapse",0.1,1};


soundExpand

Type
Array
Description
Sound played when the combobox is expanded
soundExpand[] = {"\A3\ui_f\data\sound\RscCombo\soundExpand",0.1,1};


soundSelect

Type
Array
Description
Sound played when an item from the combobox is selected.
soundSelect[] = {"\A3\ui_f\data\sound\RscCombo\soundSelect",0.1,1};


T

to

Type
Number
Description
Probably used in conjunction with from
to = 2050;


W

wholeHeight

Type
Number, String
Description
Limits the height of the expanded combobox.

Number example:

wholeHeight = 0.45;

String example:

wholeHeight = "12 * 	5 * (pixelH * pixelGrid * 	0.50)";



Default Classes

Arma 3
AddOns: Classes need to be initialised first with class SomeClass;

Missions: Since Arma 3 v2.02 one can use import SomeClass; to initialise a class (see the import keyword).

In older versions, use "Default" call BIS_fnc_exportGUIBaseClasses; and paste the result into the description.ext.

RscExample

class RscCombo
{
	deletable = 0;
	fade = 0;
	access = 0;
	type = CT_COMBO;
	colorSelect[] = {0,0,0,1};
	colorText[] = {1,1,1,1};
	colorBackground[] = {0,0,0,1};
	colorScrollbar[] = {1,0,0,1};
	colorDisabled[] = {1,1,1,0.25};
	colorPicture[] = {1,1,1,1};
	colorPictureSelected[] = {1,1,1,1};
	colorPictureDisabled[] = {1,1,1,0.25};
	colorPictureRight[] = {1,1,1,1};
	colorPictureRightSelected[] = {1,1,1,1};
	colorPictureRightDisabled[] = {1,1,1,0.25};
	colorTextRight[] = {1,1,1,1};
	colorSelectRight[] = {0,0,0,1};
	colorSelect2Right[] = {0,0,0,1};
	tooltipColorText[] = {1,1,1,1};
	tooltipColorBox[] = {1,1,1,1};
	tooltipColorShade[] = {0,0,0,0.65};
	soundSelect[] =
	{
		"\A3\ui_f\data\sound\RscCombo\soundSelect",
		0.1,
		1
	};
	soundExpand[] =
	{
		"\A3\ui_f\data\sound\RscCombo\soundExpand",
		0.1,
		1
	};
	soundCollapse[] =
	{
		"\A3\ui_f\data\sound\RscCombo\soundCollapse",
		0.1,
		1
	};
	maxHistoryDelay = 1;
	class ComboScrollBar: ScrollBar
	{
		color[] = {1,1,1,1};
	};
	style = ST_MULTI + ST_NO_RECT;
	font = "RobotoCondensed";
	sizeEx = GUI_TEXT_SIZE_MEDIUM;
	shadow = 0;
	x = 0;
	y = 0;
	w = 0.12;
	h = 0.035;
	colorSelectBackground[] = {1,1,1,0.7};
	arrowEmpty = "\A3\ui_f\data\GUI\RscCommon\rsccombo\arrow_combo_ca.paa";
	arrowFull = "\A3\ui_f\data\GUI\RscCommon\rsccombo\arrow_combo_active_ca.paa";
	wholeHeight = 0.45;
	colorActive[] = {1,0,0,1};
};