iup-ffi 0.13.0-x86_64-linux

data/lib/wrapped/val.rb

@@ -0,0 +1,162 @@
+module Iup
+
+  # An interactive control allowing the user to select a value within a limited
+  # range.
+  #
+  # === Example
+  #
+  # The following sets up a vertical control with a range from 0 to 10. 
+  # As the slider is moved, a label's title is updated to the current value.
+  #
+  #   Iup::Val.new('vertical') do |v|
+  #     t.max = 10
+  #     v.valuechanged_cb = ->{
+  #       label.title = "VALUE=#{"%0.2f" % v.value}"
+  #       Iup::DEFAULT
+  #     }
+  #   end
+  #
+  class Val < Iup::Widget
+
+    # Creates an instance of the control.
+    # If a block is given, the new instance is yielded to it.
+    # * +orientation+ - 'horizontal' / 'vertical'
+    def initialize(orientation='horizontal')
+      @handle = IupLib.IupVal(orientation)
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: canfocus
+    # Enables the control to gain focus. Values 'yes' / 'no'.
+    define_attribute :canfocus
+
+    ##
+    # :attr: expand
+    # Allows button to fill available space in indicated direction.
+    # Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+    define_attribute :expand
+
+    ##
+    # :attr: inverted
+    # If set, places maximum value on opposite side: values 'yes' / 'no'.
+    define_attribute :inverted
+
+    ##
+    # :attr: max
+    # Maximum value, defaults to 1.
+    define_attribute :max
+
+    ##
+    # :attr: min
+    # Minimum value, defaults to 0.
+    define_attribute :min
+
+    ##
+    # :attr: orientation
+    # Orientation of control: 'horizontal' / 'vertical'
+    define_attribute :orientation
+
+    ##
+    # :attr: pagestep
+    # Proportion of increment for pageup / pagedown.
+    # Value between 0.0 and 1.0, default is 0.1.
+    define_attribute :pagestep
+
+    ##
+    # :attr_reader: position
+    # Returns position in pixels within client window as "x,y".
+    define_reader :position
+
+    ##
+    # :attr: rastersize
+    # Size of the control, in pixels, value as "widthxheight".
+    define_attribute :rastersize
+
+    ##
+    # :attr_reader: screenposition
+    # Returns position in pixels on screen as "x,y".
+    define_reader :screenposition
+
+    ##
+    # :attr: step
+    # Proportion of increment for up / down.
+    # Value between 0.0 and 1.0, default is 0.01.
+    define_attribute :step
+
+    ##
+    # :attr: value
+    # Returns the current value of the control.
+    define_attribute :value
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: button_press_cb
+    # Calls callback when mouse button pressed to change the control value.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def button_press_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'button_press_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'BUTTON_PRESS_CB', :plain
+    end
+
+    ##
+    # :attr_writer: button_release_cb
+    # Calls callback when mouse button released.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def button_release_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'button_release_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih, a|
+        callback.call
+      end
+      define_callback cb, 'BUTTON_RELEASE_CB', :plain
+    end
+
+    ##
+    # :attr_writer: mousemove_cb
+    # Calls callback when mouse is used to move control.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def mousemove_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'mousemove_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih, a|
+        callback.call
+      end
+      define_callback cb, 'MOUSEMOVE_CB', :plain
+    end
+
+    ##
+    # :attr_writer: valuechanged_cb
+    # Calls callback after the value was interactively changed by the user.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    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/vbox.rb

@@ -0,0 +1,93 @@
+module Iup
+
+  # A container for one or more child widgets, arranged in a vertical column.
+  #
+  # === Example
+  #
+  # This example arranges three buttons vertically with equal width, and some
+  # spacing:
+  #
+  #   box = Iup::VBox.new(button1, button2, button3) do |b|
+  #     b.gap = 10
+  #     b.margin = '5x5'
+  #     b.expandchildren = :yes
+  #   end
+  #
+  # Also see: Fill, HBox
+  #
+  class VBox < Iup::Widget
+    include DynamicFillMethods
+
+    # Creates an instance of the vbox.
+    # If a block is given, the new instance is yielded to it.
+    #
+    # * +widgets+ - one or more child widgets 
+    #
+    def initialize *widgets
+      @handle = IupLib.IupVbox(*widget_list(widgets))
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: alignment
+    # horizontal alignment of children, 'aleft' / 'acenter' / 'aright'
+    define_attribute :alignment
+
+    ##
+    # :attr_reader: clientoffset
+    # returns current offset of box in its client as "widthxheight".
+    define_reader :clientoffset
+
+    ##
+    # :attr_reader: clientsize
+    # returns current size of box as "widthxheight".
+    define_reader :clientsize
+
+    ##
+    # :attr: expand
+    # Allows container to fill available space in indicated direction.
+    # Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+    define_attribute :expand
+
+    ##
+    # :attr: expandchildren
+    # Set to allow children to expand fully in horizontal direction, values as
+    # 'yes' / 'no'.
+    define_attribute :expandchildren
+
+    ##
+    # :attr: gap
+    # Number of pixels between children, default value of 0.
+    define_attribute :gap
+
+    ##
+    # :attr: homogeneous
+    # Set to force all children to get equal vertical size, values as 'yes' /
+    # 'no'. 
+    define_attribute :homogeneous
+
+    ##
+    # :attr: margin
+    # Margin in x and y directions, value as "mxn".
+    define_attribute :margin
+
+    ##
+    # :attr: normalsize
+    # Set to make natural size of children same, values as 'yes' / 'no'.
+    define_attribute :normalizesize
+
+    ##
+    # :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
+  end
+end

