index :: ui

ui.icon

simple icon with button capabilities

available since version: 0.5

---

information

Alt+Click outputs all possible icon names to Pd window. Can be in bang, button and toggle modes. Button mode is default: outputs 1 on mouse down, 0 on mouse up. See @mode property for more information.

arguments:

• NAME icon name from list
  type: symbol
  

methods:

• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

• interp for this object acts as load, no interpolation performed
  

• load loads specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• pos set UI element position
  parameters:

  • X top left x-coord
    type: float
    required: True
    

  • Y top right y-coord
    type: float
    required: True
    

• set sets icon name
  

• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

properties:

• @mode Get/set output mode. In bang mode - outputs bang on mouse down. In button mode outputs 1 on mouse down and 0 on mouse up. In toggle mode outputs 1/0 on mouse down, like vanilla toggle object.
  type: symbol
  enum: toggle, button, bang
  default: button
  

• @enabled Get/set enabled property
  type: bool
  default: 1
  

• @icon_size Get/set icons size
  type: int
  enum: 18, 24, 36, 48
  default: 24
  

• @icon Get/set icon name
  type: symbol
  enum: add, add_circle, add_circle_outline, add_to_queue, alarm, alarm_off, alarm_on, album, arrow_down, arrow_left, arrow_right, arrow_up, audio, backspace, block, bluetooth, blur_on, bookmark, bookmark_border, build, cached, capslock, check_circle, ceammc, clear, clock, computer, content_cut, copy, copyright, delete, delete_forever, done, eject, equalizer, exit, fast_forward, fast_rewind, favorite, favorite_border, fingerprint, flag, folder, folder_open, functions, gamepad, get_app, grade, grain, group, hdmi, headset, headset_mic, hearing, help, help_outline, history, home, hourglass, info, info_outline, input, keyboard, label, label_outline, levels, lightbulb_outline, linear_scale, list, lock, lock_open, loop, mic, mic_none, mic_off, midi, mouse, movie, notifications, open_with, pause, pause_circle_filled, pause_circle_outline, play, play_circle_filled, play_circle_filled_white, play_circle_outline, power, radio, record, redo, refresh, remove, remove_circle, remove_circle_outline, repeat, repeat_one, report_problem, save, search, select_all, settings, settings2, settings_voice, shuffle, skip_next, skip_previous, speaker, speaker_group, stars, stop, tape, timeline, touch_app, trending_flat, undo, videocam, visibility, visibility_off, volume_down, volume_mute, volume_off, volume_up, zoom_in, zoom_out
  default: help
  

• @presetname Get/set preset name for using with [ui.preset]
  type: symbol
  default: (null)
  

• @send Get/set send destination
  type: symbol
  default: (null)
  

• @receive Get/set receive source
  type: symbol
  default: (null)
  

• @pinned Get/set pin mode. if 1 - put element to the lowest level
  type: bool
  default: 0
  

• @active_color Get/set active color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0 0.75 1 1
  

• @background_color Get/set element background color (list of red, green, blue values in 0-1 range)
  type: list
  default: 1 1 1 1
  

• @border_color Get/set border color (list of red, green, blue values in 0-1 range)
  type: list
  default: 1 1 1 1
  

• @fontsize Get/set fontsize
  type: int
  range: 4..100
  default: 11
  

• @fontname Get/set fontname
  type: symbol
  enum: Helvetica, Monaco, Courier, Times, DejaVu
  default: Helvetica
  

• @fontweight Get/set font weight
  type: symbol
  enum: normal, bold
  default: normal
  

• @fontslant Get/set font slant
  type: symbol
  enum: roman, italic
  default: roman
  

inlets:

• (hidden inlet!) see @mode property
  type: control

outlets:

• (hidden outlet!) see @mode property
  type: control

keywords:

ui icon button

See also: [ui.bang]

Authors: Serge Poltavsky

License: GPL3 or later