iup-ffi 0.12.0

data/lib/wrapped/dial.rb

@@ -0,0 +1,87 @@
+module Iup
+
+  class Dial < Widget
+
+    def initialize orientation = 'horizontal', &block
+      open_controls
+      @handle = ControlsLib.IupDial orientation
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_attribute :expand
+    define_attribute :orientation
+    define_readonly :position
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :tip
+    define_attribute :unit
+    
+    def value val=nil
+      if val.nil?
+        result = IupLib.IupGetAttribute(@handle, 'VALUE').first
+        result.to_f
+      else
+        IupLib.IupSetAttribute @handle, 'VALUE', val.to_s
+      end
+    end
+
+    # -- callbacks
+
+    include ButtonCallback
+
+    # Called when the user presses the left mouse button over the dial. 
+    # The angle here is always zero, except for the circular dial.
+    # Callback is a 1-argument function: (angle)
+    def button_press_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'button_press_cb callback must take 1 argument: (angle)'
+      end
+      cb = Proc.new do |ih, angle|
+        callback.call angle 
+      end
+      define_callback cb, 'BUTTON_PRESS_CB', :d_i
+    end
+
+    # Called when the user releases the left mouse button after pressing it over the dial.
+    # The angle here is always zero, except for the circular dial.
+    # Callback is a 1-argument function: (angle)
+    def button_release_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'button_release_cb callback must take 1 argument: (angle)'
+      end
+      cb = Proc.new do |ih, angle|
+        callback.call angle
+      end
+      define_callback cb, 'BUTTON_RELEASE_CB', :d_i
+    end
+
+    # Called each time the user moves the dial with the mouse button pressed. 
+    # The angle the dial rotated since it was initialized is passed as a parameter.
+    # Callback is a 1-argument function: (angle)
+    def mousemove_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'mousemove_cb callback must take 1 argument: (angle)'
+      end
+      cb = Proc.new do |ih, angle|
+        callback.call angle
+      end
+      define_callback cb, 'MOUSEMOVE_CB', :d_i
+    end
+
+    # Called after the value was interactively changed by the user. Called when 
+    # the selection is changed or when the text is edited.
+    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/dialog.rb

