iup-ffi 0.13.0-x86_64-linux

data/lib/wrapped/filedialog.rb

@@ -0,0 +1,168 @@
+module Iup
+
+  # Convenience function to show a modal dialog to select a filename.
+  #
+  # * +filter+ - path + filter for files to show
+  #
+  # Returns the status code and selected filename: 
+  # status is an integer, 1 for new file, 0 for existing file/directory, or -1
+  # for cancelled.
+  #
+  # Also see: FileDialog
+  # 
+  # For example, select a filename ending in ".txt" from current directory.
+  #
+  #   code, file = Iup.get_file('./*.txt')
+  # 
+  def self.get_file filter=''
+    file = ' '*(256-filter.size) + filter
+    code = IupLib.IupGetFile(file)
+    case code
+    when 0, 1
+      filename = file[0...file.index("\0")]
+      return code, filename
+    else
+      return code, ''
+    end
+  end
+
+  # A predefined modal dialog for selecting files or a directory.
+  #
+  # === Example
+  #
+  # The following opens a "save file" dialog, filtered on Ruby files.
+  #
+  #   filedlg = Iup::FileDialog.new do |d|
+  #      d.dialogtype = 'save'
+  #      d.title = 'File Save'
+  #      d.filter = '*.rb'
+  #      d.filterinfo = 'Ruby Files'
+  #    end
+  #    filedlg.popup(300, 300)
+  #
+  # Note that +popup+ must be used to show the dialog.
+  #
+  # Also see: Iup.get_file
+  #
+  class FileDialog < Iup::Dialog
+
+    # Creates a new dialog.
+    # If a block is given, the new instance is yielded to it.
+    def initialize 
+      @handle = IupLib.IupFileDlg
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: allownew
+    # If set, indicates if non-existent filenames are accepted.
+    # Values as 'yes' / 'no' - defaults to 'no'.
+    define_attribute :allownew
+
+    ##
+    # :attr: dialogtype
+    # 'open' / 'save' / 'dir'
+    define_attribute :dialogtype
+
+    ##
+    # :attr: directory
+    # Initial directory
+    define_attribute :directory
+
+    ##
+    # :attr: extfilter
+    # Defines filters, e.g. "Text files\|\*.txt;\*.doc\|Image files\|\*.gif;\*.jpg;\*.bmp\|", 
+    # has priority over +filterinfo+ and +filter+.
+    define_attribute :extfilter
+
+    ##
+    # :attr: file
+    # Name of file. Will be used instead of +dictionary+ if it contains a complete path.
+    define_attribute :file
+
+    ##
+    # :attr: filter
+    # Filter to use, e.g. "\*.C;\*.LED;test.\*".
+    define_attribute :filter
+
+    ##
+    # :attr: filterinfo
+    # Information about the +filter+, e.g. "C files".
+    define_attribute :filterinfo
+
+    ##
+    # :attr: filterused
+    # n, index of filter from +extfilter+ that was used. 
+    # Index counts from 1.
+    define_attribute :filterused
+
+    ##
+    # :attr: multiplefiles
+    # 'no' / 'yes', set to allow selection of multiple files.
+    define_attribute :multiplefiles
+
+    ##
+    # :attr: nochangedir
+    # 'yes' / 'no', if set, restores current directory after dialog is closed.
+    define_attribute :nochangedir
+
+    ##
+    # :attr: nooverwriteprompt
+    # 'no' / 'yes', if set, prompts before overwriting existing files.
+    define_attribute :nooverwriteprompt
+
+    ##
+    # :attr: showhidden
+    # 'no' / 'yes', if set, shows hidden files.
+    define_attribute :showhidden
+
+    ##
+    # :attr: showpreview
+    # 'no' / 'yes', if set, shows a preview area for file.
+    define_attribute :showpreview
+
+    ##
+    # :attr_reader: status
+    #
+    # Returns an integer: 1 for new file, 0 for existing file/directory, or -1 for cancelled.
+
+    # --
+    def status 
+      status = IupLib.IupGetAttribute(@handle, 'STATUS').first
+      status.to_i
+    end
+
+    ##
+    # :attr_reader: value
+    # Name of file(s) selected.
+    define_reader :value
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: file_cb
+    #
+    # Sets callback for when a file is selected. 
+    # callback must respond to +call+ and take two arguments: (filename, status)
+    # * +filename+ - filename of selected file
+    # * +status+ -
+
+    # --
+    def file_cb= callback
+      unless callback.arity == 2
+        raise ArgumentError, 'file_cb callback must take 2 arguments, a filename, and status'
+      end
+      cb = Proc.new do |ih, fn_ptr, st_ptr|
+        fn = FFI::Pointer.new(fn_ptr).read_string
+        st = FFI::Pointer.new(st_ptr).read_string
+        callback.call fn, st
+      end
+      define_callback cb, 'FILE_CB', :ss_i
+    end
+  end
+end
+

