ultimatepp/uppsrc/CtrlLib/src.tpp/ColumnList_en-us.tpp
cxl 3636f66cd2 .docs
git-svn-id: svn://ultimatepp.org/upp/trunk@14193 f0d560ea-af0d-0410-9eb7-867de7ffcac7
2020-03-27 16:34:00 +00:00

444 lines
No EOL
24 KiB
C++

topic "ColumnList";
[i448;a25;kKO9;2 $$1,0#37138531426314131252341829483380:class]
[l288;2 $$2,2#27521748481378242620020725143825:desc]
[0 $$3,0#96390100711032703541132217272105:end]
[H6;0 $$4,0#05600065144404261032431302351956:begin]
[i448;a25;kKO9;2 $$5,0#37138531426314131252341829483370:item]
[l288;a4;*@5;1 $$6,6#70004532496200323422659154056402:requirement]
[l288;i1121;b17;O9;~~~.1408;2 $$7,0#10431211400427159095818037425705:param]
[i448;b42;O9;2 $$8,8#61672508125594000341940100500538:tparam]
[b42;2 $$9,9#13035079074754324216151401829390:normal]
[2 $$0,0#00000000000000000000000000000000:Default]
[{_}
[ {{10000@(113.42.0) [s0;%% [*@7;4 ColumnList]]}}&]
[s0; &]
[s1;:Upp`:`:ColumnList`:`:class: [@(0.0.255)3 class][3 _][*3 ColumnList][3 _:_][@(0.0.255)3 publ
ic][3 _][*@3;3 Ctrl][3 , ][@(0.0.255)3 private][3 _][*@3;3 CtrlFrame]&]
[s2;%%
@@image:1606&706
(AwEBcQAAAI//AAAAAHic7Z1hkuQmDIX7xDnD/s0RcoP8SO0Z5hi5QqrmDmSq2KUYJIQwQtit95Vr1k0D9sN6bk8PWj7/+/cTGzZs2LBhw4Yt5PbHnz+xYQu41RZIAAQDFsj88/dfp0/hDGGFp9/a9RZ4fcfrNJ0QIgHC31J40lmADsLHx0dT7n/mO2giAcLfXnhSW4Duf41JGRw6IJdvHb3KPvciGgl0Xy989ug+GlnWhVP0EoSLruxhBb0FXl//JnJPSK8fP364SZjtcLY+GwlTwtng2XrOJqwLp6wLubMF0u9bQTQLpJHwpuTaZ8Fsk3XWhVPexgIvQuKeDNmzFZ4TaOdNE7bbYYelhO7rR2NFuPCyd6rKHn6FJXdceRDchDfl5YRZLXXl5ifbpKd9HY0FPirK0fP+1w3ha6d3W5DjQSgRBkHZIe1HQxMJF4TLAdw7N41GecTYEr18W+HypRRq0jPXxNUiSgs0wsvglLf2WUDusHfzYesPoZEwK/yaBfQ9sP3Ig6DBVvhlCwi99V6uo7FAGY0yCKm6J2ROWUCuthgJF4QfsYCmHxlb4fssYB7/aeF3gV+/HJH7T9O299L8htA0lMOjh+aRWBauv476q1wfRT+GbFeewunJXLvobAVDLnwjVN8TZr8RakaPjid9a6rD9D1g2CYC8hcjGuG9CBFOVaNR7n84CEN2CG8uJS1pyoWrVir0xnYFpQXyxyJ9MhSegjTYalmHRsIm4VNcdrSedeHXTuwOAXBhgsS3e8KaK+8wAjXyPAFD4UroIdwsMCtcf2Juo6cE0+Rqws4WCys8zVvgvQk7Zzis8AQLfCdsJIQVXsCDUCbs8wAsgHyBTNhp87DA/fMFfLDNF2Cb0/rKHrYCCzwlX2A3tvkC9CXFaugWhxoWeEq+wG788wVggZvwlHyB3ezLF+jpelV/+hf66TUUepgCFnhKvsBuTKbNs+4Q9NKoTjNDR3u+ACzwlHyB3ezOF2Dv7cP91HFWzz4XgAWeki+wm935AisWoGcLCxjylHyB3dhOm0+iBWSl+qEzuWnAAk/JF9iNybR59mVPl9ICQkO2q1lgAeQLZO6ZL+AALIB8gczd8gXcgAUwTS6DaXJhwWTpTNhICCu8AAtkwkZCWOEFPAhl8CAUFuQLZJAvEBa3fIFezOh7aJrYBuHZ9QUOAguY5ws0JcN4GPYgN7GKtzusL3AEWMA8X+BdLZD2ry9wBFjAPF+g97LeqVuVpxpas6E5Im24wtZ8AVk7u+MGLGCeL9ALkjpumxLWDmxz2pVVzPisL8BKGFbeCixgni8gRwK9xLJNhtX2WcBWeNmv3d376QksYJ4v8B4WMBc+lAALnMI8X0BvAU0J262DBRaFs/v6Qk9gAfN8Ac3NsI4fNrbZMGsK2R4us299AUECfXddyCywwKl8gbuBfIGwnMoXuBvIFwgLpsllME0uLJgsnQkbCWGFF2CBTNhICCu8gAehDB6EwoJ8gQzyBcLiv77A6/tX4jcJqvV8gXQbLVPAAv75AiXyaYWDkeO/vsBNgAX88wUEC7D1fTDPF3gKsIBnvkBdv94R6jdtaR32oBcwzxegvQ11HQEW8MkXqOs0kS9YgJ5tr625BdbzBWihIPygC2CB3fkCtPCCBRpP9X6uYJ4vwKpoBPY+UDyBBXbnC9DCWQv02m61gL/wU8ACu/MFaKHyeUCuYP4UsWl9gQvCnYEFducL1OV15NSRMIwoWmerBdIl4T0t8plT4c7AAsgXyCBfICzIF8ggXyAsmCaXwTS5sGCydCZsJIQVXqAWKC9DbWEjIazwgt4CzfPA8aB1swAehN4b2QL06tOpMsejd4cFNMIPXK0NwAJDC5SaZb+ZNk/DSWOQ/Bat0Cv3t8BQ+HBs9Tbp1XQwGiygsYA8bZ6N4cVQv4kFpvIFKOsBDAs4MGuBRP5IqoneN7AAFT4cW1jgEQgWeBFSZ9q8xgIl5uvgF6wxfJTaZwG98HokafmrM02IVm5+sk3kQ8jVBGAB2QLKafP6T4FmR7CA8yeCbb4ADWxaztZsYput3DTUOE4AFhhaQDNt/i0tsJIvcNkCQm9TXdH6PWAB2QLKafPvZ4HFfAFY4EFc+F2ATpsXLNCE9FMsoBRej+QwsEuTWQsIFWCBdaa+EWKnzbP3fOoO1gvUSrTcIf4/R98IKRMlGmsIwd9U1lugdwihcxlYYGiB4bR5nxD1t8BsvoAm3ihTrWYPAQtomJogwU6bPx69mywwFN6MpD4+p+7Ss4eY7RwWwDQ51gI1jXDHi+MBLIDJ0kMLvDdhhReQMpMJGwlhhReQOJnBg1BYsL5ABvkCYTFfXyDp4uR16UvsfaznCzzUFLCAz/oCvWps5SOYry/wFGCB3esL9Ap71jgF1hcIy+71Beqump1e5br/pjl9ywrD9QXqd5tqtCHtbZPAHrDAjvUF6FHq61vvyJVpNfqWFYb5AsJOU1lQyrbaASzgvL7AugV6N+FFDPMF5J3mM4Iq3SSwByzgvL6A4aeALYb5AhqxmhIfYIHd6wv0Ypi94sPAoG9ZYZgvYGUBfAr4YL6+QOJ+xUuiF9jKdYnwlhUm+QKaHSqtV2IrsAcsgPUFMsfXFzg1krAA1hfIHFlf4A7DCAtgmlwG0+TCgsnSmbCREFZ4ARYAwYEFQHBgARAcWAAEBxYAwYEFQHBgARAcWAAEBxYAwWksgA1bwO34f2aIDRs2bNjusP0PoOOuNQ==)
&]
[s2; &]
[s2;%% This widget displays the same type of items in several columns.
The number of columns can be altered by user action. It is typically
used to display a list of files.&]
[s3; &]
[ {{10000F(128)G(128)@1 [s0;%% [* Public Method List]]}}&]
[s3; &]
[s5;:Upp`:`:ColumnList`:`:WhenLeftClick: [_^Upp`:`:Event^ Event]<>_[* WhenLeftClick]&]
[s2;%% This event is dispatched when the user clicks the widget with
the left mouse button. Clicked item has the cursor.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:WhenLeftClickPos: [_^Upp`:`:Event^ Event]<[_^Upp`:`:Point^ Poin
t]>_[* WhenLeftClickPos]&]
[s2;%% Similar to WhenLeftClick but also provides the coordinates
within the clicked item.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:WhenLeftDouble: [_^Upp`:`:Event^ Event]<>_[* WhenLeftDouble]&]
[s2;%% This event is dispatched when the user double`-clicks the
widget with the left mouse button.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:WhenBar: [_^Upp`:`:Event^ Event]<Bar[@(0.0.255) `&]>_[* WhenBar]&]
[s2;%% This event is dispatched when the user clicks the widget with
the right mouse button. Client code can use this event to set
a context menu.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:WhenSel: [_^Upp`:`:Event^ Event]<>_[* WhenSel]&]
[s2;%% This event is dispatched when the cursor, or selection status
of the widget is changed.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetColumnItems`(`)const: [@(0.0.255) int]_[* GetColumnItems]()_
[@(0.0.255) const]&]
[s2;%% Returns the number of items that fit in a single column at
current view size.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetColumnCx`(int`)const: [@(0.0.255) int]_[* GetColumnCx]([@(0.0.255) i
nt]_[*@3 i]_`=_[@3 0])_[@(0.0.255) const]&]
[s2;%% Returns the current width of column [%-*@3 i].&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetPageItems`(`)const: [@(0.0.255) int]_[* GetPageItems]()_[@(0.0.255) c
onst]&]
[s2;%% Returns the number of items that fit into the current view
size.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetItem`(Upp`:`:Point`): [@(0.0.255) int]_[* GetItem]([_^Upp`:`:Point^ P
oint]_[*@3 p])&]
[s2;%% Returns the item index for the given point of view area (accounts
for the scrollbar position too).&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetItemRect`(int`)const: [_^Upp`:`:Rect^ Rect]_[* GetItemRect](
[@(0.0.255) int]_[*@3 i])_[@(0.0.255) const]&]
[s2;%% Returns the view rectangle of the item at [%-*@3 i].&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetCursor`(`)const: [@(0.0.255) int]_[* GetCursor]()_[@(0.0.255) c
onst]&]
[s2;%% Returns the current cursor position. If there is no cursor,
returns a negative value.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:SetCursor`(int`): [@(0.0.255) void]_[* SetCursor]([@(0.0.255) int
]_[*@3 c])&]
[s2;%% Sets the current cursor position. If [%-*@3 c] is out of range,
it is `"fixed`" (negative becomes 0, >GetCount() becomes GetCount()
`- 1).&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:KillCursor`(`): [@(0.0.255) void]_[* KillCursor]()&]
[s2;%% Cancels the cursor.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:IsCursor`(`)const: [@(0.0.255) bool]_[* IsCursor]()_[@(0.0.255) c
onst]&]
[s2;%% Tests whether cursor is at any item. Same as [C GetCursor()
>`= 0].&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetSbPos`(`)const: [@(0.0.255) int]_[* GetSbPos]()_[@(0.0.255) co
nst]&]
[s2;%% Returns the scrollbar position.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:SetSbPos`(int`): [@(0.0.255) void]_[* SetSbPos]([@(0.0.255) int]_
[*@3 y])&]
[s2;%% Sets the scrollbar position to [%-*@3 y].&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetScroll`(`)const: [@(0.0.255) int]_[* GetScroll]()_[@(0.0.255) c
onst]&]
[s2;%% Returns the scroll position.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:ScrollTo`(int`): [@(0.0.255) void]_[* ScrollTo]([@(0.0.255) int]_
[*@3 a])&]
[s2;%% Scrolls to position [%-*@3 a].&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:SetFrame`(Upp`:`:CtrlFrame`&`): [@(0.0.255) void]_[* SetFrame](
[_^Upp`:`:CtrlFrame^ CtrlFrame][@(0.0.255) `&]_[*@3 frame])&]
[s2;%% Sets the decorative frame of ColumnList to [%-*@3 frame]. This
is required because ColumnList has special zero index (decorative)
frame to provide RoundSize option. Decorative frame set by this
method is used by this special rounding frame.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:Clear`(`): [@(0.0.255) void]_[* Clear]()&]
[s2;%% Empties the ColumnList.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:Add`(const Upp`:`:Value`&`,bool`): [@(0.0.255) void]_[* Add]([@(0.0.255) c
onst]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 val], [@(0.0.255) bool]_[*@3 canselect]_`=
_[@(0.0.255) true])&]
[s5;:Upp`:`:ColumnList`:`:Add`(const Upp`:`:Value`&`,const Upp`:`:Display`&`,bool`): [@(0.0.255) v
oid]_[* Add]([@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 val],
[@(0.0.255) const]_[_^Upp`:`:Display^ Display][@(0.0.255) `&]_[*@3 display],
[@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s5;:Upp`:`:ColumnList`:`:Add`(const Upp`:`:Value`&`,const Upp`:`:Value`&`,bool`): [@(0.0.255) v
oid]_[* Add]([@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 key],
[@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 val],
[@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s5;:Upp`:`:ColumnList`:`:Add`(const Upp`:`:Value`&`,const Upp`:`:Value`&`,const Upp`:`:Display`&`,bool`): [@(0.0.255) v
oid]_[* Add]([@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 key],
[@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 val],
[@(0.0.255) const]_[_^Upp`:`:Display^ Display][@(0.0.255) `&]_[*@3 display],
[@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s2;%% Adds an item to the ColumnList. Optionally a [%-*@3 key ]can
be assigned to the item. If [%-*@3 canselect] is false, item cannot
be selected. If specified, [%-*@3 display] is used to display the
item (otherwise common display as set by SetDisplay method is
used).&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetCount`(`)const: [@(0.0.255) int]_[* GetCount]()_[@(0.0.255) co
nst]&]
[s2;%% Returns the current number of items in the list.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:Get`(int`)const: [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&
]_[* Get]([@(0.0.255) int]_[*@3 i])_[@(0.0.255) const]&]
[s5;:Upp`:`:ColumnList`:`:operator`[`]`(int`)const: [@(0.0.255) const]_[_^Upp`:`:Value^ V
alue][@(0.0.255) `&]_[* operator`[`]]([@(0.0.255) int]_[*@3 i])_[@(0.0.255) const]&]
[s2; [%% Returns the item with index ][*@3 i]. If the item is previously
assigned a key, then this method returns a reference to the key
itself. Otherwise it is the same as GetValue.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetValue`(int`)const: [@(0.0.255) const]_[_^Upp`:`:Value^ Value
][@(0.0.255) `&]_[* GetValue]([@(0.0.255) int]_[*@3 i])_[@(0.0.255) const]&]
[s2;%% Returns the value of item with index [%-*@3 i].&]
[s3;%% &]
[s4;%% &]
[s5;:Upp`:`:ColumnList`:`:Set`(int`,const Upp`:`:Value`&`,bool`): [@(0.0.255) void]_[* Se
t]([@(0.0.255) int]_[*@3 ii], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 v
al], [@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s5;:Upp`:`:ColumnList`:`:Set`(int`,const Upp`:`:Value`&`,const Upp`:`:Display`&`,bool`): [@(0.0.255) v
oid]_[* Set]([@(0.0.255) int]_[*@3 ii], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&
]_[*@3 val], [@(0.0.255) const]_[_^Upp`:`:Display^ Display][@(0.0.255) `&]_[*@3 display],
[@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s5;:Upp`:`:ColumnList`:`:Set`(int`,const Upp`:`:Value`&`,const Upp`:`:Value`&`,bool`): [@(0.0.255) v
oid]_[* Set]([@(0.0.255) int]_[*@3 ii], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&
]_[*@3 key], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 val],
[@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s5;:Upp`:`:ColumnList`:`:Set`(int`,const Upp`:`:Value`&`,const Upp`:`:Value`&`,const Upp`:`:Display`&`,bool`): [@(0.0.255) v
oid]_[* Set]([@(0.0.255) int]_[*@3 ii], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&
]_[*@3 key], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 val],
[@(0.0.255) const]_[_^Upp`:`:Display^ Display][@(0.0.255) `&]_[*@3 display],
[@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s2;%% Sets the value of item at position [%-*@3 ii]. Optionally a
[%-*@3 key ]can be assigned to the item. If [%-*@3 canselect] is
false, item cannot be selected. If specified, [%-*@3 display] is
used to display the item (otherwise common display as set by
SetDisplay method is used).&]
[s3;%% &]
[s4;%% &]
[s5;:Upp`:`:ColumnList`:`:Set`(const Upp`:`:Value`&`,const Upp`:`:Value`&`,const Upp`:`:Display`&`,bool`): [@(0.0.255) v
oid]_[* Set]([@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 key],
[@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 val],
[@(0.0.255) const]_[_^Upp`:`:Display^ Display][@(0.0.255) `&]_[*@3 display],
[@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s5;:Upp`:`:ColumnList`:`:Set`(const Upp`:`:Value`&`,const Upp`:`:Value`&`,bool`): [@(0.0.255) v
oid]_[* Set]([@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 key],
[@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 val],
[@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s2;%% Sets the value of item with the [%-*@3 key]. If [%-*@3 canselect]
is false, item cannot be selected. If specified, [%-*@3 display]
is used to display the item (otherwise common display as set
by SetDisplay method is used).&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:Insert`(int`,const Upp`:`:Value`&`,bool`): [@(0.0.255) void]_
[* Insert]([@(0.0.255) int]_[*@3 ii], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&
]_[*@3 val], [@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s5;:Upp`:`:ColumnList`:`:Insert`(int`,const Upp`:`:Value`&`,const Upp`:`:Display`&`,bool`): [@(0.0.255) v
oid]_[* Insert]([@(0.0.255) int]_[*@3 ii], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&
]_[*@3 val], [@(0.0.255) const]_[_^Upp`:`:Display^ Display][@(0.0.255) `&]_[*@3 display],
[@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s5;:Upp`:`:ColumnList`:`:Insert`(int`,const Upp`:`:Value`&`,const Upp`:`:Value`&`,bool`): [@(0.0.255) v
oid]_[* Insert]([@(0.0.255) int]_[*@3 ii], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&
]_[*@3 key], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 val],
[@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s5;:Upp`:`:ColumnList`:`:Insert`(int`,const Upp`:`:Value`&`,const Upp`:`:Value`&`,const Upp`:`:Display`&`,bool`): [@(0.0.255) v
oid]_[* Insert]([@(0.0.255) int]_[*@3 ii], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&
]_[*@3 key], [@(0.0.255) const]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 val],
[@(0.0.255) const]_[_^Upp`:`:Display^ Display][@(0.0.255) `&]_[*@3 display],
[@(0.0.255) bool]_[*@3 canselect]_`=_[@(0.0.255) true])&]
[s2;%% Inserts an item at position [%-*@3 ii]. Optionally a [%-*@3 key
]can be assigned to the item. If [%-*@3 canselect] is false, item
cannot be selected. If specified, [%-*@3 display] is used to display
the item (otherwise common display as set by SetDisplay method
is used).&]
[s0;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:Remove`(int`): [@(0.0.255) void]_[* Remove]([@(0.0.255) int]_[*@3 i
i])&]
[s2;%% Removes the item at position [%-*@3 ii].&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:Remove`(const Upp`:`:Value`&`): [@(0.0.255) void]_[* Remove]([@(0.0.255) c
onst]_[_^Upp`:`:Value^ Value]_`&_[*@3 key])&]
[s2;%% Removes the item with [%-*@3 key].&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:RemoveSelection`(`): [@(0.0.255) void]_[* RemoveSelection]()&]
[s2;%% Removes the selected item(s).&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetSelectCount`(`)const: [@(0.0.255) int]_[* GetSelectCount]()_
[@(0.0.255) const]&]
[s2;%% Returns the number of selected items.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:IsSelection`(`)const: [@(0.0.255) bool]_[* IsSelection]()_[@(0.0.255) c
onst]&]
[s2;%% Test whether any items are selected.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:ClearSelection`(`): [@(0.0.255) void]_[* ClearSelection]()&]
[s2;%% Clear the selection.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:SelectOne`(int`,bool`): [@(0.0.255) void]_[* SelectOne]([@(0.0.255) i
nt]_[*@3 i], [@(0.0.255) bool]_[*@3 sel])&]
[s2;%% Sets the selection status for item at position [%-*@3 i].&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:IsSelected`(int`)const: [@(0.0.255) bool]_[* IsSelected]([@(0.0.255) i
nt]_[*@3 i])_[@(0.0.255) const]&]
[s2;%% Returns the selection status at position [%-*@3 i].&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:IsSel`(int`)const: [@(0.0.255) bool]_[* IsSel]([@(0.0.255) int]_[*@3 i
])_[@(0.0.255) const]&]
[s2;%% If there is selection in the widget, returns true if [%-*@3 i]
is selected, otherwise returns true if cursor is at [%-*@3 i].&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:Find`(const Upp`:`:Value`&`)const: [@(0.0.255) int]_[* Find]([@(0.0.255) c
onst]_[_^Upp`:`:Value^ Value][@(0.0.255) `&]_[*@3 key])_[@(0.0.255) const]&]
[s2;%% Returns the position of item with [%-*@3 key] on success, and
a negative value on failure.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:Sort`(const Upp`:`:ValueOrder`&`): [@(0.0.255) void]_[* Sort]([@(0.0.255) c
onst]_[_^Upp`:`:ValueOrder^ ValueOrder][@(0.0.255) `&]_[*@3 order])&]
[s2;%% Sorts list items.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:Mode`(int`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&]_[* M
ode]([@(0.0.255) int]_[*@3 m])&]
[s2;%% Sets the view mode of ColumnList to [%-*@3 m]. Returns `*this
for method chaining. Currently there are three possible view
modes: [C MODE`_LIST], [C MODE`_COLUMN], [C MODE`_ROWS]. &]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:ListMode`(`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&]_
[* ListMode]()&]
[s2;%% Puts the ColumnList into list mode. Same as Mode([C MODE`_LIST]).
Returns `*this for method chaining.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:RowMode`(`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&]_[* R
owMode]()&]
[s2;%% Puts the ColumnList into row mode. Same as Mode([C MODE`_ROWS]).
Returns `*this for method chaining.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:ColumnMode`(`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* ColumnMode]()&]
[s2;%% Puts the ColumnList into column mode. Same as Mode([C MODE`_COLUMN]).
Returns `*this for method chaining.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:Columns`(int`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* Columns]([@(0.0.255) int]_[*@3 n])&]
[s2;%% Sets the number of columns to [%-*@3 n]. (User action can change
the number of columns by dragging the column boundary too). Returns
`*this for method chaining.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetColumns`(`)const: [@(0.0.255) int]_[* GetColumns]()_[@(0.0.255) c
onst]&]
[s2;%% Returns the column count.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:ItemHeight`(int`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* ItemHeight]([@(0.0.255) int]_[*@3 cy])&]
[s2;%% Sets the item height in pixels. Returns `*this for method
chaining.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetItemHeight`(`)const: [@(0.0.255) int]_[* GetItemHeight]()_[@(0.0.255) c
onst]&]
[s2;%% Returns the value set by ItemHeight.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:ItemWidth`(int`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* ItemWidth]([@(0.0.255) int]_[*@3 cx])&]
[s2;%% Sets the item width in pixels. Returns `*this for method chaining.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:GetItemWidth`(`)const: [@(0.0.255) int]_[* GetItemWidth]()_[@(0.0.255) c
onst]&]
[s2;%% Returns the value set by ItemWidth.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:RoundSize`(bool`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* RoundSize]([@(0.0.255) bool]_[*@3 b]_`=_[@(0.0.255) true])&]
[s2;%% This mode visually changes the decorative frame of ColumnList
so that there are no empty areas at the bottom of view (GetSize().cy
% GetItemHeight()). Default is off. Returns `*this for method
chaining.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:NoRoundSize`(`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* NoRoundSize]()&]
[s2;%% Same as RoundSize(false). Returns `*this for method chaining.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:ClickKill`(bool`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* ClickKill]([@(0.0.255) bool]_[*@3 b]_`=_[@(0.0.255) true])&]
[s2;%% In this mode, if user clicks on a view area that does not
contain any items, cursor is canceled. Default is off. Returns
`*this for method chaining.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:NoClickKill`(`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* NoClickKill]()&]
[s2;%% Same as ClickKill(false). Returns `*this for method chaining.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:SetDisplay`(const Upp`:`:Display`&`): [_^Upp`:`:ColumnList^ C
olumnList][@(0.0.255) `&]_[* SetDisplay]([@(0.0.255) const]_[_^Upp`:`:Display^ Display][@(0.0.255) `&
]_[*@3 d])&]
[s2;%% Sets the display to be used for items to [%-*@3 d], unless an
item`-specific display is specified in Add or Insert methods.
Returns `*this for method chaining.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:NoBackground`(bool`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* NoBackground]([@(0.0.255) bool]_[*@3 b]_`=_[@(0.0.255) true])&]
[s2;%% Sets the widget into transparent mode `- background is not
painted and Transparent is activated `- a result, anything painted
behind the widget is visible, allowing client code to provide
any background it needs. Returns `*this for method chaining.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:Multi`(bool`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&]_
[* Multi]([@(0.0.255) bool]_[*@3 b]_`=_[@(0.0.255) true])&]
[s5;:Upp`:`:ColumnList`:`:MultiSelect`(bool`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* MultiSelect]([@(0.0.255) bool]_[*@3 b]_`=_[@(0.0.255) true])&]
[s2;%% Enables or disables multiselection of items. Returns `*this
for method chaining.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:IsMulti`(`)const: [@(0.0.255) bool]_[* IsMulti]()_[@(0.0.255) con
st]&]
[s5;:Upp`:`:ColumnList`:`:IsMultiSelect`(`)const: [@(0.0.255) bool]_[* IsMultiSelect]()_[@(0.0.255) c
onst]&]
[s2;%% Returns the status of multiselection mode.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:PopUpEx`(bool`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* PopUpEx]([@(0.0.255) bool]_[*@3 b]_`=_[@(0.0.255) true])&]
[s2;%% If active, enlarged small popup is displayed when mouse hovers
over items that do not fit designated area (the area is smalled
than Display`::GetMinSize). Default is active.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:NoPopUpEx`(`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&]_
[* NoPopUpEx]()&]
[s2;%% Same as PopUpEx(false).&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:AutoHideSb`(bool`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* AutoHideSb]([@(0.0.255) bool]_[*@3 b]_`=_[@(0.0.255) true])&]
[s2;%% Automatically hides the scrollbar if all of the items can
fit into the widget`'s view. Returns `*this for method chaining.&]
[s3;%% &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:NoAutoHideSb`(`): [_^Upp`:`:ColumnList^ ColumnList][@(0.0.255) `&
]_[* NoAutoHideSb]()&]
[s2;%% Same as AutoHideSb(false). Returns `*this for method chaining.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ColumnList`:`:SetScrollBarStyle`(const Upp`:`:ScrollBar`:`:Style`&`): [_^Upp`:`:ColumnList^ C
olumnList][@(0.0.255) `&]_[* SetScrollBarStyle]([@(0.0.255) const]_[_^Upp`:`:ScrollBar`:`:Style^ S
crollBar`::Style][@(0.0.255) `&]_[*@3 s])&]
[s2;%% Sets the scrollbar`'s visual style to [%-*@3 s]. Returns `*this
for method chaining.&]
[s3;%% &]
[ {{10000F(128)G(128)@1 [s0;%% [* Constructor detail]]}}&]
[s3; &]
[s5;:Upp`:`:ColumnList`:`:ColumnList`(`): [* ColumnList]()&]
[s2;%% Default constructor.&]
[s3; &]
[s0;%% ]]