"

 COPYRIGHT (c) 1998 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:libview2' }"

Object subclass:#MenuItem

	instanceVariableNames:'activeHelpKey enabled label value nameKey adornment

		translateLabel isButton startGroup isVisible hideMenuOnActivated

		triggerOnDown'

	classVariableNames:''

	poolDictionaries:''

	category:'Views-Support'

!

Object subclass:#MenuItemAdornment

	instanceVariableNames:'color indication submenu submenuChannel shortcutKey labelText

		labelImage accessCharacterPosition argument choice choiceValue

		font auxValue showBusyCursorWhilePerforming keepLinkedMenu'

	classVariableNames:''

	poolDictionaries:''

	privateIn:MenuItem

!

!MenuItem class methodsFor:'documentation'!

copyright

"

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

"

    not yet finished MenuItem class - this will eventually replace

    most of the MenuView and PopUpMenu stuff.

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

    For now, only a subset of the full protocol is implemented.

    [author:]

        Claus Gittinger

    [see also:]

        MenuItem

        PopUpMenu

"

! !

!MenuItem class methodsFor:'instance creation'!

label:aString

    "create and return a new menuItem, given a label string"

    ^ self new label:aString

    "Modified: / 4.8.1998 / 17:33:13 / cg"

    "Created: / 14.8.1998 / 19:19:14 / cg"

!

label:labelString value:selectorOrValue

    "create and return a new menuItem, given its label and value"

    ^ (self new) label:labelString; value:selectorOrValue; yourself

    "Created: / 4.8.1998 / 17:34:18 / cg"

!

labeled:aString

    "create and return a new menuItem, given a label string"

    ^ self new label:aString

    "Modified: / 4.8.1998 / 17:33:13 / cg"

! !

!MenuItem methodsFor:'Compatibility - ST80'!

isEnabled:aBoolean

    self enabled:aBoolean

    "Created: / 27.10.1997 / 16:34:55 / cg"

! !

!MenuItem methodsFor:'accessing'!

accessCharacterPosition

    "get the index of the access character in the label text or string, or nil if none

    "

    adornment notNil ifTrue:[

        ^ adornment accessCharacterPosition

    ].

    ^ nil

!

accessCharacterPosition:index

    "set the index of the access character in the label text or string, or nil if none

    "

    (index isNil and:[adornment isNil]) ifFalse:[

        self adornment accessCharacterPosition:index

    ]

!

activeHelpKey

    ^ activeHelpKey

!

activeHelpKey:aKey

    activeHelpKey := aKey

!

argument

    "get argument given to the value (selector)

    "

    adornment notNil ifTrue:[

        ^ adornment argument

    ].

    ^ nil

!

argument:something

    "set argument given to the value (selector)

    "

    |arg|

    (arg := something) notNil ifTrue:[

        arg isString ifTrue:[

            (arg size == 0 or:[(arg indexOfNonSeparatorStartingAt:1) == 0]) ifTrue:[

                arg := nil

            ]

        ]

    ].

    (arg isNil and:[adornment isNil]) ifFalse:[

        self adornment argument:arg

    ]

!

auxValue

    "an additional, arbitrary value"

    adornment notNil ifTrue:[

        ^ adornment auxValue

    ].

    ^ nil

!

auxValue:something

    "set the auxValue - an arbitrary user value

    "

    (something notNil or:[adornment notNil]) ifTrue:[

        self adornment auxValue:something

    ]

    "Modified: / 4.2.2000 / 12:38:44 / cg"

!

font

    "get the specific font for an item or nil

    "

    adornment notNil ifTrue:[

        ^ adornment font

    ].

    ^ nil

!

font:aFont

    "set the index of the access character in the label text or string, or nil if none

    "

    (aFont isNil and:[adornment isNil]) ifFalse:[

        self adornment font:aFont

    ]

!

hideMenuOnActivated

    "hide the menu when the item was activated; the default is true

    "

    ^ hideMenuOnActivated ? true

!

hideMenuOnActivated:aBool

   "hide the menu when the item was activated; the default is true

   "

    hideMenuOnActivated := aBool ? true

!

isVisible

    ^ isVisible ? true

!

isVisible:something

    isVisible := something

!

keepLinkedMenu

    "an additional, arbitrary value"

    adornment notNil ifTrue:[

        ^ adornment keepLinkedMenu

    ].

    ^ false

!

keepLinkedMenu:aBoolean

    "set the keepLinkedMenu

    "

    adornment notNil ifTrue:[

        adornment keepLinkedMenu:aBoolean.

    ] ifFalse:[

        aBoolean == true ifTrue:[

            "/ the default is false

            self adornment keepLinkedMenu:true

        ]

    ].

!

label

    ^ self filteredLabel "/ label

    "Created: / 25.2.1997 / 19:48:16 / cg"

    "Modified: / 19.6.1998 / 00:02:55 / cg"

!

label:aString

    label := aString

    "Created: 25.2.1997 / 19:55:16 / cg"

!

