"

 COPYRIGHT (c) 1997 by eXept Software AG

              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:libwidg2' }"

"{ NameSpace: Smalltalk }"

View subclass:#MenuPanel

	instanceVariableNames:'shadowView mapTime mustRearrange superMenu shortKeyInset

		selection items groupSizes receiver enabled lastActiveMenu

		enteredItem prevFocusView previousPointerGrab

		previousKeyboardGrab relativeGrabOrigin hasImplicitGrap

		scrollActivity rightArrowShadow rightArrow fgColor verticalLayout

		showSeparatingLines showGroupDivider implicitGrabView

		lastPointerView openDelayedMenuBlock closeDelayedMenuBlock

		preferredWidth application originator centerItems hideOnRelease

		defaultHideOnRelease buttonInsetX buttonInsetY itemSpace

		stringOffsetX doAccessCharacterTranslation lastItem hasPerformed

		focusComesByTab lastDrawnScrollerNextBounds

		buttonActiveBackgroundColor buttonEnteredBackgroundColor

		buttonPassiveBackgroundColor sizeFixed extraMargin

		buttonActiveLevel buttonPassiveLevel buttonEnteredLevel

		pluggableHelpSpecProvider'

	classVariableNames:'DefaultBackgroundColor DefaultForegroundColor

		IconDisabledIndicationOff IconDisabledIndicationOn

		IconDisabledRadioOff IconDisabledRadioOn IconIndicationOff

		IconIndicationOn IconRadioOff IconRadioOn Images

		InitialSelectionQuerySignal LigthenedImages

		MaxShortCutSearchLevel'

	poolDictionaries:''

	category:'Views-Menus'

!

Object subclass:#Item

	instanceVariableNames:'menuItem layout menuPanel subMenu displayLabel displayLabelExtent

		disabledDisplayLabel enableChannel label activeHelpText

		flyByHelpText isVisible indication choice accessCharacter'

	classVariableNames:'HorizontalInset VerticalInset HorizontalButtonInset

		VerticalButtonInset LabelRightOffset VerticalPopUpInset'

	poolDictionaries:''

	privateIn:MenuPanel

!

Object subclass:#Adornment

	instanceVariableNames:'indication accessCharacterPosition shortcutKey argument argument2

		choice choiceValue'

	classVariableNames:''

	poolDictionaries:''

	privateIn:MenuPanel::Item

!

Object subclass:#ScrollActivity

	instanceVariableNames:'semaLock activeMenu scrollTask direction icons'

	classVariableNames:''

	poolDictionaries:''

	privateIn:MenuPanel

!

!MenuPanel class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1997 by eXept Software AG

              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 panel used for both pull-down-menus and pop-up-menus.

    Due to some historic leftover, there are two mechanisms for menus:

        1) the (very) old MenuView (which inherits from SelectionInListView)

        2) this new MenuPanel.

    this will eventually replace most of the MenuView and PopUpMenu stuff.

    (and hopefully be ST-80 compatible...)

    To create a menu, there exists a MenuEditor which can generate

    menu specifications, from which a MenuPanel can be dynamically created.

    Notice:

        This is going to replace the obsolete MenuView.

    [author:]

        Claus Atzkern

    [see also:]

        Menu

        MenuItem

        MenuEditor

    cg: this code is so ugly - needs a complete rewrite...

"

!

examples