data/lib/wrapped/widget.rb

@@ -0,0 +1,282 @@
+module Iup
+
+  # This class provides shared functionality across all widgets in the 
+  # IUP library.
+  #
+  # Every widget has a +handle+, which is often a C pointer:
+  #
+  #   p Iup::Button.new.handle
+  #   # => #<FFI::Pointer address=0x0000647e530e6a80>
+  #
+  # The Widget class provides attributes supporting appearance,
+  # including whether the widget is active, its size, font and color, and its
+  # position in the z-order list (where widgets are overlapping, and the top
+  # one is visible).
+  #
+  # Some common callbacks are also found in this class, responding to:
+  # * map/unmap, where the native interface elements are created. Some child
+  #   widgets require their parent to be mapped first.
+  # * focus events.
+  # * keyboard/mouse events.
+  #
+  # === Example
+  #
+  # The following code creates a button with large red text, 
+  # which reports when the mouse moves over the button and any key is pressed:
+  #
+  #   Iup::mainloop do
+  #     btn = Iup::Button.new("hello") do
+  #       it.fgcolor = "255 0 0"
+  #       it.font = "Times, Bold 18"
+  #       it.enterwindow_cb = ->{ puts "on button" }
+  #       it.leavewindow_cb = ->{ puts "off button" }
+  #       it.k_any = ->(k){ puts "Key #{k.chr}" }
+  #     end
+  #     
+  #     Iup::Dialog.new(btn).show
+  #   end
+  #
+  class Widget
+    extend AttributeBuilders
+    include CallbackSetter
+
+    # Unique reference to widget.
+    attr_accessor :handle
+
+    # Sets the internal handle name for this widget.
+    def assign_handle name
+      IupLib.IupSetHandle(name, @handle)
+    end
+
+    @@controlslib = false
+
+    # Ensure the controls library is opened
+    def open_controls
+      unless @@controlslib
+        ControlsLib.IupControlsOpen
+        @@controlslib = true
+      end
+    end
+
+    ## -- common attributes
+
+    ##
+    # :attr: active
+    # Enables or prevents user interaction.
+    # Typically, a widget will appear greyed-out when inactive.
+    # Values 'yes' / 'no'.
+    define_attribute :active
+
+    ##
+    # :attr: bgcolor
+    # Specify RGB values for background color, as "r g b".
+    define_attribute :bgcolor
+
+    ##
+    # :attr: fgcolor
+    # Specify RGB values for foreground color, as "r g b".
+    define_attribute :fgcolor
+
+    ##
+    # :attr: font
+    # Sets the widget's font, using a font description as "<font face>, <font
+    # styles> <font size>", e.g. "Times, Bold 14".
+    # For portability, the fonts Courier, Helvetica and Times are always mapped
+    # to appropriate native system fonts.
+    define_attribute :font
+
+    ##
+    # :attr: visible
+    # Shows or hides the widget. Values 'yes' / 'no'.
+    define_attribute :visible
+
+    ##
+    # :attr: maxsize
+    # Maximum size of widget, value as "widthxheight".
+    define_attribute :maxsize
+
+    ##
+    # :attr: minsize
+    # Minimum size of widget, value as "widthxheight".
+    define_attribute :minsize
+
+    ##
+    # :attr: size
+    # Size of the widget, in character units, value as "widthxheight".
+    define_attribute :size
+
+    ##
+    # :attr_reader: wid
+    # Native widget identifier.
+    define_reader :wid
+
+    ##
+    # :attr_writer: zorder
+    # Alters z-order, values as 'top' / 'bottom'.
+    define_writer :zorder
+
+    # When no longer required, call +destroy+ to have the C backend
+    # reclaim the widget.
+    def destroy
+      IupLib.IupDestroy @handle
+    end
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: map_cb
+    #
+    # Called right after a widget is mapped and its layout updated.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def map_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'map_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'MAP_CB', :plain
+    end
+
+    ##
+    # :attr_writer: unmap_cb
+    #
+    # Called right before a widget is unmapped.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def unmap_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'unmap_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'UNMAP_CB', :plain
+    end
+
+    ##
+    # :attr_writer: getfocus_cb
+    #
+    # Action generated when a widget is given keyboard focus.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def getfocus_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'getfocus_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'GETFOCUS_CB', :plain
+    end
+
+    ##
+    # :attr_writer: killfocus_cb
+    #
+    # Action generated when a widget loses keyboard focus.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def killfocus_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'killfocus_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'KILLFOCUS_CB', :plain
+    end
+
+    ##
+    # :attr_writer: enterwindow_cb
+    #
+    # Action generated when the mouse enters the widget.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def enterwindow_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'enterwindow_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'ENTERWINDOW_CB', :plain
+    end
+
+    ##
+    # :attr_writer: leavewindow_cb
+    #
+    # Action generated when the mouse leaves the widget.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def leavewindow_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'leavewindow_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'LEAVEWINDOW_CB', :plain
+    end
+
+    ##
+    # :attr_writer: k_any
+    #
+    # Action generated when a keyboard event occurs.
+    # Callback must respond to +call+ and takes 1-argument: (key)
+    # * +key+ - the character that is pressed, see {Key definitions}[../Iup.html#Key+definitions].
+
+    # --
+    def k_any= callback
+      unless callback.arity == 1
+        raise ArgumentError, 'k_any callback must take 1 argument, a character'
+      end
+      cb = Proc.new do |ih, c|
+        callback.call c
+      end
+      define_callback cb, 'K_ANY', :i_i
+    end
+
+    ##
+    # :attr_writer: help_cb
+    #
+    # Action generated when the user presses F1 at a control.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def help_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'help_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'HELP_CB', :plain_v
+    end
+
+    # :section:
+
+    private
+
+    # given an array of widgets, 
+    # convert into format widget1, :pointer, widget2, ... , :pointer, nil
+    def widget_list widgets
+      result = []
+
+      widgets.each do |widget|
+        result << widget.handle
+        result << :pointer
+      end
+
+      result << nil
+
+      return result
+    end
+  end
+end

