wx:text%

Superclass: wx:item%

A wx:text% object is an area of editable text, with an optional label displayed in front of it.

Whenever the content of a text item is changed by the user, the text item's callback procedure is invoked. (The callback procedure is provided as an initialization argument when the text item is created.)

• (make-object wx:text% parent func label value x y width height style name) -> wx:text% object
      parent : wx:panel% object
      func : null or procedure of two arguments: a wx:text% object and a wx:command-event% object
      label : string or null
      value = "" : string
      x = -1 : small integer
      y = -1 : small integer
      width = -1 : small integer
      height = -1 : small integer
      style = 0 : small integer
      name = "text" : string

  If func is not null, it is used as the callback for the following event types:

  • wx:const-event-type-text-command -- the text has changed
  • wx:const-event-type-text-enter-command -- the enter key has been pressed; this is only called when the wx:const-process-enter style flag is used.
  • wx:const-event-type-set-focus -- the item has received the keyboard focus
  • wx:const-event-type-skill-focus -- the item has lost the keyboard focus

  If label is not null, it will be used to label the text item. Otherwise, no label will be used. 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 parameters x and y are used to specify an absolute position for the text item within the panel; if -1 is provided, a default position will be assigned such that the text item 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 text item based on the inital value string.

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

  • wx:const-process-enter -- the callback function will receive the message wx:const-event-type-text-enter-command. (Note: this will break tab traversal for this panel item under Windows.)
  • wx:const-password -- the text will be echoed as asterisks
  • wx:const-readonly -- the text will not be user-editable
  (Use 0 for no flags.)

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

  
  

Methods:

• copy
• cut
• get-value
• on-char
• paste
• set-editable
• set-value

All methods:

• center from wx:window%
• centre from wx:window%
• client-to-screen from wx:window%
• command from wx:item%
• copy
• cut
• enable from wx:window%
• 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-size from wx:window%
• 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-size from wx:window%
• get-text-extent from wx:window%
• get-value
• get-width from wx:window%
• get-x from wx:window%
• get-y from wx:window%
• is-shown? from wx:window%
• move from wx:window%
• on-char
• on-kill-focus from wx:window%
• on-set-focus from wx:window%
• on-size from wx:window%
• paste
• pre-on-char from wx:window%
• pre-on-event from wx:window%
• refresh from wx:window%
• screen-to-client from wx:window%
• set-background-colour from wx:item%
• set-button-colour from wx:item%
• set-cursor from wx:window%
• set-editable
• set-focus from wx:window%
• set-label from wx:item%
• set-label-colour from wx:item%
• set-size from wx:window%
• set-value
• show from wx:window%