iup-ffi 0.12.0

data/lib/wrapped/list.rb

@@ -0,0 +1,353 @@
+module Iup
+
+  # A List control presents a list of options to the user.
+  # The list may be visible, or a hidden, drop-down list. 
+  # Optionally, items may be editable.
+  #
+  # Note that lists are indexed from 1.
+  #
+  # == Attributes
+  #
+  # autohide:: If set, scrollbars are only shown if necessary, values 'yes' / 'no'.
+  # canfocus:: If set, the control can gain focus, values 'yes' / 'no'.
+  # count:: <b>read-only</b> returns the number of items in the list.
+  # dragdroplist:: If yes, enables drag and drop between lists: 'yes' / 'no'.
+  # dropdown:: 'yes' / 'no', if set, only the selected item is visible.
+  # editbox:: 'yes' / 'no', if set adds an editable box to the list.
+  # expand:: Allows list to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # multiple:: If set, allows selection of multiple items: values 'yes' / 'no'.
+  #            Only available if editbox = dropdown = no.
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # rastersize:: Size of the list, in pixels, value as "widthxheight".
+  # removeitem:: n / 'all', removes item n or all items from the list.
+  # screenposition:: <b>read-only</b> returns position in pixels on screen
+  #                  as "x,y".
+  # showdragdrop:: If set, enables internal drag/drop: values 'yes' / 'no'.
+  # showdropdown:: <b>write-only</b> Shows the dropdown list, if dropdown=yes.
+  # sort:: Forces items to be sorted alphabetically. 
+  #        Insert/append operations will ignore the index number.
+  # spacing:: Space between items, value as a number.
+  # tip:: Tooltip string.
+  # visiblecolumns:: The minimum number of visible columns, defaults to 5.
+  # visiblelines:: The minimum number of visible lines, when dropdown=no.
+  #
+  # == Attributes (with editbox set)
+  #
+  # append:: <b>write-only</b> appends given string to end of text.
+  # caret:: 'col', in single-line mode, or 'lin,col' in multi-line mode.
+  # caretpos:: Index of character of the insertion point.
+  # clipboard:: 'clear' / 'copy' / 'cut' / 'paste', <b>write-only</b> access the 
+  #             clipboard with the current selection.
+  # insert:: <b>write-only</b> Places a given string at current caret position, 
+  #          overwriting any current selection.
+  # mask:: Defines a mask to filter text input.
+  # nc:: Maximum number of characters allowed for keyboard input (0 allows an indefinite number).
+  # padding:: Margin in x and y directions, value as "mxn".
+  # readonly:: If set, prevents the user changing contents: values 'yes' / 'no'.
+  # scrollto:: <b>write-only</b> 
+  #            'col' Scrolls to make given column number visible, 
+  #            in single-line mode.
+  #            'lin/col' Scrolls to make line and column number visible,
+  #            in multi-line mode.
+  # scrolltopos:: <b>write-only</b> Scrolls to make character 'number' visible.
+  # selectedtext:: Reads or overwrites the current selection. 
+  #                Does nothing if no text is selected.
+  # selection:: Selects text as 'col1:col2' (single-line) / 'lin1,col1:lin2,col2' (multi-line) / 'all' / 'none'.
+  # selectionpos:: Selects text between character positions: 'pos1:pos2' / 'all' / 'none'.
+  #
+  class List < Widget
+    include DragDropAttributes
+    include InternalDragDropAttributes
+
+    # Creates an instance of the list.
+    # All options are set through the _block_.
+    def initialize &block
+      @handle = IupLib.IupList nil
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+    
+    define_writeonly :append
+    
+    # Adds given item to end of list.
+    # text:: required text label
+    # image:: optional image reference / name.
+    def appenditem text, image=nil 
+      IupLib.IupSetAttribute 'APPENDITEM', text
+      case image
+      when NilClass
+        ;
+      when String
+        IupLib.SetAttibute @handle, "IMAGE#{count}", image
+      when ImageWidget
+        image_name = IupLib.IupGetName(name).first
+        if image_name.nil? or image_name.empty?
+          image_name = SecureRandom.uuid
+          image.assign_handle image_name
+        end
+        IupLib.IupSetAttribute @handle, "IMAGE#{count}", image_name
+      end
+    end
+
+    define_attribute :autohide
+    define_attribute :canfocus
+    define_attribute :caret
+    define_attribute :caretpos
+    define_attribute :clipboard
+    define_readonly :count
+    define_attribute :dragdroplist
+    define_attribute :dropdown
+    define_attribute :editbox
+    define_attribute :expand
+    define_writeonly :insert
+
+    # insert item at given index
+    # index:: index to add item (1-indexed)
+    # text:: required text label
+    # image:: optional image reference / name.
+    def insertitem index, text, image=nil
+      IupLib.IupSetAttribute @handle, "INSERTITEM#{index}", text
+      case image
+      when NilClass
+        ;
+      when String
+        IupLib.IupSetAttibute @handle, "IMAGE#{index}", image
+      when ImageWidget
+        image_name = IupLib.IupGetName(name).first
+        if image_name.nil? or image_name.empty?
+          image_name = SecureRandom.uuid
+          image.assign_handle image_name
+        end
+        IupLib.IupSetAttribute @handle, "IMAGE#{index}", image_name
+      end
+    end
+
+    # If text / image are set, adds a new item to the list.
+    # Otherwise, retrieves item at the given index.
+    # index:: index to item (1-indexed)
+    # text:: optional text label
+    # image:: optional image reference / name.
+    def item index, text=nil, image=nil
+      if text.nil?
+        IupLib.IupGetAttribute(@handle, index.to_s).first
+      else
+        IupLib.IupSetAttribute @handle, index.to_s, text
+        case image
+        when NilClass
+          ;
+        when String
+          IupLib.IupSetAttribute @handle, "IMAGE#{index}", image
+        when ImageWidget
+          image_name = IupLib.IupGetName(image.handle).first
+          if image_name.nil? or image_name.empty?
+            image_name = SecureRandom.uuid
+            image.assign_handle image_name
+          end
+          IupLib.IupSetAttribute @handle, "IMAGE#{index}", image_name
+        end
+        text
+      end
+    end
+
+    define_attribute :mask
+    define_attribute :multiple
+    define_attribute :nc
+    define_attribute :padding
+    define_readonly :position
+    define_attribute :rastersize
+    define_attribute :readonly
+    define_attribute :removeitem
+    define_readonly :screenposition
+    define_attribute :scrollbar
+    define_attribute :scrollto
+    define_attribute :scrolltopos
+    define_attribute :selectedtext
+    define_attribute :selection
+    define_attribute :selectionpos
+    define_attribute :showdragdrop
+    define_attribute :showdropdown
+    define_attribute :showimage
+    define_attribute :sort
+    define_attribute :spacing
+    define_attribute :tip
+    
+    # If val is:
+    # string:: when editbox is set, sets/gets the text entered by user.
+    # nil or an integer:: when dropdown = 'yes' or multiple = 'no', 
+    #                     sets/gets index of selected items. 
+    #
+    # When list is multiple, val is converted to/from array of indices from/to +/-
+    #
+    def value val=nil
+      if val.nil?
+        item_str = IupLib.IupGetAttribute(@handle, 'VALUE').first
+        if multiple == 'YES'
+          result = []
+          item_str.split('').each_with_index do |item, index|
+            result << index+1 if item == '+'
+          end
+          return result
+        else
+          return item_str
+        end
+      else
+        if multiple == 'YES'
+          result = ""
+          count.to_i.times do |i|
+            if val.include?(i+1)
+              result << '+'
+            else
+              result << '-'
+            end
+          end
+          IupLib.IupSetAttribute @handle, 'VALUE', result
+        else
+          IupLib.IupSetAttribute @handle, 'VALUE', val.to_s
+        end
+      end
+    end
+    
+    define_attribute :visiblecolumns
+    define_attribute :visiblelines
+
+    # -- callbacks
+
+    # Action generated when the state of an item in the list is changed.
+    # action takes a 3-argument callback: text, item, state
+    def action callback
+      unless callback.arity == 3
+        raise ArgumentError, 'action callback must take 3 arguments: (text, item, state)'
+      end
+      cb = Proc.new do |ih, text, item, state|
+        callback.call text, item, state
+      end
+      define_callback cb, 'ACTION', :sii_i
+    end
+
+    include ButtonCallback
+
+    # Action generated when the caret/cursor position is changed.  Valid only when EDITBOX=YES.
+    # caret_cb takes a callback which accepts 3 arguments (line, column, position) of caret
+    def caret_cb callback
+      unless callback.arity == 3
+        raise ArgumentError, 'caret_cb callback must take 3 arguments: (line, column, position)'
+      end
+      cb = Proc.new do |ih, lin, col, pos|
+        callback.call lin, col, pos
+      end
+      define_callback cb, 'CARET_CB', :iii_i
+    end
+
+    # Action generated when the user double click an item. Called only when DROPDOWN=NO.
+    # dblclick_cb takes a callback which accepts 2 arguments (index, text) 
+    def dblclick_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'dblclick_cb callback must take 2 arguments: index, text'
+      end
+      cb = Proc.new do |ih, index, text|
+        callback.call index, text
+      end
+      define_callback cb, 'DBLCLICK_CB', :is_i
+    end
+
+    # Action generated when an internal drag and drop is executed. Only active if SHOWDRAGDROP=YES.
+    # dragdrop_cb takes a callback which accepts 4 arguments (drag_id, drop_id, isshift, iscontrol)
+    # drag_id:: is an integer index of dragged item
+    # drop_id:: is an integer index of drop location
+    # isshift:: boolean flag for if shift key held
+    # iscontrol:: boolean flag for if control key held
+    # callback should return Iup::CONTINUE for item to be moved/copied.
+    def dragdrop_cb callback
+      unless callback.arity == 4
+        raise ArgumentError, 'dragdrop_cb callback must take 4 arguments: (drag_id, drop_id, isshift, iscontrol)'
+      end
+      cb = Proc.new do |ih, drag_id, drop_id, isshift, iscontrol|
+        callback.call drag_id.to_i, drop_id.to_i, (isshift != 0), (iscontrol != 0)
+      end
+      define_callback cb, 'DRAGDROP_CB', :iiii_i
+    end
+
+    # Action generated when the list of a dropdown is shown or hidden. Called only when DROPDOWN=YES.
+    # dropdown_cb takes a 1-argument callback, shown is a boolean, true if dropdown visible.
+    # dropdown_cb is only called if dropdown=yes
+    def dropdown_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'dropdown_cb callback must take 1 argument, shown'
+      end
+      cb = Proc.new do |ih, state|
+        callback.call (state == 1)
+      end
+      define_callback cb, 'DROPDOWN_CB', :i_i
+    end
+
+    # Action generated when the text in the text box is manually changed by the user, but 
+    # before its value is actually updated. Valid only when EDITBOX=YES.
+    # edit_cb takes a 2-argument callback, the character typed, and the new text value
+    def edit_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'edit_cb callback must take 2 arguments: (character, new_value)'
+      end
+      cb = Proc.new do |ih, c, text|
+        callback.call c, text
+      end
+      define_callback cb, 'EDIT_CB', :is_i
+    end
+
+    # Action generated when the mouse is moved.
+    # Callback takes 3 arguments: (x, y, state)
+    # x:: x position of mouse
+    # y:: y position of mouse
+    # state:: status of mouse buttons and certain keyboard keys at the moment the event was generated.
+    #--
+    # TODO: include functions, as in button_cb
+    #
+    def motion_cb callback
+      unless callback.arity == 3
+        raise ArgumentError, 'motion_cb callback must take 3 arguments: (x, y, state)'
+      end
+      cb = Proc.new do |ih, x, y, state|
+        callback.call x, y, state
+      end
+      define_callback cb, 'MOTION_CB', :iis_i
+    end
+
+    # Action generated when the state of an item in the multiple selection list is changed. But 
+    # it is called only when the interaction is over.
+    # callback called with two arrays:
+    # * indices of selected items
+    # * indices of deselected items
+    def multiselect_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'multiselect_cb callback must take 2 arguments, the array of selected and array of deselected items'
+      end
+      cb = Proc.new do |ih, val_ptr|
+        val = FFI::Pointer.new(val_ptr).read_string
+        selected = []
+        deselected = []
+        val.split('').each_with_index do |item, index|
+          selected << index+1 if item == '+'
+          deselected << index+1 if item == '-'
+        end
+        callback.call selected, deselected
+      end
+      define_callback cb, 'MULTISELECT_CB', :s_i
+    end
+
+    # Called after the value was interactively changed by the user. Called when 
+    # the selection is changed or when the text is edited.
+    def valuechanged_cb callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'valuechanged_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'VALUECHANGED_CB', :plain
+    end
+  end
+end

