iup-ffi 0.13.0-x86_64-linux

data/lib/wrapped/scrollbar-attributes.rb

@@ -0,0 +1,178 @@
+module Iup
+
+  # Attributes for widgets that permit a scrollbar.
+  #
+  module ScrollBarAttributes
+    extend AttributeBuilders
+
+    ##
+    # :attr: scrollbar
+    # Selects 'no' / 'horizontal' / 'vertical' / 'yes' (for both) scrollbars.
+    define_attribute :scrollbar
+
+    ##
+    # :attr: dx
+    # Defines the size of the horizontal thumbnail.
+    # Size defaults to 0.1, and must be in range 0 < value < (xmax-xmin).
+
+    # --
+    def dx
+      IupLib.IupGetAttribute(@handle, 'DX').first.to_f
+    end
+
+    def dx= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'DX', val.to_s)
+    end
+
+    ##
+    # :attr: dy
+    # Defines the size of the vertical thumbnail.
+    # Size defaults to 0.1, and must be in range 0 < value < (ymax-ymin).
+
+    # --
+    def dy
+      IupLib.IupGetAttribute(@handle, 'DY').first.to_f
+    end
+
+    def dy= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'DY', val.to_s)
+    end
+
+    ##
+    # :attr: posx
+    # Position of horizontal thumbnail.
+    # Size starts at 0.0, and must be in range xmin < value < (xmax-dx).
+
+    # --
+    def posx
+      IupLib.IupGetAttribute(@handle, 'POSX').first.to_f
+    end
+
+    def posx= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'POSX', val.to_s)
+    end
+
+    ##
+    # :attr: posy
+    # Position of vertical thumbnail.
+    # Size starts at 0.0, and must be in range ymin < value < (ymax-dy).
+
+    # --
+    def posy
+      IupLib.IupGetAttribute(@handle, 'POSY').first.to_f
+    end
+
+    def posy= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'POSY', val.to_s)
+    end
+
+    ##
+    # :attr: xmin
+    # Minimum value of horizontal scrollbar. Starts at 0.0.
+
+    # --
+    def xmin 
+      IupLib.IupGetAttribute(@handle, 'XMIN').first.to_f
+    end
+
+    def xmin= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'XMIN', val.to_s)
+    end
+
+    ##
+    # :attr: ymin
+    # Minimum value of vertical scrollbar. Starts at 0.0.
+
+    # --
+    def ymin 
+      IupLib.IupGetAttribute(@handle, 'YMIN').first.to_f
+    end
+
+    def ymin= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'YMIN', val.to_s)
+    end
+
+    ##
+    # :attr: xmax
+    # Maximum value of horizontal scrollbar. Defaults to 1.0.
+
+    # --
+    def xmax
+      IupLib.IupGetAttribute(@handle, 'XMAX').first.to_f
+    end
+
+    def xmax= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'XMAX', val.to_s)
+    end
+
+    ##
+    # :attr: ymax
+    # Maximum value of vertical scrollbar. Defaults to 1.0.
+
+    # --
+    def ymax
+      IupLib.IupGetAttribute(@handle, 'YMAX').first.to_f
+    end
+
+    def ymax= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'YMAX', val.to_s)
+    end
+
+    ##
+    # :attr: linex
+    # Amount thumb moves in horizontal direction. Default is dx/10.
+
+    # --
+    def linex
+      IupLib.IupGetAttribute(@handle, 'LINEX').first.to_f
+    end
+
+    def linex= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'LINEX', val.to_s)
+    end
+
+    ##
+    # :attr: liney
+    # Amount thumb moves in vertical direction. Default is dy/10.
+
+    # --
+    def liney
+      IupLib.IupGetAttribute(@handle, 'LINEY').first.to_f
+    end
+
+    def liney= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'LINEY', val.to_s)
+    end
+
+    ##
+    # :attr: xautohide
+    # If set, hides horizontal scrollbar if not required. Values 'yes' / 'no'.
+    define_attribute :xautohide
+
+    ##
+    # :attr: yautohide
+    # If set, hides vertical scrollbar if not required. Values 'yes' / 'no'.
+    define_attribute :yautohide
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: scroll_cb
+    # Called when scrollbar used. 
+    # Callback must respond to +call+ and takes three arguments (op, posx, posy): 
+    # * +op+ - operation performed on scrollbar (see {Scrollbar operations}[../Iup.html#Scrollbar+operations]).
+    # * +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,40 @@
+module Iup
+
+  # A container holding a single child widget, enabling that child widget to be
+  # scrolled.
+  #
+  # === Example
+  #
+  # Wrapping a matrix element in a scroll box before showing on a dialog:
+  #
+  #   Iup::Dialog.new(
+  #     Iup::ScrollBox.new(matrix)
+  #   ).map
+  #
+  class ScrollBox < Iup::Canvas
+    include DynamicFillMethods
+
+    # Creates a new instance of the container.
+    # If a block is given, the new instance is yielded to it.
+    #
+    # * +widget+ - the child widget to display.
+    def initialize widget
+      @handle = IupLib.IupScrollBox(widget.handle)
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :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
+  end
+end

