"

 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 itemValue value nameKey

		translateLabel isButton startGroup isVisible hideMenuOnActivated

		triggerOnDown indication submenu submenuChannel shortcutKey

		labelImage accessCharacterPosition argument choice choiceValue

		font auxValue showBusyCursorWhilePerforming keepLinkedMenu

		horizontalLayout sendToOriginator ignoreMnemonicKeys

		ignoreShortcutKeys'

	classVariableNames:''

	poolDictionaries:''

	category:'Views-Support'

!

!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"

!

separator

    "create and return a new menuItem for a separator"

    ^ self label:'-'

! !

!MenuItem methodsFor:'Compatibility-ST80'!

isEnabled:aBoolean

    self enabled:aBoolean

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

!

value

    "obsolete - please use #itemValue (value is bad: it prevents us from using a valueHolder)"

    ^ itemValue

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

!

value:something

    "obsolete - please use #itemValue: (value is bad: it prevents us from using a valueHolder)"

    itemValue := something

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

! !

!MenuItem methodsFor:'accessing'!

accessCharacterPosition

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

    "

    ^ accessCharacterPosition

!

accessCharacterPosition:index

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

    "

    accessCharacterPosition := index

!

activeHelpKey

    ^ activeHelpKey

!

activeHelpKey:aKey

    activeHelpKey := aKey

!

argument

    "get argument given to the value (selector)

    "

    ^ argument

!

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

            ]

        ]

    ].

    argument := arg

!

auxValue

    "an additional, arbitrary value"

    ^ auxValue

!

auxValue:something

    "set the auxValue - an arbitrary user value

    "

    auxValue := something

!

choice:something

    "set the value of the instance variable 'choice' (automatically generated)"

    choice := something.

    "Created: / 14.8.1998 / 14:32:06 / cg"

!

choiceValue

    "return the value of the instance variable 'choiceValue' (automatically generated)"

    ^ choiceValue

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

!

choiceValue:something

    "set the value of the instance variable 'choiceValue' (automatically generated)"

    choiceValue := something.

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

!

font

    "get the specific font for an item or nil

    "

    ^ font

!

font:aFont

    "set a specific font for an item

    "

    font := aFont.

!

horizontalLayout

    "on default submenus has a vertical layout;

     true, the submenu has a horizontal layout.

    "

    ^ horizontalLayout

!

horizontalLayout:aBoolean

    "on default submenus has a vertical layout;

     true, the submenu has a horizontal layout.

    "

    horizontalLayout := aBoolean.

!

ignoreMnemonicKeys

    "if true, mnemonic (access character) in the submenus under the item are ignored;

     the default is set to false

    "

    ^ ignoreMnemonicKeys ? false

!

ignoreMnemonicKeys:aBoolean

    "if true, mnemonic (access character) in the submenus under the item are ignored;

     the default is set to false

    "

    ignoreMnemonicKeys := aBoolean.

!

ignoreShortcutKeys

    "if true, shortcutKeys (accelerators) in the submenus under the item are ignored;

     the default is set to false

    "

    ^ ignoreShortcutKeys ? false

!

ignoreShortcutKeys:aBoolean

    "if true, shortcutKeys (accelerators) in the submenus under the item are ignored;

     the default is set to false

    "

    ignoreShortcutKeys := aBoolean.

!

indication

    "test whether the menu item has an on/off indicator (CheckToggle)

    "

    ^ indication

    "Created: 25.2.1997 / 20:59:28 / cg"

!

indication:something

    "test whether the menu item has an on/off indicator (CheckToggle)

    "

    indication := something.

    "Created: 25.2.1997 / 20:59:28 / cg"

!

isVisible

    ^ isVisible ? true

!

isVisible:something

    isVisible := something

!

itemValue

    ^ itemValue

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

!

itemValue:something

    itemValue := something

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

!

keepLinkedMenu

    "return the value of the instance variable 'keepLinkedMenu' (automatically generated)"

    ^ keepLinkedMenu ? false

!

keepLinkedMenu:aBoolean

    "set the value of the instance variable 'keepLinkedMenu' (automatically generated)"

    keepLinkedMenu := aBoolean ? false.

!

labelImage

    "return the value of the instance variable 'labelImage' (automatically generated)"

    ^ labelImage

!

labelImage:something

    "set the value of the instance variable 'labelImage' (automatically generated)"

    labelImage := something.

!

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"

!

resourceRetriever

    |retriever|

    retriever := labelImage.

    (retriever notNil and:[retriever isKindOf:ResourceRetriever]) ifTrue:[

        ^ retriever

    ].

    ^ nil

!

resourceRetriever:aRetriever

    self labelImage:aRetriever

!

shortcutKey

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

    "

    ^ shortcutKey

!

shortcutKey:something

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

    "

    shortcutKey := something.

!

shortcutKeyCharacter

    "Backward compatibility; same as #shortcutKey.

     get the  key to press to select the menu item from the keyboard

    "

    ^ self shortcutKey

!

shortcutKeyCharacter:something

    "Backward compatibility; same as #shortcutKey:.

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

    "

    self shortcutKey:something.

!

showBusyCursorWhilePerforming

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

     while performing the menu action. Defaults to false."

    ^ showBusyCursorWhilePerforming ? false

!

showBusyCursorWhilePerforming:aBoolean

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

     while performing the menu action. Defaults to false."

    showBusyCursorWhilePerforming := aBoolean

!

submenu

    "get the submenu or nil

    "

    ^ submenu value

    "Created: / 25.2.1997 / 20:59:28 / cg"

    "Modified: / 19.6.1998 / 00:33:58 / cg"

!

submenu:something

    "set the submenu or nil

    "

    (something isValueModel or:[something isBlock]) ifTrue:[

        submenuChannel notNil ifTrue:[

            "/ programmers error ?

            "/ how can I decide which one to use if there is both

            "/ a channel and a subMenu ...

            self error:'overwriting submenuchannel' mayProceed:true.

        ].

        submenuChannel := something

    ] ifFalse:[

        submenu := something.

    ]

    "Created: / 25.2.1997 / 20:59:28 / cg"

    "Modified: / 5.2.2000 / 16:53:28 / cg"

!

submenuChannel

    "get the submenuChannel or nil

    "

    ^ submenuChannel

!

submenuChannel:something

    "set the submenuChannel or nil

    "

    submenuChannel := something.

! !

!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)

    "

    ^ choice

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

    "Modified: / 14.8.1998 / 15:11:57 / 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

!

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

   "