data/lib/wrapped/fill.rb

@@ -0,0 +1,29 @@
+module Iup
+
+  # Dynamically fills empty space. Its parent _must_ be an HBox or VBox.
+  #
+  class Fill < Iup::Widget
+
+    # Creates a new instance.
+    # Note that attributes must be set separately, not through a block.
+    def initialize
+      @handle = IupLib.IupFill
+    end
+
+    ##
+    # :attr_reader: expand
+    # 'horizontal' if in an HBox, or 'vertical' if in a VBox.
+    define_reader :expand
+
+    ##
+    # :attr_reader: position
+    # returns position in pixels within client window as "x,y".
+    define_reader :position
+
+    ##
+    # :attr: rastersize
+    # Size of the widget, in pixels, value as "widthxheight".
+    define_attribute :rastersize
+  end
+end
+

data/lib/wrapped/fontdialog.rb

@@ -0,0 +1,71 @@
+module Iup
+
+  # A predefined modal dialog to select a font.
+  #
+  # === Example
+  #
+  #   dlg = Iup::FontDialog.new do
+  #     d.title = "Select a new font"
+  #     d.font = "Times, bold 18"
+  #   end
+  #   dlg.popup
+  #
+  # Note that +popup+ must be used to show the dialog.
+  #
+  class FontDialog < Iup::Widget
+
+    # Creates a new dialog.
+    # If a block is given, the new instance is yielded to it.
+    def initialize
+      @handle = IupLib.IupFontDlg
+
+      yield self if block_given?
+    end
+
+    # Shows the dialog at position x, y.
+    # * +x+ - x-coordinate to use, or one of {show constants}[../Iup.html#Dialog+show+position]
+    # * +y+ - y-coordinate to use, or one of {show constants}[../Iup.html#Dialog+show+position]
+    def popup x=0, y=0
+      IupLib.IupPopup @handle, x, y
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: parentdialog
+    # This dialog will be always in front of the parent dialog. 
+    # If the parent is minimized, this dialog is automatically minimized.
+    # *Important* Closing the parent will also close the child, but the 
+    # child dialog's CLOSE_CB method will not be called.
+
+    # --
+    def parentdialog 
+      attribute_reference('PARENTDIALOG', Dialog, nil)
+    end
+
+    def parentdialog= parent # :nodoc:
+      attribute_reference('PARENTDIALOG', Dialog, parent)
+    end
+
+    ##
+    # :attr: previewtext
+    # The text to use for preview of font selection.
+    define_attribute :previewtext
+
+    ##
+    # :attr_reader: status
+    # returns '1' if 'OK' pressed, or null
+    define_reader :status
+
+    ##
+    # :attr: title
+    # Title text for the message dialog.
+    define_attribute :title
+
+    ##
+    # :attr: value
+    # Initial value of font for dialog, and return value if 'OK' pressed.
+    define_attribute :value
+  end
+end
+

data/lib/wrapped/frame.rb