data/lib/wrapped/separator.rb

@@ -0,0 +1,24 @@
+module Iup
+
+  # A Separator is used within a menu, appears as a horizontal line.
+  #
+  # === Example
+  #
+  # The following shows construction of a typical file menu, with a 
+  # separating line before the exit item:
+  #
+  #   file_menu = Iup::Menu.new(
+  #     item_open, item_save, 
+  #     Iup::Separator.new, 
+  #     item_exit)
+  #
+  # See also: Menu, MenuItem, SubMenu
+  #
+  class Separator < Iup::Widget
+
+    # Creates a new instance.
+    def initialize
+      @handle = IupLib.IupSeparator
+    end
+  end
+end

data/lib/wrapped/splitbox.rb

@@ -0,0 +1,114 @@
+
+
+module Iup
+
+  # A container for two child widgets, with a moveable divider between them.
+  #
+  # Note: named IupSplit in Tecgraf's documentation.
+  #
+  # === Example
+  #
+  # The following code creates a split box between two text areas, 
+  # with a blue divider oriented horizontally - so the text areas 
+  # are placed one above the other:
+  #
+  #   split = Iup::SplitBox.new(text1, text2) do |b|
+  #     b.orientation = 'HORIZONTAL'
+  #     b.color = '127 127 255'
+  #   end
+  # 
+  # Also see: StretchBox
+  #
+  class SplitBox < Iup::Widget
+    include DynamicFillMethods
+
+    # Creates an instance of the split box.
+    # If a block is given, the new instance is yielded to it.
+    #
+    # * +child1+ - the left or top child widget
+    # * +child2+ - the right or bottom child widget
+    def initialize child1, child2
+      @handle = IupLib.IupSplit(child1.handle, child2.handle)
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    ##
+    # :attr: autohide
+    # If set, hides a child if the child client area is smaller than
+    # the bar size. Values 'yes' / 'no'.
+    define_attribute :autohide
+
+    ##
+    # :attr: barsize
+    # Controls the size of the bar handler, defaults to 5.
+    define_attribute :barsize
+
+    ##
+    # :attr: color
+    # Color of the bar grip, as "r g b".
+    define_attribute :color
+
+    ##
+    # :attr: expand
+    # Allows container to fill available space in indicated direction.
+    # Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+    define_attribute :expand
+
+    ##
+    # :attr: layoutdrag
+    # Updates the children's layout when bar moved automatically.
+    # Values 'yes' / 'no'.
+    define_attribute :layoutdrag
+
+    ##
+    # :attr: minmax
+    # minimum/maximum values for +value+ in form "min:max", where +min+ and +max+
+    # are integers.
+    define_attribute :minmax
+
+    ##
+    # :attr: orientation
+    # Bar handler can be either 'horizontal' or 'vertical'.
+    define_attribute :orientation
+
+    ##
+    # :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: showgrip
+    # If set, shows the bar grip. Values 'yes' / 'no'.
+    define_attribute :showgrip
+
+    ##
+    # :attr: value
+    # Proportion of the left/top area relative to whole, integer in range [0,1000].
+    define_attribute :value
+
+    # :section: Callbacks 
+
+    ##
+    # :attr_writer: valuechanged_cb
+    # Callback called 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/stretchbox.rb

