iup-ffi 0.12.0

data/lib/wrapped/frame.rb

@@ -0,0 +1,47 @@
+module Iup
+
+  # A frame contains a child widget and displays it with a border.
+  # Optionally, the frame can have a text title.
+  #
+  # == Attributes
+  #
+  # clientoffset:: read-only, returns current offset of frame in its client
+  #                as "widthxheight".
+  # clientsize:: read-only, returns current size of frame as "widthxheight".
+  # expand:: Allows frame to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # rastersize:: Size of the frame, in pixels, value as "widthxheight".
+  # screenposition:: <b>read-only</b> returns position in pixels on screen
+  #                  as "x,y".
+  # sunken:: For frame with no title, gives a sunken appearance if set: 
+  #          values as 'yes' / 'no'.
+  # title:: Text displayed as frame title.
+  #
+  class Frame < Widget
+
+    # Creates an instance of the frame.
+    # widget:: the child widget to contain
+    # block:: optional block to set up the box's attributes.
+    def initialize widget, &block
+      @handle = IupLib.IupFrame widget.handle
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_readonly :clientoffset
+    define_readonly :clientsize
+    define_attribute :expand
+    define_readonly :position
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :sunken
+    define_attribute :title
+    
+  end
+end
+

data/lib/wrapped/gridbox.rb

@@ -0,0 +1,94 @@
+module Iup
+
+  # A container which arranges its widgets in a left-to-right, top-to-bottom order.
+  #
+  # == Attributes
+  # 
+  # alignmentcol:: gets/sets horizontal alignment of columns.
+  # * alignmentcol() -> reads value of 'ALIGNMENTCOL'
+  # * alignmentcol(val) -> sets 'ALIGNMENTCOL' to +val+, which is 'ALEFT' / 'ACENTER' / 'ARIGHT'
+  # * alignmentcol(n, val) -> sets alignment of column +n+ to +val+.  
+  # alignmentlin:: vertical alignment within line, as 'atop' / 'abottom' / 'acenter'
+  # cgapcol:: n, horizontal space in characters between columns.
+  # cgaplin:: n, vertical space in characters between lines.
+  # clientoffset:: <b>read-only</b>, returns current offset of box in its client
+  #                as "widthxheight".
+  # clientsize:: <b>read-only</b>, returns current size of box as "widthxheight".
+  # cmargin:: Margin in x and y directions in characters, value as "mxn".
+  # expand:: Allows container to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # expandchildren:: Set to allow children to expand fully, 
+  #                  values as 'yes' / 'no' / 'horizontal' / 'vertical'.
+  # fittochildren:: 'column' / 'line', n -> force column/line n to fit largest element in that column/line.
+  # gapcol:: n, horizontal space in pixels between columns.
+  # gaplin:: n, vertical space in pixels between lines.
+  # homogeneouscol:: Forces all columns to have same horizontal space, 
+  #                  values as 'yes' / 'no'.
+  # homogeneouslin:: Forces all lines to have same vertical space.
+  #                  values as 'yes' / 'no'.
+  # margin:: Margin in x and y directions in pixels, value as "mxn".
+  # normalsize:: Set to make natural size of children same, 
+  #              values as 'yes' / 'no' / 'horizontal' / 'vertical'.
+  # numcol:: <b>read-only</b> returns number of columns.
+  # numdiv:: 'auto' / n, controls number of divisions in direction as 
+  #          determined by +orientation+.
+  # numlin:: <b>read-only</b> returns number of lines.
+  # orientation:: Controls distribution of children, in lines or columns.
+  #               Value as 'horizontal' / 'vertical'.
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # rastersize:: Size of the container, in pixels, value as "widthxheight".
+  # sizecol:: Index of column to use for calculating height of lines.
+  # sizelin:: Index of line to use for calculating width of columns.
+  #
+  #
+  class GridBox < Widget
+    include DynamicFillMethods
+
+    # Creates an instance of the hbox.
+    # *widgets:: one or more child widgets 
+    # block:: optional block to set up the box's attributes.
+    def initialize *widgets, &block
+      @handle = IupLib.IupGridBox *widget_list(widgets)
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end   
+
+    # -- attributes
+
+    def alignmentcol val=nil, val2=nil # :nodoc:
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, 'ALIGNMENTCOL').first
+      elsif val2.nil?
+        IupLib.IupSetAttribute @handle, 'ALIGNMENTCOL', val.to_s
+      else
+        IupLib.IupSetAttribute @handle, "ALIGNMENTCOL#{val}", val2.to_s
+      end
+    end
+
+    define_attribute :alignmentlin
+    define_attribute :cgapcol
+    define_attribute :cgaplin
+    define_readonly :clientoffset
+    define_readonly :clientsize
+    define_attribute :cmargin
+    define_attribute :expand
+    define_attribute :expandchildren
+    define_attribute :fittochildren
+    define_attribute :gapcol
+    define_attribute :gaplin
+    define_attribute :homogeneouscol
+    define_attribute :homogeneouslin
+    define_attribute :margin
+    define_attribute :normalizesize
+    define_readonly :numcol
+    define_attribute :numdiv
+    define_readonly :numlin
+    define_attribute :orientation
+    define_readonly :position
+    define_attribute :rastersize
+    define_attribute :sizecol
+    define_attribute :sizelin
+  end
+end

