iup-ffi 0.13.0-x86_64-linux

data/lib/wrapped/image.rb

@@ -0,0 +1,178 @@
+module Iup
+
+  # Loads an image from file, returning an ImageWidget instance.
+  # * +filename+ - name of image file
+  # Raises +RuntimeError+ if no file of given filename exists.
+  def self.load_image filename
+    if File.exist?(filename)
+      handle = ImLib.IupLoadImage(filename)
+      puts handle # TODO - broken?
+      image = ImageWidget.new
+      image.handle = handle
+
+      return image
+    else
+      raise RuntimeError, "File does not exist", filename
+    end
+  end
+
+  # Parent class of images provides common attributes.
+  # 
+  # See also: Image, ImageRGB, ImageRGBA, Iup.load_image.
+  class ImageWidget < Iup::Widget
+
+    ##
+    # :attr_writer: assign_handle
+    # The name for referring to image.
+    define_writer :assign_handle
+
+    ##
+    # :attr_reader: bpp
+    # Returns the number of bits per pixel.
+    define_reader :bpp
+
+    ##
+    # :attr_reader: channels
+    # Returns the number of channels.
+    define_reader :channels
+
+    ##
+    # :attr_reader: height
+    # Height of the image, in pixels.
+    define_reader :height
+
+    ##
+    # :attr: hotspot
+    # "x:y", coordinates of spot in image used for mouse click. Default is
+    # "0:0".
+    define_attribute :hotspot
+
+    ##
+    # :attr_reader: rastersize
+    # Size of the image, in pixels, value as "widthxheight".
+    define_reader :rastersize
+
+    ##
+    # :attr_reader: wid
+    # Native widget identifier.
+    define_reader :wid
+
+    ##
+    # :attr_reader: width
+    # Width of the image, in pixels.
+    define_reader :width
+
+    # Saves image to given filename.
+    # Optional format is one of: "BMP", "JPEG", "GIF", "TIFF", "PNG", "PNM", "PCX", "ICO", etc.
+    def save(filename, format = 'png')
+      err = IupIm.IupSaveImage @handle, filename, format
+      if err.zero?
+        raise Exception, 'Could not save image as file'
+      end
+    end
+  end
+
+  # \Image made from greyscale values.
+  # The colors are defined in a table, and their indices used when 
+  # defining the image pixel-map.
+  #
+  # === Example
+  #
+  # The following image is built from 3 colors: the pixmap gives their
+  # placement in the 11x11 image, and the constructor uses a block to 
+  # specify the color for each of the 3 values. When displayed, the 
+  # image presents a red X on a yellow background.
+  #
+  #   pixmap_x = [
+  #    1,2,3,3,3,3,3,3,3,2,1, 
+  #    2,1,2,3,3,3,3,3,2,1,2, 
+  #    3,2,1,2,3,3,3,2,1,2,3, 
+  #    3,3,2,1,2,3,2,1,2,3,3, 
+  #    3,3,3,2,1,2,1,2,3,3,3, 
+  #    3,3,3,3,2,1,2,3,3,3,3, 
+  #    3,3,3,2,1,2,1,2,3,3,3, 
+  #    3,3,2,1,2,3,2,1,2,3,3, 
+  #    3,2,1,2,3,3,3,2,1,2,3, 
+  #    2,1,2,3,3,3,3,3,2,1,2, 
+  #    1,2,3,3,3,3,3,3,3,2,1
+  #  ]
+  #  
+  #  img = Iup::Image.new(11, 11, pixmap_x) do |i|
+  #   i.color(1, '0 1 0')
+  #   i.color(2, '255 0 0')
+  #   i.color(3, '255 255 0')
+  #  end
+  #
+  class Image < Iup::ImageWidget
+    # Constructor creates an image from raw pixels, using 1-value per pixel.
+    # If a block is given, the new instance is yielded to it.
+    # * +width+ - width of image in pixels
+    # * +height+ - height of image in pixels
+    # * +pixels+ - an array of pixel values, each value being a color index
+    def initialize(width, height, pixels)
+      @handle = IupLib.IupImage(width, height, IupLib.pointer_from_chars(pixels))
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # :call-seq:
+    #   image.color(index)        # retrieves 
+    #   image.color(index, value) # sets 
+    #
+    # Access color at given index.
+    # * +index+ - integer of color found in pixel map
+    # * +value+ - 'r g b' representation of color
+    def color(index, value=nil)
+      IupLib.IupSetAttribute(@handle, index.to_s, value)
+    end
+  end
+
+  # \Image made from RGB values.
+  #
+  # === Example
+  #
+  #   image_data_24 = [
+  #     r1,g1,b1,r2,g2,b2, ... r20,g20,b20, # 3x20 triples of RGB values
+  #     ... # 20 rows
+  #   ]
+  #   Iup::ImageRGB.new(20, 20, image_data_24)
+  #
+  class ImageRGB < Iup::ImageWidget
+    # Constructor creates an image from raw pixels.
+    # If a block is given, the new instance is yielded to it.
+    # * +width+ - width of image in pixels
+    # * +height+ - height of image in pixels
+    # * +pixels+ - an array of pixel values, using 3 values per pixel.
+    def initialize(width, height, pixels)
+      @handle = IupLib.IupImageRGB(width, height, IupLib.pointer_from_chars(pixels))
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+  end
+
+  # \Image made from RGBA values.
+  #
+  # === Example
+  #
+  #   image_data = [
+  #     r1,g1,b1,a1,r2,g2,b2,a2, ... r20,g20,b20,a20, # 4x20 sets of RGBA values
+  #     ... # 20 rows
+  #   ]
+  #   Iup::ImageRGBA.new(20, 20, image_data)
+  #
+  class ImageRGBA < Iup::ImageWidget
+    # Constructor creates an image from raw pixels.
+    # If a block is given, the new instance is yielded to it.
+    # * +width+ - width of image in pixels
+    # * +height+ - height of image in pixels
+    # * +pixels+ - an array of pixel values, using 4 values per pixel.
+    def initialize(width, height, pixels)
+      @handle = IupLib.IupImageRGBA(width, height, IupLib.pointer_from_chars(pixels))
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+  end
+end

