.doc .CtrlLib Informative dialogs reference now describes return values

git-svn-id: svn://ultimatepp.org/upp/trunk@10302 f0d560ea-af0d-0410-9eb7-867de7ffcac7
This commit is contained in:
klugier 2016-10-12 13:07:58 +00:00
parent 2129273b2e
commit 27937afe64

View file

@ -52,43 +52,59 @@ used DeQtf functino to display U`+`+ appropriate):&]
[s5;:Upp`:`:PromptOK`(const char`*`):%- [@(0.0.255) void]_[* PromptOK]([@(0.0.255) const]_[@(0.0.255) c
har]_`*[*@3 qtf])&]
[s2;%- The simplest variant with OK button.&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:PromptOKCancel`(const char`*`):%- [@(0.0.255) int]_[* PromptOKCancel]([@(0.0.255) c
onst]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2;%- Variant with OK and Cancel buttons.&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s2; [* Return value-|] 1 for OK; 0 when Cancel button was clicked;&]
[s3; &]
[s4; &]
[s5;:Upp`:`:PromptYesNo`(const char`*`):%- [@(0.0.255) int]_[* PromptYesNo]([@(0.0.255) con
st]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with Yes and No buttons.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s2; [* Return value-|]1 for Yes; 0 when No button was clicked;&]
[s3; &]
[s4; &]
[s5;:Upp`:`:PromptYesNoCancel`(const char`*`):%- [@(0.0.255) int]_[* PromptYesNoCancel]([@(0.0.255) c
onst]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with Yes, No and Cancel buttons.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s2; [* Return value-|]1 for Yes; 0 when No button was clicked; `-1
for Cancel;&]
[s3; &]
[s4; &]
[s5;:Upp`:`:PromptRetryCancel`(const char`*`):%- [@(0.0.255) int]_[* PromptRetryCancel]([@(0.0.255) c
onst]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with Retry and Cancel buttons.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s2; [* Return value-|]1 for Retry; 0 when Cancel button was clicked;&]
[s3; &]
[s4; &]
[s5;:Upp`:`:PromptAbortRetry`(const char`*`):%- [@(0.0.255) int]_[* PromptAbortRetry]([@(0.0.255) c
onst]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with Abort and Retry buttons.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s2; [* Return value-|]1 for Abort; 0 when Retry button was clicked;&]
[s3; &]
[s4; &]
[s5;:Upp`:`:PromptAbortRetryIgnore`(const char`*`):%- [@(0.0.255) int]_[* PromptAbortRetr
yIgnore]([@(0.0.255) const]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with Abort, Retry and Ignore buttons.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s2; [* Return value-|]1 for Abort; 0 when Retry button was clicked;
`-1 for Ignore;&]
[s3; &]
[s4; &]
[s5;:Upp`:`:PromptSaveDontSaveCancel`(const char`*`):%- [@(0.0.255) int]_[* PromptSaveDon
tSaveCancel]([@(0.0.255) const]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with Save, Don`'t Save and Cancel buttons.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s2; [* Return value-|]1 for Save; 0 when Don`'t Save button was clicked;
`-1 for Cancel;&]
[s10;%- &]
[ {{10000F(128)G(128)@1 [s0; [* Exclamation family]]}}&]
[s10;%- Displays dialogs with warning.&]
@ -105,6 +121,7 @@ on our donators list.`");]&]
[s4;%- &]
[s5;:Upp`:`:Exclamation`(const char`*`):%- [@(0.0.255) void]_[* Exclamation]([@(0.0.255) co
nst]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2;%- Simply variant with OK button.&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s10;%- &]
[ {{10000F(128)G(128)@1 [s0; [* Error family]]}}&]
@ -121,35 +138,52 @@ nst]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s4;%- &]
[s5;:Upp`:`:ErrorOK`(const char`*`):%- [@(0.0.255) void]_[* ErrorOK]([@(0.0.255) const]_[@(0.0.255) c
har]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- The simpliest variant with OK button. Should be used to notify
about errors that cannot be avoided at certain point of program
execution.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ErrorOKCancel`(const char`*`):%- [@(0.0.255) int]_[* ErrorOKCancel]([@(0.0.255) c
onst]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with OK and Cancel buttons.&]
[s2; [%-*@3 qtf-|-|-|]Message to display in QTF format.&]
[s2; [* Return value-|]1 for OK; 0 when Cancel button was clicked;&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ErrorYesNo`(const char`*`):%- [@(0.0.255) int]_[* ErrorYesNo]([@(0.0.255) const
]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with Yes and No buttons.&]
[s2; [%-*@3 qtf-|-|-|]Message to display in QTF format.&]
[s2; [* Return value-|]1 for Yes; 0 when No button was clicked;&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ErrorYesNoCancel`(const char`*`):%- [@(0.0.255) int]_[* ErrorYesNoCancel]([@(0.0.255) c
onst]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with Yes, No and Cancel buttons.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s2; [* Return value-|]1 for Yes; 0 when No button was clicked; 1 for
Yes; `-1 for Cancel;&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ErrorRetryCancel`(const char`*`):%- [@(0.0.255) int]_[* ErrorRetryCancel]([@(0.0.255) c
onst]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with Retry and Cancel buttons.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s2; [* Return value-|]1 for Retry; 0 when Cancel button was clicked;&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ErrorAbortRetry`(const char`*`):%- [@(0.0.255) int]_[* ErrorAbortRetry]([@(0.0.255) c
onst]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with Abort and Retry buttons.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s2; [* Return value-|]1 for Abort; 0 when Retry button was clicked;&]
[s3; &]
[s4; &]
[s5;:Upp`:`:ErrorAbortRetryIgnore`(const char`*`):%- [@(0.0.255) int]_[* ErrorAbortRetryI
gnore]([@(0.0.255) const]_[@(0.0.255) char]_`*[*@3 qtf])&]
[s2; [%-*@3 qtf] .Message to display in QTF format.&]
[s2;%- Variant with Abort, Retry and Ignore buttons.&]
[s2; [%-*@3 qtf] -|-|-|Message to display in QTF format.&]
[s2; [* Return value-|]1 for Abort; 0 when Retry button was clicked;
`-1 for Ignore;&]
[s10;%- ]]