data/lib/wrapped/hbox.rb

@@ -0,0 +1,49 @@
+module Iup
+
+    # A container for one or more child widgets, arranged in a horizontal row.
+  #
+  # == Attributes
+  #
+  # alignment:: horizontal alignment of children, 'atop' / 'acenter' / 'abottom'
+  # clientoffset:: <b>read-only</b>, returns current offset of box in its client
+  #                as "widthxheight".
+  # clientsize:: <b>read-only</b>, returns current size of box as "widthxheight".
+  # expand:: Allows container to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # expandchildren:: Set to allow children to expand fully, values as 'yes' / 'no'.
+  # gap:: Number of pixels between children, default value of 0.
+  # homogeneous:: Set to force all children to get equal size, values as 'yes' / 'no'. 
+  # margin:: Margin in x and y directions, value as "mxn".
+  # normalsize:: Set to make natural size of children same, values as 'yes' / 'no'.
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # rastersize:: Size of the container, in pixels, value as "widthxheight".
+  #
+  class HBox < Widget
+    include DynamicFillMethods
+
+    # Creates an instance of the hbox.
+    # *widgets:: one or more child widgets 
+    # block:: optional block to set up the box's attributes.
+    def initialize *widgets, &block
+      @handle = IupLib.IupHbox *widget_list(widgets)
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_attribute :alignment
+    define_readonly :clientoffset
+    define_readonly :clientsize
+    define_attribute :expand
+    define_attribute :expandchildren
+    define_attribute :gap
+    define_attribute :homogeneous
+    define_attribute :margin
+    define_attribute :normalizesize
+    define_readonly :position
+    define_attribute :rastersize
+  end
+end

data/lib/wrapped/image-attributes.rb

@@ -0,0 +1,27 @@
+module Iup
+
+  # Defines attributes for widgets which contain images.
+  #
+  module ImageAttributes
+    include AttributeReference
+
+    # Sets the image to display, based on an image or image name.
+    # This can use an actual image object, or the name of an image 
+    # from +IupImageLib+.
+    def image val=nil
+      attribute_reference 'IMAGE', ImageWidget, val
+    end
+
+    # Sets the image to display when inactive, based on an image or image name.
+    def iminactive val=nil
+      attribute_reference 'IMINACTION', ImageWidget, val
+    end
+
+    # Sets the image to display when pressed, based on an image or image name.
+    def impress val=nil
+      attribute_reference 'IMPRESS', ImageWidget, val
+    end
+  end
+
+end
+

data/lib/wrapped/image.rb