@@ -0,0 +1,70 @@
+module Iup
+
+  # A frame contains a child widget and displays it with a border.
+  # Optionally, the frame can have a text title.
+  #
+  # === Example
+  #
+  # Example placing a text label on widgets placed into a HBox:
+  #
+  #   Iup::Frame.new(hbox) do |f|
+  #     f.title = 'ALIGNMENT=ALEFT, GAP=10'
+  #   end
+  #
+  class Frame < Iup::Widget
+
+    # Creates an instance of the frame.
+    # If a block is given, the new instance is yielded to it.
+    # * +widget+ - the child widget to display.
+    def initialize widget
+      @handle = IupLib.IupFrame(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 frame in its client as "widthxheight".
+    define_reader :clientoffset
+
+    ##
+    # :attr_reader: clientsize
+    # Returns current size of frame as "widthxheight".
+    define_reader :clientsize
+
+    ##
+    # :attr: expand
+    # Allows frame to fill available space in indicated direction.
+    # Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+    define_attribute :expand
+
+    ##
+    # :attr_reader: position
+    # returns position in pixels within client window as "x,y".
+    define_reader :position
+
+    ##
+    # :attr: rastersize
+    # Size of the frame, in pixels, value as "widthxheight".
+    define_attribute :rastersize
+
+    ##
+    # :attr_reader: screenposition
+    # returns position in pixels on screen as "x,y".
+    define_reader :screenposition
+
+    ##
+    # :attr: sunken
+    # For frame with no title, gives a sunken appearance if set: values as 'yes' / 'no'.
+    define_attribute :sunken
+
+    ##
+    # :attr: title
+    # \Text displayed as frame title.
+    define_attribute :title
+  end
+end
+

data/lib/wrapped/gridbox.rb

@@ -0,0 +1,188 @@
+module Iup
+
+  # A container which arranges its widgets in a left-to-right, top-to-bottom order 
+  # to form a grid-like arrangement.
+  #
+  # === Example
+  #
+  # The following example sets up a 2x2 grid of labels, each centered with a 
+  # small gap between the columns:
+  #
+  #   box = Iup::GridBox.new(lbl1, lbl2, lbl3, lbl4) do |b|
+  #     b.sizelin = 1 # the second line is used for calculating spacing
+  #     b.numdiv = 2 # arranges labels with 2 columns
+  #     b.alignmentlin = 'acenter'
+  #     b.gapcol = 5
+  #   end
+  #
+  # Also see: HBox, VBox
+  #
+  class GridBox < Iup::Widget
+    include DynamicFillMethods
+
+    # Creates an instance of the gridbox.
+    # If a block is given, the new instance is yielded to it.
+    #
+    # * +widgets+ -one or more child widgets 
+    #
+    def initialize *widgets
+      @handle = IupLib.IupGridBox(*widget_list(widgets))
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end   
+
+    # -- attributes
+
+    # :call-seq:
+    #   gridbox.alignmentcol()    # Reads value of "ALIGNMENTCOL"
+    #   grid.alignmentcol(val)    # Sets "ALIGNMENTCOL" to val
+    #   grid.alignmentcol(n, val) # Sets alignment of column n to val
+    #
+    # Alignment values are 'ALEFT' / 'ACENTER' / 'ARIGHT'.
+    def alignmentcol val=nil, val2=nil 
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, 'ALIGNMENTCOL').first
+      elsif val2.nil?
+        IupLib.IupSetAttribute @handle, 'ALIGNMENTCOL', val.to_s
+      else
+        IupLib.IupSetAttribute @handle, "ALIGNMENTCOL#{val}", val2.to_s
+      end
+    end
+
+    # :call-seq:
+    #   gridbox.alignmentlin()    # Reads value of "ALIGNMENTLIN"
+    #   grid.alignmentlin(val)    # Sets "ALIGNMENTLIN" to val
+    #   grid.alignmentlin(n, val) # Sets alignment of line n to val
+    #
+    # Alignment values are 'ATOP' / 'ACENTER' / 'ABOTTOM'.
+    def alignmentlin val=nil, val2=nil 
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, 'ALIGNMENTLIN').first
+      elsif val2.nil?
+        IupLib.IupSetAttribute @handle, 'ALIGNMENTLIN', val.to_s
+      else
+        IupLib.IupSetAttribute @handle, "ALIGNMENTLIN#{val}", val2.to_s
+      end
+    end
+
+    ##
+    # :attr: cgapcol
+    # n, horizontal space in characters between columns.
+    define_attribute :cgapcol
+
+    ##
+    # :attr: cgaplin
+    # n, vertical space in characters between lines.
+    define_attribute :cgaplin
+
+    ##
+    # :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: cmargin
+    # Margin in x and y directions in characters, value as "mxn".
+    define_attribute :cmargin
+
+    ##
+    # :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, 
+    # values as 'yes' / 'no' / 'horizontal' / 'vertical'.
+    define_attribute :expandchildren
+
+    ##
+    # :attr: fittochildren
+    # 'column' / 'line', n -> force column/line n to fit largest element in that column/line.
+    define_attribute :fittochildren
+
+    ##
+    # :attr: gapcol
+    # Horizontal space in pixels between columns.
+    define_attribute :gapcol
+
+    ##
+    # :attr: gaplin
+    # Vertical space in pixels between lines.
+    define_attribute :gaplin
+
+    ##
+    # :attr: homogeneouscol
+    # Forces all columns to have same horizontal space. 
+    # Values as 'yes' / 'no'.
+    define_attribute :homogeneouscol
+
+    ##
+    # :attr: homogeneouslin
+    # Forces all lines to have same vertical space.
+    # Values as 'yes' / 'no'.
+    define_attribute :homogeneouslin
+
+    ##
+    # :attr: margin
+    # Margin in x and y directions in pixels, value as "mxn".
+    define_attribute :margin
+
+    ##
+    # :attr: normalsize
+    # Set to make natural size of children same, 
+    # values as 'yes' / 'no' / 'horizontal' / 'vertical'.
+    define_attribute :normalizesize
+
+    ##
+    # :attr_reader: numcol
+    # returns number of columns.
+    define_reader :numcol
+
+    ##
+    # :attr: numdiv
+    # 'auto' / n, controls number of divisions in direction as determined by
+    # +orientation+.
+    define_attribute :numdiv
+
+    ##
+    # :attr_reader: numlin
+    # returns number of lines.
+    define_reader :numlin
+
+    ##
+    # :attr: orientation
+    # Controls distribution of children, in lines or columns.
+    # Value as 'horizontal' / '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: sizecol
+    # Index of column to use for calculating height of lines.
+    # Note: make sure column is within range, else can crash.
+    define_attribute :sizecol
+
+    ##
+    # :attr: sizelin
+    # Index of line to use for calculating width of columns.
+    # Note: make sure line is within range, else can crash.
+    define_attribute :sizelin
+  end
+end