@@ -0,0 +1,176 @@
+module Iup
+
+  # A Dialog is a top-level window, containing a single widget.
+  #
+  # == Attributes
+  #
+  # background:: RGB colour for background of dialog and children.
+  # border:: If set, displays a resize border around dialog.
+  # clientsize:: <b>read-only</b>, returns current size of box as "widthxheight".
+  # cursor:: Defines the mouse shape / cursor for the dialog.
+  # expand:: Allows container to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # fullscreen:: 'no' / 'yes'.
+  # maxbox:: 'no' / 'yes', to show maximize box on dialog.
+  # menubox:: 'no' / 'yes', to show system menu box on dialog.
+  # minbox:: 'no' / 'yes', to show minimize box on dialog.
+  # modal:: <b>read-only</b> Returns modal state of dialog.
+  # parentdialog:: Sets/retrieves dialog to use as parent of this dialog.
+  # placement:: 'normal' / 'maximized' / 'minimized' / 'full'.
+  # rastersize:: Size of the dialog, in pixels, value as "widthxheight".
+  # resize:: 'no' / 'yes'.
+  # shrink:: 'no' / 'yes', allows dialog's children to reduce their size if
+  #          the dialog is made smaller.
+  # screenposition:: <b>read-only</b> returns position in pixels on screen
+  #                  as "x,y".
+  # size:: Size of the dialog, in character units, value as "widthxheight".
+  #        Can also use: 'full' / 'half' / 'third' / 'quarter' / 'eighth'.
+  # startfocus:: Name of widget to gain focus when dialog first shown.
+  # tip:: Tooltip string.
+  # title:: text displayed as dialog title.
+  #
+  class Dialog < Widget
+    include DragDropAttributes
+
+    include AttributeReference
+
+    # Creates a new dialog for given widget.
+    # widget:: the child widget to display.
+    # block:: optional block to set up attributes.
+    def initialize widget, &block
+      @handle = IupLib.IupDialog widget.handle
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given? 
+    end
+
+    # Hides the dialog from view.
+    def hide
+      IupLib.IupHide @handle
+    end
+
+    # Lays out the child widget and its contents, without showign the dialog.
+    def map
+      IupLib.IupMap @handle
+      self
+    end
+
+    # Shows the dialog at position (x, y).
+    def popup x, y
+      IupLib.IupPopup @handle, x.to_i, y.to_i
+    end
+    
+    # Shows the dialog at the default screen position, 
+    # or at (x, y) if specified.
+    def show x=nil, y=nil
+      if x.nil? and y.nil?
+        IupLib.IupShow @handle
+      else
+        IupLib.IupShowXY @handle, x.to_i, y.to_i
+      end
+    end
+
+    # -- attributes
+
+    # --- common
+
+    define_attribute :background
+    define_attribute :border
+    define_readonly :clientsize
+
+    def cursor image=nil # :nodoc:
+      attribute_reference 'CURSOR', ImageWidget, image
+    end
+
+    define_attribute :expand
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :tip
+    define_attribute :title
+
+    # --- exclusive
+
+    # Identifies button to activate when 'enter' is pressed.
+    # Leave item nil to retrieve current button.
+    def defaultenter item=nil
+      attribute_reference 'DEFAULTENTER', Button, item
+    end
+
+    # Identifies button to activate when 'escape' is pressed.
+    # Leave item nil to retrieve current button.
+    def defaultesc item=nil
+      attribute_reference 'DEFAULTESC', Button, item
+    end
+
+    define_attribute :fullscreen
+
+    # Defines or retrieves icon to use for dialog.
+    # item:: optional instance of ImageWidget
+    def icon item=nil
+      attribute_reference 'ICON', ImageWidget, item
+    end
+
+    define_attribute :maxbox
+
+    # Assigns given item as the menu for this dialog.
+    # item may be an instance of Menu, or the string name for a menu.
+    def menu item=nil
+      attribute_reference 'MENU', Menu, item
+    end
+
+    define_attribute :menubox
+    define_attribute :minbox
+    define_readonly :modal
+
+    def parentdialog parent=nil # :nodoc:
+      attribute_reference 'PARENTDIALOG', Dialog, parent
+    end
+
+    define_attribute :placement
+    define_attribute :resize
+    define_attribute :shrink
+
+    def startfocus item=nil # :nodoc:
+      attribute_reference 'STARTFOCUS', Widget, item
+    end
+
+    # -- callbacks
+    
+    # Called right before the dialog is closed.
+    def close_cb callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'close_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'CLOSE_CB', :plain
+    end
+
+     # Action generated when the canvas 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
+
+    # Called right after the dialog is shown, hidden, maximized, minimized or restored from minimized/maximized. 
+    # Callback takes one argument, the state of the change.
+    def show_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'show_cb callback must take 1 argument: (state)'
+      end
+      cb = Proc.new do |ih, state|
+        callback.call state
+      end
+      define_callback cb, 'SHOW_CB', :i_i
+    end
+  end
+end

data/lib/wrapped/dialogs.rb

