From d3430589f27da23a28d441e74ae595d5da055e03 Mon Sep 17 00:00:00 2001 From: cbpporter Date: Thu, 12 Mar 2009 18:04:16 +0000 Subject: [PATCH] StatusBar documentation update git-svn-id: svn://ultimatepp.org/upp/trunk@951 f0d560ea-af0d-0410-9eb7-867de7ffcac7 --- uppsrc/CtrlLib/src.tpp/StatusBar$en-us.tpp | 309 ++++++++++++++++++++- 1 file changed, 294 insertions(+), 15 deletions(-) diff --git a/uppsrc/CtrlLib/src.tpp/StatusBar$en-us.tpp b/uppsrc/CtrlLib/src.tpp/StatusBar$en-us.tpp index a34193d87..85fbca243 100644 --- a/uppsrc/CtrlLib/src.tpp/StatusBar$en-us.tpp +++ b/uppsrc/CtrlLib/src.tpp/StatusBar$en-us.tpp @@ -1,15 +1,294 @@ -TITLE("StatusBar and related widgets") -COMPRESSED -120,156,221,90,251,83,20,87,22,254,87,110,229,65,129,2,233,238,153,97,6,72,82,238,98,54,177,146,184,41,101,55,85,75,33,211,51,115,97,122,211,211,61,213,221,3,178,235,90,188,196,103,64,163,68,37,40,198,7,106,80,67,76,130,16,133,104,34,62,162,70,204,38,198,199,26,9,74,192,104,162,150,10,110,86,139,61,247,118,247,76,15,52,160,32,38,187,254,192,204,244,237,123,239,57,223,61,231,59,143,107,14,135,158,122,138,73,102,158,100,198,248,151,49,29,231,243,17,81,203,205,17,156,78,79,38,207,185,50,223,120,249,143,233,153,83,166,37,166,57,147,96,17,22,22,113,184,89,135,199,229,96,157,92,26,252,97,29,44,231,226,28,78,214,195,165,59,61,14,135,135,201,240,139,188,170,230,230,136,156,199,147,73,118,230,96,18,231,118,113,172,219,233,113,122,88,135,219,195,193,92,142,97,56,198,205,185,88,167,195,195,185,50,2,88,245,231,230,240,30,71,230,148,89,105,48,201,65,118,130,197,25,54,141,115,186,157,28,227,96,56,39,108,197,122,60, -78,214,237,242,56,210,211,210,50,252,124,88,19,100,201,216,75,96,89,142,205,244,177,238,76,16,121,254,252,249,169,172,147,209,37,112,194,98,44,227,4,81,89,120,198,56,57,55,235,74,103,210,93,30,214,195,56,96,113,151,155,113,101,132,121,133,15,217,107,78,214,112,141,169,186,155,201,16,52,12,75,76,153,202,178,110,152,146,150,156,246,36,235,116,131,162,30,135,211,229,113,51,176,57,199,113,14,7,199,58,184,244,116,206,149,230,114,103,4,49,31,192,74,110,206,223,243,254,241,244,11,51,83,254,52,27,229,168,142,76,52,91,227,181,136,250,123,94,65,10,22,121,13,7,16,133,21,171,136,151,2,72,145,35,154,32,97,53,33,55,71,101,50,17,249,112,101,190,60,141,65,57,79,51,76,10,195,76,75,100,82,153,84,206,229,74,66,198,105,152,207,201,57,230,153,63,209,12,41,95,206,210,20,49,151,172,192,233,11,193,199,180,105,66,136,47,192,25,105,78,71,2,156,79,73,121,111,201,234,146,146,146,242,43,131,240,183,228,238,251,117,63,125,115,98,113, -73,83,201,178,5,93,91,251,171,15,111,187,81,94,221,189,111,215,134,238,219,11,151,172,175,88,217,252,65,67,243,79,155,246,221,168,106,122,235,139,193,246,237,159,92,90,53,176,232,171,247,174,238,222,180,229,202,221,235,173,231,6,86,119,245,238,219,95,94,219,121,188,165,178,239,227,206,202,198,35,173,11,171,55,156,248,236,70,107,201,150,117,155,250,238,29,187,55,216,187,248,64,125,199,145,15,111,110,190,84,177,179,121,237,185,246,190,15,62,190,188,174,189,175,227,64,99,103,229,206,187,119,170,118,44,106,219,120,244,70,247,217,230,115,183,79,31,252,186,243,254,123,235,191,95,255,207,170,53,253,27,107,187,87,124,85,127,255,230,207,221,87,62,90,125,235,106,249,183,23,106,206,246,220,61,125,160,233,210,194,55,75,107,59,183,150,244,191,127,227,163,234,183,222,90,213,242,197,143,117,205,155,151,237,217,218,188,253,204,206,120,221,77,72,144,0,80,35,85,8,133,69,140,84,56,13,193,143,232,115,45,200,107,112,40,97,5,171,88,210,84,36,192,4,37,196, -19,67,68,249,2,22,3,169,104,134,70,102,171,145,112,88,86,225,228,52,25,249,48,138,144,175,188,138,254,0,102,134,145,156,111,57,98,111,10,10,129,219,9,100,43,115,127,21,249,121,137,204,227,3,1,203,68,149,172,166,5,113,108,118,50,236,42,138,130,84,128,4,13,229,43,114,136,14,139,56,95,67,50,88,143,80,16,212,82,109,116,3,223,225,125,34,21,36,32,168,97,145,47,38,75,168,184,16,43,188,8,159,126,162,144,138,138,4,45,136,2,56,31,172,45,0,63,2,90,48,57,250,19,195,24,86,136,104,127,230,197,8,38,219,193,247,215,120,65,210,102,193,124,19,7,94,84,101,68,247,2,209,141,189,16,56,74,88,86,120,165,24,249,101,73,3,32,17,160,72,37,55,87,231,67,114,4,30,131,124,154,16,194,169,150,83,2,139,207,121,6,77,199,138,80,8,239,17,149,115,77,195,215,65,122,101,214,179,68,205,231,115,227,253,195,198,59,10,101,33,16,245,134,168,95,128,35,205,198,90,244,121,98,238,240,137,160,163,205,60,7,210,120,95,244,121, -50,178,153,8,234,170,54,83,231,120,51,188,25,81,232,230,196,80,140,190,234,77,176,238,67,172,110,244,141,70,146,144,30,98,116,36,41,247,127,5,28,106,99,115,116,83,123,44,160,128,181,129,162,42,74,244,43,24,24,24,60,61,31,73,24,131,55,38,81,67,53,124,132,90,104,48,230,184,212,82,157,153,38,158,83,178,12,197,83,230,205,144,2,120,46,121,221,152,105,247,38,85,33,101,94,150,225,20,150,151,13,39,51,221,133,184,176,44,129,183,106,58,195,16,17,52,60,87,3,158,33,142,252,59,117,182,166,192,23,187,61,116,101,83,230,189,78,62,45,91,192,230,40,44,204,197,162,154,138,102,226,2,160,180,66,140,10,233,174,130,20,16,252,20,4,74,127,230,4,53,40,71,196,0,97,41,112,106,63,8,82,0,83,36,36,69,66,62,32,6,88,89,95,46,70,75,148,142,144,79,86,2,250,248,48,224,184,73,241,214,201,112,186,73,241,156,71,233,0,241,86,76,45,22,12,66,140,25,46,61,74,191,12,54,164,15,23,5,101,113,116,59,30,217,58,199, -207,180,217,102,36,120,236,39,56,54,67,144,200,35,67,174,149,231,125,206,186,10,228,174,204,196,236,96,226,74,79,42,29,82,189,35,150,177,49,245,183,154,217,176,216,158,108,134,125,96,8,1,84,130,148,151,230,29,70,164,55,147,141,177,45,206,150,91,141,51,130,183,178,225,171,26,230,117,74,30,42,196,4,76,244,5,41,96,115,96,81,197,103,132,66,56,32,0,59,138,197,144,41,202,97,213,154,81,141,37,135,101,127,115,101,203,169,12,73,216,65,150,23,177,150,205,251,178,72,110,20,255,82,98,82,44,175,215,13,199,4,107,202,51,104,22,214,34,138,164,147,57,1,10,78,41,70,210,113,248,143,15,33,57,12,105,163,38,43,222,231,198,109,208,122,188,154,131,244,207,17,76,90,181,49,59,146,78,67,222,9,230,151,168,38,217,89,136,58,132,178,226,89,144,18,32,61,41,123,10,28,14,8,21,215,124,103,78,172,136,178,19,153,82,126,180,172,158,76,104,2,163,120,100,64,23,64,79,16,160,218,208,130,144,62,24,145,93,213,43,19,139,95,206,140,136, -162,62,170,162,48,41,58,163,9,6,44,136,66,88,11,202,1,59,156,3,128,243,116,203,78,169,35,27,160,119,10,21,129,228,252,254,32,112,182,153,169,76,20,236,87,160,236,25,87,106,90,52,2,122,145,112,172,106,210,235,56,35,211,201,153,66,107,172,92,48,25,200,120,226,139,52,155,170,201,54,15,179,230,96,195,194,238,227,3,109,22,73,202,30,27,106,52,5,252,13,193,198,100,102,88,209,138,251,158,232,77,202,136,238,61,28,198,88,8,200,34,222,171,68,252,64,129,169,58,4,217,65,65,154,33,169,88,211,85,139,234,200,208,6,142,247,137,89,224,108,197,222,39,200,192,80,15,141,151,14,13,137,23,15,221,228,137,118,10,70,232,242,176,92,154,39,129,117,176,101,229,199,74,106,72,155,231,170,222,230,217,83,247,211,218,182,170,207,55,44,90,126,232,254,224,59,215,214,54,110,57,219,125,236,224,23,167,26,155,207,52,92,57,221,93,181,249,203,21,71,55,46,187,181,178,164,105,217,153,250,95,58,46,95,62,95,217,190,175,107,85,197,166,193,139,37, -251,223,57,125,103,213,157,250,207,59,239,221,27,92,95,186,182,186,174,180,235,235,207,154,6,62,88,86,85,209,248,118,105,217,246,253,77,181,27,174,172,89,82,209,8,223,107,90,150,54,239,88,250,159,69,87,58,246,55,213,212,30,120,123,251,182,154,234,174,166,178,158,11,155,142,236,250,250,112,207,209,147,203,251,191,218,118,113,105,77,105,217,205,91,59,170,122,119,245,55,31,216,125,170,243,122,219,158,142,29,219,143,29,237,61,180,226,126,237,149,119,215,244,44,104,216,178,183,254,250,162,142,203,239,86,31,249,100,83,235,174,95,246,180,236,57,122,169,175,188,99,160,233,124,207,189,189,117,125,39,63,255,113,119,79,67,203,185,203,239,53,86,46,121,187,119,121,251,142,198,47,203,142,46,188,211,191,103,71,217,133,91,101,71,119,156,95,185,186,185,235,135,131,107,250,23,108,92,243,237,169,158,193,139,219,15,253,235,64,243,225,157,45,235,142,239,190,186,253,212,130,147,187,214,156,187,121,103,101,221,241,187,255,6,241,234,239,53,175,95,209,191,173,119,119,95, -99,83,71,123,219,194,182,117,119,111,151,14,84,172,188,118,178,113,111,217,206,202,165,215,183,84,45,238,109,24,232,232,57,249,75,205,193,178,197,183,54,151,181,94,107,169,124,247,204,247,205,155,47,44,175,216,187,254,187,238,129,214,218,107,23,27,62,108,104,236,90,120,186,188,236,195,149,55,119,94,123,179,249,253,229,213,215,150,183,12,126,243,209,199,37,203,143,111,233,111,56,63,80,182,160,189,178,28,190,127,87,115,173,237,231,31,207,150,111,61,113,100,201,15,125,135,154,62,169,31,248,244,250,138,141,235,90,63,109,43,61,113,251,112,93,252,233,198,186,75,180,145,165,27,159,222,252,33,145,48,48,172,47,101,233,99,241,34,242,193,68,168,14,136,105,250,100,77,131,242,205,168,214,66,224,65,136,15,135,69,82,15,146,248,89,4,181,161,92,148,58,202,238,130,20,132,8,171,25,189,154,24,51,208,78,38,214,96,65,210,36,18,233,242,249,17,201,175,139,32,104,197,230,158,62,94,197,186,141,211,158,18,176,134,10,30,164,10,127,195,222,148,2,69,8,131, -27,17,239,86,48,60,34,145,220,152,166,75,134,18,161,110,167,189,56,90,42,251,138,233,24,240,145,70,244,77,162,82,0,47,72,5,164,194,215,76,55,245,225,32,95,40,200,17,37,158,191,134,65,66,102,132,121,133,164,22,6,16,40,91,38,18,162,144,172,96,189,33,104,215,179,3,212,99,64,0,213,21,0,103,60,104,143,43,174,107,251,255,159,175,69,81,179,97,237,232,24,249,97,42,133,178,192,154,124,188,255,13,214,251,44,213,32,38,174,55,193,251,124,28,171,71,145,200,139,78,210,231,228,153,19,158,55,88,222,62,184,252,14,249,141,121,180,156,78,214,227,154,32,21,202,111,224,64,50,29,164,170,70,219,155,182,218,12,13,221,209,151,230,88,216,219,62,120,191,132,199,29,189,189,121,254,226,17,2,56,145,52,72,87,54,157,41,94,238,33,39,70,87,210,203,10,125,214,163,203,98,30,2,138,153,242,108,160,132,23,129,16,108,34,244,116,25,73,178,22,237,63,235,244,129,116,246,152,112,242,16,103,134,177,31,241,233,195,112,241,71,203,31,44,39,64, -232,15,18,115,137,62,243,71,20,202,54,106,49,228,235,161,104,222,144,15,254,2,228,72,207,74,161,89,189,36,163,2,81,246,1,151,191,14,38,249,18,22,195,70,110,158,152,20,179,89,51,217,50,173,147,114,147,254,144,176,33,82,101,189,75,68,152,188,72,0,142,38,188,21,35,119,75,67,255,85,44,69,40,151,102,203,178,72,137,63,46,158,144,188,70,125,196,137,205,107,138,92,0,156,175,18,62,52,129,204,38,167,69,103,161,176,34,23,10,1,208,195,184,196,209,64,48,170,168,165,58,15,27,75,196,221,226,8,82,188,197,163,68,152,84,128,37,114,51,34,22,39,147,113,147,130,147,104,64,2,194,144,160,154,164,60,31,37,117,217,247,87,120,102,4,57,26,62,244,248,98,54,112,105,178,107,217,159,54,88,229,81,105,193,170,240,156,120,245,237,61,34,27,80,127,252,4,31,235,3,65,181,169,135,207,88,255,199,200,119,69,222,135,69,218,33,182,71,192,38,36,100,63,210,146,114,92,88,190,30,119,77,240,48,92,235,159,59,10,80,69,102,53,67,179,127, -244,23,172,200,80,102,243,146,209,109,143,189,18,228,85,19,80,172,97,37,68,125,55,70,15,86,128,44,224,193,222,102,197,20,235,240,255,122,64,142,31,68,8,51,15,4,163,141,77,33,179,49,1,154,113,12,51,66,16,251,109,1,245,26,33,141,16,150,198,27,221,53,222,39,12,135,43,75,191,86,142,24,109,29,202,76,54,136,145,49,53,140,253,66,190,224,183,94,117,141,118,61,96,108,153,50,111,118,244,66,41,128,231,166,70,117,53,188,30,48,139,165,211,57,177,121,201,118,98,196,191,130,188,83,17,59,225,112,109,197,222,172,247,189,137,230,47,90,249,39,88,115,196,184,247,99,71,164,119,4,98,135,19,109,27,88,94,161,162,143,112,45,163,163,139,13,178,228,21,168,1,198,128,215,232,134,71,95,66,175,70,84,13,225,185,130,10,46,16,136,68,219,152,162,144,143,73,95,156,28,152,85,248,95,147,62,101,141,23,199,107,200,113,115,109,2,13,25,183,222,58,154,102,4,41,82,216,246,90,193,92,19,162,138,101,238,175,8,207,120,175,212,189,121,97,57, -22,131,31,234,146,103,108,92,37,92,100,155,33,217,35,74,4,129,194,205,200,79,205,121,15,142,254,40,39,55,145,243,152,204,255,208,16,143,254,36,1,136,134,130,68,177,161,255,195,8,8,195,87,108,140,91,250,242,19,186,93,26,255,173,146,237,209,79,106,127,98,164,115,9,219,156,137,165,237,16,78,122,20,162,77,245,78,181,169,228,172,251,0,154,80,108,145,144,149,100,191,95,172,251,48,134,114,137,73,176,238,40,208,211,157,30,32,210,197,253,142,47,79,109,73,202,190,66,125,232,125,172,61,245,132,7,216,117,132,72,154,111,147,205,12,17,107,136,83,229,19,142,177,137,172,163,75,239,157,63,34,78,200,59,63,247,65,33,155,142,109,106,122,122,185,70,250,129,163,73,229,64,185,255,5,204,176,58,93, +topic "StatusBar and related widgets"; +[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 +[s0; [*+150 StatusBar related classes and routines]&] +[s3;%- &] +[ {{10000@3 [s0; [*@(229)4 InfoCtrl]]}}&] +[s3; &] +[s1;:InfoCtrl`:`:class:%- [@(0.0.255)3 class][3 _][*3 InfoCtrl][3 _:_][@(0.0.255)3 public][3 _][*@3;3 F +rameLR][@(0.0.255)3 <][_^Ctrl^3 Ctrl][@(0.0.255)3 >][3 _]&] +[s0; &] +[s2; +@@image:643&143 +瀗͉Ǩ⼮􇊞Ҫ벣 +̸Іȹ𹀥ȳㄭھ豵䝾Іٶ +ӎҟ鴗ݕ㇍Ч𴏒Ꜷح +&] +[s0; &] +[s9; InfoCtrl is a simple static Ctrl that represents information +field. It is supposed to be used as Frame of StatusBar `- multiple +InfoCtrls can be added as Frames to the StatusBar, filling it +from the left or right.&] +[s9; InfoCtrl is capable of displaying several sections with defined +width, defined either as Value or as PaintRect. It is also able +to display temporary content for the defined amount of time.&] +[s0; &] +[s0;%- [%%/ Derived from][%% ]FrameLR&] +[s3; &] +[s0;%- &] +[ {{10000F(128)G(128)@1 [s0; [* Constructor Detail]]}}&] +[s3;%- &] +[s5;:InfoCtrl`:`:InfoCtrl`(`):%- [* InfoCtrl]()&] +[s2; Constructor. Sets ThinInsetFrame as Frame 0 and `"Ready`" as +the default text.&] +[s3; &] +[s0; &] +[ {{10000F(128)G(128)@1 [s0; [* Public Method List]]}}&] +[s3;%- &] +[s5;:InfoCtrl`:`:Set`(int`,const PaintRect`&`,int`):%- [@(0.0.255) void]_[* Set]([@(0.0.255) i +nt]_[*@3 tab], [@(0.0.255) const]_[_^PaintRect^ PaintRect][@(0.0.255) `&]_[*@3 info], +[@(0.0.255) int]_[*@3 width])&] +[s5;:InfoCtrl`:`:Set`(int`,const Value`&`,int`):%- [@(0.0.255) void]_[* Set]([@(0.0.255) in +t]_[*@3 tab], [@(0.0.255) const]_[_^Value^ Value][@(0.0.255) `&]_[*@3 info], +[@(0.0.255) int]_[*@3 width])&] +[s2; Sets (creates if needed) the section of the InfoCtrl.&] +[s7; [%-*C@3 tab]-|Index of section.&] +[s7; [%-*C@3 info]-|Content of section. Value content is converted to +the text using AsString.&] +[s7; [%-*C@3 width]-|Width of section in pixels. Negative value indicates +that section should be placed given number of pixels from the +right border of the InfoCtrl.&] +[s3; &] +[s4;%- &] +[s5;:InfoCtrl`:`:Set`(const PaintRect`&`):%- [@(0.0.255) void]_[* Set]([@(0.0.255) const]_[_^PaintRect^ P +aintRect][@(0.0.255) `&]_[*@3 info])&] +[s5;:InfoCtrl`:`:Set`(const Value`&`):%- [@(0.0.255) void]_[* Set]([@(0.0.255) const]_[_^Value^ V +alue][@(0.0.255) `&]_[*@3 info])&] +[s2; Sets the single section that covers the whole InfoCtrl.&] +[s7; [%-*C@3 info]-|Content of section.&] +[s3; &] +[s4;%- &] +[s5;:InfoCtrl`:`:Temporary`(const PaintRect`&`,int`):%- [@(0.0.255) void]_[* Temporary]([@(0.0.255) c +onst]_[_^PaintRect^ PaintRect][@(0.0.255) `&]_[*@3 info], [@(0.0.255) int]_[*@3 timeoout]_`= +_[@3 2000])&] +[s5;:InfoCtrl`:`:Temporary`(const Value`&`,int`):%- [@(0.0.255) void]_[* Temporary]([@(0.0.255) c +onst]_[_^Value^ Value][@(0.0.255) `&]_[*@3 info], [@(0.0.255) int]_[*@3 timeout]_`=_[@3 2000]) +&] +[s2; Sets the temporary content, displayed instead of defined sections.&] +[s7; [%-*C@3 info]-|Content.&] +[s7; [%-*C@3 timeoout]-|Timespan of temporary content.&] +[s3; &] +[s4;%- &] +[s5;:InfoCtrl`:`:EndTemporary`(`):%- [@(0.0.255) void]_[* EndTemporary]()&] +[s2; Immediately stops displaying temporary content.&] +[s3; &] +[s4;%- &] +[s5;:InfoCtrl`:`:GetTabCount`(`)const:%- [@(0.0.255) int]_[* GetTabCount]()_[@(0.0.255) con +st]&] +[s7; [*/ Return value]-|The number of sections.&] +[s3; &] +[s4;%- &] +[s5;:InfoCtrl`:`:operator`=`(const String`&`):%- [@(0.0.255) void]_[* operator`=]([@(0.0.255) c +onst]_[_^String^ String][@(0.0.255) `&]_[*@3 s])&] +[s2; Same as Set(s).&] +[s7; [%-*C@3 s]-|Content of single section covering the whole InfoCtrl.&] +[s3; &] +[s4;%- &] +[s5;:InfoCtrl`:`:SetDefault`(const String`&`):%- [_^InfoCtrl^ InfoCtrl][@(0.0.255) `&]_[* S +etDefault]([@(0.0.255) const]_[_^String^ String][@(0.0.255) `&]_[*@3 d])&] +[s2; Sets the default text `- this value is used instead of Null +values passed to the Set method.&] +[s7; [%-*C@3 d]-|Default text.&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s4;%- &] +[s5;:InfoCtrl`:`:Left`(int`):%- [_^InfoCtrl^ InfoCtrl][@(0.0.255) `&]_[* Left]([@(0.0.255) in +t]_[*@3 w])&] +[s2; Sets up InfoCtrl to be placed [* left] when added as Frame with +defined width.&] +[s7; [%-*C@3 w]-|Width of InfoCtrl.&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s4;%- &] +[s5;:InfoCtrl`:`:Right`(int`):%- [_^InfoCtrl^ InfoCtrl][@(0.0.255) `&]_[* Right]([@(0.0.255) i +nt]_[*@3 w])&] +[s2; Sets up InfoCtrl to be placed [* right] when added as Frame with +defined width.&] +[s7; [%-*C@3 w]-|Width of InfoCtrl.&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s0; &] +[s0; &] +[s0;%- &] +[ {{10000@3 [s0; [*@(229)4 StatusBar]]}}&] +[s3; &] +[s1;:StatusBar`:`:class:%- [@(0.0.255)3 class][3 _][*3 StatusBar][3 _:_][@(0.0.255)3 public][3 _][*@3;3 I +nfoCtrl]&] +[s0; &] +[s2; +@@image:1268&131 +ˀ홽à왫ѫئ⎤Αɢ󓀰؟ۆ߀ +°阊ంݣȮϐҨߋ +ｷŬƑ願兦䡏Ⱥ妸䪫 +΂ɇɬۓĘߩǭ̲хϮ諰ž +ϫ漏Ă󤂹츆ᶤݐߦփ썶쐸մ +̥̥ޕكȊưǜ +&] +[s0; &] +[s9; StatusBar is a Frame Ctrl intended to be used as informational +bar at the bottom of the main application window.&] +[s9; StatusBar is inherited from InfoCtrl and retains all the functionality +of the base class. It adds `"size`-grip`" for resizing of the +window (if supported by the platform) and changes its Frame behaviour +to be placed at the bottom of its parent window. To add more +fields to the StatusBar, use InfoCtrl widgets.&] +[s0; &] +[s0;%- [%%/ Derived from][%% ][^topic`:`/`/CtrlLib`/src`/StatusBar`$en`-us`#InfoCtrl`:`:class^ I +nfoCtrl]&] +[s3; &] +[s0;%- &] +[ {{10000F(128)G(128)@1 [s0; [* Constructor Detail]]}}&] +[s3;%- &] +[s5;:StatusBar`:`:StatusBar`(`):%- [* StatusBar]()&] +[s2; Constructor. Sets the height based on the current system default +font. If there is no global WhenHelpDefault() callback defined +for the Bar, defines it so that Bar will use StatusBar to display +Menu and ToolBar informational texts.&] +[s3; &] +[s4;%- &] +[s5;:StatusBar`:`:`~StatusBar`(`):%- [@(0.0.255) `~][* StatusBar]()&] +[s2; Default destructor.&] +[s3;%- &] +[s0; &] +[s0;%- &] +[ {{10000F(128)G(128)@1 [s0; [* Public Method List]]}}&] +[s3;%- &] +[s5;:StatusBar`:`:operator`=`(const String`&`):%- [@(0.0.255) virtual] +[@(0.0.255) void]_[* operator`=]([@(0.0.255) const]_[_^String^ String][@(0.0.255) `&]_[*@3 s]) +&] +[s2; Same as Set(s).&] +[s7; [%-*C@3 s]-|Content of StatusBar.&] +[s3; &] +[s4;%- &] +[s5;:StatusBar`:`:operator Callback1``(`):%- [* operator_Callback1]()&] +[s7; [*/ Return value]-|A callback that, when invoked, calls Set for +the StatusBar.&] +[s3; &] +[s4;%- &] +[s5;:StatusBar`:`:Height`(int`):%- [_^StatusBar^ StatusBar][@(0.0.255) `&]_[* Height]([@(0.0.255) i +nt]_[*@3 `_cy])&] +[s2; Sets the height of the StatusBar.&] +[s7; [%-*C@3 `_cy]-|The height.&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s4;%- &] +[s5;:StatusBar`:`:NoSizeGrip`(`):%- [_^StatusBar^ StatusBar][@(0.0.255) `&]_[* NoSizeGrip]( +)&] +[s2; Do not display `"size grip`".&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s0; &] +[s0; &] +[s0;%- &] +[ {{10000@3 [s0; [*@(229)4 ProgressInfo]]}}&] +[s3; &] +[s1;:ProgressInfo`:`:class:%- [@(0.0.255)3 class][3 _][*3 ProgressInfo]&] +[s9; This class provides simple tool for displaying progress information +in the StatusBar (or generally, in InfoCtrl). It connects to +InfoCtrl object and replaces its content with progress indicator.&] +[s3; &] +[s0;%- &] +[ {{10000F(128)G(128)@1 [s0; [* Constructor Detail]]}}&] +[s3;%- &] +[s5;:ProgressInfo`:`:ProgressInfo`(`):%- [* ProgressInfo]()&] +[s2; Constructor.&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:ProgressInfo`(InfoCtrl`&`):%- [* ProgressInfo]([_^InfoCtrl^ InfoCtrl +][@(0.0.255) `&]_[*@3 f])&] +[s2; Constructor.&] +[s7; [%-*C@3 f]-|Target InfoCtrl.&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:`~ProgressInfo`(`):%- [@(0.0.255) `~][* ProgressInfo]()&] +[s2; Destructor. Sets the Null to target InfoCtrl.&] +[s3; &] +[s0;%- &] +[ {{10000F(128)G(128)@1 [s0; [* Public Method List]]}}&] +[s3;%- &] +[s5;:ProgressInfo`:`:Text`(const String`&`):%- [_^ProgressInfo^ ProgressInfo][@(0.0.255) `& +]_[* Text]([@(0.0.255) const]_[_^String^ String][@(0.0.255) `&]_[*@3 s])&] +[s2; Sets the text to be displayed as the label of progress indicator.&] +[s7; [%-*C@3 s]-|Text.&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:TextWidth`(int`):%- [_^ProgressInfo^ ProgressInfo][@(0.0.255) `&]_[* T +extWidth]([@(0.0.255) int]_[*@3 cx])&] +[s2; Sets the width of text. Zero means that the width has to be +determined based on text.&] +[s7; [%-*C@3 cx]-|Width in pixels.&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:Width`(int`):%- [_^ProgressInfo^ ProgressInfo][@(0.0.255) `&]_[* Width +]([@(0.0.255) int]_[*@3 `_cx])&] +[s2; Sets the width of progress indicator. Default is 200.&] +[s7; [%-*C@3 `_cx]-|Width in pixels.&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:Placement`(int`):%- [_^ProgressInfo^ ProgressInfo][@(0.0.255) `&]_[* P +lacement]([@(0.0.255) int]_[*@3 `_tabi])&] +[s2; Can be used to place progress indicator to specific section +of InfoCtrl.&] +[s7; [%-*C@3 `_tabi]-|Section index. Progress label is placed at [@3 `_tabi], +progress indicator at [@3 `_tabi] `+ 1.&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:Info`(InfoCtrl`&`):%- [_^ProgressInfo^ ProgressInfo][@(0.0.255) `&]_ +[* Info]([_^InfoCtrl^ InfoCtrl][@(0.0.255) `&]_[*@3 `_info])&] +[s2; Specifies the target InfoCtrl.&] +[s7; [%-*C@3 `_info]-|InfoCtrl. Must exists during the lifetime of ProgressInfo.&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:Total`(int`):%- [_^ProgressInfo^ ProgressInfo][@(0.0.255) `&]_[* Total +]([@(0.0.255) int]_[*@3 `_total])&] +[s2; Sets the total number of progress steps.&] +[s7; [%-*C@3 `_total]-|Total number.&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:Set`(int`,int`):%- [_^ProgressInfo^ ProgressInfo][@(0.0.255) `&]_[* Se +t]([@(0.0.255) int]_[*@3 `_pos], [@(0.0.255) int]_[*@3 `_total])&] +[s2; Sets the new progress information.&] +[s7; [%-*C@3 `_pos]-|Current progress.&] +[s7; [%-*C@3 `_total]-|Total number of progress steps.&] +[s7; [*/ Return value]-|`*this for chaining.&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:Set`(int`):%- [@(0.0.255) void]_[* Set]([@(0.0.255) int]_[*@3 `_pos])&] +[s2; Sets the new progress information.&] +[s7; [%-*C@3 `_pos]-|Current progress. Total number of steps is set +by Total method.&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:Get`(`)const:%- [@(0.0.255) int]_[* Get]()_[@(0.0.255) const]&] +[s7; [*/ Return value]-|Current progress.&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:operator`=`(int`):%- [@(0.0.255) void]_[* operator`=]([@(0.0.255) int]_ +[*@3 p])&] +[s2; Same as Set(p).&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:operator`+`+`(`):%- [@(0.0.255) void]_[* operator`+`+]()&] +[s2; Same as Set(Get() `+ 1)&] +[s3; &] +[s4;%- &] +[s5;:ProgressInfo`:`:operator int`(`):%- [* operator_int]()&] +[s7; [*/ Return value]-|Get().&] +[s3; &] +[s0; ] \ No newline at end of file