BIS fnc initListNBoxSorting: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.56|Game version=
|1.56


|gr1= GUI |GROUP1=
|gr1= GUI


| Automatically creates buttons and sets them up so they can be used to sort a [[CT_LISTNBOX]]. The buttons will automatically be resized to the column width of given <tt>controlFilter</tt>.
| Automatically creates buttons and sets them up so they can be used to sort a [[CT_LISTNBOX]]. The buttons will automatically be resized to the column width of given <tt>controlFilter</tt>.
Line 18: Line 18:
** To keep a uniform style between vanilla controls and custom ones it's advisable to create a background with [[CT_STATIC]] behind the <tt>controlFilter</tt> with </tt>colorBackground[] {{=}} {0,0,0,1};</tt>}}
** To keep a uniform style between vanilla controls and custom ones it's advisable to create a background with [[CT_STATIC]] behind the <tt>controlFilter</tt> with </tt>colorBackground[] {{=}} {0,0,0,1};</tt>}}
[[Image:A3_BIS_fnc_initListNBoxSorting_example.jpg|400px|thumb|center|Example GUI using this function]]
[[Image:A3_BIS_fnc_initListNBoxSorting_example.jpg|400px|thumb|center|Example GUI using this function]]
|Description=


| [controlFilter, controlContent, columnIndexes, idc] call [[BIS_fnc_initListNBoxSorting]] |Syntax=


|p1= controlFilter: [[Control]] - Dummy [[CT_LISTNBOX]] control used for setting up the filter. If parameter is [[controlNull]] function will show an error message.|PARAMETER1=
| [controlFilter, controlContent, columnIndexes, idc] call [[BIS_fnc_initListNBoxSorting]]


|p2= controlContent: [[Control]] - The [[CT_LISTNBOX]] which actually contains the content. If parameter is [[controlNull]] function will show an error message. |PARAMETER2=
|p1= controlFilter: [[Control]] - Dummy [[CT_LISTNBOX]] control used for setting up the filter. If parameter is [[controlNull]] function will show an error message.


|p3= columnIndexes: [[Array]] - Array of [[Number|numbers]]. These are the indexes of the <tt>controlContent</tt> which should be filterable/sortable |PARAMETER3=
|p2= controlContent: [[Control]] - The [[CT_LISTNBOX]] which actually contains the content. If parameter is [[controlNull]] function will show an error message.


|p4= idc: [[Number]] - (Optional, default 200)  Will be used to assign idcs to the buttons which are automatically created. First button has <tt>idc</tt>, second button <tt>idc + 1</tt> and so on |PARAMETER4=
|p3= columnIndexes: [[Array]] - Array of [[Number|numbers]]. These are the indexes of the <tt>controlContent</tt> which should be filterable/sortable


| [[Boolean]] -  [[true]] on success, otherwise [[false]] |Return value=
|p4= idc: [[Number]] - (Optional, default 200) Will be used to assign idcs to the buttons which are automatically created. First button has <tt>idc</tt>, second button <tt>idc + 1</tt> and so on


|x1= <code>[_lnbFilter, _lnbContent, [0,1,2,3]] [[call]] [[BIS_fnc_initListNBoxSorting]];</code> |Example 1=
| [[Boolean]] -  [[true]] on success, otherwise [[false]]


| [[BIS_fnc_initSliderValue]] |See also=
|x1= <code>[_lnbFilter, _lnbContent, [0,1,2,3]] [[call]] [[BIS_fnc_initListNBoxSorting]];</code>
 
| [[BIS_fnc_initSliderValue]]
}}
}}


Revision as of 23:11, 17 January 2021

Arma 3 logo black.png1.56
Hover & click on the images for description

Description

Description:
Automatically creates buttons and sets them up so they can be used to sort a CT_LISTNBOX. The buttons will automatically be resized to the column width of given controlFilter.
ⓘ
  • controlFilter
    • x, y, w and h define where the buttons for sorting are created
    • It should be placed above the controlFilter
    • The amount of columns and their size should be identical with the onces of controlFilter.
    • The text set in the columns is displayed as text for the buttons (The buttons are transparent actually). Icons which indicate how the list is currently sorted are also adjusted when the button is pressed.
    • If a column of controlContent is supposed to be sorted by value instead of data (default), then something needs to be set in the data of corresponding controlFilter column
    • The control can also be part of a CT_CONTROLS_GROUP, if that's the case, the buttons will be created as children of that group
    • To keep a uniform style between vanilla controls and custom ones it's advisable to create a background with CT_STATIC behind the controlFilter with colorBackground[] = {0,0,0,1};
Example GUI using this function
Execution:
call
Groups:
GUI

Syntax

Syntax:
[controlFilter, controlContent, columnIndexes, idc] call BIS_fnc_initListNBoxSorting
Parameters:
controlFilter: Control - Dummy CT_LISTNBOX control used for setting up the filter. If parameter is controlNull function will show an error message.
controlContent: Control - The CT_LISTNBOX which actually contains the content. If parameter is controlNull function will show an error message.
columnIndexes: Array - Array of numbers. These are the indexes of the controlContent which should be filterable/sortable
idc: Number - (Optional, default 200) Will be used to assign idcs to the buttons which are automatically created. First button has idc, second button idc + 1 and so on
Return Value:
Boolean - true on success, otherwise false

Examples

Example 1:
[_lnbFilter, _lnbContent, [0,1,2,3]] call BIS_fnc_initListNBoxSorting;

Additional Information

See also:
BIS_fnc_initSliderValue

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note


Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_initListNBoxSorting&oldid=203137"