ultimatepp/uppsrc/CtrlLib/src.tpp/ButtonOption$en-us.tpp
cbpporter edcd1c0297 Documentation update
git-svn-id: svn://ultimatepp.org/upp/trunk@1986 f0d560ea-af0d-0410-9eb7-867de7ffcac7
2010-01-30 10:27:43 +00:00

115 lines
No EOL
4.8 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

topic "ButtonOption";
[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]
[{_}%EN-US
[ {{10000@3 [s0; [*@(229)4 ButtonOption]]}}&]
[s3; &]
[s1;:ButtonOption`:`:class:%- [@(0.0.255)3 class][3 _][*3 ButtonOption][3 _:_][@(0.0.255)3 publi
c][3 _][*@3;3 Ctrl]&]
[s2; &]
[s2;
@@image:225&125
ƒ¤ƒìÿø¯œÝËÊÃÀ¦ó˜¾ˆ«²ÁðÁ<EFBFBD> ±¸ò£ˆº© ò®ŠîĤ±<EFBFBD>Ä¥îÁŠÅë¤Õ ¡èÞ¬
÷ÛŠÙÔŸŽ<EFBFBD>ŽÃæ²±¥«×Ÿá¤œÿ¾è¹òÒèüÛÍõнºô¬ûÆäëøàíää ù­Øˆ˜êÊöô<EFBFBD>¿·µ÷©³çøôàäºìæ¼
¯¬Äšª®Èº´ïâéí÷îõÿÈ<EFBFBD><EFBFBD>ò¿½æúË­¦<EFBFBD><EFBFBD>¥œÓÑæîøúå<EFBFBD>ÙèœÔŠë¼<EFBFBD>ÙíÙôœÃ®Ê¬É©¼£ã¡ÞÔ
Ïäû¾¦éþø²ŒŒ²é¿¿ŸÿĤõäáÙˆ<EFBFBD>Óµ¯ûüžÐòâåç§Ëß±¾¿ÞÉôÛòŠØž¯ëíõ£ÄâŠè<EFBFBD>äÈÉÛšÆúú¬
<EFBFBD>¤±š¥êþÖí¾Ìï<EFBFBD>ÇĘÙÒ<EFBFBD>éØœÉó»ÈŠ´Ãíï½ôùµ<EFBFBD>¤õÅÊäá²éÜÜߨåšóܼߎ±ö¦çÖÔàáӹƈòÎ÷ÔÊ
éú×ïÙ°ÔÖíµ¦ôîͲÐÂð£©ÝÉÆÂÅ<EFBFBD>¦²<EFBFBD>õÍòê¤Á­Ãű±ê°±ËÅœŒ¸ªâèãúðáâÓœïÖ¬
üÜ<EFBFBD>³´â¡®ôÿêÖ<EFBFBD>ïú<EFBFBD>ÿä<EFBFBD>ÿý
&]
[s2; &]
[s9; Simple 2`-state Ctrl `- similar to Option, but with visual appearance
of Button. Pushed state is persistent (until next click) and
represents true. Value of ButtonOption is either 1 or 0.&]
[s0; &]
[s0;%- [%%/ Derived from][%% ][^topic`:`/`/CtrlCore`/src`/Ctrl`$en`-us`#`:`:Ctrl`:`:class Ctrl^ C
trl]&]
[s3; &]
[s0;%- &]
[ {{10000F(128)G(128)@1 [s0; [* Public Method List]]}}&]
[s3; &]
[s5;:ButtonOption`:`:SetImage`(const Image`&`):%- [_^ButtonOption^ ButtonOption][@(0.0.255) `&
]_[* SetImage]([@(0.0.255) const]_[_^Image^ Image][@(0.0.255) `&]_[*@3 img])&]
[s2; Sets the image [%-*C@3 img] to be displayed in ButtonOption. Returns
`*this.&]
[s3; &]
[s4;%- &]
[s5;:ButtonOption`:`:SetImage`(const Image`&`,const Image`&`):%- [_^ButtonOption^ Butto
nOption][@(0.0.255) `&]_[* SetImage]([@(0.0.255) const]_[_^Image^ Image][@(0.0.255) `&]_[*@3 m
], [@(0.0.255) const]_[_^Image^ Image][@(0.0.255) `&]_[*@3 m1])&]
[s2; Sets the image [%-*C@3 m] to be displayed for the `"false`" state
and [%-*C@3 m1 ]to be displayed for the `"true`" state.&]
[s3; &]
[s4;%- &]
[s5;:ButtonOption`:`:operator`=`(const Image`&`):%- [@(0.0.255) void]_[* operator`=]([@(0.0.255) c
onst]_[_^Image^ Image][@(0.0.255) `&]_[*@3 img])&]
[s2; Equivalent to SetImage([*C@3 img]).&]
[s3; &]
[s4;%- &]
[s5;:ButtonOption`:`:Set`(bool`):%- [@(0.0.255) void]_[* Set]([@(0.0.255) bool]_[*@3 b])&]
[s2; Sets the ButtonOption to [%-*C@3 b].&]
[s3; &]
[s4;%- &]
[s5;:ButtonOption`:`:Get`(`)const:%- [@(0.0.255) bool]_[* Get]()_[@(0.0.255) const]&]
[s2; Returns the state of ButtonOption.&]
[s3; &]
[s4;%- &]
[s5;:ButtonOption`:`:operator`=`(bool`):%- [@(0.0.255) void]_[* operator`=]([@(0.0.255) boo
l]_[*@3 b])&]
[s2; Equivalent to Set([*C@3 b]).&]
[s3; &]
[s4;%- &]
[s5;:ButtonOption`:`:operator bool`(`)const:%- [* operator_bool]()_[@(0.0.255) const]&]
[s2; Equivalent to Get().&]
[s3; &]
[s4;%- &]
[s5;:ButtonOption`:`:SetLabel`(const String`&`):%- [_^ButtonOption^ ButtonOption][@(0.0.255) `&
]_[* SetLabel]([@(0.0.255) const]_[_^String^ String][@(0.0.255) `&]_[*@3 text])&]
[s2; Sets the label of the button to [%-*@3 text].&]
[s3; &]
[s4;%- &]
[s5;:ButtonOption`:`:GetLabel`(`)const:%- [_^String^ String]_[* GetLabel]()_[@(0.0.255) con
st]&]
[s2; Returns the label of the button.&]
[s3;%- &]
[s4;%- &]
[s5;:ButtonOption`:`:StyleDefault`(`):%- [@(0.0.255) static] [@(0.0.255) const]_[_^ButtonOption`:`:Style^ S
tyle][@(0.0.255) `&]_[* StyleDefault]()&]
[s2; Returns the default style used to draw a `"normal`" ButtonOption.&]
[s0; &]
[s4;%- &]
[s5;:ButtonOption`:`:StyleFlat`(`):%- [@(0.0.255) static] [@(0.0.255) const]_[_^ButtonOption`:`:Style^ S
tyle][@(0.0.255) `&]_[* StyleFlat]()&]
[s2; Returns the default style used to draw a `"flat`" ButtonOption.&]
[s3;%- &]
[s4;%- &]
[s5;:ButtonOption`:`:SetStyle`(const ButtonOption`:`:Style`&`):%- [_^ButtonOption^ Butt
onOption][@(0.0.255) `&]_[* SetStyle]([@(0.0.255) const]_[_^ButtonOption`:`:Style^ Style][@(0.0.255) `&
]_[*@3 s])&]
[s2; Sets the style of the button to [%-*@3 s]. Returns `*this for
chaining.&]
[s3; &]
[s4;%- &]
[s5;:ButtonOption`:`:AutoStyle`(`):%- [_^ButtonOption^ ButtonOption][@(0.0.255) `&]_[* Auto
Style]()&]
[s2; Clears all style information, reverting to the default look.
Returns `*this for chaining.&]
[s3;%- &]
[s0; &]
[s0;%- &]
[s0;%- &]
[ {{10000@3 [s0; [*@(229)4 ButtonOption`::Style]]}}&]
[s3; &]
[s1;:ButtonOption`:`:Style`:`:struct:%- [@(0.0.255)3 struct][3 _][*3 Style][3 _:_][@(0.0.255)3 p
ublic][3 _][*@3;3 ChStyle][@(0.0.255)3 <][*3 Style][@(0.0.255)3 >][3 _]&]
[s9; This structure defines the look of a ButtonOption.&]
[s3;%- &]
[s0; ]