@@ -0,0 +1,118 @@
+module Iup
+
+  # Loads an image from file and returns an appropriate ruby class
+  def Iup.LoadImage filename
+    handle = ImLib.IupLoadImage filename
+    image = ImageWidget.new
+    image.instance_eval do
+      @handle = handle
+    end
+    return image
+  end
+
+  # Parent class of images provides common attributes.
+  # 
+  # == Attributes
+  #
+  # assign_handle:: <b>write-only</b> sets the name for referring to image.
+  # bpp:: <b>read-only</b> Returns the number of bits per pixel.
+  # channels:: <b>read-only</b> Returns the number of channels.
+  # color:: index, "r g b" -> gets/sets colour index. (Used only in 8-bit images created using +Image+)
+  # colour:: index, "r g b" -> gets/sets colour index. (Used only in 8-bit images created using +Image+)
+  # height:: <b>read-only</b> Height of the image, in pixels.
+  # hotspot:: "x:y", coordinates of spot in image used for mouse click. Default is "0:0".
+  # rastersize:: <b>read-only</b> Size of the image, in pixels, value as "widthxheight".
+  # wid:: <b>read-only</b> Native widget identifier.
+  # width:: <b>read-only</b> Width of the image, in pixels.
+  #
+  class ImageWidget < Widget
+
+    define_readonly :bpp
+    define_readonly :channels
+    
+    def colour index, value #:nodoc:
+      IupLib.IupSetAttribute @handle, index.to_s, value
+    end
+    
+    def color index, value # :nodoc:
+      colour index, value
+    end
+
+    define_readonly :height
+    define_attribute :hotspot
+    define_readonly :rastersize
+    define_readonly :wid
+    define_readonly :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. For example:
+  #
+  #   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 = Image.new 11, 11, pixmap_x
+  #
+  class Image < ImageWidget
+    # Constructor creates an image from raw pixels, using 1-value per pixel.
+    # width:: width of image in pixels
+    # height:: height of image in pixels
+    # pixels:: an array of pixel values
+    # block:: an optional block to set attributes
+    def initialize width, height, pixels, &block
+      @handle = IupLib.IupImage width, height, IupLib.pointer_from_chars(pixels)
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+  end
+
+  # Image made from RGB values.
+  class ImageRGB < ImageWidget
+    # Constructor creates an image from raw pixels, using 3-values per pixel.
+    # width:: width of image in pixels
+    # height:: height of image in pixels
+    # pixels:: an array of pixel values
+    # block:: an optional block to set attributes
+    def initialize width, height, pixels, &block
+      @handle = IupLib.IupImageRGB width, height, IupLib.pointer_from_chars(pixels)
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+  end
+
+  # Image made from RGBA values.
+  class ImageRGBA < ImageWidget
+    # Constructor creates an image from raw pixels, using 4-values per pixel.
+    # width:: width of image in pixels
+    # height:: height of image in pixels
+    # pixels:: an array of pixel values
+    # block:: an optional block to set attributes
+    def initialize width, height, pixels, &block
+      @handle = IupLib.IupImageRGBA width, height, IupLib.pointer_from_chars(pixels)
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+  end
+end

data/lib/wrapped/internal-drag-drop-attributes.rb

@@ -0,0 +1,21 @@
+module Iup
+
+  # defines attributes and methods used for internal drag and drop
+  # 
+  module InternalDragDropAttributes
+    extend AttributeBuilders
+
+    # attributes
+
+    define_attribute :dragdroplist
+    define_attribute :dropfilestarget
+    define_attribute :showdragdrop
+
+    # callbacks
+
+    def dragdrop_cb callback
+      define_callback callback, 'DRAGDROP_CB', :iiii_i
+    end
+  end
+
+end

data/lib/wrapped/iup-global.rb

@@ -0,0 +1,51 @@
+module Iup
+
+  # All IUP GUI code must be called via a block passed to this method, as 
+  # in this minimal example.
+  #
+  #   mainloop do
+  #   
+  #     label = Label.new("Hello World!")
+  #   
+  #     Dialog.new label do
+  #       title ' ... from IUP'
+  #       size '150x50'
+  #     end.show
+  #   end
+  #
+  def 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 global name, val=nil
+    if val.nil?
+      IupLib.IupGetGlobal(name).first
+    else
+      IupLib.IupSetGlobal name, val
+    end
+  end
+
+  # Sets the idle_action
+  def 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
+
+  # Make all of Iup module available at class level
+  # so Iup::mainloop etc can be used within 'include'
+  class << self 
+    include Iup
+  end
+end

data/lib/wrapped/label.rb

