"{ Encoding: utf8 }"

"

 COPYRIGHT (c) 1991 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libwidg' }"

"{ NameSpace: Smalltalk }"

DialogBox subclass:#OptionBox

	instanceVariableNames:'labelPanel formLabel textLabel textView buttons actions

		defaultButtonIndex'

	classVariableNames:'WarnBitmap InfoBitmap YesNoBitmap'

	poolDictionaries:''

	category:'Views-DialogBoxes'

!

!OptionBox class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1991 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

   CAVEAT: this is a leftover - functionality has been merged into DialogBox

   PLEASE use one of the `Dialog chooseXXX' methods instead of OptionBox.

   Historic note:

      originally, ST/X had separate classes for the various entry methods;

      there were YesNoBox, EnterBox, InfoBox and so on.

      In the meantime, the DialogBox class (and therefore its alias: Dialog)

      is going to duplicate most functionality found in these classes.

      In the future, those existing subclasses' functionality is going to

      be moved fully into Dialog, and the subclasses will be replaced by dummy

      delegators. (They will be kept for backward compatibility, though).

    Description:

      OptionBoxes are like YesNoBoxes but with as many buttons as you like;

      this will finally be a superclass of WarnBox and YesNoBox - or maybe merged

      all into DialogBox..

      Use them for multiway questions.

      For a consistent user interface, the rightmost (last) button should be the default return

      button (i.e. pressing return in the box performs this buttons function).

      However, this is reversed automatically if the viewStyle says so (Windows vs. OSX vs. Linux),

      so the programmer MUST always put the no-actions (i.e. cancel) first and the ok-actions (yes) last.

    [author:]

        Claus Gittinger

    [see also:]

        DialogBox

"

!

examples

"

 just opening 

 (not real world examples, as you'd have to ask the box instance about the choice afterwards;

  see better usage examples below):

                                                                        [exBegin]

    |box|

    box := OptionBox title:'hello' numberOfOptions:4.

    box showAtPointer

                                                                        [exEnd]

                                                                        [exBegin]

    |box|

    box := OptionBox title:'hello'.

    box buttonTitles:#('one' 'two' 'three').

    box defaultButtonIndex:3.

    box showAtPointer

                                                                        [exEnd]

 showing a long list:                                                                    

                                                                        [exBegin]

    |box|

    box := OptionBox title:(1 to:100 collect:#asString) numberOfOptions:3.

    box buttonTitles:#('one' 'two' 'three').

    box defaultButtonIndex:3.

    box showAtPointer

                                                                        [exEnd]

 performing an action:

                                                                        [exBegin]

    |box|

    box := OptionBox title:'hello' numberOfOptions:3.

    box buttonTitles:#('one' 'two' 'three').

    box action:[:which | Transcript show:'button ';

                                    show: which;

                                    showCR:' was pressed'].

    box showAtPointer

                                                                        [exEnd]

 returning a value:

                                                                        [exBegin]

    |what|

    what := OptionBox

                  request:('text has not been accepted.\\Your modifications will be lost when continuing.') withCRs

                  label:' Attention'

                  image:(WarningBox iconBitmap)

                  buttonLabels:#('Abort' 'Accept' 'Continue')

                  values:#(#abort #accept #continue).

    Transcript showCR:what.

                                                                        [exEnd]

 use callBack-hook to intercept creation:

                                                                        [exBegin]

    |what|

    AboutToOpenBoxNotificationSignal handle:[:ex |

        |box|

        box := ex parameter.

        box verticalPanel

            add:(CheckBox label:'Do no show this Dialog again.'

                          model:false asValue).

        ex proceed.

    ] do:[

        what := OptionBox

                      request:('bla bla bla bla.\\You must bla bla bla!!') withCRs

                      label:' Attention'

                      image:(WarningBox iconBitmap)

                      buttonLabels:#('Abort' 'Accept' 'Continue')

                      values:#(#abort #accept #continue)

                      default:#continue.

    ].

    Transcript showCR:what.

                                                                        [exEnd]

"

! !

!OptionBox class methodsFor:'instance creation'!

title:titleString

    "create a new optionBox with title, aTitleString"

    |box|

    box := self basicNew.

    box device:Screen current.

    "/ do not initialize, #device: already did that

"/    box initialize.

    box title:titleString.

    ^ box

    "Created: / 26-10-2018 / 10:56:42 / Claus Gittinger"

    "Modified: / 29-07-2019 / 11:50:43 / Maren"

!

title:titleString numberOfOptions:nOptions

    "create a new optionBox with title, aTitleString and nOptions options"

    |box|

    box := self basicNew numberOfOptions:nOptions.

    box device:Screen current.

    "/ do not initialize, #device: already did that

"/    box initialize.

    box title:titleString.

    ^ box

    "Modified (comment): / 26-10-2018 / 10:56:48 / Claus Gittinger"

    "Modified: / 29-07-2019 / 11:46:21 / Maren"

! !

!OptionBox class methodsFor:'easy startup'!

forRequest:title label:label image:anImage buttonLabels:labels values:values default:defaultValue

    "create a new optionBox and return it.

     Does not open the box."

    |box|

    box := OptionBox title:title numberOfOptions:(labels size).

    box buttonTitles:labels.

    box defaultButtonIndex:(values indexOf:defaultValue).

    box label:label; image:anImage.

    values keysAndValuesDo:[:idx :val |

        val == false ifTrue:[

            (box buttons at:idx) cursor:(Cursor thumbsDown).

        ].

        val == true ifTrue:[

            (box buttons at:idx) cursor:(Cursor thumbsUp).

        ].

    ].

    ^ box

    "Modified: / 23.2.2000 / 11:59:32 / cg"

!

request:title buttonLabels:labels values:values

    "create a new optionBox, open it modal and return the value of

     the corresponding values collection. Return nil if canceled"

    ^ self

        request:title

        label:title

        buttonLabels:labels

        values:values

    "

     OptionBox

        request:'please select any'

        buttonLabels:#('one' 'two' 'three')

        values:#(1 2 3)

    "

    "Modified: / 08-02-2011 / 11:22:13 / cg"

    "Modified (comment): / 24-08-2017 / 15:03:02 / cg"

!

request:title buttonLabels:labels values:values default:defaultValue

    "create a new optionBox, open it modal and return the value of

     the corresponding values collection. Return nil if canceled."

    ^ self

        request:title label:title image:(YesNoBox iconBitmap) buttonLabels:labels values:values

        default:defaultValue onCancel:nil

    "

     OptionBox

        request:'please select'

        buttonLabels:#('one' 'two' 'three')

        values:#(1 2 3)

        default:3

    "

    "Modified (comment): / 24-08-2017 / 15:03:07 / cg"

!

request:title label:label buttonLabels:labels values:values

    "create a new optionBox, open it modal and return the value of

     the corresponding values collection. Return nil if canceled"

    ^ self

        request:title

        label:label

        image:(YesNoBox iconBitmap)

        buttonLabels:labels

        values:values

        default:nil

        onCancel:nil

    "

     OptionBox

        request:'please select'

        label:'select any'

        buttonLabels:#('one' 'two' 'three')

        values:#(1 2 3)

    "

    "Modified: / 08-02-2011 / 11:32:48 / cg"

    "Modified (comment): / 24-08-2017 / 15:03:10 / cg"

!

request:title label:label buttonLabels:labels values:values default:defaultValue

    "create a new optionBox, open it modal and return the value of

     the corresponding values collection. Return nil if canceled"

    ^ self

        request:title label:label image:(YesNoBox iconBitmap) buttonLabels:labels values:values

        default:defaultValue onCancel:nil

    "

     OptionBox

        request:'please select'

        label:'select any'

        buttonLabels:#('one' 'two' 'three')

        values:#(1 2 3)

        default:3

    "

    "Modified (comment): / 24-08-2017 / 15:03:15 / cg"

!

request:title label:label buttonLabels:labels values:values default:defaultValue onCancel:cancelValue

    "create a new optionBox, open it modal and return the value of

     the corresponding values collection. Return cancelValue if canceled."

    ^ self

        request:title label:label image:(YesNoBox iconBitmap) buttonLabels:labels values:values

        default:defaultValue onCancel:cancelValue

    "

     OptionBox

        request:'please select'

        label:'select any'

        buttonLabels:#('one' 'two' 'three')

        values:#(1 2 3)

        default:3

        onCancel:2

    "

    "Modified (comment): / 24-08-2017 / 15:03:18 / cg"

!

request:title label:label image:anImage buttonLabels:labels values:values

    "create a new optionBox, open it modal and return the value of

     the corresponding values collection. Return nil, if canceled."

    ^ self

        request:title label:label image:anImage buttonLabels:labels values:values

        default:nil onCancel:nil

    "

     OptionBox

        request:'please select'

        label:'select any'

        image:(WarningBox iconBitmap)

        buttonLabels:#('one' 'two' 'three')

        values:#(1 2 3)

    "

    "Modified (comment): / 24-08-2017 / 15:03:31 / cg"

!

request:title label:label image:anImage buttonLabels:labels values:values default:defaultValue

    "create a new optionBox, open it modal and return the value of

     the corresponding values collection. Return nil if canceled."

    ^ self

        request:title label:label image:anImage buttonLabels:labels values:values

        default:defaultValue onCancel:nil

    "

     OptionBox

        request:'please select'

        label:'select any'

        image:(WarningBox iconBitmap)

        buttonLabels:#('one' 'two' 'three')

        values:#(1 2 3)

        default:3

    "

    "Modified (comment): / 24-08-2017 / 15:03:34 / cg"

!

request:title label:label image:anImage buttonLabels:labels values:values default:defaultValue onCancel:cancelValue

    "create a new optionBox, open it modal and return the value of

     the corresponding values collection. Return cancelValue if canceled."

    |box retVal|

    retVal := cancelValue.

    box := self

                forRequest:title

                label:label

                image:anImage

                buttonLabels:labels

                values:values

                default:defaultValue.

    box action:[:n | retVal := values at:n].

    self showAndThenDestroyBox:box.

    ^ retVal

    "

     OptionBox

        request:'please select'

        label:'select any'

        image:(WarningBox iconBitmap)

        buttonLabels:#('one' 'two' 'three')

        values:#(1 2 3)

        default:3

        onCancel:nil

    "

    "Modified: / 23-02-2000 / 11:59:32 / cg"

    "Modified (comment): / 24-08-2017 / 15:03:36 / cg"

! !

!OptionBox class methodsFor:'obsolete'!

forRequest:title label:label form:anImage buttonLabels:labels values:values default:defaultValue

    "create a new optionBox and return it.

     Does not open the box."

    <resource:#obsolete>

    self forRequest:title label:label image:anImage buttonLabels:labels values:values default:defaultValue

!

request:title label:label form:aForm buttonLabels:labels values:values

    "create a new optionBox, open it modal and return the value of

     the corresponding values collection. Return nil, if canceled."

    <resource:#obsolete>

    ^ self

        request:title label:label image:aForm buttonLabels:labels values:values

        default:nil onCancel:nil

    "Modified (comment): / 24-08-2017 / 15:03:22 / cg"

!

request:title label:label form:aForm buttonLabels:labels values:values default:defaultValue

    "create a new optionBox, open it modal and return the value of

     the corresponding values collection. Return nil if canceled."

    <resource:#obsolete>

    ^ self

        request:title

        label:label

        image:aForm

        buttonLabels:labels

        values:values

        default:defaultValue

        onCancel:nil

    "Modified (comment): / 24-08-2017 / 15:03:25 / cg"

!

request:title label:label form:aForm buttonLabels:labels values:values default:defaultValue onCancel:cancelValue

    "create a new optionBox, open it modal and return the value of

     the corresponding values collection. Return cancelValue if canceled."

    <resource:#obsolete>

    ^ self request:title label:label image:aForm buttonLabels:labels values:values default:defaultValue onCancel:cancelValue

    "Modified (comment): / 24-08-2017 / 15:03:28 / cg"

! !

!OptionBox methodsFor:'accessing'!

action:actionBlock

    "define a single the action for all buttons.

     The action will be evaluated with the button index as argument."

    buttons keysAndValuesDo:[:index :button |

	button action:[

		       button turnOffWithoutRedraw.

		       self hide.

		       actionBlock value:index

		      ]

    ].

!

actions:actionBlocks

    "define the actions"

    actions := actionBlocks

!

buttonTitles:titles actions:actionBlocks

    "define both button titles and actions"

    self buttonTitles:titles.

    actions := actionBlocks.

!

defaultButtonIndex:index

    "define which button is the default (i.e. return-) button.

     By default, no returnButton is setup.