@@ -0,0 +1,106 @@
+module Iup
+
+  # Creates and shows an AlarmDialog, returning the number of the button clicked.
+  #
+  #   mainloop do
+  #     case alarm 'IupAlarm Example', 'File not saved!  Save it now?', 'Yes', 'No', 'Cancel'
+  #     when 1
+  #       message 'Save file', 'File saved successfully - leaving program'
+  #     when 2
+  #       message 'Save file', 'File not saved - leaving program anyway'
+  #     when 3
+  #       message 'Save file', 'Operation cancelled'
+  #     end
+  #     exit # needed, as we don't have a persistent dialog, so don't wish to run the   mainloop
+  #   end
+  #
+  # title:: the title of the dialog window
+  # msg:: the text to display within the dialog
+  # button1:: label for the first button
+  # button2:: label for the optional second button
+  # button3:: label for the optional third button
+  #
+  def alarm title, msg, button1, button2=nil, button3=nil
+    IupLib.IupAlarm title, msg, button1, button2, button3
+  end
+
+  # Shows a modal dialog allowing user to select a colour.  
+  # As input, provide the x,y coordinates to show dialog.  
+  # Returns r/g/b triple of selected colour, or nil if "cancel" clicked.
+  #
+  #   r, g, b = get_colour 150, 150
+  # 
+  def get_colour x=0, y=0
+    r = FFI::MemoryPointer.new(:int, 1, 0)
+    g = FFI::MemoryPointer.new(:int, 1, 0)
+    b = FFI::MemoryPointer.new(:int, 1, 0)
+    code = IupLib.IupGetColor x, y, r, g, b
+    if code == 0
+      return nil, nil, nil
+    else
+      return r.read_int, g.read_int, b.read_int
+    end
+  end
+
+  # Convenience function to show a modal dialog to select a filename.
+  # As input, accepts a path and filter for the file.  
+  # Returns the status code and selected filename.
+  # 
+  # Example, selecting a filename ending in ".txt" from current directory.
+  #
+  #   code, file = get_file './*.txt'
+  # 
+  def 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
+
+  # Show a modal dialog to edit a multiline text.
+  # Returns the text or nil if cancelled.
+  # Assumes 2048 as maximum length, unless a larger text is input.
+  #
+  # text:: Initial text to display.
+  # title:: Title of dialog box.
+  #--
+  # TODO: Crashes - double free or corruption.
+  # def get_text title, text=''
+  #   text += ' '*(2048-text.size)
+  #   text_ptr = FFI::MemoryPointer.from_string text
+  #   code = IupLib.IupGetText FFI::MemoryPointer.from_string(title), text_ptr
+  #   return (code.zero? ? nil : text_ptr.read_string.force_encoding('UTF-8').strip)
+  # end
+
+  # show a list dialog.
+  # returns selected item, or nil if cancel clicked.
+  #--
+  # TODO: Include multiple selection, change to cols/lines
+  def listdialog title, items
+    strptrs = []
+    strptrs << nil
+ 
+    items_ptr = FFI::MemoryPointer.new(:pointer, items.length)
+    items.each_with_index do |item, i|
+      items_ptr[i].put_pointer(0, FFI::MemoryPointer.from_string(item))
+    end
+
+    code = IupLib.IupListDialog 1, title, items.length, items_ptr, 1, 1, 10, nil
+
+    return (code == -1 ? nil : items[code])
+  end
+
+  # Create a MessageDialog with given title and displayed message.
+  #
+  #   message "title of dialog", "text of message"
+  #
+  def message title, msg
+    IupLib.IupMessage title, msg
+  end
+
+end

data/lib/wrapped/drag-drop-attributes.rb

@@ -0,0 +1,57 @@
+module Iup
+
+  # defines attributes and methods for drag and drop
+  #
+  # Steps to use the Drag & Drop support in an IUP application:
+  #
+  # AT SOURCE::
+  #        * Enable the element as source using the attribute DRAGSOURCE=YES;
+  #        * Define the data types supported by the element for the drag operation using the DRAGTYPES attribute;
+  #        * Register the required callbacks DRAGBEGIN_CB, DRAGDATASIZE_CB and DRAGDATA_CB for drag handling. DRAGEND_CB is the only optional drag callback, all other callbacks and attributes must be set.
+  # AT TARGET::
+  #        * Enable the element as target using the attribute DROPTARGET=YES;
+  #        * Define the data types supported by the element for the drop using the DROPTYPES attribute;
+  #        * Register the required callback DROPDATA_CB for handling the data received. This callback and all the drop target attributes must be set too. DROPMOTION_CB is the only optional drop callback.
+  #
+  module DragDropAttributes
+    extend AttributeBuilders
+
+    # attributes for drag-n-drop
+
+    define_attribute :dragsource
+    define_attribute :dragtypes
+    define_attribute :dragsourcemove
+    define_attribute :droptarget
+    define_attribute :droptypes
+
+    # callbacks for drag-n-drop
+
+    def dragbegin_cb callback
+      define_callback callback, 'DRAGBEGIN_CB', :ii_i
+    end 
+
+    def dragdatasize_cb callback
+      define_callback callback, 'DRAGDATASIZE_CB', :s_i
+    end 
+
+    # Note: user data assumed to be a string
+    def dragdata_cb callback
+      define_callback callback, 'DRAGDATA_CB', :ssi_i
+    end 
+
+    def dragend_cb callback
+      define_callback callback, 'DRAGEND_CB', :i_i
+    end 
+
+    # Note: user data assumed to be a string
+    def dropdata_cb callback
+      define_callback callback, 'DROPDATA_CB', :ssiii_i
+    end
+
+    def dropmotion_cb callback
+      define_callback callback, 'DROPMOTION_CB', :iis_i
+    end
+  end
+
+end
+

