iup-ffi 0.12.0

data/lib/wrapped/scrollbar-attributes.rb

@@ -0,0 +1,141 @@
+module Iup
+
+  # Attributes for widgets that permit a scrollbar.
+  #
+  # For all these attributes, the optional argument is used to _set_ the value, 
+  # else the current value is returned.
+  #
+  # == Attributes
+  #
+  # xautohide:: If set, hides horizontal scrollbar if not required. Values 'yes' / 'no'.
+  # yautohide:: If set, hides vertical scrollbar if not required. Values 'yes' / 'no'.
+  #
+  module ScrollBarAttributes
+    extend AttributeBuilders
+
+    define_attribute :scrollbar
+
+    # Defines the size of the horizontal thumbnail.
+    # Size defaults to 0.1, and must be in range 0 < value < (xmax-xmin).
+    def dx val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'DX').first
+        result.to_f
+      else
+        IupLib.IupSetAttribute @handle, 'DX', val.to_s
+      end
+    end
+
+    # Defines the size of the vertical thumbnail.
+    # Size defaults to 0.1, and must be in range 0 < value < (ymax-ymin).
+    def dy val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'DY').first
+        result.to_f
+      else
+        IupLib.IupSetAttribute @handle, 'DY', val.to_s
+      end
+    end
+
+    # Position of horizontal thumbnail.
+    # Size starts at 0.0, and must be in range xmin < value < (xmax-dx).
+    def posx val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'POSX').first
+        result.to_f
+      else
+        IupLib.IupSetAttribute @handle, 'POSX', val.to_s
+      end
+    end
+
+    # Position of vertical thumbnail.
+    # Size starts at 0.0, and must be in range ymin < value < (ymax-dy).
+    def posy val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'POSY').first
+        result.to_f
+      else
+        IupLib.IupSetAttribute @handle, 'POSY', val.to_s
+      end
+    end
+
+    # Minimum value of horizontal scrollbar. Starts at 0.0.
+    def xmin val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'XMIN').first
+        result.to_f
+      else
+        IupLib.IupSetAttribute @handle, 'XMIN', val.to_s
+      end
+    end
+
+    # Minimum value of vertical scrollbar. Starts at 0.0.
+    def ymin val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'YMIN').first
+        result.to_f
+      else
+        IupLib.IupSetAttribute @handle, 'YMIN', val.to_s
+      end
+    end
+
+    # Maximum value of horizontal scrollbar. Defaults to 1.0.
+    def xmax val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'XMAX').first
+        result.to_f
+      else
+        IupLib.IupSetAttribute @handle, 'XMAX', val.to_s
+      end
+    end
+
+    # Maximum value of vertical scrollbar. Defaults to 1.0.
+    def ymax val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'YMAX').first
+        result.to_f
+      else
+        IupLib.IupSetAttribute @handle, 'YMAX', val.to_s
+      end
+    end
+    
+    # Amount thumb moves in horizontal direction. Default is dx/10.
+    def linex val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'LINEX').first
+        result.to_f
+      else
+        IupLib.IupSetAttribute @handle, 'LINEX', val.to_s
+      end
+    end
+
+    # Amount thumb moves in vertical direction. Default is dy/10.
+    def liney val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'LINEY').first
+        result.to_f
+      else
+        IupLib.IupSetAttribute @handle, 'LINEY', val.to_s
+      end
+    end
+
+    define_attribute :xautohide
+    define_attribute :yautohide
+
+    # Called when scrollbar used. 
+    # Callback must take three arguments: 
+    # op:: operation performed on scrollbar, see Iup
+    # posx:: x position of scroll thumb (same as posx attribute)
+    # posy:: y position of scroll thumb (same as posy attribute)
+    def scroll_cb callback
+      unless callback.arity == 3
+        raise ArgumentError, 'scroll_cb callback must take 3 arguments: (op, posx, posy)'
+      end
+      cb = Proc.new do |ih, op, posx, posy|
+        callback.call op, posx, posy
+      end
+      define_callback cb, 'SCROLL_CB', :iff_i
+    end
+
+  end
+end

data/lib/wrapped/scrollbox.rb

