ultimatepp/uppsrc/CtrlLib/src.tpp/Option$en-us.tpp

topic "Option";
[2 $$0,0#00000000000000000000000000000000:Default]
[i448;a25;kKO9;2 $$1,0#37138531426314131252341829483380:class]
[l288;2 $$2,0#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]
[{_} 
[ {{10000@3 [s0;%% [*@(229)4 Option]]}}&]
[s3; &]
[s1;:Option`:`:class: [@(0.0.255)3 class][3 _][*3 Option][3 _:_][@(0.0.255)3 public][3 _][*@3;3 Push
er]&]
[s0; &]
[s2;%% 
@@image:712&131
€ƒò€•€€€ƒëÿ€€€€ø·œí˜íŠƒÀöŒ†½Óï´ç©ØӮ€ð¢â‘ÙÊÒŸØ<EFBFBD>‰•›Ìäâ‚Ø»”’Þä¾¹Ôäž“ü𼯄³Ëåò¹Ž
÷ÐéôáÑ¿Ç<EFBFBD>ùÞ‚âßè¡í„ï´¦éÚ¶Çý¹Û°ŒÎõ¥‰Ô<EFBFBD>§Ì£ÔÁ«Ç»®¼úùƒúú‚ÉÇÛÝ惱€†€ëºèÞ§êõÙ¥¨·–ùÚù–—Ñ
<EFBFBD>ÝÿҠƩʖȗ‡¤Äõ„œÇ§ÚÀ•ø¸‚½àÈ<EFBFBD>‚ ŠÑçù¶Óå½ÖÁŽ£«ò涭º€Òù仺崩¿Ì<EFBFBD>¥Šæ…ª¤¨Ñ¥µ°ë¤Û©²­
½åôúŠä ¼ú˜<EFBFBD>Ú¼¤‚´ê¿«Ð¥Ž°ÀÔ¤ÁáƒÏß´å‚ܵÐÍݜѥªÓ¨å¥Š¤®›¤ÂµåÚÖÒ•…¿¢<EFBFBD>Ï΋š‘ª¥<EFBFBD>¢„±«ß¨Êµõ
˜–£ÕÝ‹ÎÕä¡©©öÝ×÷²½Ô»Ãú‡öδխ¹ê<EFBFBD>À¼²®£šÍÕž÷<EFBFBD>ºèÒø„ô÷Š¶¿ƒÈ­õºÊ–ÒªŠ£¡ÁÉ­¹åᨃÚìÌÙª€ôš
ô¦»Õ²ÙëèäýõÜÿ€–´—Ưìò¹Ü®ƒ×¢›«¤¬Ü
&]
[s0;%% &]
[s9;%% Widget providing the selection of 2 or alternatively 3 states 
(true, false, Null). Value of Option is either 0, 1, or Null. 
When setting Value to Option, string `"1`" is interpreted as 
true state, other non`-Null strings as false. Depending on whether 
Option is in NotNull mode, Null is interpreted as false or Null 
state. 0 is always interpreted as false, Null number as either 
Null (NotNull mode) or false (NoNotNull mode), other numbers 
as true.&]
[s0;%% &]
[s0; [%%/ Derived from][%%  ]Pusher&]
[s3;%% &]
[s0; &]
[ {{10000F(128)G(128)@1 [s0;%% [* Constructor Detail]]}}&]
[s3; &]
[s5;:Option`:`:Option`(`): [* Option]()&]
[s2;%% Initializes Option into NotNull, 2`-state mode, false value 
and standard appearance.&]
[s3;%% &]
[s4; &]
[s5;:Option`:`:`~Option`(`): [@(0.0.255) `~][* Option]()&]
[s2;%% Default destructor.&]
[s3; &]
[s0; &]
[ {{10000F(128)G(128)@1 [s0;%% [* Public Method List]]}}&]
[s3; &]
[s5;:Option`:`:Set`(int`): [_^Option^ Option][@(0.0.255) `&]_[* Set]([@(0.0.255) int]_[*@3 b])&]
[s2;%% Sets Option to the specified state (0, 1 or Null).&]
[s7;%% [%-*C@3 b]-|State.&]
[s3;%% &]
[s4; &]
[s5;:Option`:`:Get`(`)const: [@(0.0.255) int]_[* Get]()_[@(0.0.255) const]&]
[s7;%% [*/ Return value]-|Current state of Option.&]
[s3;%% &]
[s4; &]
[s5;:Option`:`:operator int`(`)const: [* operator_int]()_[@(0.0.255) const]&]
[s7;%% [*/ Return value]-|[^topic`:`/`/CtrlLib`/src`/Option`$en`-us`#Option`:`:Get`(`)const^ G
et]()&]
[s3;%% &]
[s4; &]
[s5;:Option`:`:operator`=`(int`): [@(0.0.255) void]_[* operator`=]([@(0.0.255) int]_[*@3 b])&]
[s2;%% Same as [^topic`:`/`/CtrlLib`/src`/Option`$en`-us`#Option`:`:Set`(int`)^ Set](b)
.&]
[s7;%% [%-*C@3 b]-|State.&]
[s3;%% &]
[s4; &]
[s5;:Option`:`:BlackEdge`(bool`): [_^Option^ Option][@(0.0.255) `&]_[* BlackEdge]([@(0.0.255) b
ool]_[*@3 b]_`=_[@(0.0.255) true])&]
[s2;%% Activates visual appearance suitable for placing Option on 
white background (SColorPaper), like in list, as opposed to default 
representation suitable for placing it on dialog (SColorFace).&]
[s7;%% [%-*C@3 b]-|true to activate.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Option`:`:SwitchImage`(bool`): [_^Option^ Option][@(0.0.255) `&]_[* SwitchImage]([@(0.0.255) b
ool]_[*@3 b]_`=_[@(0.0.255) true])&]
[s2;%% Activates visual representation that paints the Option with 
the Switch appearance.&]
[s7;%% [%-*C@3 b]-|true to activate.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Option`:`:ThreeState`(bool`): [_^Option^ Option][@(0.0.255) `&]_[* ThreeState]([@(0.0.255) b
ool]_[*@3 b]_`=_[@(0.0.255) true])&]
[s2;%% Activates three`-state mode. Also activates NoNotNull mode.&]
[s7;%% [%-*C@3 b]-|true to activate.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Option`:`:NotNull`(bool`): [_^Option^ Option][@(0.0.255) `&]_[* NotNull]([@(0.0.255) boo
l]_[*@3 nn]_`=_[@(0.0.255) true])&]
[s2;%% Activates NotNull mode `- Null Value assigned to Option (via 
SetData) is interpreted as false.&]
[s7;%% [%-*C@3 nn]-|true to activate.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Option`:`:NoNotNull`(`): [_^Option^ Option][@(0.0.255) `&]_[* NoNotNull]()&]
[s2;%% Activates NoNotNull mode `- Null Value assigned to Option 
is interpreted as Null.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Option`:`:ShowLabel`(bool`): [_^Option^ Option][@(0.0.255) `&]_[* ShowLabel]([@(0.0.255) b
ool]_[*@3 b]_`=_[@(0.0.255) true])&]
[s2;%% Togles the display of the option`'s label.&]
[s7; [*@3 b]-|true to show label&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s0; ]