data/lib/wrapped/dynamic-fill-methods.rb

@@ -0,0 +1,27 @@
+module Iup
+
+  # Methods for containers where the child elements can be added after construction.
+  #
+  module DynamicFillMethods
+
+    # Inserts an interface element at the end of the container, 
+    # after the last element of the container. 
+    # Valid for any element that contains other elements like 
+    # dialog, frame, hbox, vbox, zbox or menu.
+    def append child
+      IupLib.IupAppend @handle, child.handle
+    end
+
+    # Inserts an interface element before another child of the container. 
+    # Valid for any element that contains other elements like 
+    # dialog, frame, hbox, vbox, zbox, menu, etc.
+    def insert ref_child, new_child
+      if ref_child.nil?
+        IupLib.IupInsert @handle, nil, new_child.handle
+      else
+        IupLib.IupInsert @handle, ref_child.handle, new_child.handle
+      end
+    end
+  end
+
+end

data/lib/wrapped/expander.rb

@@ -0,0 +1,65 @@
+module Iup
+
+  # An expandable container for a single widget. 
+  # The user can show or hide the child widget, as required.
+  #
+  # == Attributes
+  #
+  # autoshow:: If set, child will be shown when mouse hovers over container.
+  #            Values 'yes' / 'no'.
+  # backcolor:: Colour of background in title area, as "r g b".
+  # barposition:: Position of expander bar, as 'top' / 'bottom' / 'left' / 'right'.
+  # barsize:: n, size of bar - defaults to text line height + 5.
+  # 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'.
+  # forecolor:: Colour of text in title area, as "r g b".
+  # 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".
+  # state:: Show or hide child, as 'open' / 'close'.
+  # title:: Displayed on box in title area.
+  #
+  class Expander < Widget
+
+    # Creates an instance of the Expander.
+    # child:: the child widget
+    # block:: optional block to set up the container's attributes.
+    def initialize child, &block
+      @handle = IupLib.IupExpander child.handle
+
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_attribute :autoshow
+    define_attribute :backcolor
+    define_attribute :barposition
+    define_attribute :barsize
+    define_readonly :clientoffset
+    define_readonly :clientsize
+    define_attribute :expand
+    define_attribute :forecolor
+    define_attribute :position
+    define_attribute :rastersize
+    define_attribute :state
+    define_attribute :title
+
+    # -- callbacks
+
+    # Action generated after the expander state is interactively changed.
+    # callback:: a zero-argument procedure
+    def action_cb callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'action_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'ACTION_CB', :plain
+    end
+  end
+end

data/lib/wrapped/filedialog.rb

