iup-ffi 0.13.0-x86_64-linux

data/lib/wrapped/colorbar.rb

@@ -0,0 +1,212 @@
+module Iup
+
+  # Displays a palette of colors from which the user can select a primary and 
+  # secondary color.
+  #
+  # === Example
+  #
+  # The following example sets up a default set of colors in a 2-column layout, 
+  # responding to color selections by calling +redraw+ which updates an associated
+  # display (not given here):
+  #
+  #   Iup::ColorBar.new do |b|
+  #     # the following settings define the display
+  #     b.rastersize = '70x'  
+  #     b.expand = 'vertical'
+  #     b.num_parts = 2
+  #     b.show_secondary = 'yes'
+  #     b.preview_size = 60
+  #     # this call back responds to single-click color selections by updating display
+  #     b.select_cb = ->(idx, type){
+  #       case type
+  #       when Iup::IUP_PRIMARY
+  #         canvas.foreground = b.cell(idx)
+  #       when Iup::IUP_SECONDARY
+  #         canvas.background = b.cell(idx)
+  #       end
+  #       canvas.redraw
+  #       Iup::DEFAULT
+  #     }
+  #     # this call back responds to double-click color selections by updating display
+  #     b.cell_cb = ->(idx){
+  #       canvas.foreground cell(idx)
+  #       canvas.redraw
+  #       Iup::DEFAULT
+  #     }
+  #     # updates display with a switch between primary and secondary colors
+  #     b.switch_cb = ->(prim_cell, sec_cell){
+  #       fg_colour = canvas.foreground
+  #       canvas.foreground = canvas.background
+  #       canvas.background = fg_colour
+  #       canvas.redraw
+  #       Iup::DEFAULT
+  #     }
+  #   end
+  #
+  class ColorBar < Iup::Canvas
+
+    # Creates a new colorbar instance.
+    # If a block is given, the new instance is yielded to it.
+    def initialize
+      open_controls
+      @handle = ControlsLib.IupColorbar
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :call-seq: 
+    #   bar.cell(n)
+    #   bar.cell(n, val)
+    #
+    # Access nth cell color, n in range 0 to num_cells-1.
+    define_id_attribute :cell
+
+    ##
+    # :attr: num_cells
+    # Contains the number of cells, defaults to 16.
+    define_attribute :num_cells
+
+    ##
+    # :attr_reader: count
+    # Same as #num_cells.
+    define_reader :count
+
+    ##
+    # :attr: num_parts
+    # The number of lines or columns, defaults to 1.
+    define_attribute :num_parts
+
+    ##
+    # :attr: orientation
+    # 'horizontal' / 'vertical'
+    define_attribute :orientation
+
+    ##
+    # :attr: preview_size
+    # Size of preview area in pixels.
+    define_attribute :preview_size
+
+    ##
+    # :attr: show_preview
+    # Flag to show preview area or not, values 'yes' / 'no'.
+    define_attribute :show_preview
+
+    ##
+    # :attr: show_secondary
+    # Whether to allow the selection of a secondary color, values 'no' / 'yes'.
+    define_attribute :show_secondary
+
+    ##
+    # :attr: primary_cell
+    # Index of the primary cell, defaults to 0 (black).
+    define_attribute :primary_cell
+
+    ##
+    # :attr: secondary_cell
+    # Index of the secondary cell, defaults to 15 (white).
+    define_attribute :secondary_cell
+
+    ##
+    # :attr: squared
+    # Controls aspect ratio of color cells. Values 'yes' / 'no'.
+    define_attribute :squared
+
+    ##
+    # :attr: shadowed
+    # Controls 3D effect of color cells. Values 'yes' / 'no'.
+    define_attribute :shadowed
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: cell_cb
+    # Callback called when the user double clicks a color cell to change its value.
+    # Callback must respond to +call+ and is a 1-argument function: (cell_index),
+    # * +cell_index+ - index of clicked cell, between 0 and num_cells-1.
+    # Returns a new color (as a string), or nil if no change.
+
+    # --
+    def cell_cb= callback
+      unless callback.arity == 1
+        raise ArgumentError, 'cell_cb callback must take 1 argument: (cell_index)'
+      end
+      cb = Proc.new do |ih, cell_index|
+        callback.call cell_index 
+      end
+      define_callback cb, 'CELL_CB', :i_s
+    end
+
+    ##
+    # :attr_writer: extended_cb
+    # Callback called when the user right click a cell with the Shift key pressed
+    # Callback must respond to +call+ is a 1-argument function: (cell_index).
+    # * +cell_index+ - index of clicked cell, between 0 and num_cells-1.
+    # If returns Iup::DEFAULT, cell is redrawn; if returns Iup::IGNORE, cell
+    # is not redrawn.
+
+    # --
+    def extended_cb= callback
+      unless callback.arity == 1
+        raise ArgumentError, 'extended_cb callback must take 1 argument: (cell_index)'
+      end
+      cb = Proc.new do |ih, cell_index|
+        callback.call cell_index 
+      end
+      define_callback cb, 'EXTENDED_CB', :i_i
+    end
+
+    ##
+    # :attr_writer: select_cb
+    # Callback called when a color is selected. 
+    # The primary color is selected with the left mouse button, and, if 
+    # present, secondary is selected with the right mouse button.
+    # Callback must respond to +call+ and is a 2-argument function: (cell_index, type):
+    # * +cell_index+ - index of selected color
+    # * +type+ - of color, see {type constants}[../Iup.html#ColorBar+select_cb+type]
+
+    # --
+    def select_cb= callback
+      unless callback.arity == 2
+        raise ArgumentError, 'select_cb callback must take 2 arguments: (cell_index, type)'
+      end
+      cb = Proc.new do |ih, cell_index, type|
+        callback.call cell_index, type 
+      end
+      define_callback cb, 'SELECT_CB', :ii_i
+    end
+
+    ##
+    # :attr_writer: switch_cb
+    # Callback called when the user double clicks the preview area outside the
+    # preview cells to switch the primary and secondary selections. It is
+    # only called if SHOW_SECONDARY=YES.
+    # Callback must respond to +call+ and takes 2 arguments: (prim_cell, sec_cell):
+    # * +prim_cell+ - index of primary cell
+    # * +sec_cell+ - index of secondary cell
+
+    # --
+    def switch_cb= callback
+      unless callback.arity == 2
+        raise ArgumentError, 'switch_cb callback must take 2 arguments: (prim_cell, sec_cell)'
+      end
+      cb = Proc.new do |ih, cell_index, type|
+        callback.call cell_index, type 
+      end
+      define_callback cb, 'SWITCH_CB', :ii_i
+    end
+  end
+
+  # :section: ColorBar select_cb type
+
+  # Identifies color type as the primary color.
+  IUP_PRIMARY = -1
+  # Identifies color type as the secondary color.
+  IUP_SECONDARY = -2
+
+  # :section:
+end
+