@@ -0,0 +1,147 @@
+module Iup
+
+  # A container holding a single child widget, 
+  # enabling that child widget to be scrolled.
+  #
+  # == Attributes
+  #
+  # border:: Set to show a border around the scrollbox. Values 'yes' / 'no'.
+  # canfocus:: Always 'no' - control cannot gain focus. 
+  # 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".
+  # cursor:: Name of the mouse shape / cursor for the scrollbox.
+  # drawsize:: Size of drawing area in pixels, as "widthxheight".
+  # expand:: Allows container to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # padding:: Margin in x and y directions in pixels, value as "mxn".
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # rastersize:: Size of the container, in pixels, value as "widthxheight".
+  # screenposition:: <b>read-only</b> returns position in pixels on screen
+  #                  as "x,y".
+  # scrollbar:: Selects 'no' / 'horizontal' / 'vertical' / 'yes' (for both) scrollbars.
+  # tip:: Tooltip string.
+  #
+  class ScrollBox < Widget
+    include DragDropAttributes
+    include ScrollBarAttributes
+
+    # Creates a new instance of the container.
+    # child:: a child widget
+    # block:: optional block to set up attributes
+    def initialize child, &block
+      @handle = IupLib.IupScrollBox child.handle
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_attribute :border
+    define_attribute :canfocus
+    define_attribute :clientoffset
+    define_attribute :clientsize
+    define_attribute :cursor
+    define_attribute :drawsize
+    define_attribute :expand
+    define_attribute :padding
+    define_readonly :position
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :tip
+
+    # -- callbacks
+
+    # Action generated when the scrollbar needs to be redrawn.
+    # action takes a callback which accepts 2 arguments (posx, posy).
+    # posx, posy are the position of the horizontal and vertical thumbs of the scrollbar.
+    def action callback
+      unless callback.arity == 2
+        raise ArgumentError, 'action must take 2 arguments: (posx, posy)'
+      end
+      cb = Proc.new do |ih, posx, posy|
+        callback.call posx, posy
+      end
+      define_callback cb, 'ACTION', :ff_i
+    end
+        
+    include ButtonCallback
+
+    # Called when the scrollbar gets or loses the keyboard focus.
+    # Callback takes a single parameter: (focus)
+    # focus:: non-zero if canvas gaining focus, else zero.
+    def focus_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'focus_cb callback must take 1 argument, the focus'
+      end
+      cb = Proc.new do |ih, focus|
+        callback.call focus
+      end
+      define_callback cb, 'FOCUS_CB', :i_i
+    end
+
+    # Action generated when a key is pressed or released.
+    # keypress_cb takes a 2-argument callback: (character, pressed).
+    # pressed == 1 if key is pressed, 
+    # pressed == 0 if key is released.
+    def keypress_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'keypress_cb callback must take 2 arguments: (char, press)'
+      end
+      cb = Proc.new do |ih, char, press|
+        callback.call char, press
+      end
+      define_callback cb, 'KEYPRESS_CB', :ii_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 scrollbar size is changed.
+    # resize_cb a 2-argument callback: (width, height).
+    # width:: internal width of canvas (client width)
+    # height:: internal height of canvas (client height)
+    def resize_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'resize_cb callback must take 2 arguments: (width, height)'
+      end
+      cb = Proc.new do |ih, width, height|
+        callback.call width, height
+      end
+      define_callback cb, 'RESIZE_CB', :ii_i
+    end
+
+    # Action generated when the mouse wheel is rotated.
+    # wheel_cb a 4-argument callback: (delta, x, y, status).
+    # delta:: the amount the wheel was rotated in notches.
+    # x, y:: position in the canvas where the event has occurred, in pixels.
+    # status:: status of mouse buttons and certain keyboard keys at the moment the event was generated.
+    def wheel_cb callback
+      unless callback.arity == 4
+        raise ArgumentError, 'wheel_cb callback must take 4 arguments: (delta, x, y, status)'
+      end
+      cb = Proc.new do |ih, delta, x, y, status_ptr|
+        status = FFI::Pointer.new(status_ptr).read_string
+        callback.call delta, x, y, status
+      end
+      define_callback cb, 'WHEEL_CB', :fiis_i
+    end
+  end
+end

data/lib/wrapped/separator.rb

@@ -0,0 +1,11 @@
+module Iup
+
+  # A Separator is used within a menu, appears as a horizontal line.
+  class Separator < Widget
+
+    # Creates an instance.
+    def initialize
+      @handle = IupLib.IupSeparator
+    end
+  end
+end