@@ -0,0 +1,93 @@
+module Iup
+
+  # A FileDialog is a predefined dialog for selecting files or a directory.
+  # The dialog can only be shown using the popup function.
+  #
+  # == Attributes
+  #
+  # allownew:: If set, indicates if non-existent filenames are accepted.
+  #            Values as 'yes' / 'no' - defaults to 'no'.
+  # dialogtype:: 'open' / 'save' / 'dir'
+  # directory:: Initial directory
+  # extfilter:: Defines filters, e.g. "Text files\|*.txt;*.doc\|Image files\|*.gif;*.jpg;*.bmp\|", 
+  #             has priority over +filterinfo+ and +filter+.
+  # file:: Name of file. Will be used instead of +dictionary+ if it contains 
+  #        a complete path.
+  # filter:: Filter to use, e.g. "*.C;*.LED;test.*".
+  # filterinfo:: Information about the +filter+, e.g. "C files".
+  # filterused:: n, index of filter from +extfilter+ that was used. 
+  #              Index counts from 1.
+  # multiplefiles:: 'no' / 'yes', set to allow selection of multiple files.
+  # nochangedir:: 'yes' / 'no', if set, restores current directory after dialog is closed.
+  # nooverwriteprompt:: 'no' / 'yes', if set, prompts before overwriting existing files.
+  # 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.
+  # showhidden:: 'no' / 'yes', if set, shows hidden files.
+  # showpreview:: 'no' / 'yes', if set, shows a preview area for file.
+  # status:: <b>read-only</b> Returns an integer: 1 for new file, 0 for existing file/directory, for -1 for cancelled.
+  # title:: Title text for the file dialog.
+  # value:: <b>read-only</b> Name of file(s) selected.
+  #
+  class FileDialog < Widget
+
+    # Creates a dialog, using the optional block to set its attributes.
+    def initialize &block
+      @handle = IupLib.IupFileDlg
+
+      self.instance_eval &block if block_given?
+    end
+
+    # Shows the dialog at position x, y.
+    def popup x=0, y=0
+      IupLib.IupPopup @handle, x, y
+    end
+
+    # -- attributes
+
+    define_attribute :allownew
+    define_attribute :dialogtype
+    define_attribute :directory
+    define_attribute :extfilter
+    define_attribute :file
+    define_attribute :filter
+    define_attribute :filterinfo
+    define_attribute :filterused
+    define_attribute :multiplefiles
+    define_attribute :nochangedir
+    define_attribute :nooverwriteprompt
+
+    def parentdialog parent=nil # :nodoc:
+      attribute_reference 'PARENTDIALOG', Dialog, parent
+    end
+
+    define_attribute :showhidden
+    define_attribute :showpreview
+    
+    def status # :nodoc:
+      status = IupLib.IupGetAttribute(@handle, 'STATUS').first
+      status.to_i
+    end
+
+    define_attribute :title
+    define_readonly :value
+    
+    # -- callbacks
+
+    # Called when a file is selected. 
+    # callback:: takes two arguments, a filename and a 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,26 @@
+module Iup
+
+  # Dynamically fills empty space. Its parent _must_ be an HBox or VBox.
+  #
+  # == Attributes
+  #
+  # expand:: <b>read-only</b>, 'horizontal' if in an HBox, or 'vertical' if 
+  #          in a VBox.
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # rastersize:: Size of the widget, in pixels, value as "widthxheight".
+  #
+  class Fill < Widget
+
+    # Creates an instance of Fill.
+    # Note that attributes must be set separately, not through a block.
+    def initialize
+      @handle = IupLib.IupFill
+    end
+
+    define_readonly :expand
+    define_readonly :position
+    define_attribute :rastersize
+  end
+end
+

data/lib/wrapped/fontdialog.rb

@@ -0,0 +1,42 @@
+module Iup
+
+  # A FontDialog allows the user to select a font.
+  #
+  # == Attributes
+  #
+  # 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.
+  # previewtext:: The text to use for preview of font selection.
+  # status:: <b>read-only</b> returns '1' if 'OK' pressed, or null
+  # title:: Title text for the message dialog.
+  # value:: Initial value of font for dialog, and return value if 'OK' pressed.
+  #
+  class FontDialog < Widget
+    
+    # Creates a dialog, using the optional block to set its attributes.
+    def initialize &block
+      @handle = IupLib.IupFontDlg
+
+      self.instance_eval &block if block_given?
+    end
+
+    # Shows the dialog at position x, y.
+    def popup x=0, y=0
+      IupLib.IupPopup @handle, x, y
+    end
+
+    # -- attributes
+
+    def parentdialog parent=nil #:nodoc:
+      attribute_reference 'PARENTDIALOG', Dialog, parent
+    end
+
+    define_attribute :previewtext
+    define_readonly :status
+    define_attribute :title
+    define_attribute :value
+  end
+end
+