"

 COPYRIGHT (c) 1989 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.

"

SelectionInListView subclass:#MenuView

	instanceVariableNames:'selectors args receiver enableFlags disabledFgColor onOffFlags

		subMenus subMenuShown superMenu checkColor lineLevel lineInset

		masterView needResize hideOnRelease sizeFixed shortKeys

		maxShortKeyStringLen actions'

	classVariableNames:'DefaultCheckColor DefaultViewBackground DefaultForegroundColor

		DefaultBackgroundColor DefaultDisabledForegroundColor

		DefaultHilightForegroundColor DefaultHilightBackgroundColor

		DefaultHilightLevel DefaultHilightStyle DefaultHilightFrameColor

		DefaultLineLevel DefaultLineInset DefaultShadowColor

		DefaultLightColor ShowAcceleratorKeys'

	poolDictionaries:''

	category:'Views-Menus'

!

!MenuView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 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

"

    a menu view used for both pull-down-menus and pop-up-menus (and also,

    for nonModal menus, such as the Launchers click-menu).

    the action to be performed can be defined either as:

    1) action:aBlockWithOneArg

       which defines a block to be called with the line number (1..n)

       of the selected line.

    2) selectors:selectorArray [args: argArray] [receiver:anObject]

       which defines the messages to be sent to the model or

       receiver. Giving an explicit receiver overrides the model.

    It is also possible to define both actionBlock and selectorArray.

    The wellknown popups are created by wrapping a MenuView into an instance of

    PopUpMenu (read the description of popupmenu).

    menu entries starting with '\c' are check-entries.

    menu entries starting with '\b' are checkBox-entries.

    menu entries starting with '\t' are thumbUp/Down-entries.

    menu entries conisting of '-' alone, are separating lines.

    menu entries conisting of '=' alone, are double separating lines.

    StyleSheet defaults:

        menuFont                    font to use for menus

        menuViewBackground          view background (should be same as menuBackgroundColor)

        menuForegroundColor         foreground color

        menuBackgroundColor         background color

        menuShadowColor             shadow color for 3D effects

        menuLightColor              lightColor for 3D effects

        menuHilightForegroundColor  hilighted items foregroundColor

        menuHilightBackgroundColor  hilighted items backgroundColor

        menuHilightFrameColor       frame arounf hilighted items (or nil, if none)

                                    defaults to selectionHilightFrameColor

        menuHilightLevel            3D level of selected items

        menuHilightStyle            #openwin or nil (special kludge)

        menuSeparatingLineLevel     3D level of sep. lines

        menuSeparatingLineInset     left/right inset of sep. lines

        menuDisabledForegroundColor foreground color of disabled items

        menuCheckColor              color to use for check marks

        menuFont                    font to use

    other values and some defaults are inherited via SelectionInListViews

    styles (i.e. look for selectionForegroundColor ...)

    [author:]

        Claus Gittinger

    [see also:]

        PopUpMenu PullDownMenu

        ClickMenuView

        LineMenu PatternMenu

"

!

examples

"

    See real examples in PopUpMenu & PullDownMenu

    Examples:

        Notice: normally, menuviews are wrapped into either a popup-

        menu or pulldown-menu.

        But they can also be used stand-alone as in the following examples:

                                                                        [exBegin]

        |m|

        m := MenuView

                labels:#('foo'

                         'bar'

                         'baz')

                selectors:#(

                            #foo

                            #bar

                            #baz)

                receiver:nil.

        m open

                                                                        [exEnd]

                                                                        [exBegin]

        |m|

        m := MenuView

                labels:#('foo'

                         'bar'

                         'baz')

                selectors:#foo:

                args:#(1 2 3)   

                receiver:nil.

        m open

                                                                        [exEnd]

"

! !

!MenuView class methodsFor:'instance creation'!

forMenu:aTopMenu

    "create and return a new menuView, which will be contained in

     aTopMenus superView"

    aTopMenu isNil ifTrue:[

        ^ self new

    ].

    ^ self in:(aTopMenu superView).

    "Created: 5.6.1996 / 11:29:27 / cg"

!

labels:labels

    "create and return a new MenuView. The parent view,

     selectors and receiver should be set later."

    ^ self labels:labels selectors:nil args:nil receiver:nil 

!

labels:labels selector:aSelector args:argArray receiver:anObject for:aTopMenu

    "create and return a new MenuView

     - receiverObject gets message aSelector with argument from

       argArray for ALL entries"

    "OBSOLETE protocol: labels:selectors:args:receiver: knows how to handle a

     single symbol-arg for selectors ..."

    ^ self labels:labels selectors:aSelector args:argArray receiver:anObject in:(aTopMenu superView)