data/lib/wrapped/colordialog.rb

@@ -0,0 +1,121 @@
+module Iup
+
+  # Shows a modal dialog to select a color.  
+  #
+  # * +x+, +y+ - optional coordinates to place the dialog
+  #
+  # Returns r/g/b triple of selected color, or nil if "cancel" clicked.
+  #
+  #   r, g, b = Iup.get_color(150, 150)
+  #
+  # Also see: ColorDialog
+  #
+  def self.get_color x=0, y=0
+    r = FFI::MemoryPointer.new(:int, 1, 0)
+    g = FFI::MemoryPointer.new(:int, 1, 0)
+    b = FFI::MemoryPointer.new(:int, 1, 0)
+    code = IupLib.IupGetColor x, y, r, g, b
+    if code == 0
+      return nil
+    else
+      return r.read_int, g.read_int, b.read_int
+    end
+  end
+
+  # A predefined modal dialog used for selecting a color.
+  #
+  # === Example
+  #
+  #   dlg = Iup::ColorDialog.new do |d|
+  #     d.title = "select a new color"
+  #   end
+  #   dlg.popup
+  #   p dlg.value # retrieve the selected color
+  # 
+  # Also see: Iup.get_color
+  #
+  class ColorDialog < Iup::Dialog
+
+    # Creates a dialog, using the optional block to set its attributes.
+    def initialize &block
+      @handle = IupLib.IupColorDlg
+
+      yield self if block_given?
+    end
+
+    # :section: Callbacks
+ 
+    ##
+    # :attr_writer: colorupdate_cb
+    #
+    # Action generated when the color is updated in the dialog.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def colorupdate_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'colorupdate_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'COLORUPDATE_CB', :plain_v
+    end
+
+    # :section:
+
+    # -- attributes
+
+    ##
+    # :attr: alpha
+    # If defined, enables alpha selection in dialog. 
+    # Returns value if user pressed 'OK'.
+    define_attribute :alpha
+
+    ##
+    # :attr: colortable
+    # "m;n;..." gives a list of values for the palette.
+    define_attribute :colortable
+
+    ##
+    # :attr: showalpha
+    # If set, shows the color table. Values 'yes' / 'no'.
+    define_attribute :showalpha
+
+    ##
+    # :attr: showcolortable
+    # If set, shows the color table. Values 'yes' / 'no'.
+    define_attribute :showcolortable
+
+    ##
+    # :attr: showhelp
+    # Shows a help button if +help_cb+ defined. Values 'yes' / 'no'.
+    define_attribute :showhelp
+
+    ##
+    # :attr: showhex
+    # If set, shows a hexadecimal representation of color. Values 'yes' / 'no'.
+    define_attribute :showhex
+
+    ##
+    # :attr_reader: status
+    # Returns '1' if 'OK' pressed, or null.
+    define_reader :status
+
+    ##
+    # :attr: value
+    # Initial value for dialog, and return value if 'OK' pressed, as 'r g b' or 'r g b a'.
+    define_attribute :value
+
+    ##
+    # :attr: valuehex
+    # Initial value for dialog, and return value if 'OK' pressed, as 'rrggbb'.
+    define_attribute :valuehex
+
+    ##
+    # :attr: valuehsi
+    # Initial value for dialog, and return value if 'OK' pressed, as 'H S I'.
+    define_attribute :valuehsi
+  end
+end
+

data/lib/wrapped/common-attributes.rb

@@ -0,0 +1,34 @@
+module Iup
+
+  # Standard callback method for when a mouse button is pressed or released.
+  module ButtonCallback
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: button_cb
+    #
+    # Action generated when any mouse button is pressed or released.
+    # Callback must respond to +call+ and accept 5 arguments (button, state, x,
+    # y, status)
+    # * +button+ - the number of the button that changed, one of: BUTTON1 (left), BUTTON2 (middle), BUTTON3 (right)
+    # * +state+ - 1 for 'pressed', 0 for 'released'
+    # * +x+ - x-coordinate 
+    # * +y+ - y-coordinate
+    # * +status+ - status of the mouse buttons and some keyboard keys at the moment the event is generated.
+
+    #-- 
+    def button_cb= callback
+      unless callback.arity == 5
+        raise ArgumentError, 'button_cb callback must take 5 arguments: (button, state, x, y, status)'
+      end
+      cb = Proc.new do |ih, b, p, x, y, status|
+        callback.call b.chr, p, x, y, status
+      end
+      define_callback cb, 'BUTTON_CB', :iiiis_i
+    end
+
+  end
+
+end
+