"

  a PullDownMenu

                                                                                [exBegin]

    |top subView mview labels|

    top := StandardSystemView new.

    labels := #( 'foo' 'bar' 'baz' 'test') copy.

    labels at:4 put:(LabelAndIcon label:'test' icon:(ToolbarIconLibrary cutIcon)).

    mview := MenuPanel in:top.

    mview labels:labels.

    (mview itemAt:1) enabled:false.

    (mview itemAt:4) enabled:false.

    top extent:(mview preferredExtent + 20).

    top open.

                                                                                [exEnd]

                                                                                [exBegin]

    |top subView mview desc s1 s2 s3 img lbs labels|

    top := StandardSystemView new.

    mview := MenuPanel in:top.

    labels := #( 'foo' 'bar' 'baz' 'test' 'claus' ).

    mview level:2.

    mview verticalLayout:false.

    img := Image fromFile:'bitmaps/SBrowser.xbm'.

    lbs := Array with:'foo' with:'bar' with:img with:'baz' with:'test' with:'ludwig'.

    mview labels:lbs.

    mview shortcutKeyAt:2 put:#Cut.

    mview accessCharacterPositionAt:1 put:1.

    mview accessCharacterPositionAt:2 put:2.

    mview enabledAt:5 put:false.

    mview groupSizes:#( 2 2 ).

    s1 := MenuPanel labels:labels.

    s1 accessCharacterPositionAt:1 put:1.

    s1 accessCharacterPositionAt:2 put:2.

    s1 groupSizes:#( 2 2 ).

    s2 := MenuPanel labels:#( '1' nil '2' '-' '3' '=' '4' ' ' '5' ).

    s3 := MenuPanel labels:lbs.

    s1 subMenuAt:2 put:s2.

    s1 subMenuAt:3 put:(MenuPanel labels:lbs).

    s2 subMenuAt:3 put:s3.

    s3 subMenuAt:3 put:(MenuPanel labels:labels).

    s3 shortcutKeyAt:3 put:$q.

    mview subMenuAt:1 put:s1.

    mview subMenuAt:4 put:(MenuPanel labels:lbs).

    (mview subMenuAt:4) shortcutKeyAt:3 put:#Copy.

    s1 shortcutKeyAt:1 put:#Copy.

    s1 shortcutKeyAt:3 put:#Paste.

    mview subMenuAt:2 put:(MenuPanel labels:labels).

    top extent:(mview preferredExtent).

    top open.

                                                                                [exEnd]

  a PullDownMenu with applications

                                                                                [exBegin]

    |top menu view item|

    top  := StandardSystemView extent:240@100.

    menu := MenuPanel in:top.

    menu labels:#( 'foo' 'Application' 'Clock' ).

    menu verticalLayout:false.

    menu subMenuAt:1 put:(MenuPanel labels:#( 'bar' 'baz' )).

    menu subMenuAt:2 put:(MenuPanel labels:#( 'foo' 'bar' 'baz' )).

    view := ClockView new.

    view preferredExtent:100@100.

    item := menu itemAt:3.

    item submenu:view.

    view := ImageView new.

    view image:(Image fromScreen:(0@0 corner:200@200)).

    view preferredExtent:(200@200).

    item := menu itemAt:2.

    item submenu:view.

    menu origin:0@0 corner:1.0@30.

    top open.

                                                                                [exEnd]

  a PopUpMenu

                                                                                [exBegin]

    |subView mview desc s1 s2 s3 img lbs labels|

    mview := MenuPanel new.

    labels := #( 'foo' 'bar' 'baz' ).

    mview level:2.

    img := Image fromFile:'bitmaps/SBrowser.xbm'.

    lbs := Array with:'foo' with:'bar' with:img with:'baz' with:'test'.

    mview labels:lbs.

    s1 := MenuPanel labels:labels.

    s2 := MenuPanel labels:#( '1' nil '2' '-' '3' '=' '4' ' ' '5' ).

    s3 := MenuPanel labels:lbs.

    s1 subMenuAt:2 put:s2.

    s1 subMenuAt:3 put:(MenuPanel labels:lbs).

    s2 subMenuAt:3 put:s3.

    s3 subMenuAt:3 put:(MenuPanel labels:labels).

    s3 shortcutKeyAt:3 put:$q.

    mview subMenuAt:1 put:s1.

    mview subMenuAt:4 put:(MenuPanel labels:lbs).

    (mview subMenuAt:4) shortcutKeyAt:3 put:#Copy.

    s1 shortcutKeyAt:1 put:#Copy.

    s1 shortcutKeyAt:3 put:#Paste.

    mview subMenuAt:2 put:(MenuPanel labels:labels).

    mview startUp

                                                                                [exEnd]

  a menu spec

                                                                                [exBegin]

    |menu|

    menu := MenuPanel menu:

        #(#Menu #( #(#MenuItem

                    #label: 'File'

                    #submenu:

                      #(#Menu #(#(#MenuItem #label: 'quit' #value:#quit )

                                 (#MenuItem

                                    #label: 'edit'

                                    #submenu:

                                      #(#Menu #( #(#MenuItem #label: 'edit'  #value:#edit )

                                                 #(#MenuItem #label: 'close' #value:#close)

                                               )

                                               nil

                                               nil

                                       )

                                  )

                                 #(#MenuItem #label: 'help' #value:#help )

                               )

                               nil

                               nil

                       )

                 )

                #(#MenuItem #label: 'Inspect' #value:#inspectMenu )

                #(#MenuItem #label: 'Bar'

                            #submenu:

                               #(#Menu #( #(#MenuItem #label: 'bar 1' #value:#bar1 )

                                          #(#MenuItem #label: 'bar 2' #value:#bar2 )

                                        )

                                        nil

                                        nil

                                )

                 )

              )

              #( 2 )

              nil

         ) decodeAsLiteralArray.

    menu verticalLayout:false.

    Transcript showCR:(menu startUp).

                                                                                [exEnd]