labelImage

    "gets the labelImage

    "

    adornment notNil ifTrue:[

        ^ adornment labelImage value

    ].

  ^ nil

!

labelImage:aResourceRetriever

    "set the labelImage

    "

    aResourceRetriever notNil ifTrue:[

        self adornment labelImage:aResourceRetriever

    ]

!

nameKey

    ^ nameKey

!

nameKey:aNameKey

    nameKey := aNameKey.

!

rawLabel

    ^ label

    "Created: 25.2.1997 / 19:48:16 / cg"

!

rawLabel:aString

    label := aString

    "Created: 25.2.1997 / 19:11:02 / cg"

!

shortcutKeyCharacter

    "ignored for now"

    adornment notNil ifTrue:[

        ^ adornment shortcutKeyCharacter

    ].

    ^ nil

!

shortcutKeyCharacter:aKey

    "set the  key to press to select the menu item from the keyboard

    "

    (aKey notNil or:[adornment notNil]) ifTrue:[

        self adornment shortcutKeyCharacter:aKey

    ]

    "Modified: / 4.2.2000 / 12:39:30 / cg"

!

showBusyCursorWhilePerforming

    "get the flag which controls if a busy cursor is to be shown

     while performing the menu action. Defaults to false."

    adornment notNil ifTrue:[

        ^ adornment showBusyCursorWhilePerforming

    ].

    ^ nil

!

showBusyCursorWhilePerforming:aBoolean

    "set/clear the flag which controls if a busy cursor is to be shown

     while performing the menu action. Defaults to false."

    ((aBoolean == true) or:[adornment notNil]) ifTrue:[

        self adornment showBusyCursorWhilePerforming:aBoolean

    ]

!

startGroup

    "start group #left #right #center ... or nil

     at the moment only #right is implemented

    "

    ^ startGroup 

!

startGroup:aSymbol

    "start group #left #right #center ...

     at the moment only #right is implemented

    "

    (startGroup isNil or:[startGroup == #right]) ifTrue:[

        startGroup := aSymbol

    ] ifFalse:[

        self warn:('not supported group: ', aSymbol printString ).

    ]

!

submenu

    adornment notNil ifTrue:[

        ^ adornment submenu

    ].

    ^ nil

    "Created: 25.2.1997 / 20:57:24 / cg"

!

submenu:aMenu

    (aMenu notNil or:[adornment notNil]) ifTrue:[

        self adornment submenu:aMenu

    ]

    "Created: / 25.2.1997 / 20:56:20 / cg"

    "Modified: / 4.2.2000 / 12:40:02 / cg"

!

submenuChannel

    adornment notNil ifTrue:[

        ^ adornment submenuChannel

    ].

    ^ nil

!

submenuChannel:something

    (something notNil or:[adornment notNil]) ifTrue:[

        self adornment submenuChannel:something

    ]

    "Modified: / 4.2.2000 / 12:40:19 / cg"

!

triggerOnDown

   "trigger the action if pressed

   "

   ^ triggerOnDown ? false

!

triggerOnDown:aBool

   "trigger the action if pressed

   "

    triggerOnDown := aBool.

!

value

    ^ value

    "Created: 25.2.1997 / 19:50:14 / cg"

!

value:something

    value := something

    "Created: 25.2.1997 / 19:11:13 / cg"

! !

!MenuItem methodsFor:'accessing-behavior'!

beOff

    "set indication off

    "

    self indication:false

!

beOn

    "set indication on

    "

    self indication:true

!

choice

    "return the menu items choice indicator (RadioButton)

    "

    adornment notNil ifTrue:[

        ^ adornment choice

    ].

    ^ nil

    "Created: / 14.8.1998 / 14:34:55 / cg"

    "Modified: / 14.8.1998 / 15:11:57 / cg"

!

choice:aChoice

    "set the menu items choice indicator (RadioButton)

    "

    (aChoice notNil or:[adornment notNil]) ifTrue:[

        self adornment choice:aChoice.

    ].

    "Created: / 14.8.1998 / 15:11:17 / cg"

!

choiceValue

    "return the menu items choiceValue (RadioButton)

    "

    adornment notNil ifTrue:[

        ^ adornment choiceValue

    ].

    ^ nil

    "Modified: / 14.8.1998 / 15:11:57 / cg"

    "Created: / 14.8.1998 / 15:38:05 / cg"

!

choiceValue:something

    "set the menu items choiceValue (RadioButton)

    "

    (something notNil or:[adornment notNil]) ifTrue:[

        self adornment choiceValue:something.

    ].

    "Created: / 14.8.1998 / 15:39:12 / cg"

!

disable

    enabled := false

    "Created: 25.2.1997 / 19:39:09 / cg"

!

enable

    enabled := true

    "Created: 25.2.1997 / 19:39:00 / cg"

!

enabled

    "returns a boolean, valueHolder or block

    "

    ^ enabled

!

enabled:something

    "a boolean, valueHolder or block

    "

    enabled := something

!

indication

    "return the menu items on/off indicator (CheckToggle)

    "

    adornment notNil ifTrue:[

        ^ adornment indication

    ].