data/lib/wrapped/splitbox.rb

@@ -0,0 +1,48 @@
+module Iup
+
+  # A container for two child widgets, with a moveable divider between them.
+  # Note that moving the divider cannot affect other widgets.
+  #
+  # == Attributes
+  # 
+  # autohide:: If set, hides a child if the child client area is smaller than
+  #            the bar size. Values 'yes' / 'no'.
+  # barsize:: Controls the size of the bar handler, defaults to 5.
+  # color:: Colour of the bar grip, as "r g b".
+  # expand:: Allows container to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # layoutdrag:: Updates the children's layout when bar moved automatically.
+  #              Values 'yes' / 'no'.
+  # orientation:: Bar handler can be either 'horizontal' or 'vertical'.
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # rastersize:: Size of the container, in pixels, value as "widthxheight".
+  # showgrip:: If set, shows the bar grip. Values 'yes' / 'no'.
+  # value:: 0 <= n <= 1000 sets the proportion of the left/top area relative to whole.
+  #
+  class SplitBox < Widget
+
+    # Creates an instance of the SplitBox.
+    # child1:: the left or top child widget
+    # child2:: the right or bottom child widget
+    # block:: optional block to set up the box's attributes.
+    def initialize child1, child2, &block
+      @handle = IupLib.IupSplit child1.handle, child2.handle
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    define_attribute :autohide
+    define_attribute :barsize
+    define_attribute :color
+    define_attribute :expand
+    define_attribute :layoutdrag
+    define_attribute :minmax
+    define_attribute :orientation
+    define_readonly :position
+    define_attribute :rastersize
+    define_attribute :showgrip
+    define_attribute :value
+  end
+end

data/lib/wrapped/stretchbox.rb

@@ -0,0 +1,42 @@
+module Iup
+
+  # A stretchable container around one child widget.
+  #
+  # == Attributes
+  #
+  # clientoffset:: read-only, returns current offset of box in its client
+  #                as "widthxheight".
+  # clientsize:: read-only, returns current size of box as "widthxheight".
+  # color:: Specify RGB values for stretch bar colour, as "r g b".
+  # direction:: Direction and position of the stretch bar.
+  #             Values as 'east' / 'west' / 'north' / 'south'.
+  # expand:: Allows container to fill available space in indicated direction,
+  #          but only on the side away from the stretch bar.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # rastersize:: Size of the container, in pixels, value as "widthxheight".
+  #
+  class StretchBox < Widget
+    
+    # Creates an instance of the container.
+    # widget:: the child widget to contain
+    # block:: optional block to set up the container's attributes.
+    def initialize widget, &block
+      @handle = IupLib.IupSbox widget.handle
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_attribute :clientoffset
+    define_attribute :clientsize
+    define_attribute :color
+    define_attribute :direction
+    define_attribute :expand
+    define_attribute :position
+    define_attribute :rastersize
+  end
+end

data/lib/wrapped/submenu.rb

@@ -0,0 +1,34 @@
+module Iup
+
+  # A menu item that, when selected, opens another menu.
+  #
+  # == Attributes
+  #
+  # image:: Image to show on menu.
+  # title:: Label of menu.
+  # wid:: <b>read-only</b> Native widget identifier.
+  #
+  class SubMenu < Widget
+
+    # Creates instance of a SubMenu.
+    #
+    # title:: Label of menu
+    # item:: child menu to open
+    # block:: optional block to set menu's attributes
+    def initialize title, item, &block
+      @handle = IupLib.IupSubmenu title, item.handle
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+    
+    def image val=nil # :nodoc:
+      attribute_reference 'IMAGE', ImageWidget, val
+    end
+
+    define_attribute :title
+    define_readonly :wid
+  end
+end

data/lib/wrapped/tabs.rb

