iup-ffi 0.12.0

data/lib/wrapped/widget.rb

@@ -0,0 +1,137 @@
+module Iup
+
+  # Parent class for controls in the library.
+  #
+  class Widget
+    extend AttributeBuilders
+    include CommonAttributes
+    include CallbackSetter
+
+    # Unique reference to widget.
+    attr_reader :handle
+
+    # The C 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 callbacks
+
+    # Called right after an element is mapped and its layout updated
+    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
+
+    # Called right before an element is unmapped
+    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
+
+    # Action generated when an element is given keyboard focus
+    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
+
+    # Action generated when an element loses keyboard focus
+    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
+
+    # Action generated when the mouse enters the element
+    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
+
+    # Action generated when the mouse leaves the element
+    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
+    
+    # Action generated when a keyboard event occurs.
+    # k_any takes a 1-argument callback, the argument 
+    # being the character that is pressed.
+    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
+
+    # Action generated when the user presses F1 at a control
+    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
+
+    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,54 @@
+module Iup
+
+  # A ZBox is a container class, which stores a list of widgets but only 
+  # displays one of them. 
+  #
+  # == Attributes
+  #
+  # alignment:: alignment of visible child.
+  #             Values: 'north' / 'south' / 'east' / 'west'/
+  #             'ne' / 'nw' / 'se' / 'sw' / 'acenter'
+  # 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'.
+  # gap:: Number of pixels between children, default value of 0.
+  # rastersize:: Size of the container, in pixels, value as "widthxheight".
+  # size:: Size of the container, in character units, value as "widthxheight".
+  #
+  class ZBox < Widget
+    include DynamicFillMethods
+
+    # Creates an instance of the ZBox.
+    # *widgets:: one or more child widgets 
+    # block:: optional block to set up the box's attributes.
+    def initialize *widgets, &block
+      @handle = IupLib.IupZbox *widget_list(widgets)
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    # Returns the visible child, accessed by its index position.
+    def valuepos val=nil? 
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'VALUEPOS').first
+        result.to_i
+      else
+        IupLib.IupSetAttribute @handle, 'VALUEPOS', (val.to_i - 1).to_s
+      end
+    end
+
+    define_attribute :alignment
+    define_readonly :clientoffset
+    define_readonly :clientsize
+    define_attribute :expand
+    define_attribute :gap
+    define_attribute :rastersize
+    define_attribute :size
+  end
+
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: iup-ffi
+version: !ruby/object:Gem::Version
+  version: 0.12.0
+platform: ruby
+authors:
+- Peter Lane
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: |2
+    FFI binding for Ruby to the IUP portable user interface toolkit. The library
+    provides both a low-level binding to the C library calls, and a high-level
+    wrapping of most widgets to give a more natural Ruby syntax.
+email: peterlane@gmx.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENCE.txt
+- README.rdoc
+files:
+- LICENCE.txt
+- README.rdoc
+- lib/iup-ffi-plain.rb
+- lib/iup-ffi.rb
+- lib/plain/iupcdlib.rb
+- lib/plain/iupcontrolslib.rb
+- lib/plain/iupimglib.rb
+- lib/plain/iupimlib.rb
+- lib/plain/iuplib.rb
+- lib/plain/scintilla-lib.rb
+- lib/wrapped/attribute-builders.rb
+- lib/wrapped/attribute-reference.rb
+- lib/wrapped/background-box.rb
+- lib/wrapped/button.rb
+- lib/wrapped/callback-setter.rb
+- lib/wrapped/canvas.rb
+- lib/wrapped/colourbar.rb
+- lib/wrapped/colourdialog.rb
+- lib/wrapped/common-attributes.rb
+- lib/wrapped/constants.rb
+- lib/wrapped/dial.rb
+- lib/wrapped/dialog.rb
+- lib/wrapped/dialogs.rb
+- lib/wrapped/drag-drop-attributes.rb
+- lib/wrapped/dynamic-fill-methods.rb
+- lib/wrapped/expander.rb
+- lib/wrapped/filedialog.rb
+- lib/wrapped/fill.rb
+- lib/wrapped/fontdialog.rb
+- lib/wrapped/frame.rb
+- lib/wrapped/gridbox.rb
+- lib/wrapped/hbox.rb
+- lib/wrapped/image-attributes.rb
+- lib/wrapped/image.rb
+- lib/wrapped/internal-drag-drop-attributes.rb
+- lib/wrapped/iup-global.rb
+- lib/wrapped/label.rb
+- lib/wrapped/link.rb
+- lib/wrapped/list.rb
+- lib/wrapped/matrix.rb
+- lib/wrapped/menu.rb
+- lib/wrapped/menuitem.rb
+- lib/wrapped/messagedialog.rb
+- lib/wrapped/progressbar.rb
+- lib/wrapped/progressdialog.rb
+- lib/wrapped/radio.rb
+- lib/wrapped/scintilla.rb
+- lib/wrapped/scrollbar-attributes.rb
+- lib/wrapped/scrollbox.rb
+- lib/wrapped/separator.rb
+- lib/wrapped/splitbox.rb
+- lib/wrapped/stretchbox.rb
+- lib/wrapped/submenu.rb
+- lib/wrapped/tabs.rb
+- lib/wrapped/text.rb
+- lib/wrapped/timer.rb
+- lib/wrapped/toggle.rb
+- lib/wrapped/tree.rb
+- lib/wrapped/val.rb
+- lib/wrapped/vbox.rb
+- lib/wrapped/widget.rb
+- lib/wrapped/zbox.rb
+homepage: https://rubygems.org/gems/iup-ffi
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://rubydoc.info/gems/iup-ffi
+  source_code_uri: https://codeberg.org/peterlane/iup-ffi
+rdoc_options:
+- "-m"
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: An FFI binding for Ruby to the IUP portable user interface toolkit.
+test_files: []