data/lib/wrapped/iup-global.rb

@@ -0,0 +1,46 @@
+module Iup
+
+  # All IUP GUI code must be called via a block passed to this method, as 
+  # in this minimal example.
+  #
+  #   Iup.mainloop do
+  #   
+  #     label = Iup::Label.new("Hello World!")
+  #   
+  #     Iup::Dialog.new label do |d|
+  #       d.title = ' ... from IUP'
+  #       d.size = '150x50'
+  #     end.show
+  #   end
+  #
+  def self.mainloop 
+    begin
+      IupLib.IupOpen(0, nil)
+      ImgLib.IupImageLibOpen()
+
+      yield
+      IupLib.IupMainLoop
+    ensure
+      IupLib.IupClose
+    end
+  end
+
+  # Accesses the global variable 'name'.
+  # Provide a value for 'val' to set the variable, 
+  # or leave as nil to get the variable.
+  def self.global(name, val=nil)
+    if val.nil?
+      IupLib.IupGetGlobal(name).first
+    else
+      IupLib.IupSetGlobal(name, val)
+    end
+  end
+
+  # Sets the idle_action
+  def self.idle callback
+    unless callback.nil? or callback.arity.zero? 
+      raise ArgumentError 'callback to idle must take no arguments'
+    end
+    IupLib.IupSetFunction('IDLE_ACTION', callback)
+  end
+end

data/lib/wrapped/label.rb