data/lib/wrapped/zbox.rb

@@ -0,0 +1,80 @@
+module Iup
+
+  # A container of a list of widgets, but only displays one of them. 
+  #
+  # === Example
+  #
+  # The following example stores four widgets and displays the +label+:
+  #
+  #   zbox = Iup::ZBox.new(frame, text, label, button) do |b|
+  #     b.alignment = 'acenter'
+  #     b.expand = 'yes'
+  #     b.valuepos = 2
+  #   end
+  #
+  # Also see: HBox, Tabs, VBox
+  #
+  class ZBox < Iup::Widget
+    include DynamicFillMethods
+
+    # Creates a new instance.
+    # If a block is given, the new instance is yielded to it.
+    #
+    # * +widgets+ - one or more child widgets 
+    #
+    def initialize *widgets
+      @handle = IupLib.IupZbox(*widget_list(widgets))
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: valuepos
+    # The visible child, accessed by its index position, 0-indexed.
+
+    # --
+    def valuepos
+      IupLib.IupGetAttribute(@handle, 'VALUEPOS').first.to_i
+    end
+
+    def valuepos= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'VALUEPOS', val.to_s)
+    end
+
+    ##
+    # :attr: alignment
+    # alignment of visible child.
+    # Values: 'north' / 'south' / 'east' / 'west'/ 'ne' / 'nw' / 'se' / 'sw' / 'acenter'
+    define_attribute :alignment
+
+    ##
+    # :attr_reader: clientoffset
+    # returns current offset of box in its client as "widthxheight".
+    define_reader :clientoffset
+
+    ##
+    # :attr_reader: clientsize
+    # returns current size of box as "widthxheight".
+    define_reader :clientsize
+
+    ##
+    # :attr: expand
+    # Allows container to fill available space in indicated direction.
+    # Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+    define_attribute :expand
+
+    ##
+    # :attr: rastersize
+    # Size of the container, in pixels, value as "widthxheight".
+    define_attribute :rastersize
+
+    ##
+    # :attr: size
+    # Size of the container, in character units, value as "widthxheight".
+    define_attribute :size
+  end
+
+end