iup-ffi 0.13.0-x86_64-linux

data/lib/wrapped/tree.rb

@@ -0,0 +1,612 @@
+module Iup
+
+  # A tree displays a hierarchy of branch and leaf nodes.
+  # Each node may display some text and an optional image.
+  #
+  # === Example
+  #
+  #   tree = Iup::Tree.new
+  # 
+  #   dlg = Iup::Dialog.new(tree) do |d|
+  #     d.title = 'Tree Example'
+  #   end.map
+  # 
+  #   tree.size = '80x80'
+  #   tree.font = 'Courier, Normal 10'
+  #   tree.addbranch(0, '3D')
+  #   tree.addbranch(0, '2D')
+  #   tree.addleaf(1, 'trapeze')
+  #   tree.addbranch(1, 'parallelogram')
+  #   tree.addleaf(2, 'diamond')
+  #   tree.addleaf(2, 'square')
+  #   tree.addbranch(4, 'triangle')
+  #   tree.addleaf(5, 'scalenus')
+  #   tree.addleaf(5, 'isoceles')
+  #   tree.addleaf(5, 'equilateral')
+  #   tree.value = 6
+  #   tree.addexpanded = 'no'
+  # 
+  #   dlg.show 
+  #
+  # Note: the contents of the tree can only be created after its containing 
+  # dialog has been mapped.
+  #
+  class Tree < Iup::Widget
+    include DragDropAttributes 
+
+    # Creates an instance of Tree.
+    # Unusually, does not accept an initialization block, as tree 
+    # must be placed and mapped within a dialog before setup can 
+    # take place - see Example.
+    def initialize
+      @handle = IupLib.IupTree
+    end
+
+    # -- attributes
+
+    # --- general
+
+    ##
+    # :attr: addexpanded
+    # 'yes' / 'no', to expand branches when created.
+    define_attribute :addexpanded
+
+    ##
+    # :attr: addroot
+    # 'yes' / 'no', automatically adds an empty branch as the first node, on
+    # creation.
+    define_attribute :addroot
+
+    ##
+    # :attr: canfocus
+    # Enables the control to gain focus. Values 'yes' / 'no'.
+    define_attribute :canfocus
+
+    ##
+    # :attr_reader: count
+    # Returns total number of nodes in the tree.
+    define_reader :count
+
+    ##
+    # :attr: dragdroptree
+    # Determines if tree supports dragdrop operations. Values 'yes' / 'no'.
+    define_attribute :dragdroptree
+
+    ##
+    # :attr: dropequaldrag
+    # 'yes' / 'no', if set, allows a drop node to equal drag node.
+    define_attribute :dropequaldrag
+
+    ##
+    # :attr: expand
+    # Allows control to fill available space in indicated direction.
+    # Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+    define_attribute :expand
+
+    ##
+    # :attr: hidebuttons
+    # 'yes' / 'no', to hide expand and create buttons.
+    define_attribute :hidebuttons
+
+    ##
+    # :attr: hidelines
+    # 'yes' / 'no', the lines connecting nodes in hierarchy.
+    define_attribute :hidelines
+
+    ##
+    # :attr: indentation
+    # level of indentation in pixels, defaults to 5.
+    define_attribute :indentation
+
+    ##
+    # :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: showdragdrop
+    # 'yes' / 'no', enables internal drag and drop of nodes.
+    define_attribute :showdragdrop
+
+    ##
+    # :attr: showtoggle
+    # 'yes' / 'no' / '3state', enables use of toggles for all nodes of the tree.
+    define_attribute :showtoggle
+
+    ##
+    # :attr: spacing
+    # vertical, internal padding for each node, defaults to 3 pixels.
+    define_attribute :spacing
+
+    ##
+    # :attr_writer: topitem
+    # Positions given node id at the top of tree, or near, to make it visible.
+    define_writer :topitem
+
+    ##
+    # :attr:value
+    # When retrieved, returns the identifier of the focussed node. When 
+    # given a value, moves focus appropriately: 
+    # 'root' / 'last' / 'next' / 'previous' / 'pgdn' / 'pgup' 
+    define_attribute :value
+
+    # --- nodes
+
+    # Returns the number of immediate child of given node.
+    # * +id+ - identifier of a node
+    def childcount id
+      IupLib.IupGetAttribute(@handle, "CHILDCOUNT#{id}").first
+    end
+
+    # :call-seq:
+    #   tree.color(id) # retrieves
+    #   tree.color(id, val) # sets
+    #
+    # Accesses text foreground color: 
+    # * +id+ - identifier of a node
+    # * +val+ - "r g b" color
+    def color id, val=nil
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, "COLOR#{id}").first
+      else
+        IupLib.IupSetAttribute @handle, "COLOR#{id}", val
+      end
+    end
+
+    # Returns the depth of the given node.
+    # * +id+ - identifier of a node
+    def depth id
+      IupLib.IupGetAttribute(@handle, "DEPTH#{id}").first
+    end
+
+    # Returns kind of given node, as 'leaf' or 'branch'.
+    # * +id+ - identifier of a node
+    def kind id
+      IupLib.IupGetAttribute(@handle, "KIND#{id}").first
+    end
+
+    # Returns identifier of parent of given node.
+    # * +id+ - identifier of a node
+    def parent id
+      IupLib.IupGetAttribute(@handle, "PARENT#{id}").first
+    end
+
+    # :call-seq:
+    #   tree.state(id) # retrieves
+    #   tree.state(id, val) # sets
+    #
+    # Accesses state as 'collapsed' or 'expanded': 
+    # * +id+ - identifier of a node
+    # * +val+ - value 'collapsed' or 'expanded'.
+    def state id, val=nil
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, "STATE#{id}").first
+      else
+        IupLib.IupSetAttribute @handle, "STATE#{id}", val
+      end
+    end
+
+    # :call-seq:
+    #   tree.title(id) # retrieves
+    #   tree.title(id, val) # sets
+    #
+    # Accesses title of given node: 
+    # * +id+ - identifier of a node
+    # * +val+ - title.
+    def title id, val=nil
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, "TITLE#{id}").first
+      else
+        IupLib.IupSetAttribute @handle, "TITLE#{id}", val
+      end
+    end
+
+    # :call-seq:
+    #   tree.titlefont(id) # retrieves
+    #   tree.titlefont(id, val) # sets
+    #
+    # Accesses font of node title: 
+    # * +id+ - identifier of a node
+    # * +val+ - font description.
+    def titlefont id, val=nil
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, "TITLEFONT#{id}").first
+      else
+        IupLib.IupSetAttribute @handle, "TITLEFONT#{id}", val
+      end
+    end
+
+    # :call-seq:
+    #   tree.togglevalue(id) # retrieves
+    #   tree.togglevalue(id, val) # sets
+    #
+    # Accesses toggle state of given node: 
+    # * +id+ - identifier of a node
+    # * +val+ - state as 'on' / 'off' / 'notdef'
+    def togglevalue id, val=nil
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, "TOGGLEVALUE#{id}").first
+      else
+        IupLib.IupSetAttribute @handle, "TOGGLEVALUE#{id}", val
+      end
+    end
+
+    # :call-seq:
+    #   tree.togglevisible(id) # retrieves
+    #   tree.togglevisible(id, val) # sets
+    #
+    # Accesses toggle visibility of given node: 
+    # * +id+ - identifier of a node
+    # * +val+ - visibility as 'yes' / 'no'.
+    def togglevisible id, val=nil
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, "TOGGLEVISIBLE#{id}").first
+      else
+        IupLib.IupSetAttribute @handle, "TOGGLEVISIBLE#{id}", val
+      end
+    end
+
+    # Returns total number of children for given node.
+    # * +id+ - identifier of a node
+    def totalchildcount id
+      IupLib.IupGetAttribute(@handle, "TOTALCHILDCOUNT#{id}").first
+    end
+
+    # :call-seq:
+    #   tree.userdata(id) # retrieves
+    #   tree.userdata(id, val) # sets
+    #
+    # Accesses userdata for given node id.
+    # * +id+ - identifier of a node
+    # * +val+ - user data (a string)
+    def userdata id, val=nil
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, "USERDATA#{id}").first
+      else
+        IupLib.IupSetAttribute @handle, "USERDATA#{id}", val
+      end
+    end
+
+    # --- images
+
+    # Sets image to use for given node.
+    # * +id+ - identifier of a node
+    # * +img+ - image name or reference. This can use an actual image object, or the name of an image from +IupImageLib+.
+    def image id, img
+      attribute_reference "IMAGE#{id}", ImageWidget, img
+    end
+
+    # Sets image to use for given node, for expanded branches.
+    # * +id+ - identifier of a node
+    # * +img+ - image name or reference. This can use an actual image object, or the name of an image from +IupImageLib+.
+    def imageexpanded id, img
+      attribute_reference "IMAGEEXPANDED#{id}", ImageWidget, img
+    end
+
+    ##
+    # :attr: imageleaf
+    # \Image to be used for all leaf nodes. 
+    # This can use an actual image object, or the name of an image 
+    # from +IupImageLib+.
+
+    # --
+    def imageleaf
+      attribute_reference("IMAGELEAF", ImageWidget, nil)
+    end
+
+    def imageleaf= img # :nodoc:
+      attribute_reference("IMAGELEAF", ImageWidget, img)
+    end
+
+    ##
+    # :attr: imagebranchcollapsed
+    # \Image to be used for all collapsed branches. 
+    # This can use an actual image object, or the name of an image 
+    # from +IupImageLib+.
+
+    # --
+    def imagebranchcollapsed 
+      attribute_reference("IMAGEBRANCHCOLLAPSED", ImageWidget, nil)
+    end
+
+    def imagebranchcollapsed= img # :nodoc:
+      attribute_reference("IMAGEBRANCHCOLLAPSED", ImageWidget, img)
+    end
+
+    ##
+    # :attr: imagebranchexpanded
+    # \Image to be used for all expanded branches. 
+    # This can use an actual image object, or the name of an image 
+    # from +IupImageLib+.
+
+    # --
+    def imagebranchexpanded 
+      attribute_reference("IMAGEBRANCHEXPANDED", ImageWidget, nil)
+    end
+
+    def imagebranchexpanded= img # :nodoc:
+      attribute_reference("IMAGEBRANCHEXPANDED", ImageWidget, img)
+    end
+
+    # --- marks
+
+    ##
+    # :attr_writer: mark
+    # selects a range of nodes:
+    # 'start-end' / 'INVERTid' / 'block' / 'clearall' / 'markall' / 'invertall'
+    define_writer :mark
+
+    # :call-seq:
+    #   tree.marked(id)  # retrieves
+    #   tree.marked(id, val) # sets
+    #
+    # Accesses marked state of node:
+    # * +id+ - identity of node
+    # * +val+ - 'yes' / 'no'
+    def marked id, val=nil
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, "MARKED#{id}").first
+      else
+        IupLib.IupSetAttribute @handle, "MARKED#{id}", val
+      end
+    end
+
+    ##
+    # :attr: markednodes
+    # Sets/gets selection indices of all marked nodes, when markmode=multiple.
+
+    # --
+    def markednodes 
+      mns = IupLib.IupGetAttribute(@handle, 'MARKEDNODES').first
+      result = []
+
+      mns.split('').each_with_index do |item, index|
+        result << index+1 if item == '+'
+      end
+
+      return result
+    end
+
+    def markednodes= val # :nodoc:
+      result = ""
+      count.to_i.times do |i|
+        if val.include?(i+1)
+          result << '+'
+        else
+          result << '-'
+        end
+      end
+      IupLib.IupSetAttribute @handle, 'MARKEDNODES', result
+    end
+
+    ##
+    # :attr: markmode
+    # 'single' / 'multiple', for selection of nodes.
+    define_attribute :markmode
+
+    ##
+    # :attr: markstart
+    # Initial node for block marking, used when mark=block.
+    define_attribute :markstart
+
+    # --- hierarchy
+
+    # Adds new branch after specified node.
+    # * +id+ - identifier of a node
+    # * +val+ - text label
+    def addbranch id, val
+      IupLib.IupSetAttribute @handle, "ADDBRANCH#{id}", val.to_s
+    end
+
+    # Adds new leaf after specified node.
+    # * +id+ - identifier of a node
+    # * +val+ - text label
+    def addleaf id, val
+      IupLib.IupSetAttribute @handle, "ADDLEAF#{id}", val.to_s
+    end
+
+    # Copies source node and its children to target.
+    # * +source_id+ - identifier of a node
+    # * +target_id+ - identifier of a node
+    def copynode source_id, target_id
+      IupLib.IupSetAttribute @handle, "COPYNODE#{id}", target_id.to_s
+    end
+
+    # Delete one or more nodes:
+    # * +id+ - identifier of a node
+    # * +val+ - one of
+    #   * 'all': ignores id and deletes all nodes in tree, including root.
+    #   * 'selected': deletes selected node and its children.
+    #   * 'children': deleted only the children of selected node.
+    #   * 'marked': ignores id and deletes all selected node.
+    def delnode id, val
+      IupLib.IupSetAttribute @handle, "DELNODE#{id}", val.to_s
+    end
+
+    ##
+    # :attr: expandall
+    # Expands or contracts all nodes, values 'yes' / 'no'.
+    define_attribute :expandall
+
+    # Inserts new branch after specified node, preserving depth.
+    # * +id+ - identifier of a node
+    # * +val+ - text label
+    def insertbranch id, val
+      IupLib.IupSetAttribute @handle, "INSERTBRANCH#{id}", val.to_s
+    end
+
+    # Inserts new leaf after specified node, preserving depth.
+    # * +id+ - identifier of a node
+    # * +val+ - text label
+    def insertleaf id, val
+      IupLib.IupSetAttribute @handle, "INSERTLEAF#{id}", val.to_s
+    end
+
+    # Moves source to target, as a new child or sibling.
+    # * +source_id+ - identifier of a node
+    # * +target_id+ - identifier of a node
+    def movenode source_id, target_id
+      IupLib.IupSetAttribute @handle, "MOVENODE#{id}", target_id.to_s
+    end
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: selection_cb
+    # Callback called when a node is selected or deselected. 
+    # Callback must respond to +call+ and takes 2 arguments: (node_id, status)
+    # * +node_id+ - reference to node 
+    # * +status+ - whether node is selected or deselected
+
+    # --
+    def selection_cb= callback
+      unless callback.arity == 2
+        raise ArgumentError, 'selection_cb callback must take 2 arguments: node_id, status'
+      end
+      cb = Proc.new do |ih, id, status|
+        callback.call id, status
+      end
+      define_callback cb, 'SELECTION_CB', :ii_i
+    end
+
+    ##
+    # :attr_writer: branchopen_cb
+    # Callback called when a branch is expanded.
+    # Callback must respond to +call+ and takes 1 argument: (node_id)
+    # * +node_id+ - reference to node opened
+
+    # --
+    def branchopen_cb= callback
+      unless callback.arity == 1
+        raise ArgumentError, 'branchopen_cb callback must take 1 argument: node_id'
+      end
+      cb = Proc.new do |ih, id|
+        callback.call id
+      end
+      define_callback cb, 'BRANCHOPEN_CB', :i_i
+    end
+
+    ##
+    # :attr_writer: branchclose_cb
+    # Callback called when a branch is collapsed.
+    # Callback must respond to +call+ and takes 1 argument: (node_id)
+    # * +node_id+ - reference to node closed
+
+    # --
+    def branchclose_cb= callback
+      unless callback.arity == 1
+        raise ArgumentError, 'branchclose_cb callback must take 1 argument: node_id'
+      end
+      cb = Proc.new do |ih, id|
+        callback.call id
+      end
+      define_callback cb, 'BRANCHCLOSE_CB', :i_i
+    end
+
+    ##
+    # :attr_writer: executeleaf_cb
+    # Callback called when a leaf is to be executed.
+    # Callback must respond to +call+ and takes 1 argument: (node_id)
+    # * +node_id+ - reference to node 
+
+    # --
+    def executeleaf_cb= callback
+      unless callback.arity == 1
+        raise ArgumentError, 'executeleaf_cb callback must take 1 argument: node_id'
+      end
+      cb = Proc.new do |ih, id|
+        callback.call id
+      end
+      define_callback cb, 'EXECUTELEAF_CB', :i_i
+    end
+
+    ##
+    # :attr_writer: rightclick_cb
+    # Callback called when the right mouse button is pressed over a node.
+    # Callback must respond to +call+ and takes 1 argument: (node_id)
+    # * +node_id+ - reference to node 
+
+    # --
+    def rightclick_cb= callback
+      unless callback.arity == 1
+        raise ArgumentError, 'rightclick_cb callback must take 1 argument: node_id'
+      end
+      cb = Proc.new do |ih, id|
+        callback.call id
+      end
+      define_callback cb, 'RIGHTCLICK_CB', :i_i
+    end
+
+    ##
+    # :attr_writer: togglevalue_cb
+    # Callback called when the toggle's state was changed.
+    # Callback must respond to +call+ and takes 2 arguments: (node_id, status).
+    # * +node_id+ - reference to node 
+    # * +status+ - new state of toggle
+
+    # --
+    def togglevalue_cb= callback
+      unless callback.arity == 2
+        raise ArgumentError, 'togglevalue_cb callback must take 2 arguments: node_id, status'
+      end
+      cb = Proc.new do |ih, id, status|
+        callback.call id, status
+      end
+      define_callback cb, 'TOGGLEVALUE_CB', :ii_i
+    end 
+
+    include ButtonCallback
+
+    ##
+    # :attr_writer: dragdrop_cb
+    # Callback called when an internal drag & drop is executed. Only active if
+    # SHOWDRAGDROP=YES.
+    # Callback must respond to +call+ and accepts 4 arguments (drag_id,
+    # drop_id, isshift, iscontrol)
+    # * +drag_id+ - is an integer index of dragged item
+    # * +drop_id+ - is an integer index of drop location
+    # * +isshift+ - boolean flag for if shift key held
+    # * +iscontrol+ - boolean flag for if control key held
+    # Callback should return Iup::CONTINUE for item to be moved/copied.
+
+    # --
+    def dragdrop_cb= callback
+      unless callback.arity == 4
+        raise ArgumentError, 'dragdrop_cb callback must take 4 arguments: (drag_id, drop_id, isshift, iscontrol)'
+      end
+      cb = Proc.new do |ih, drag_id, drop_id, isshift, iscontrol|
+        callback.call drag_id.to_i, drop_id.to_i, (isshift != 0), (iscontrol != 0)
+      end
+      define_callback cb, 'DRAGDROP_CB', :iiii_i
+    end
+
+    ##
+    # :attr_writer: motion_cb
+    # Callback called when the mouse is moved.
+    # Callback must respond to +call+ and 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.
+
+    #--
+    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
+  end
+end