"

! !

!MenuPanel class methodsFor:'instance creation'!

fromSpec:aSpec

    ^ self fromSpec:aSpec receiver:nil

!

fromSpec:aSpec receiver:aReceiver

    |menu|

    aSpec notNil ifTrue:[

        menu := Menu new.

        menu receiver:aReceiver.

        menu fromLiteralArrayEncoding:aSpec.

    ].

  ^ self menu:menu receiver:aReceiver

!

labels:labels

    ^ self labels:labels nameKeys:nil receiver:nil

!

labels:labels nameKeys:nameKeys

    ^ self labels:labels nameKeys:nameKeys receiver:nil

!

labels:labels nameKeys:nameKeys receiver:aReceiver

    |mview|

    mview := self menu:nil receiver:aReceiver.

    mview labels:labels.

    mview nameKeys:nameKeys.

  ^ mview

!

labels:labels receiver:aReceiver

    ^ self labels:labels nameKeys:nil receiver:aReceiver

!

menu:aMenu

    ^ self menu:aMenu receiver:nil

!

menu:aMenu receiver:aReceiver

    |mview|

    mview := self new.

    (aMenu notNil and:[aMenu receiver isNil]) ifTrue:[

        "/ no receiver specified in the menu; thus set the receiver immediately

        mview receiver:aReceiver

    ].

    mview menu:aMenu.

"/ a menu itself may contain a receiver

"/ thus we do not overwrite the receiver

    aReceiver notNil ifTrue:[

        mview receiver:aReceiver

    ].

  ^ mview

! !

!MenuPanel class methodsFor:'class initialization'!

initialize

    InitialSelectionQuerySignal isNil ifTrue:[

        InitialSelectionQuerySignal := QuerySignal new.

    ].

    "

     self initialize

    "

    "Modified: / 15.1.1998 / 23:08:31 / stefan"

! !

!MenuPanel class methodsFor:'default icons'!

delayedMenuIndicator

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self delayedMenuIndicator inspect

     ImageEditor openOnClass:self andSelector:#delayedMenuIndicator

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'MenuPanel class delayedMenuIndicator'

        ifAbsentPut:[(Depth1Image width:7 height:6) bits:(ByteArray fromPackedString:'@@@@@HCB')

            colorMapFromArray:#[0 0 0 255 255 255]

            mask:((ImageMask width:7 height:6) bits:(ByteArray fromPackedString:'@J+V[C P'); yourself); yourself]

!