@@ -0,0 +1,70 @@
+module Iup
+
+  # A stretchable container around one child widget.
+  #
+  # Note: named IupSBox in Tecgraf's documentation.
+  #
+  # Also see: SplitBox
+  #
+  class StretchBox < Iup::Widget
+    include DynamicFillMethods
+
+    # Creates an instance of the stretch box.
+    # If a block is given, the new instance is yielded to it.
+    #
+    # * +widget+ - the widget to contain
+    def initialize widget
+      @handle = IupLib.IupSbox(widget.handle)
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :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: color
+    # Specify RGB values for stretch bar color, as "r g b".
+    define_attribute :color
+
+    ##
+    # :attr: direction
+    # Direction and position of the stretch bar.
+    # Values as 'east' / 'west' / 'north' / 'south'.
+    define_attribute :direction
+
+    ##
+    # :attr: 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'.
+    define_attribute :expand
+
+    ##
+    # :attr_reader: position
+    # returns position in pixels within client window as "x,y".
+    define_attribute :position
+
+    ##
+    # :attr: rastersize
+    # Size of the container, in pixels, value as "widthxheight".
+    define_attribute :rastersize
+
+    ##
+    # :attr: showgrip
+    # Grip appearance: 
+    # * "no" - grip is colored using +color+ setting,
+    # * "lines" - shows two parallel lines
+    define_attribute :showgrip
+  end
+end

data/lib/wrapped/submenu.rb

@@ -0,0 +1,58 @@
+module Iup
+
+  # A menu item that, when selected, opens another menu.
+  # Apart from its text label, a menu item may include an 
+  # optional image.
+  #
+  # === Example
+  #
+  # The following line associates the 'File' name with its 
+  # menu, ready to place into a parent menu:
+  #
+  #   file_submenu = Iup::SubMenu.new('File', file_menu))
+  #
+  # See also Menu, MenuItem, Separator
+  #
+  class SubMenu < Iup::Widget
+
+    # Creates instance of a submenu.
+    # If a block is given, the new instance is yielded to it.
+    #
+    # * +title+ - displayed name of menu
+    # * +child_menu+ - child menu to open
+    #
+    def initialize title, child_menu
+      @handle = IupLib.IupSubmenu(title, child_menu.handle)
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: image
+    # Image name or instance to show on menu.
+    # This can use an actual image object, or the name of an image 
+    # from +IupImageLib+.
+
+    # --
+    def image
+      attribute_reference('IMAGE', ImageWidget, nil)
+    end
+
+    def image= val # :nodoc:
+      attribute_reference('IMAGE', ImageWidget, val)
+    end
+
+    ##
+    # :attr: title
+    # String to show on menu.
+    define_attribute :title
+
+    ##
+    # :attr_reader: wid
+    # Native widget identifier.
+    define_reader :wid
+  end
+end

data/lib/wrapped/tabs.rb

