Smalltalk/X Webserver

Documentation of class 'PullDownMenu':

Class: PullDownMenu

Inheritance
Description
Class protocol
- defaults
- instance creation
Instance protocol
Examples

Inheritance:

   Object
   |
   +--GraphicsMedium
      |
      +--DisplaySurface
         |
         +--SimpleView
            |
            +--View
               |
               +--PullDownMenu

Package:: stx:libwidg

Category:: Views-Menus

Version:: rev: 1.123 date: 2024/01/16 19:26:43; user: cg; file: PullDownMenu.st directory: libwidg; module: stx stc-classLibrary: libwidg

Description:

Notice: this class is obsolete now 
- please use a MenuPanel in new applications, 
which provides all of this functionality, plus more and a nicer look.

PullDown menu provides the top (always visible) part of these menus. 
It controls display of its menus, which become visible when one of the 
PullDownMenus entries is pressed.

A PullDownMenu itself consists of a single row of labels, which activate
a pulled menu when clicked. Entries may be empty (i.e. have no menu)
and empty entries may (optionally) also perform some action when clicked.
An entries selector is used as the key to define and access submenus
and (for empty entries:) the selector sent to the receiver of the menu.

[Instance variables:]

  menus                   <Collection>    the sub menus

  titles                  <Collection>    the strings in the menu

  selectors               <Collection>    the selectors to send to the menu-
                                          receiver (for empty pull-menus)
                                          if nil (the default), title entries
                                          do not send anything.

  activeMenuNumber        <Number>        the index of the currently active menu

  showSeparatingLines     <Boolean>       show separating lines between my menu-strings

  topMargin               <Number>        number of pixels at top

  fgColor                 <Color>         fg color to draw passive menu-titles
  bgColor                 <Color>         bg color to draw passive menu-titles

  activeFgColor           <Color>         fg color to draw activated menu-titles
  activeBgColor           <Color>         bg color to draw activated menu-titles

  onLevel                 <Integer>       3D level of entry-buttons when pressed
  offLevel                <Integer>       3D level of entry-buttons when released

  edgeStyle               <Symbol>        how to draw edges

  toggleMode              <Symbol>        if #toggle, press pulls menu,
                                          another press hides it.
                                          if other, its hidden on release.

 except menus, titles and selectors, instvars are usually defined from
 defaults in the styleSheet; you should not care for them.


[StyleSheet values:]

  pullDownMenuViewBackground              view background Color for the menu bar
                                          default: menuViewBackground

  pullDownMenuForegroundColor             foreground drawing color for the menu bar
                                          default: menuForegroundColor

  pullDownMenuBackgroundColor             background drawing color for the menu bar
                                          default: menuBackgroundColor

  pullDownMenuHilightForegroundColor      active foreground drawing color for the menu bar
                                          default: menuHilightForegroundColor

  pullDownMenuHilightBackgroundColor      active background drawing color for the menu bar
                                          default: menuHilightBackgroundColor

  pullDownMenuHilightLevel                level (3D only) when active
                                          default: menuHilightLevel

  pullDownMenuEdgeStyle                   edge style (nil or #soft)

  pullDownMenuKeepMenu                    if true, pulled menu stays open until button
                                          is pressed again outside of the item-area (motif behavior)
                                          if false, menu closes on release (default)

  pullDownMenuToggleKeep                  if true, pulled menu closes when an entry is pressed
                                          again. Otherwise, only press outside of the items area
                                          hides it. default is false

  pullDownMenuLevel                       level (3D only)

  pullDownMenuFont                        font to use for the menu bar
                                          default: menuFont

  pullDownMenuShowSeparatingLines         if true, lines are drawn between items.
                                          default: false

  pullDownMenuRaiseTop                    if true, topview is raised whenever an entry
                                          is activated.
                                          default: true

copyrightCOPYRIGHT (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.

Class protocol:

defaults

updateStyleCache

extract values from the styleSheet and cache them in class variables

Usage example(s):

     PullDownMenu updateStyleCache

instance creation

labels: titleArray: create and return a new PullDownMenu

Instance protocol:

accessing

add: label selector: selector

add a new title-item at the end.
The corresponding label can later be set with #at:putMenu:
or #at:putLabels:selectors:...

add: label selector: selector after: indexOrString

add a new title-item after an existing item, indexOrString,
or at the end if the after-arg is nil.
The corresponding label can later be set with #at:putMenu:
or #at:putLabels:selectors:...

Usage example(s):

     |top m|

     top := StandardSystemView new.
     m := PullDownMenu in:top.
     m labels:#('file' 'edit').
     m selectors:#(file #edit).

     m add:'help' selector:#help after:#file.
     m at:#help putMenu:(MenuView labels:#('foo' 'bar')
                               selectors:#(foo bar)
                                receiver:nil).

     top open

add: label selector: selector before: indexOrString

add a new title-item before an existing item, indexOrString,
or at the beginning if the before-arg is nil.
The corresponding label can later be set with #at:putMenu:
or #at:putLabels:selectors:...

Usage example(s):

     |top m|

     top := StandardSystemView new.
     m := PullDownMenu in:top.
     m labels:#('file' 'edit').
     m selectors:#(file #edit).

     m add:'help' selector:#help before:#edit.
     m at:#help putMenu:(MenuView labels:#('foo' 'bar')
                               selectors:#(foo bar)
                                receiver:nil).

     m add:'foo' selector:#foo before:nil.
     m at:#foo putMenu:(MenuView labels:#('foo1' 'foo2')
                               selectors:#(foo1 foo2)
                                receiver:nil).

     top open

at: aString putLabels: labels selector: selector args: args receiver: anObject

create and set the menu under the title, aString
OBSOLETE protocol: labels:selectors:args:receiver: knows how to handle a
single symbol-arg for selectors ...

at: aString putLabels: labels selectors: selectors