iconIndicationDisabledOff

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self iconIndicationDisabledOff inspect

     ImageEditor openOnClass:self andSelector:#iconIndicationDisabledOff

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'MenuPanel class iconIndicationDisabledOff'

        ifAbsentPut:[(Depth8Image width:13 height:13) bits:(ByteArray fromPackedString:'

@@@@@@@@@@@@@@@@@@@GA0\GA0\GA0\GA0@@A2@ HB@ HBH$G@\@@@\ L#H2L#DQB!!HG@@@GHCH2DC@WK!!(#A0@@A2@,G0HJG"XVC@\@@@\3DSP*E"DEARTG

@@@GB28)F3TA@PD(A0@@A04]FPTAA0$GEP\@@@\NFPTHA0XFA PG@@@G@1LTJ2<OFB4''A0@@A0\GA0\GA0\GA0\@@@@@@@@@@@@@@@@@@@@a')

            colorMapFromArray:#[142 143 143 242 242 242 212 215 219 202 203 204 230 230 230 237 237 237 246 246 246 244 244 244 240 240 240 245 245 245 219 221 223 184 187 191 204 205 205 188 191 194 194 196 198 234 235 235 205 209 214 213 216 220 193 195 197 212 212 213 219 219 220 225 226 226 232 232 232 216 219 222 235 236 236 233 233 233 226 227 228 234 234 234 187 190 193 227 228 229 225 226 227 208 212 217 174 179 185 236 236 236 175 180 186 198 199 200 180 185 189 212 213 214 229 230 230 233 233 234 220 221 222 228 229 229 224 225 227 224 225 225 205 209 215 235 235 236 221 223 225 230 231 231 210 213 218 208 211 216 203 207 213 178 183 188 218 220 223 239 239 239]; yourself]

!

iconIndicationDisabledOn

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self iconIndicationDisabledOn inspect

     ImageEditor openOnClass:self andSelector:#iconIndicationDisabledOn

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'MenuPanel class iconIndicationDisabledOn'

        ifAbsentPut:[(Depth4Image width:13 height:13) bits:(ByteArray fromPackedString:'"H"H"H"H H&Y&YT,PXBI&Y%R1AFH"Y&UKDF; H&YH$F7L8BET$F7L@BA#DF7@@** HP[\J*&*(BK\0**)**@!!3B*)&Y& XLJ**Y&Y(B@**)&Y&ZD"H"H"H"H

 @@a')

            colorMapFromArray:#[249 249 249 245 245 245 242 242 242 248 248 248 244 244 244 241 241 241 251 251 251 247 247 247 177 177 177 240 240 240 250 250 250 246 246 246 243 243 243]; yourself]

!

iconIndicationOff

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self iconIndicationOff inspect

     ImageEditor openOnClass:self andSelector:#iconIndicationOff

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'MenuPanel class iconIndicationOff'

        ifAbsentPut:[(Depth8Image width:13 height:13) bits:(ByteArray fromPackedString:'

@@@@@@@@@@@@@@@@@@@GA0\GA0\GA0\GA0@@A2@ HB@ HBH$G@\@@@\ L#H2L#DQB!!HG@@@GHCH2DC@WK!!(#A0@@A2@,G0HJG"XVC@\@@@\3DSP*E"DEARTG

@@@GB28)F3TA@PD(A0@@A04]FPTAA0$GEP\@@@\NFPTHA0XFA PG@@@G@1LTJ2<OFB4''A0@@A0\GA0\GA0\GA0\@@@@@@@@@@@@@@@@@@@@a')

            colorMapFromArray:#[142 143 143 242 242 242 212 215 219 202 203 204 230 230 230 237 237 237 246 246 246 244 244 244 240 240 240 245 245 245 219 221 223 184 187 191 204 205 205 188 191 194 194 196 198 234 235 235 205 209 214 213 216 220 193 195 197 212 212 213 219 219 220 225 226 226 232 232 232 216 219 222 235 236 236 233 233 233 226 227 228 234 234 234 187 190 193 227 228 229 225 226 227 208 212 217 174 179 185 236 236 236 175 180 186 198 199 200 180 185 189 212 213 214 229 230 230 233 233 234 220 221 222 228 229 229 224 225 227 224 225 225 205 209 215 235 235 236 221 223 225 230 231 231 210 213 218 208 211 216 203 207 213 178 183 188 218 220 223 239 239 239]; yourself]

!

iconIndicationOn

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self iconIndicationOn inspect

     ImageEditor openOnClass:self andSelector:#iconIndicationOn

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'MenuPanel class iconIndicationOn'

        ifAbsentPut:[(Depth8Image width:13 height:13) bits:(ByteArray fromPackedString:'

E1\WE1\WE1\WE1\WE1\/K2</K2</MP(^K1\WK3\7M3\7B1=@H PWE2<7DQDQIB@IA1@^E1\/M1DQMDP(LPHEK1\WK3\%K!!X#BC@RGR<WE2<;C3<=KPD8MS(/

E1\/C@@0GAP3PQ8+K1\WK0L<CTL3C!!$/L"<WE2<XHRYBO"\JG X/E1\/F20UM#$SF"$*K1\WK2</A@(5AB</K2<WE1\WE1\WE1\WE1\WE0@a')

            colorMapFromArray:#[110 127 170 73 94 150 101 119 165 205 207 209 245 245 245 231 231 232 230 230 230 68 90 146 94 113 161 87 106 157 249 249 249 201 204 208 222 224 225 72 93 149 97 115 164 201 207 221 185 191 208 203 207 213 188 195 214 242 243 246 103 120 167 223 226 233 213 216 220 142 143 143 198 200 202 248 249 250 236 237 237 202 203 204 207 212 226 219 220 220 246 246 246 157 167 192 237 238 241 234 236 240 220 223 228 242 243 244 204 208 214 213 217 221 139 153 187 176 185 209 175 184 207 235 235 236 233 233 234 220 221 222 218 218 219 186 193 213 223 226 229 244 244 244 71 92 148 69 90 146 225 226 226 75 96 151 205 209 214 248 248 248 140 153 186 174 179 185 100 118 165 144 157 189 213 213 214 197 201 205 222 225 233 237 238 238 76 97 152 163 174 200 119 134 171 183 191 213 74 95 151 73 95 150 224 226 230]; yourself]

!

iconRadioGroupDisabledOff

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self iconRadioGroupDisabledOff inspect

     ImageEditor openOnClass:self andSelector:#iconRadioGroupDisabledOff

    "

"/    <resource: #image>

"/

"/    IconDisabledRadioOff isNil ifTrue:[

"/        IconDisabledRadioOff := Icon