@@ -0,0 +1,98 @@
+module Iup
+
+  # A Label is a a static control. 
+  # It can display some text or an image, or act as a separator.
+  #
+  # The following example (see "examples/label.rb") displays three labels:
+  #
+  # 1. a label with some text given in blue, a large font, and center aligned.
+  # 2. a label as a horizontal separator.
+  # 3. a label using an image.
+  #
+  #  labeltext = <<-END
+  #  This label has the following attributes set:
+  #  BGCOLOR = 255 255 0
+  #  FGCOLOR = 0 0 255
+  #  FONT = 'Courier, Normal 14'
+  #  ALIGNMENT = ACENTER
+  #  END
+  #  
+  #  lbl = Label.new labeltext  do                    # <1>
+  #    bgcolor '255 255 0'
+  #    fgcolor '0 0 255'
+  #    font 'Courier, Normal 14'
+  #    alignment 'ACENTER'
+  #  end
+  #  
+  #  lbl_explain = Label.new 'The label on the right has the image of a star'
+  #  lbl_star = Label.new do                          # <2>
+  #    image img_star # reference to an image
+  #  end
+  #  
+  #  separator = Label.new do                         # <3>
+  #    separator 'HORIZONTAL' 
+  #  end
+  #  
+  #  Dialog.new(VBox.new(lbl, separator, HBox.new(lbl_explain, lbl_star))) do
+  #    title 'IupLabel Example'
+  #  end.show
+  # 
+  # 1. A label with text, modifying the attributes of the text.
+  # 2. A label with an image.
+  # 3. A label which acts as an horizontal separator.
+  #
+  # == Attributes
+  #
+  # alignment:: Sets the horizontal and vertical alignment.
+  #             The value is a string "horizontal:vertical", with 
+  #             options ALEFT, ACENTER, ARIGHT or none.
+  # ellipsis:: If set, adds "..." to the text if there is inadequate space,
+  #            values 'yes' / 'no'.
+  # expand:: Allows label to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # image:: Sets the image to display. 
+  #         This can be an actual image object, or the name of an image.
+  # iminactive:: Sets the image to display wihen inactive.
+  # padding:: Margin in x and y directions, value as "mxn".
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # rastersize:: Size of the label, in pixels, value as "widthxheight".
+  # separator:: 'horizontal' / 'vertical', makes line into a line separator.
+  # screenposition:: <b>read-only</b> returns position in pixels on screen
+  #                  as "x,y".
+  # spacing:: Space between image and text, value as a number.
+  # tip:: Tooltip string.
+  # title:: text to display (unless label has an image or is a separator).
+  #
+  class Label < Widget
+    include ImageAttributes
+    include DragDropAttributes
+
+    # Creates an instance of a label.
+    # text:: optional text to use for label.
+    # block:: optional block to set label's attributes.
+    def initialize text=nil, &block
+      @handle = IupLib.IupLabel text
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_attribute :alignment
+    define_attribute :ellipsis
+    define_attribute :expand
+    define_attribute :padding
+    define_readonly :position
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :separator
+    define_attribute :tip
+    define_attribute :title
+
+    # -- callbacks
+
+    include ButtonCallback
+  end
+end

data/lib/wrapped/link.rb

@@ -0,0 +1,59 @@
+module Iup
+
+  # A Link is a static control, a kind of Label, which displays an underlined
+  # clickable text. When clicked, the Link can open a url.
+  #
+  # The control can show the actual link, or an alternative piece of text.
+  # A custom +action+ can be provided, which must return +DEFAULT+ to also 
+  # open the URL, or +IGNORE+ if the URL should not be opened.
+  # 
+  # For example:
+  #
+  #   link1 = Link.new 'https://ruby-lang.org'               # <1>
+  # 
+  #   link2 = Link.new 'https://ruby-lang.org', 'Source' do  # <2>
+  #     tip 'Link is https://ruby-lang.org'
+  #   end
+  # 
+  #   link3 = Link.new 'https://ruby-lang.org', 'Source' do  # <3>
+  #     action ->(url) {
+  #       puts "you clicked on #{title} with URL: #{url}"
+  #       IGNORE # return DEFAULT if you also want link to be opened
+  #     }
+  #   end
+  # 
+  # 1. Simply displays the URL, and opens it when clicked.
+  # 2. Displays the word "Source" but opens URL when clicked.
+  # 3. Displays the word "Source" but overrides +action+ so the URL is not opened when clicked.
+  # 
+  class Link < Label
+
+    # Creates an instance of Link.
+    # url:: the URL to display / follow.
+    # text:: optional text to display in place of URL
+    # block:: optional block to set up link's parameters
+    def initialize url, text=nil, &block
+      @handle = IupLib.IupLink url, text
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- callbacks
+
+    # action callback is called when the link is clicked.
+    # The action callback takes a single argument, the 
+    # url of the link.
+    # Return IUP_CLOSE to process link. 
+    # If returns IUP_DEFAULT, or link is not defined, the IupHelp function will be called.
+    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