!

labels:labels selector:aSelector args:argArray receiver:anObject in:aTopMenu

    "create and return a new MenuView

     - receiverObject gets message aSelector with argument from

       argArray for all entries"

    "OBSOLETE protocol: labels:selectors:args:receiver: knows how to handle a

     single symbol-arg for selectors ..."

    ^ self labels:labels selectors:aSelector args:argArray receiver:anObject in:aTopMenu

!

labels:labels selectors:selArray

    "create and return a new MenuView. The parent veiw

     and receiver should be set later."

    ^ self labels:labels selectors:selArray args:nil receiver:nil 

!

labels:labels selectors:selArray accelerators:shorties

    "create and return a new MenuView. The parent veiw

     and receiver should be set later."

    ^ self labels:labels selectors:selArray accelerators:shorties args:nil receiver:nil 

!

labels:labels selectors:selArray accelerators:shorties args:argArray receiver:anObject

    "create and return a new MenuView. The parent view

     should be set later."

    ^ (self new) 

        labels:labels

        selectors:selArray

        accelerators:shorties 

        args:argArray 

        receiver:anObject

!

labels:labels selectors:selArray accelerators:shorties args:argArray receiver:anObject in:aView

    "create and return a new MenuView in aView

     - receiverObject gets message from selectorArray with argument

       from argArray"

    ^ (self in:aView) 

        labels:labels 

        selectors:selArray

        accelerators:shorties 

        args:argArray

        receiver:anObject

!

labels:labels selectors:selArray accelerators:shorties receiver:anObject

    "create and return a new MenuView. The parent view

     should be set later."

    ^ self labels:labels selectors:selArray accelerators:shorties args:nil receiver:anObject

!

labels:labels selectors:selArray args:argArray

    "create and return a new MenuView. The parent view

     should be set later."

    ^ self labels:labels selectors:selArray args:argArray

!

labels:labels selectors:selArray args:argArray receiver:anObject

    "create and return a new MenuView. The parent view

     should be set later."

    ^ (self new) 

	labels:labels

	selectors:selArray

	args:argArray 

	receiver:anObject

!

labels:labels selectors:selArray args:argArray receiver:anObject for:aTopMenu

    "create and return a new MenuView for a topMenu"

    ^ self labels:labels selectors:selArray args:argArray receiver:anObject in:(aTopMenu superView)

!

labels:labels selectors:selArray args:argArray receiver:anObject in:aView

    "create and return a new MenuView in aView

     - receiverObject gets message from selectorArray with argument

       from argArray"

    ^ (self in:aView) 

	labels:labels 

	selectors:selArray

	args:argArray

	receiver:anObject

!

labels:labels selectors:selArray receiver:anObject

    "create and return a new MenuView. The parent view

     should be set later."

    ^ self labels:labels selectors:selArray args:nil receiver:anObject

!

labels:labels selectors:selArray receiver:anObject for:aTopMenu

    ^ self labels:labels selectors:selArray args:nil receiver:anObject for:aTopMenu

!

labels:labels selectors:selArray receiver:anObject in:aView

    "create and return a new MenuView in aView

     - receiverObject gets message from selectorArray without argument"

    ^ self labels:labels selectors:selArray args:nil receiver:anObject in:aView

! !

!MenuView class methodsFor:'defaults'!

showAcceleratorKeys

    ^ ShowAcceleratorKeys ~~ false

    "Created: 2.3.1996 / 14:52:34 / cg"

    "Modified: 2.3.1996 / 14:54:58 / cg"

!

showAcceleratorKeys:aBoolean

    ShowAcceleratorKeys := aBoolean

    "Created: 2.3.1996 / 14:52:43 / cg"

!