data/lib/wrapped/hbox.rb

@@ -0,0 +1,90 @@
+module Iup
+
+  # A container for one or more child widgets, arranged in a horizontal row.
+  #
+  # === Example
+  #
+  # The following example puts a label beside a button: 
+  #
+  #   box = Iup::HBox.new(label, button) do |b|
+  #     b.gap = 10
+  #     b.margin = '5x5'
+  #     b.expand = :yes
+  #   end
+  #
+  # Also see: Fill, VBox
+  #
+  class HBox < Iup::Widget
+    include DynamicFillMethods
+
+    # Creates an instance of the hbox.
+    # If a block is given, the new instance is yielded to it.
+    #
+    # * +widgets+ - one or more child widgets 
+    #
+    def initialize *widgets
+      @handle = IupLib.IupHbox(*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, 'atop' / 'acenter' / 'abottom'
+    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 in vertical 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 horizontal space, 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/image-attributes.rb

@@ -0,0 +1,58 @@
+module Iup
+
+  # Defines attributes for widgets which contain images.
+  #
+  module ImageAttributes
+    include AttributeReference
+
+    ##
+    # :attr: image
+    # 
+    # The image to display, based on an image or image name.
+    # 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: iminactive
+    #
+    # The image to display when inactive, based on an image or image name.
+    # This can use an actual image object, or the name of an image 
+    # from +IupImageLib+.
+
+    # --
+    def iminactive
+      attribute_reference('IMINACTION', ImageWidget, nil)
+    end
+
+    def iminactive= val # :nodoc:
+      attribute_reference('IMINACTION', ImageWidget, val)
+    end
+
+    ##
+    # :attr: impress
+    #
+    # The image to display when pressed, based on an image or image name.
+    # This can use an actual image object, or the name of an image 
+    # from +IupImageLib+.
+
+    # --
+    def impress
+      attribute_reference('IMPRESS', ImageWidget, nil)
+    end
+
+    def impress= val # :nodoc:
+      attribute_reference('IMPRESS', ImageWidget, val)
+    end
+  end
+
+end
+