class Iup::Toggle

A control that can have two or three states, and displays either some text or an image.

Example

(1) with text label

Iup::Toggle.new('click to change')

(2) with a standard image, reporting changes to value

Iup::Toggle.new do |t|
  t.image = "IUP_MessageHelp"
  t.valuechanged_cb = ->{ puts "button 1 state #{toggle1.value}" }
end

Sets the horizontal and vertical alignment. The value is a string “horizontal:vertical”, with horizontal options ALEFT, ACENTER, ARIGHT and vertical options ATOP, ACENTER, ABOTTOM. Partial values also accepted, e.g. “ARIGHT”, “:ATOP”.

canfocus [RW]

Enables the control to gain focus. Values ‘yes’ / ‘no’.

expand [RW]

Allows control to fill available space in indicated direction. Values ‘no’ / ‘horizontal’ / ‘vertical’ / ‘yes’.

flat [RW]

If set, hides the control’s border until mouse enters the button area. Values ‘yes’ / ‘no’.

padding [RW]

Margin in x and y directions, value as “mxn”.

position [R]

Returns position in pixels within client window as “x,y”.

radio [R]

Returns ‘yes’ / ‘no’, if toggle is within a radio control.

rastersize [RW]

Size of the control, in pixels, value as “widthxheight”.

screenposition [R]

returns position in pixels on screen as “x,y”.

three_state [RW]

‘no’ / ‘yes’, 3-state only for text labels, and not in a radio control.

tip [RW]

Tooltip string.

title [RW]

text to display.

value [RW]

Toggle’s state, value one of ‘on’ / ‘off’ / ‘toggle’ / ‘notdef’ (for 3-state toggles).

Public Class Methods

new (title=nil) { |self| ... }

Source

# File lib/wrapped/toggle.rb, line 25
def initialize(title=nil)
  @handle = IupLib.IupToggle(title, '')

  # run any provided block on instance, to set up further attributes
  yield self if block_given?
end

Creates a new instance. If a block is given, the new instance is yielded to it.

title - optional text to display

Callbacks

Attributes

action [W]

Callback called when the toggle’s state (on/off) was changed. Callback must respond to call and takes a 1-argument callback: (state_change)

state_change - state changed to ‘on’ or ‘off’ gives value 1 or 0

valuechanged_cb [W]

Callback called after the value was interactively changed by the user. Callback must respond to call and take no arguments.