@@ -0,0 +1,110 @@
+module Iup
+
+  # A static control used to display some text or an image, or act as a
+  # separator.
+  #
+  # === Example
+  #
+  # (1) label with text and setting font and colors:
+  #
+  #  Iup::Label.new("Iup Label Text") do |l|
+  #    l.bgcolor = '255 255 0'
+  #    l.fgcolor = '0 0 255'
+  #    l.font = 'Courier, Normal 14'
+  #    l.alignment = 'ACENTER'
+  #   end
+  #
+  # (2) label with image aligned to right
+  # 
+  #   Iup::Label.new do |l|
+  #     l.image = img_star
+  #   end
+  #
+  # (3) label as a horizontal separator
+  #
+  #   Iup::Label.new do |l|
+  #     l.separator = 'HORIZONTAL'
+  #   end
+  #
+  class Label < Iup::Widget
+    include ImageAttributes
+    include DragDropAttributes
+
+    # Creates an instance of a label.
+    # If a block is given, the new instance is yielded to it.
+    # * +text+ - optional text to use for label.
+    def initialize text=nil
+      @handle = IupLib.IupLabel(text)
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: alignment
+    # 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".
+    define_attribute :alignment
+
+    ##
+    # :attr: ellipsis
+    # If set, adds "..." to the text if there is inadequate space,
+    # values 'yes' / 'no'.
+    define_attribute :ellipsis
+
+    ##
+    # :attr: expand
+    # Allows label to fill available space in indicated direction.
+    # Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+    define_attribute :expand
+
+    ##
+    # :attr: padding
+    # Margin in x and y directions, value as "mxn".
+    define_attribute :padding
+
+    ##
+    # :attr_reader: position
+    # Returns position in pixels within client window as "x,y".
+    define_reader :position
+
+    ##
+    # :attr: rastersize
+    # Size of the label, in pixels, value as "widthxheight".
+    define_attribute :rastersize
+
+    ##
+    # :attr_reader: screenposition
+    # returns position in pixels on screen as "x,y".
+    define_reader :screenposition
+
+    ##
+    # :attr: separator
+    # 'horizontal' / 'vertical', makes line into a line separator.
+    define_attribute :separator
+
+    ##
+    # :attr: spacing
+    # Space between image and text, value as a number.
+    define_attribute :spacing
+
+    ##
+    # :attr: tip
+    # Tooltip string.
+    define_attribute :tip
+
+    ##
+    # :attr: title
+    # text to display (unless label has an image or is a separator).
+    define_attribute :title
+
+    # :section: Callbacks
+
+    include ButtonCallback
+  end
+end

data/lib/wrapped/link.rb

@@ -0,0 +1,54 @@
+module Iup
+
+  # A static control, a kind of label which displays an underlined
+  # clickable text. When clicked, the text is opened in the browser
+  # as a url.
+  #
+  # === Example
+  #
+  # (1) Display clickable link:
+  #
+  #   Iup::Link.new('https://www.ruby-lang.org')
+  #
+  # (2) Display text instead of link, and custom callback on click:
+  #
+  #   Iup::Link.new('https://www.ruby-lang.org', 'Ruby Home') do |l|
+  #     l.action = ->(url) {
+  #       puts "you clicked on #{l.title} with URL: #{url}"
+  #       Iup::IGNORE # return DEFAULT if you also want link to be opened
+  #     }
+  #   end 
+  class Link < Iup::Label
+
+    # Creates a new link instance.
+    # If a block is given, the new instance is yielded to it.
+    # * +url+ - the URL to display / follow.
+    # * +text+ - optional text to display in place of URL
+    def initialize url, text=nil
+      @handle = IupLib.IupLink(url, text)
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: action
+    # Callback called when the link is clicked.
+    # The callback must respond to +call+ and takes a single argument: (url)
+    # * +url+ - of the link.
+    # Return Iup::DEFAULT to process link after action, or Iup::IGNORE. 
+
+    # --
+    def action= callback
+      unless callback.arity == 1
+        raise ArgumentError, 'action callback must take 1 argument: the url'
+      end
+      cb = Proc.new do |ih, url|
+        callback.call url 
+      end
+      define_callback cb, 'ACTION', :s_i
+    end
+  end
+end