data/lib/wrapped/matrix.rb

@@ -0,0 +1,233 @@
+module Iup
+
+  # Matrix
+  #
+  class Matrix < Widget
+    def initialize &block
+      open_controls
+      @handle = ControlsLib.IupMatrix ""
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # get value of cell
+    def get lin, col
+      IupLib.IupGetAttribute(@handle, "#{lin}:#{col}").first
+    end
+
+    # set value of cell
+    def set lin, col, value
+      IupLib.IupSetAttribute @handle, "#{lin}:#{col}", value
+    end 
+
+    # -- attributes
+
+    # general attributes
+
+    define_attribute :cursor
+    define_attribute :dropimage
+    define_attribute :focuscell
+    define_attribute :flat
+    define_attribute :flatscrollbar
+    define_attribute :hidefocus
+    define_attribute :hiddentextmarks
+    define_attribute :hlcolor
+    define_attribute :origin
+    define_attribute :originoffset
+    define_attribute :readonly
+    define_attribute :showfillvalue
+    define_attribute :togglecentered
+    define_attribute :toggleimageon
+    define_attribute :toggleimageoff
+    define_attribute :typecolorinactive
+
+    define_attribute :expand
+    define_readonly :position
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :tip
+
+    # cell attributes (no redraw)
+
+    def bgcolor_column col, colour
+      IupLib.IupSetAttribute @handle, "BGCOLOR*:#{col}", colour
+    end
+    def bgcolor_line lin, colour
+      IupLib.IupSetAttribute @handle, "BGCOLOR#{lin}:*", colour
+    end
+    def bgcolor_cell col, lin, colour
+      IupLib.IupSetAttribute @handle, "BGCOLOR#{lin}:#{col}", colour
+    end
+
+    # size attributes
+    define_attribute :limitexpand
+    define_attribute :resizematrix
+    define_attribute :resizedrag
+    define_attribute :usetitlesize
+
+    # column size attributes
+
+    # RASTERWIDTHn, defines column width in pixels
+    def rasterwidth n, num_pixels
+      IupLib.IupSetAttribute @handle, "RASTERWIDTH#{n}", num_pixels.to_s
+    end
+
+    # WIDTHn, defines column width in SIZE units
+    def width n, size
+      IupLib.IupSetAttribute @handle, "WIDTH#{n}", size.to_s
+    end
+
+    define_attribute :widthdef
+
+    # MINCOLWIDTHn, defines column width in SIZE units
+    def mincolwidth n, size
+      IupLib.IupSetAttribute @handle, "MINCOLWIDTH#{n}", size.to_s
+    end
+
+    # line size attributes
+
+    # HEIGHTn, defines line height in SIZE units
+    def height n, size
+      IupLib.IupSetAttribute @handle, "HEIGHT#{n}", size.to_s
+    end
+
+    define_attribute :heightdef
+
+    # RASTERHEIGHTn, defines line height in pixels
+    def rasterheight n, num_pixels
+      IupLib.IupSetAttribute @handle, "RASTERHEIGHT#{n}", num_pixels.to_s
+    end
+
+    # number of cells attributes
+    define_writeonly :addcol
+    define_writeonly :addlin
+    define_writeonly :delcol
+    define_writeonly :dellin
+    define_attribute :numcol
+    define_attribute :numcol_visible
+    define_attribute :numcol_noscroll
+    define_attribute :numlin
+    define_attribute :numlin_visible
+    define_attribute :numlin_noscroll
+    define_attribute :noscrollastitle
+
+    # action attributes
+
+    def redraw # TODO - values
+      IupLib.IupSetAttribute @handle, 'redraw', 'all'
+    end
+
+    define_writeonly :fittosize
+
+    # canvas attributes
+    define_attribute :border
+    define_attribute :scrollbar
+
+    # -- callbacks
+
+    # Action generated when a keyboard event occurs
+    # returns IUP_DEFAULT to validate the key, IUP_IGNORE to ignore, 
+    # IUP_CONTINUE forwards the key, or identifier of the key to be treated
+    def action_cb callback
+      unless callback.arity == 5
+        raise ArgumentError, 'action_cb callback must take 5 arguments: (key, lin, col, edition, value)'
+      end
+      cb = Proc.new do |ih, key, lin, col, edition, value|
+        callback.call key, lin, col, edition, value
+      end
+      define_callback cb, 'ACTION_CB', :i_s
+    end
+
+    # Action generated when any mouse button is pressed over a cell.
+    def click_cb callback
+      unless callback.arity == 3
+        raise ArgumentError, 'click_cb callback must take 3 arguments: (lin, col, status)'
+      end
+      cb = Proc.new do |ih, lin, col, status|
+        callback.call lin, col, status
+      end
+      define_callback cb, 'CLICK_CB', :i_s
+    end
+
+    # Action generated when a column is interactively resized.
+    def colresize_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'colresize_cb callback must take 1 argument: (col)'
+      end
+      cb = Proc.new do |ih, col|
+        callback.call col
+      end
+      define_callback cb, 'COLRESIZE_CB', :i_s
+    end
+
+    # Action generated when any mouse button is released over a cell.
+    def release_cb callback
+      unless callback.arity == 3
+        raise ArgumentError, 'release_cb callback must take 3 arguments: (lin, col, status)'
+      end
+      cb = Proc.new do |ih, lin, col, status|
+        callback.call lin, col, status
+      end
+      define_callback cb, 'RELEASE_CB', :i_s
+    end
+
+    # Action generated after the element size has been updated, but 
+    # before the cells are refreshed.
+    def resizematrix_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'resizematrix_cb callback must take 2 arguments: (width, height)'
+      end
+      cb = Proc.new do |ih, width, height|
+        callback.call width, height
+      end
+      define_callback cb, 'RESIZEMATRIX_CB', :i_s
+    end
+
+    # Action generated when mouse has moved over the matrix.
+    def mousemove_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'mousemove_cb callback must take 2 arguments: (lin, col)'
+      end
+      cb = Proc.new do |ih, lin, col|
+        callback.call lin, col
+      end
+      define_callback cb, 'MOUSEMOVE_CB', :i_s
+    end
+
+    # Action generated when matrix cell is selected, matrix gets focus etc.
+    def enteritem_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'enteritem_cb callback must take 2 arguments: (lin, col)'
+      end
+      cb = Proc.new do |ih, lin, col|
+        callback.call lin, col
+      end
+      define_callback cb, 'ENTERITEM_CB', :i_s
+    end
+
+    # Action generated when cell is no longer current cell.
+    def leaveitem_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'leaveitem_cb callback must take 2 arguments: (lin, col)'
+      end
+      cb = Proc.new do |ih, lin, col|
+        callback.call lin, col
+      end
+      define_callback cb, 'LEAVEITEM_CB', :i_s
+    end
+
+    # Action generated when matrix is scrolled.
+    def scrolltop_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'scrolltop_cb callback must take 2 arguments: (lin, col)'
+      end
+      cb = Proc.new do |ih, lin, col|
+        callback.call lin, col
+      end
+      define_callback cb, 'SCROLLTOP_CB', :i_s
+    end
+
+
+  end
+end