@@ -0,0 +1,149 @@
+module Iup
+
+  # Tabs is a container for multiple widgets, placing the widgets in layers 
+  # with a single layer visible. The user can change the visible layer by 
+  # selecting a tab.
+  #
+  # == Attributes
+  #
+  # 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".
+  # count:: <b>read-only</b> Returns the number of tabs.
+  # expand:: Allows control to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # padding:: Margin in x and y directions, value as "mxn".
+  # position:: <b>read-only</b> returns position in pixels within client window
+  # rastersize:: Size of the control, in pixels, value as "widthxheight".
+  # screenposition:: <b>read-only</b> returns position in pixels on screen
+  #                  as "x,y".
+  # showclose:: 'no' / 'yes', shows the 'close' button on each tab. 
+  #             Clicking this hides tab unless tabclose_cb defined.
+  # taborientation:: 'horizontal' / 'vertical'.
+  # tabtype:: 'top' / 'bottom' / 'left' / 'right', indicates position of tabs.
+  # tip:: Tooltip string.
+  #
+  class Tabs < Widget
+    include AttributeReference
+
+    # Creates an instance of the tabs control.
+    # *widgets:: one or more child widgets 
+    # block:: optional block to set up the control's attributes.
+    def initialize *widgets, &block
+      @handle = IupLib.IupTabs *widget_list(widgets)
+      @widgets = widgets # store the widgets
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_readonly :clientoffset
+    define_readonly :clientsize
+
+    def count # :nodoc:
+      result = IupLib.IupGetAttribute(@handle, 'COUNT').first
+      return result.to_i
+    end
+    
+    define_attribute :expand
+    define_attribute :padding
+    define_readonly :position
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :showclose
+    define_attribute :taborientation
+
+    # Sets the title of a tab:
+    # index:: the index of the tab (0-indexed)
+    # title:: text to use for the title
+    # image:: optional image
+    def tabtitle index, title, image=nil 
+      IupLib.IupSetAttribute @handle, "TABTITLE#{index}", title
+      attribute_reference "TABIMAGE#{index}", ImageWidget, image
+    end
+
+    define_attribute :tabtype
+
+    # If val given, sets visibility of tab index, else returns its visibility.
+    def tabvisible index, val=nil
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, "TABVISIBLE#{index}").first
+      else
+        IupLib.IupSetAttribute @handle, "TABVISIBLE#{index}", val
+      end
+    end
+
+    define_attribute :tip
+
+    # If val given, changes visible tab to its position (0-indexed).
+    # Otherwise, returns currently visible tab position.
+    def valuepos val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'VALUEPOS').first
+        result.to_i
+      else
+        IupLib.IupSetAttribute @handle, 'VALUEPOS', val.to_s
+      end
+    end
+
+    # -- callbacks
+
+    # Callback called when the user clicks on some tab using the right mouse button.
+    # rightclick_cb takes a 1-argument callback, the argument 
+    # being the tab number that was clicked
+    def rightclick_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'rightclick_cb callback must take 1 argument, the tab number'
+      end
+      cb = Proc.new do |ih, tn|
+        callback.call tn
+      end
+      define_callback cb, 'RIGHTCLICK_CB', :i_i
+    end
+
+    # Callback called when the user shifts the active tab.
+    # tabchange_cb takes a 2-argument callback,
+    # the new selected tab, and the old selected tab.
+    def tabchange_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'tabchange_cb callback must take 2 argument, the new and old tab handles'
+      end
+      cb = Proc.new do |ih, hnew, hold|
+        new_tab = @widgets.find {|widget| widget.handle.address == hnew.address}
+        old_tab = @widgets.find {|widget| widget.handle.address == hold.address}
+        callback.call new_tab, old_tab
+      end
+      define_callback cb, 'TABCHANGE_CB', :pp_i
+    end
+
+    # Callback called when the user shifts the active tab. 
+    # Called only when TABCHANGE_CB is not defined.
+    # tabchangepos_cb takes a 2-argument callback, 
+    # the new selected tab number and the old selected tab number.
+    def tabchangepos_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'tabchangepos_cb callback must take 2 argument, the new and old tab numbers'
+      end
+      cb = Proc.new do |ih, tnew, told|
+        callback.call tnew, told
+      end
+      define_callback cb, 'TABCHANGEPOS_CB', :ii_i
+    end
+
+    # Callback called when the user clicks on the close button (since 3.10). 
+    # Called only when SHOWCLOSE=Yes.
+    # Callback takes one argument, the tab number.
+    def tabclose_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'tabclose_cb callback must take 1 argument, the tab number'
+      end
+      cb = Proc.new do |ih, tn|
+        callback.call tn
+      end
+      define_callback cb, 'TABCLOSE_CB', :i_i
+    end
+
+  end
+end