ultimatepp/uppsrc/CtrlLib/src.tpp/Button$en-us.tpp
cbpporter 986d9d192e CtrlLib documentation update
git-svn-id: svn://ultimatepp.org/upp/trunk@942 f0d560ea-af0d-0410-9eb7-867de7ffcac7
2009-03-11 16:19:39 +00:00

187 lines
No EOL
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 "Button";
[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 Button]]}}&]
[s3;%% &]
[s1;:Button`:`:class: [@(0.0.255)3 class][3 _][*3 Button][3 _:_][@(0.0.255)3 public][3 _][*@3;3 Push
er]&]
[s0;%% &]
[s2;%%
@@image:456&175
€λ€€€<EFBFBD><EFBFBD>€€€€<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>э<EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Μ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD>€<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Σ<EFBFBD>пソ<EFBFBD>
@@image:431&187
€η€€€<EFBFBD><EFBFBD>€€€€<EFBFBD>у<EFBFBD><EFBFBD><EFBFBD><EFBFBD>т<EFBFBD><EFBFBD>ソ
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
€<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ξ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Λ<EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Μ<EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD>€
@@image:150&162
€<EFBFBD>€€€<EFBFBD><EFBFBD>€€€€<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD>€<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD>ソ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>€<EFBFBD>€<EFBFBD><EFBFBD>
@@image:118&125
€€€€<EFBFBD><EFBFBD>€€€€<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
&]
[s0;%% &]
[s9;%% The famous foundation of any GUI. It has no Value.&]
[s0;%% &]
[s0; [%%/ Derived from][%% ][^topic`:`/`/CtrlLib`/src`/Pusher`$en`-us^ Pusher]&]
[s3;%% &]
[s0; &]
[ {{10000F(128)G(128)@1 [s0;%% [* Constructor Detail]]}}&]
[s3; &]
[s5;:Button`:`:Button`(`): [* Button]()&]
[s2;%% Initializes the button.&]
[s3; &]
[s4; &]
[s5;:Button`:`:`~Button`(`): [@(0.0.255) `~][* Button]()&]
[s2;%% Default destructor.&]
[s3; &]
[s0; &]
[ {{10000F(128)G(128)@1 [s0;%% [* Public Member List]]}}&]
[s3; &]
[s5;:Button`:`:SetImage`(const Image`&`): [_^Button^ Button][@(0.0.255) `&]_[* SetImage]([@(0.0.255) c
onst]_[_^Image^ Image][@(0.0.255) `&]_[*@3 img])&]
[s2;%% Sets the image of the button.&]
[s7;%% [%-*C@3 img]-|Image.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Button`:`:SetMonoImage`(const Image`&`): [_^Button^ Button][@(0.0.255) `&]_[* SetMonoI
mage]([@(0.0.255) const]_[_^Image^ Image][@(0.0.255) `&]_[*@3 img])&]
[s2;%% Sets the monochromatic image. Image is colored according to
current GUI look`&feel.&]
[s7;%% [%-*C@3 img]-|Image.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Button`:`:EdgeStyle`(`): [_^Button^ Button][@(0.0.255) `&]_[* EdgeStyle]()&]
[s2;%% Activates visual style suitable for buttons used inside frame
of other Ctrls, like drop`-down buttons in droplists.&]
[s2;%%
@@image:362&150
€<EFBFBD>€<EFBFBD>€€<EFBFBD><EFBFBD>€€€€<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ν<EFBFBD><EFBFBD><EFBFBD>ソ<EFBFBD>
<EFBFBD><EFBFBD><EFBFBD>€<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD>€<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>寿<EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Button`:`:ScrollStyle`(`): [_^Button^ Button][@(0.0.255) `&]_[* ScrollStyle]()&]
[s2;%% Activates visual style suitable for buttons used in Scrollbars.&]
[s2;%%
@@image:125&325
€€€€€ξ<EFBFBD>€€€€<EFBFBD><EFBFBD><EFBFBD><EFBFBD>щ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD>寿<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
<EFBFBD><EFBFBD>€<EFBFBD>€<EFBFBD><EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>μ<EFBFBD>ソ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>橿<EFBFBD>
&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Button`:`:NormalStyle`(`): [_^Button^ Button][@(0.0.255) `&]_[* NormalStyle]()&]
[s2;%% Activates the visual style suitable for a standard button.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3; &]
[s4; &]
[s5;:Button`:`:LeftEdgeStyle`(`): [_^Button^ Button][@(0.0.255) `&]_[* LeftEdgeStyle]()&]
[s2;%% Activates visual style suitable for buttons used inside frame
of other Ctrls, on the left side, like in MultiButton.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3; &]
[s4; &]
[s5;:Button`:`:AutoStyle`(`): [_^Button^ Button][@(0.0.255) `&]_[* AutoStyle]()&]
[s2;%% Sets the button to automatic look, clearing all style information.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s0; &]
[s4; &]
[s5;:Button`:`:Ok`(`): [_^Button^ Button][@(0.0.255) `&]_[* Ok]()&]
[s2;%% Makes button `"default accept`" `- it might have different
visual representation and it is activated by Enter hotkey.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Button`:`:Cancel`(`): [_^Button^ Button][@(0.0.255) `&]_[* Cancel]()&]
[s2;%% Makes button `"default cancel`" `- it might have different
visual representation and it is activated by Esc hotkey.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Button`:`:Exit`(`): [_^Button^ Button][@(0.0.255) `&]_[* Exit]()&]
[s2;%% Makes button `"default exit`" `- it might have different visual
representation and it is activated by both Esc or Enter hotkey.&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Button`:`:Normal`(`): [_^Button^ Button][@(0.0.255) `&]_[* Normal]()&]
[s2;%% Makes button (previously modifies with Ok, Cancel or Exit)
`"normal`".&]
[s7;%% [*/ Return value]-|`*this for chaining.&]
[s3;%% &]
[s4; &]
[s5;:Button`:`:SetStyle`(const Button`:`:Style`&`): [_^Button^ Button][@(0.0.255) `&]_[* Se
tStyle]([@(0.0.255) const]_[_^Button`:`:Style^ Style][@(0.0.255) `&]_[*@3 s])&]
[s2;%% Sets the style of to button to [^topic`:`/`/CtrlLib`/src`/Button`$en`-us`#Button`:`:Style`:`:struct^ B
utton`::Style] [%-*@3 s].&]
[s3;%% &]
[s4; &]
[s5;:Button`:`:StyleNormal`(`): [@(0.0.255) static] [@(0.0.255) const]_[_^Button`:`:Style^ S
tyle][@(0.0.255) `&]_[* StyleNormal]()&]
[s2;%% Returns the style used when painting `"normal`" buttons.&]
[s3; &]
[s4; &]
[s5;:Button`:`:StyleOk`(`): [@(0.0.255) static] [@(0.0.255) const]_[_^Button`:`:Style^ Styl
e][@(0.0.255) `&]_[* StyleOk]()&]
[s2;%% Returns the style used when painting `"default accept`" buttons.&]
[s3; &]
[s4; &]
[s5;:Button`:`:StyleEdge`(`): [@(0.0.255) static] [@(0.0.255) const]_[_^Button`:`:Style^ St
yle][@(0.0.255) `&]_[* StyleEdge]()&]
[s2;%% Returns the style used when painting buttons on the inside
of a frame.&]
[s3; &]
[s4; &]
[s5;:Button`:`:StyleLeftEdge`(`): [@(0.0.255) static] [@(0.0.255) const]_[_^Button`:`:Style^ S
tyle][@(0.0.255) `&]_[* StyleLeftEdge]()&]
[s2;%% Returns the style used when painting buttons on the inside
of a frame, on the left side.&]
[s3; &]
[s4; &]
[s5;:Button`:`:StyleScroll`(`): [@(0.0.255) static] [@(0.0.255) const]_[_^Button`:`:Style^ S
tyle][@(0.0.255) `&]_[* StyleScroll]()&]
[s2;%% Returns the style used when painting scrollbar buttons.&]
[s3; &]
[s0; &]
[s0;3%% &]
[s0; &]
[ {{10000@3 [s0;%% [*@(229)4 Button`::Style]]}}&]
[s3; &]
[s1;:Button`:`:Style`:`:struct: [@(0.0.255)3 struct][3 _][*3 Style][3 _:_][@(0.0.255)3 public][3 _
][*@3;3 ChStyle][@(0.0.255)3 <][*3 Style][@(0.0.255)3 >][3 _]&]
[s9;%% This structure defines the look of a Button.&]
[s3; &]
[s0; ]