@@ -0,0 +1,223 @@
+module Iup
+
+  # 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.
+  #
+  # === Example
+  #
+  # The following creates two tabs, each containing a VBox. The callback 
+  # reports when the tabs are changed:
+  #
+  #   Iup::Tabs.new(vbox1, vbox2) do |t|
+  #     t.tabchangepos_cb = ->(n, o) {
+  #       puts "Selected tab was #{o} and is now #{n}"
+  #     }
+  #     t.tabtitle(0, 'Tab A')
+  #     t.tabtitle(1, 'Tab B')
+  #   end
+  #
+  # See also: ZBox
+  #
+  class Tabs < Iup::Widget
+    include AttributeReference
+
+    # Creates an instance of the tabs control.
+    # If a block is given, the new instance is yielded to it.
+    #
+    # * +widgets+ - one or more child widgets 
+    def initialize *widgets
+      @handle = IupLib.IupTabs(*widget_list(widgets))
+      @widgets = widgets # store the widgets
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :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_reader: count
+    # The number of tabs.
+
+    # --
+    def count
+      IupLib.IupGetAttribute(@handle, 'COUNT').first.to_i
+    end
+
+    ##
+    # :attr: expand
+    # Allows control to fill available space in indicated direction.
+    # Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+    define_attribute :expand
+
+    ##
+    # :attr: padding
+    # Margin in x and y directions, value as "mxn".
+    define_attribute :padding
+
+    ##
+    # :attr_reader: position
+    # returns position in pixels within client window
+    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: showclose
+    # 'no' / 'yes', shows the 'close' button on each tab. 
+    # Clicking this hides tab unless tabclose_cb defined.
+    define_attribute :showclose
+
+    ##
+    # :attr: taborientation
+    # 'horizontal' / 'vertical'.
+    define_attribute :taborientation
+
+    # Sets the image of a tab:
+    # * +index+ - the index of the tab (0-indexed)
+    # * +image+ - image to place on tab
+    def tabimage(index, image) 
+      attribute_reference("TABIMAGE#{index}", ImageWidget, image)
+    end
+
+    # Sets the title of a tab:
+    # * +index+ - the index of the tab (0-indexed)
+    # * +title+ - text to use for the title
+    def tabtitle(index, title) 
+      IupLib.IupSetAttribute(@handle, "TABTITLE#{index}", title)
+    end
+
+    ##
+    # :attr: tabtype
+    # 'top' / 'bottom' / 'left' / 'right', indicates position of tabs.
+    define_attribute :tabtype
+
+    # :call-seq:
+    #   tabs.tabvisible(index)
+    #   tabs.tabvisible(index, val)
+    #
+    # Accesses visibility of tab index.
+    def tabvisible index, val=nil
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, "TABVISIBLE#{index}").first
+      else
+        IupLib.IupSetAttribute @handle, "TABVISIBLE#{index}", val
+      end
+    end
+
+    ##
+    # :attr: tip
+    # Tooltip string.
+    define_attribute :tip
+
+    ##
+    # :attr: valuepos
+    # Position of visible tab (0-indexed).
+
+    # --
+    def valuepos 
+      IupLib.IupGetAttribute(@handle, 'VALUEPOS').first.to_i
+    end
+
+    def valuepos= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'VALUEPOS', val.to_s)
+    end
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: rightclick_cb
+    # Callback called when the user clicks on some tab using the right mouse
+    # button.
+    # Callback must respond to +call+ and 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
+
+    ##
+    # :attr_writer: tabchange_cb
+    # Callback called when the user shifts the active tab.
+    # Callback must respond to +call+ and takes a 2-argument callback: (hnew, hold)
+    # * +hnew+ - new selected tab
+    # * +hold+ - old (previous) 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
+
+    ##
+    # :attr_writer: tabchangepos_cb
+    # Callback called when the user shifts the active tab. 
+    # Called only when TABCHANGE_CB is not defined.
+    # Callback must respond to +call+ and takes a 2-argument callback: (hnew, hold)
+    # * +hnew+ - new selected tab
+    # * +hold+ - old (previous) selected tab.
+
+    # --
+    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
+
+    ##
+    # :attr_writer: tabclose_cb
+    # Callback called when the user clicks on the close button (since 3.10). 
+    # Called only when SHOWCLOSE=Yes.
+    # Callback must respond to +call+ and takes one argument: (tab)
+    # * +tab+ - the number of the closing tab.
+    
+    # --
+    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