updateStyleCache

    "extract values from the styleSheet and cache them in class variables"

    <resource: #style (#menuForegroundColor #menuBackgroundColor

                       #menuViewBackground

                       #menuShadowColor #menuLightColor

                       #menuHilightForegroundColor #menuHilightBackgroundColor

                       #menuHilightFrameColor #selectionHilightFrameColor

                       #menuHilightLevel #menuHilightStyle

                       #menuSeparatingLineLevel #menuSeparatingLineInset

                       #menuDisabledForegroundColor #menuCheckColor

                       #menuFont #menuShowAccelerators)>

    DefaultViewBackground := StyleSheet colorAt:'menuViewBackground'.

    DefaultForegroundColor := StyleSheet colorAt:'menuForegroundColor'.

    DefaultBackgroundColor := StyleSheet colorAt:'menuBackgroundColor'.

    DefaultShadowColor := StyleSheet colorAt:'menuShadowColor'.

    DefaultLightColor := StyleSheet colorAt:'menuLightColor'.

    DefaultHilightForegroundColor := StyleSheet colorAt:'menuHilightForegroundColor'.

    DefaultHilightBackgroundColor := StyleSheet colorAt:'menuHilightBackgroundColor'.

    DefaultHilightFrameColor := StyleSheet colorAt:'menuHilightFrameColor' 

                                default:(StyleSheet colorAt:'selectionHilightFrameColor').

    DefaultHilightLevel := StyleSheet at:'menuHilightLevel'.

    DefaultHilightStyle := StyleSheet at:'menuHilightStyle'.

    DefaultLineLevel := StyleSheet at:'menuSeparatingLineLevel'.

    DefaultLineInset := StyleSheet at:'menuSeparatingLineInset'.

    DefaultDisabledForegroundColor := StyleSheet colorAt:'menuDisabledForegroundColor' default:Color darkGray.

    DefaultCheckColor := StyleSheet colorAt:'menuCheckColor'.

    DefaultFont := StyleSheet fontAt:'menuFont'.

    ShowAcceleratorKeys := StyleSheet at:'menuShowAccelerators' default:true.

    "Modified: 28.5.1996 / 20:47:31 / cg"

! !

!MenuView methodsFor:'accessing-behavior'!

action

    ^ actionBlock

    "Created: 25.5.1996 / 15:11:51 / cg"

!

disable:indexOrName

    "disable an entry"

    self setEnable:indexOrName to:false

!

disableAll

    "disable all entries"

    self disableAll:selectors

    "Created: 23.12.1995 / 16:56:05 / cg"

!

disableAll:collectionOfIndicesOrNames

    "disable an collection of entries"

    collectionOfIndicesOrNames do:[:entry |

	self disable:entry

    ]

!

enable:indexOrName

    "enable an entry"

    self setEnable:indexOrName to:true 

!

enableAll:collectionOfIndicesOrNames

    "enable an collection of entries"

    collectionOfIndicesOrNames do:[:entry |

	self enable:entry

    ]

!

hideOnRelease:aBoolean

    hideOnRelease := aBoolean

!

isEnabled:indexOrName

    |index|

    index := self indexOf:indexOrName.

    index ~~ 0 ifTrue:[

	enableFlags isNil ifTrue:[^ true].

	^ enableFlags at:index

    ].

    "ask submenus for convenience"

    (indexOrName isNumber not and:[subMenus notNil]) ifTrue:[

	subMenus do:[:m |

	    m notNil ifTrue:[

		m enable:indexOrName

	    ]

	]

    ]

!

setEnable:indexOrName to:aBoolean

    "enable/disable an entry"

    |index|

    index := self indexOf:indexOrName.

    index ~~ 0 ifTrue:[

	(enableFlags at:index) ~~ aBoolean ifTrue:[

	    enableFlags at:index put:aBoolean.

	    shown ifTrue:[

		self redrawLine:index

	    ]

	]

    ] ifFalse:[

	"try submenus for convenience"

	(indexOrName isNumber not and:[subMenus notNil]) ifTrue:[

	    subMenus do:[:m |

		m notNil ifTrue:[

		    m setEnable:indexOrName to:aBoolean

		]

	    ]

	]

    ]

! !

!MenuView methodsFor:'accessing-items'!

accelerators:collectionOfShortKeys

    "set the accelerator keys collection.

     You should pass translated symbolic keys - the menu will automatically

     show the untranslated original key sequences."

    shortKeys := collectionOfShortKeys copy.

    maxShortKeyStringLen := nil.

    shown ifTrue:[

        self resize

    ] ifFalse:[

        needResize := true

    ].

    "Created: 28.2.1996 / 17:15:31 / cg"

    "Modified: 30.4.1996 / 15:55:14 / cg"

!

actionAt:indexOrName

    "return an individual action"

    |i|

    i := self indexOf:indexOrName.

    i ~~ 0 ifTrue:[^ actions at:i].

    ^ nil

    "Created: 24.3.1996 / 17:17:22 / cg"

!

actionAt:indexOrName put:aBlock

    "set an individual action"

    |i|

    i := self indexOf:indexOrName.

    i ~~ 0 ifTrue:[

        actions isNil ifTrue:[

            actions := OrderedCollection new.

        ].

        i > actions size ifTrue:[

            actions grow:i

        ].

        actions at:i put:aBlock

    ]

    "Created: 24.3.1996 / 17:18:15 / cg"

!

addLabel:aLabel selector:aSelector

    "add another label/selector pair at the end"

    self addLabel:aLabel selector:aSelector after:nil

    "Modified: 28.2.1996 / 17:54:11 / cg"

!