class Iup::Button

A button can display some text, an image, or both. When clicked, a specified action function is called. The action should return Iup::DEFAULT, or, if the button should exit the application, Iup::CLOSE.

(1) A button with some text and an action

Iup::Button.new('click me', ->{
  puts 'clicked'
  Iup::DEFAULT
})

(2) A button with an image stored in img and action specified by a separate method; some padding around the image within the button.

def click_fn
  puts 'clicked'
  Iup::DEFAULT
end

Iup:Button.new('', ->{ click_fn }) do |b|
  b.image = img
  b.padding = '50x20'
end

(3) A button with text and image, image placed above text. The text contains an & before the “x”, so the action can be triggered using ALT+x, and closes the application.

Iup::Button.new('e&xit', ->{ puts 'exit'; Iup::CLOSE }) do |b|
  b.image = img
  b.imageposition = 'top'
end

Attributes

alignment [RW]

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 button to fill available space in indicated direction. Values ‘no’ / ‘horizontal’ / ‘vertical’ / ‘yes’.

imageposition [RW]

Position of image relative to text. Values ‘left’ / ‘right’ / ‘top’ / ‘bottom’/

impressborder [RW]

If set, shows button borders even if impress defined. 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”.

rastersize [RW]

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

screenposition [R]

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

spacing [RW]

Space between image and text, value as a number.

tip [RW]

Tooltip string.

title [RW]

Displayed on the button as a text label.

Public Class Methods

new (title='', callback = nil) { |self| ... }

Source

# File lib/wrapped/button.rb, line 45
def initialize(title='', callback = nil)
  @handle = IupLib.IupButton(title, nil)

  self.action = callback unless callback.nil?

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

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

title - the text to display on the button.
callback - procedure to call when button is left-clicked, passed to action.

Callbacks

Attributes

action [W]

Sets action called when the button 1 (usually left) is selected. Callback must respond to call and take no arguments.