iup-ffi 0.13.0-x86_64-linux

data/lib/wrapped/matrix.rb

@@ -0,0 +1,575 @@
+module Iup
+
+  # An interactive control, used to display a matrix or grid of strings on
+  # a canvas.  The API documentation
+  # can only hint at the use of this control. For more information see
+  # Tecgraf's documentation on 
+  # {IupMatrix}[https://www.tecgraf.puc-rio.br/iup/en/ctrl/iupmatrix.html].
+  #
+  # === Example
+  #
+  #   matrix =Iup::Matrix.new do |m|
+  #     m.numlin = 3
+  #     m.numcol = 3
+  #     m.set(0, 1, "Country")
+  #     m.set(0, 2, "Capital")
+  #     m.set(0, 3, "Population")
+  #     m.set(1, 1, "England")
+  #     m.set(1, 2, "London")
+  #     m.set(1, 3, "58,620,100")
+  #     m.set(2, 1, "Scotland")
+  #     m.set(2, 2, "Edinburgh")
+  #     m.set(2, 3, "5,546,900")
+  #     m.set(3, 1, "Wales")
+  #     m.set(3, 2, "Cardiff")
+  #     m.set(3, 3, "3,186,600")
+  #     m.readonly = "yes"
+  #   end
+  #   
+  #   dlg = Iup::Dialog.new(matrix) do |d|
+  #     d.title = "Matrix Example"
+  #   end.map
+  #   
+  #   dlg.show
+  #
+  # Note that the dialog must be mapped before being shown, to 
+  # correctly display the matrix.
+  #
+  class Matrix < Iup::Widget
+    # Creates a new instance.
+    # If a block is given, the new instance is yielded to it.
+    def initialize
+      open_controls
+      @handle = ControlsLib.IupMatrix ""
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # Get value of cell:
+    # * +lin+ - line number of cell
+    # * +col+ - column number of cell
+    # Returns string value of cell (lin, col).
+    def get(lin, col)
+      IupLib.IupGetAttribute(@handle, "#{lin}:#{col}").first
+    end
+
+    # Set value of cell:
+    # * +lin+ - line number of cell
+    # * +col+ - column number of cell
+    # * +value+ - new value for cell
+    def set(lin, col, value)
+      IupLib.IupSetAttribute(@handle, "#{lin}:#{col}", value.to_s)
+    end 
+
+    # -- attributes
+
+    # :section: General attributes
+
+    ##
+    # :attr: cursor
+    # Defines the mouse shape / cursor for the matrix.
+    # Available cursors are shown in the
+    # {Tecgraf documentation}[http://www.tecgraf.puc-rio.br/iup/en/attrib/iup_cursor.html].
+    define_attribute :cursor
+
+    ##
+    # :attr: focuscell
+    # Defines current cell, in format "L:C" - default "1:1".
+    define_attribute :focuscell
+
+    ##
+    # :attr: flat
+    # Removes 3D appearance from matrix, values 'yes' / 'no'.
+    define_attribute :flat
+
+    ##
+    # :attr: flatscrollbar
+    # Enables flat scrollbars, values 'yes' / 'no'.
+    define_attribute :flatscrollbar
+
+    ##
+    # :attr: hidefocus
+    # Controls display of focus mark when drawing matrix. 
+    # Values 'yes' / 'no'.
+    define_attribute :hidefocus
+
+    ##
+    # :attr: hiddentextmarks
+    # Use a "..." or crop text when longer than cell, values 'yes' / 'no'.
+    define_attribute :hiddentextmarks
+
+    ##
+    # :attr: hlcolor
+    # Overlay color for selected cells.
+    define_attribute :hlcolor
+
+    ##
+    # :attr_writer: origin
+    # Scroll visible area to given cell: "L:C" format, use a "*"
+    # for L or C to scroll to a column or line.
+    define_writer :origin
+
+    ##
+    # :attr: originoffset
+    # Defines drag offset of origin: if changed, change #origin too.
+    define_attribute :originoffset
+
+    ##
+    # :attr: readonly
+    # Disable editing of cells. Values 'yes' / 'no'.
+    define_attribute :readonly
+
+    ##
+    # :attr: expand
+    # Allows container to fill available space in indicated direction.
+    # Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+    define_attribute :expand
+
+    ##
+    # :attr_reader: position
+    # Returns position in pixels within client window as "x,y".
+    define_reader :position
+
+    ##
+    # :attr: rastersize
+    # Size of the container, in pixels, value as "widthxheight".
+    define_attribute :rastersize
+
+    ##
+    # :attr_reader: screenposition
+    # Returns position in pixels on screen as "x,y".
+    define_reader :screenposition
+
+    ##
+    # :attr: tip
+    # Tooltip string.
+    define_attribute :tip
+
+    # :section: Cell attributes
+
+    # Sets the background color of a column:
+    # * +col+ - column to change
+    # * +color+ - color in 'r g b' format
+    def bgcolor_column(col, color)
+      IupLib.IupSetAttribute(@handle, "BGCOLOR*:#{col}", color)
+    end
+    
+    # Sets the background color of a line:
+    # * +lin+ - line to change
+    # * +color+ - color in 'r g b' format
+    def bgcolor_line(lin, color)
+      IupLib.IupSetAttribute(@handle, "BGCOLOR#{lin}:*", color)
+    end
+    
+    # Sets the background color of a cell:
+    # * +col+ - column to change
+    # * +lin+ - line to change
+    # * +color+ - color in 'r g b' format
+    def bgcolor_cell(col, lin, color)
+      IupLib.IupSetAttribute(@handle, "BGCOLOR#{lin}:#{col}", color)
+    end
+
+    # Sets the foreground color of a column:
+    # * +col+ - column to change
+    # * +color+ - color in 'r g b' format
+    def fgcolor_column(col, color)
+      IupLib.IupSetAttribute(@handle, "FGCOLOR*:#{col}", color)
+    end
+    
+    # Sets the foreground color of a line:
+    # * +lin+ - line to change
+    # * +color+ - color in 'r g b' format
+    def fgcolor_line(lin, color)
+      IupLib.IupSetAttribute(@handle, "FGCOLOR#{lin}:*", color)
+    end
+    
+    # Sets the foreground color of a cell:
+    # * +col+ - column to change
+    # * +lin+ - line to change
+    # * +color+ - color in 'r g b' format
+    def fgcolor_cell(col, lin, color)
+      IupLib.IupSetAttribute(@handle, "FGCOLOR#{lin}:#{col}", color)
+    end
+
+    # Sets the font of a column:
+    # * +col+ - column to change
+    # * +font+ - font
+    def font_column(col, font)
+      IupLib.IupSetAttribute(@handle, "FONT*:#{col}", font)
+    end
+    
+    # Sets the font of a line:
+    # * +lin+ - line to change
+    # * +font+ - font 
+    def bgcolor_line(lin, font)
+      IupLib.IupSetAttribute(@handle, "FONT#{lin}:*", font)
+    end
+    
+    # Sets the font of a cell:
+    # * +col+ - column to change
+    # * +lin+ - line to change
+    # * +font+ - font
+    def font_cell(col, lin, font)
+      IupLib.IupSetAttribute(@handle, "FONT#{lin}:#{col}", font)
+    end
+
+    # :section: Size attributes
+
+    ##
+    # :attr: limitexpand
+    # Limits expansion to the largest size where all cells are visible.
+    define_attribute :limitexpand
+
+    ##
+    # :attr: resizematrix
+    # Allows column widths to be adjusted manually by users, values 
+    # 'yes' / 'no'.
+    define_attribute :resizematrix
+
+    ##
+    # :attr: resizedrag
+    # Dynamically resize the column while dragging, values 'yes' / 'no'.
+    define_attribute :resizedrag
+
+    ##
+    # :attr: usetitlesize
+    # If set, defines cell size based on the title size. 
+    # Values 'yes' / 'no'.
+    define_attribute :usetitlesize
+
+    # :section: Column size attributes
+
+    # Defines column width in pixels.
+    # * +n+ - column number
+    # * +num_pixels+ - new width of column n
+    def rasterwidth(n, num_pixels)
+      IupLib.IupSetAttribute(@handle, "RASTERWIDTH#{n}", num_pixels.to_s)
+    end
+
+    # Defines column width in SIZE units
+    # * +n+ - column number
+    # * +size+ - new size of column n
+    def width(n, size)
+      IupLib.IupSetAttribute(@handle, "WIDTH#{n}", size.to_s)
+    end
+
+    ##
+    # :attr: widthdef
+    # Default width of column in SIZE units, default value is 80.
+    define_attribute :widthdef
+
+    # Defines minimum column width in SIZE units.
+    # * +n+ - column number
+    # * +size+ - new size of column n
+    def mincolwidth(n, size)
+      IupLib.IupSetAttribute(@handle, "MINCOLWIDTH#{n}", size.to_s)
+    end
+
+    # :section: Line size attributes
+
+    # Defines line height in SIZE units:
+    # * +n+ - line number
+    # * +size+ - new size of line n
+    def height(n, size)
+      IupLib.IupSetAttribute(@handle, "HEIGHT#{n}", size.to_s)
+    end
+
+    ##
+    # :attr: height
+    # Default height of line in SIZE units, default value is 8.
+    define_attribute :heightdef
+
+    # Defines line height in pixels:
+    # * +n+ - line number
+    # * +num_pixels+ - new length of line n
+    def rasterheight(n, num_pixels)
+      IupLib.IupSetAttribute(@handle, "RASTERHEIGHT#{n}", num_pixels.to_s)
+    end
+
+    # :section: Number of cells attributes
+
+    ##
+    # :attr_writer: addcol
+    # Adds a new column to matrix after the given column. 
+    define_writer :addcol
+
+    ##
+    # :attr_writer: addlin
+    # Adds a new line to matrix after the given line. 
+    define_writer :addlin
+
+    ##
+    # :attr_writer: delcol
+    # Removes the given column from the matrix.
+    define_writer :delcol
+
+    ##
+    # :attr_writer: dellin
+    # Removes the given line from the matrix.
+    define_writer :dellin
+
+    ##
+    # :attr: numcol
+    # Defines the number of columns in the matrix, must be an integer.
+    define_attribute :numcol
+
+    ##
+    # :attr: numcol_visible
+    # Specifies the number of visible columns to include in calculating the
+    # Natural size.
+    define_attribute :numcol_visible
+
+    ##
+    # :attr: numlin_noscroll
+    # Number of columns that are non-scrollable, not counting the title
+    # column.
+    define_attribute :numcol_noscroll
+
+    ##
+    # :attr: numlin
+    # Defines the number of lines in the matrix, must be an integer.
+    define_attribute :numlin
+
+    ##
+    # :attr: numlin_visible
+    # Specifies the number of visible lines to include in calculating the
+    # Natural size.
+    define_attribute :numlin_visible
+
+    ##
+    # :attr: numlin_noscroll
+    # Number of lines that are non-scrollable, not counting the title
+    # line.
+    define_attribute :numlin_noscroll
+
+    ##
+    # :attr: noscrollastitle
+    # Makes the non-scrollable lines/columns appear like the title line/column,
+    # values 'yes' / 'no'.
+    define_attribute :noscrollastitle
+
+    # :section: Action attributes
+
+    # Instructs matrix of data change, and that it must redraw itself.
+    # Value can be:
+    # * 'all' - redraw the whole matrix
+    # * 'Ld' - redraws line d
+    # * 'Ld1-d2' - redraws lines d1 to d2
+    # * 'Cd' - redraws column c
+    # * 'Cd1-d2' - redraws columns d1 to d2
+    def redraw
+      IupLib.IupSetAttribute(@handle, 'redraw', 'all')
+    end
+
+    ##
+    # :attr_writer: fittosize
+    # Forces line/column sizes so the matrix visible fits in 
+    # the current displayed size.
+    define_writer :fittosize
+
+    # :section: Canvas attributes
+
+    ##
+    # :attr: border
+    # Changed to 'no', cf. Iup::Canvas#border.
+    define_attribute :border
+
+    ##
+    # :attr: scrollbar
+    # Changed to 'yes', cf. Iup::Canvas#scrollbar.
+    define_attribute :scrollbar
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: action_cb
+    # Callback called when a keyboard event occurs.
+    # Callback must respond to +call+ and takes 5 arguments: (key, lin, col, edition, value)
+    # * +key+ - identifier of pressed key, see {Key definitions}[../Iup.html#Key+definitions]
+    # * +lin+ - line of selected cell
+    # * +col+ - column of selected cell
+    # * +edition+ - is 1 if in edit mode, or 0 otherwise
+    # * +value+ - varies with edit mode: can be current value, string with key character, or "".
+    # 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
+
+    ##
+    # :attr_writer: click_cb
+    # Callback called when any mouse button is pressed over a cell.
+    # Callback must respond to +call+ and takes 3 arguments: (lin, col, status)
+    # * +lin+ - line of selected cell
+    # * +col+ - column of selected cell
+    # * +status+ - of mouse buttons and some keyboard keys.
+    # Return Iup::IGNORE to avoid refresh of display, or Iup::DEFAULT.
+
+    # --
+    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
+
+    ##
+    # :attr_writer: colresize_cb
+    # Callback called when a column is interactively resized.
+    # Callback must respond to +call+ and takes 1 argument: (col)
+    # * +col+ - column being resized
+    # Return Iup::IGNORE to avoid refresh of display, or Iup::DEFAULT.
+
+    # --
+    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
+
+    ##
+    # :attr_writer: release_cb
+    # Callback called when any mouse button is released over a cell.
+    # Callback must respond to +call+ and takes 3 arguments: (lin, col, status)
+    # * +lin+ - line of selected cell
+    # * +col+ - column of selected cell
+    # * +status+ - of mouse buttons and some keyboard keys.
+    # Return Iup::IGNORE to avoid refresh of display, or Iup::DEFAULT.
+
+    # --
+    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
+
+    ##
+    # :attr_writer: resizematrix_cb
+    # Callback called after the element size has been updated, but 
+    # before the cells are refreshed.
+    # Callback must respond to +call+ and takes 2 arguments: (width, height)
+    # * +width+ - of internal area in pixels
+    # * +height+ - of internal area in pixels
+
+    # --
+    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
+
+    ##
+    # :attr_writer: mousemove_cb
+    # Callback called when mouse has moved over the matrix.
+    # Callback must respond to +call+ and takes 2 arguments: (lin, col)
+    # * +lin+ - line of current mouse position
+    # * +col+ - column of current mouse position
+
+    # --
+    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
+
+    ##
+    # :attr_writer: enteritem_cb
+    # Callback called when matrix cell is selected, matrix gets focus etc.
+    # Callback must respond to +call+ and takes 2 arguments: (lin, col)
+    # * +lin+ - line of selected cell
+    # * +col+ - column of selected cell
+
+    # --
+    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
+
+    ##
+    # :attr_writer: leaveitem_cb
+    # Callback called when cell is no longer current cell, matrix loses focus etc.
+    # Callback must respond to +call+ and takes 2 arguments: (lin, col)
+    # * +lin+ - line of selected cell
+    # * +col+ - column of selected 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
+
+    ##
+    # :attr_writer: scrolltop_cb
+    # Callback called when matrix is scrolled.
+    # Callback must respond to +call+ and takes 2 arguments: (lin, col)
+    # * +lin+ - line of cell currently in top-left corner
+    # * +col+ - column of cell currently in top-left corner
+
+    # --
+    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
+
+    ##
+    # :attr_writer: value_cb
+    # Callback called to retrieve value of a cell.
+    # Callback must respond to +call+ and takes 2 arguments: (lin, col)
+    # * +lin+ - line of cell 
+    # * +col+ - column of cell
+
+    # --
+    def value_cb= callback
+      unless callback.arity == 2
+        raise ArgumentError, 'value_cb callback must take 2 arguments: (lin, col)'
+      end
+      cb = Proc.new do |ih, lin, col|
+        callback.call lin, col
+      end
+      define_callback cb, 'VALUE_CB', :i_s
+    end
+  end
+end