data/lib/wrapped/menu.rb

@@ -0,0 +1,50 @@
+module Iup
+
+  # A Menu is a collection of menu items, submenus, and separators.
+  #
+  # For example, the following menu has the items: Open, Save, ----, Undo, Exit
+  # The Undo item is greyed out as it is inactive, and the Exit item, when clicked,
+  # will close the dialog. Notice how the File menu, which contains these items, 
+  # is a submenu of the main menu.
+  #
+  #   mainloop do
+  #     item_open = MenuItem.new 'Open'
+  #     item_save = MenuItem.new 'Save' 
+  #     item_undo = MenuItem.new 'Undo' do
+  #       active 'NO'
+  #     end
+  #     item_exit = MenuItem.new 'Exit', ->{ CLOSE } 
+  #     file_menu = Menu.new item_open, item_save, Separator.new, item_undo, item_exit
+  #     menu = Menu.new SubMenu.new('File', file_menu)
+  #   
+  #     Dialog.new Canvas.new do
+  #       menu menu
+  #       size '200x100'
+  #       title 'Menu Example'
+  #     end.show
+  #   end
+  #
+  # == Attributes
+  #
+  # radio:: If set, makes children act as a radio group. Values 'yes' / 'no'.
+  # wid:: <b>read-only</b> Native widget identifier.
+  #
+  class Menu < Widget
+
+    # Creates instance of a menu.
+    #
+    # *widgets:: one or more menu items, sub menus or separators.
+    # block:: optional block to set up menu's attributes.
+    def initialize *widgets, &block
+      @handle = IupLib.IupMenu *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 :radio
+    define_readonly :wid
+  end
+end