wx:list-box%

Superclass: wx:item%

A list box is used to select one or more of a list of strings. The strings are displayed in a scrolling box, with the selected string(s) marked in reverse video. A list item can be single selection (if an item is selected, the previous selection is removed) or multiple selection (clicking an item toggles the item on or off independently of other selections).

Whenever the selection in a list box is changed by the user, the list box's callback procedure is invoked. (The callback procedure is provided as an initialization argument when the list box is created.)

List box choices are numbered from 0.

See also wx:choice%.

• (make-object wx:list-box% parent func label multiple-selection x y width height choices style name) -> wx:list-box% object
      parent : wx:panel% object
      func : null or procedure of two arguments: a wx:list-box% object and a wx:command-event% object
      label : string or null
      multiple-selection = wx:const-single : small integer
      x = -1 : small integer
      y = -1 : small integer
      width = -1 : small integer
      height = -1 : small integer
      choices : list of strings
      style = 0 : small integer
      name = "listBox" : string

  If func is not null, it is used as the callback for the list box when the selection is changed by the user.

  If label is not null, it will be used as the list box label. Otherwise, the list box will not have a label. The label string can mark a character of the label as the Windows shortcut by preceding the key with an ampersand (``&''). Ampersands are stripped from label before it is used as a label. Double ampersands are converted to a single (unstripped) ampersand.

  The multiple-selection argument is one of the following:

  • wx:const-single -- single-selection list
  • wx:const-multiple -- multiple-selection list; a single click deselects other items and selects a new item
  • wx:const-extended -- extended-selection list; like wx:const-multiple, but a single click extends the selection

  The parameters x and y are used to specify an absolute position for the list box within the panel; if -1 is provided, a default position will be assigned such that the list box is placed next to the last item inserted into the panel. If width or height is -1, an appropriate size will be used for the list box based on the list items.

  The style argument is reserved for future use.

  The style argument is any bitwise-ior combination of the following:

  • wx:const-always-sb -- create the scrollbars immediately
  • wx:const-hscroll -- create a horizontal scrollbar if the contents are two wide
  (Use 0 for no flags.)

  The constant wx:const-needed-sb is equal to 0.

  The name argument is used to associate a name with the list box, allowing the application user to set X Windows resource values for each individual list box.

  
  

Methods:

• append
• clear
• delete
• find-string
• get-client-data
• get-first-item
• get-selection
• get-selections
• get-string
• get-string-selection
• number
• number-of-visible-items
• selected?
• set
• set-client-data
• set-first-item
• set-selection
• set-string
• set-string-selection

All methods:

• append
• center from wx:window%
• centre from wx:window%
• clear
• client-to-screen from wx:window%
• command from wx:item%
• delete
• enable from wx:window%
• find-string
• get-background-colour from wx:item%
• get-button-colour from wx:item%
• get-char-height from wx:window%
• get-char-width from wx:window%
• get-client-data
• get-client-size from wx:window%
• get-first-item
• get-grand-parent from wx:window%
• get-height from wx:window%
• get-label from wx:item%
• get-label-colour from wx:item%
• get-name from wx:window%
• get-parent from wx:window%
• get-position from wx:window%
• get-selection
• get-selections
• get-size from wx:window%
• get-string
• get-string-selection
• get-text-extent from wx:window%
• get-width from wx:window%
• get-x from wx:window%
• get-y from wx:window%
• is-shown? from wx:window%
• move from wx:window%
• number
• number-of-visible-items
• on-kill-focus from wx:window%
• on-set-focus from wx:window%
• on-size from wx:window%
• pre-on-char from wx:window%
• pre-on-event from wx:window%
• refresh from wx:window%
• screen-to-client from wx:window%
• selected?
• set
• set-background-colour from wx:item%
• set-button-colour from wx:item%
• set-client-data
• set-cursor from wx:window%
• set-first-item
• set-focus from wx:window%
• set-label from wx:item%
• set-label-colour from wx:item%
• set-selection
• set-size from wx:window%
• set-string
• set-string-selection
• show from wx:window%