data/lib/wrapped/menu.rb

@@ -0,0 +1,91 @@
+module Iup
+
+  # A menu is a collection of menu items, submenus, and separators.
+  # It is usually placed within a Dialog, or launched from an 
+  # action, using +popup+. 
+  #
+  # This widget basically acts as a container for other menu 
+  # widgets, but setting the +radio+ attribute makes those other 
+  # widgets act as a radio group.
+  #
+  # === Example
+  #
+  # The following example creates open, save and exit menu items, and places 
+  # them onto a menu. The save menu item is initially inactive. Notice 
+  # the use of a separator, and how a SubMenu adds a clickable title to the
+  # file menu.
+  #
+  #   item_open = Iup::MenuItem.new('Open')
+  #   item_save = Iup::MenuItem.new('Save') do |i|
+  #     i.active = 'NO'
+  #   end
+  #   item_exit = Iup::MenuItem.new('Exit', ->{ Iup::CLOSE })
+  #   file_menu = Iup::Menu.new(
+  #     item_open, item_save, 
+  #     Iup::Separator.new, 
+  #     item_exit)
+  #   menu = Iup::Menu.new(Iup::SubMenu.new('File', file_menu))
+  #
+  # See also: MenuItem, Separator, SubMenu
+  #
+  class Menu < Iup::Widget
+
+    # Creates instance of a menu for given menu widgets.
+    # If a block is given, the new instance is yielded to it.
+    #
+    # * +widgets+ - one or more menu items, sub menus or separators.
+    #
+    def initialize *widgets
+      @handle = IupLib.IupMenu *widget_list(widgets)
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: radio
+    # If set, makes children act as a radio group. Values 'yes' / 'no'.
+    define_attribute :radio
+
+    ##
+    # :attr_reader: wid
+    # Native widget identifier.
+    define_reader :wid
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: open_cb
+    # Callback called just before the menu is opened.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def open_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'open callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'OPEN_CB', :plain
+    end
+
+    ##
+    # :attr_writer: menuclose_cb
+    # Callback called just after the menu is closed.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def menuclose_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'menuclose callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'MENUCLOSE_CB', :plain
+    end
+  end
+end