iup-ffi 0.13.0-x86_64-linux

data/lib/wrapped/dialog.rb

@@ -0,0 +1,309 @@
+module Iup
+
+  # A top-level window, containing a single widget. Supports 
+  # standard window decorations and a menu.
+  #
+  # === Example
+  #
+  # The following example displays a label widget within the dialog, 
+  # setting the dialog's title and size before showing it.
+  #
+  #   Iup::Dialog.new(label) do |d|
+  #     d.title = " ... from IUP"
+  #     d.size = "150x50"
+  #   end.show
+  #
+  # Also see: Menu.
+  #
+  class Dialog < Iup::Widget
+    include DragDropAttributes
+    include AttributeReference
+
+    # Creates a new dialog for given widget. 
+    # If a block is given, the new instance is yielded to it.
+    # * +widget+ - the child widget to display.
+    #
+    # Use +show+ to display the dialog after initialisation; 
+    # some widgets require the dialog to be mapped first, 
+    # and then shown after the widget is initialised.
+    def initialize widget
+      @handle = IupLib.IupDialog(widget.handle)
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given? 
+    end
+
+    # Hides the dialog from view.
+    def hide
+      IupLib.IupHide @handle
+    end
+
+    # Lays out the child widget and its contents, without showing the dialog.
+    def map
+      IupLib.IupMap @handle
+      self
+    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=nil, y=nil
+      IupLib.IupPopup @handle, x.to_i, y.to_i
+    end
+
+    # Shows the dialog at the default screen position, 
+    # or at (x, y) if specified.
+    # * +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 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
+
+    ##
+    # :attr: background
+    # RGB color for background of dialog and children.
+    define_attribute :background
+
+    ##
+    # :attr: border
+    # If set, displays a resize border around dialog.
+    define_attribute :border
+
+    ##
+    # :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: cursor
+    # Defines the mouse shape / cursor for the dialog.
+
+    # --
+    def cursor
+      attribute_reference('CURSOR', ImageWidget, nil)
+    end
+
+    def cursor= image # :nodoc:
+      attribute_reference('CURSOR', ImageWidget, image)
+    end
+
+    ##
+    # :attr: expand
+    # Allows container to fill available space in indicated direction.
+    # Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+    define_attribute :expand
+
+    ##
+    # :attr: rastersize
+    # Size of the dialog, in pixels, value as "widthxheight".
+    define_attribute :rastersize
+
+    ##
+    # :attr_reader: screenposition
+    # returns position in pixels on screen as "x,y".
+    define_reader :screenposition
+
+    ##
+    # :attr: tip
+    # Tooltip string.
+    define_attribute :tip
+
+    ##
+    # :attr: title
+    # Displayed as dialog title.
+    define_attribute :title
+
+    # --- exclusive
+
+    ##
+    # :attr: defaultenter
+    #
+    # Identifies button to activate when 'enter' is pressed.
+
+    # --
+    def defaultenter
+      attribute_reference('DEFAULTENTER', Button, nil)
+    end
+
+    def defaultenter= item # :nodoc:
+      attribute_reference('DEFAULTENTER', Button, item)
+    end
+
+    ##
+    # :attr: defaultesc
+    # Identifies button to activate when 'escape' is pressed.
+
+    # --
+    def defaultesc
+      attribute_reference('DEFAULTESC', Button, nil)
+    end
+
+    def defaultesc= item # :nodoc:
+      attribute_reference('DEFAULTESC', Button, item)
+    end
+
+    ##
+    # :attr: fullscreen
+    # 'no' / 'yes'.
+    define_attribute :fullscreen
+
+    ##
+    # :attr: icon
+    # An ImageWidget instance to use for dialog.
+
+    # --
+    def icon
+      attribute_reference('ICON', ImageWidget, nil)
+    end
+
+    def icon= item # :nodoc:
+      attribute_reference('ICON', ImageWidget, item)
+    end
+
+    ##
+    # :attr: maxbox
+    # 'no' / 'yes', to show maximize box on dialog.
+    define_attribute :maxbox
+
+    ##
+    # :attr: menu
+    # 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
+      attribute_reference('MENU', Menu, nil)
+    end
+
+    def menu= item # :nodoc:
+      attribute_reference('MENU', Menu, item)
+    end
+
+    ##
+    # :attr: menubox
+    # 'no' / 'yes', to show system menu box on dialog.
+    define_attribute :menubox
+
+    ##
+    # :attr: minbox
+    # 'no' / 'yes', to show minimize box on dialog.
+    define_attribute :minbox
+
+    ##
+    # :attr_reader: modal
+    # Returns modal state of dialog.
+    define_reader :modal
+
+    ##
+    # :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: placement
+    # 'normal' / 'maximized' / 'minimized' / 'full'.
+    define_attribute :placement
+
+    ##
+    # :attr: resize
+    # 'no' / 'yes'.
+    define_attribute :resize
+
+    ##
+    # :attr: shrink
+    # 'no' / 'yes', allows dialog's children to reduce their size if
+    # the dialog is made smaller.
+    define_attribute :shrink
+
+    ##
+    # :attr: startfocus
+    # Name of widget to gain focus when dialog first shown.
+
+    # --
+    def startfocus
+      attribute_reference('STARTFOCUS', Widget, nil)
+    end
+
+    def startfocus= item # :nodoc:
+      attribute_reference('STARTFOCUS', Widget, item)
+    end
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: close_cb
+    # Sets callback called right before the dialog is closed.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def close_cb= callback # :nodoc:
+      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
+
+    ##
+    # :attr_writer: resize_cb
+    # Callback called when the dialog size is changed.
+    # Callback must respond to +call+ and takes 2 arguments: (width, height).
+    # * +width+ -internal width of canvas (client width)
+    # * +height+ - internal height of canvas (client height)
+
+    # --
+    def resize_cb= callback # :nodoc:
+      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
+
+    ##
+    # :attr_writer: show_cb
+    # Sets callback called right after the dialog visible state changes,
+    # such as from shown to hidden, or maximised to minimised.
+    # Callback must respond to +call+ and takes one argument: (state)
+    # * +state+ - of the change, see {state constants}[../Iup.html#Dialog+show_cb+state] 
+
+    # --
+    def show_cb= callback #:nodoc:
+      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/drag-drop-attributes.rb

@@ -0,0 +1,98 @@
+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
+
+    ##
+    # :attr: dragsource
+    define_attribute :dragsource
+
+    ##
+    # :attr: dragtypes
+    define_attribute :dragtypes
+
+    ##
+    # :attr: dragsourcemove
+    define_attribute :dragsourcemove
+
+    ##
+    # :attr: droptarget
+    define_attribute :droptarget
+
+    ##
+    # :attr: droptypes
+    define_attribute :droptypes
+
+    # :section: Callbacks
+    # callbacks for drag-n-drop
+
+    ##
+    # :attr_writer: dragbegin_cb
+
+    # --
+    def dragbegin_cb= callback
+      define_callback callback, 'DRAGBEGIN_CB', :ii_i
+    end 
+
+    ##
+    # :attr_writer: dragdatasize_cb
+
+    # --
+    def dragdatasize_cb= callback
+      define_callback callback, 'DRAGDATASIZE_CB', :s_i
+    end 
+
+    ##
+    # :attr_writer: dragdata_cb
+    # Note: user data assumed to be a string
+
+    # --
+    def dragdata_cb= callback
+      define_callback callback, 'DRAGDATA_CB', :ssi_i
+    end 
+
+    ##
+    # :attr_writer: dragend_cb
+
+    # --
+    def dragend_cb= callback
+      define_callback callback, 'DRAGEND_CB', :i_i
+    end 
+
+    ##
+    # :attr_writer: dropdata_cb
+    # Note: user data assumed to be a string
+
+    # --
+    def dropdata_cb= callback
+      define_callback callback, 'DROPDATA_CB', :ssiii_i
+    end
+
+    ##
+    # :attr_writer: dropmotion_cb
+
+    # --
+    def dropmotion_cb= callback
+      define_callback callback, 'DROPMOTION_CB', :iis_i
+    end
+  end
+end
+

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

@@ -0,0 +1,22 @@
+module Iup
+
+  # Methods for containers where the child elements can be added after construction.
+  #
+  module DynamicFillMethods
+
+    # Inserts an element at the end of the container, 
+    # after the last element of the container. 
+    def append child
+      IupLib.IupAppend(@handle, child.handle)
+    end
+
+    # Inserts an element before another child of the container. 
+    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,128 @@
+module Iup
+
+  # An expandable container for a single widget. 
+  # The user can show or hide the child widget, as required.
+  #
+  # === Example
+  #
+  # The following places a button in an expandable area, with a 
+  # blue title:
+  #
+  #   bt = Iup::Button.new('Button ONE')
+  #   
+  #   exp = Iup::Expander.new(bt) do |e|
+  #     e.title = 'Expander title'
+  #     e.forecolor = '0 0 255'
+  #   end
+  #
+  class Expander < Iup::Widget
+
+    # Creates an instance of the Expander.
+    # If a block is given, the new instance is yielded to it.
+    # * +child+ - the child widget to display.
+    def initialize child
+      @handle = IupLib.IupExpander(child.handle)
+
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: autoshow
+    # If set, child will be shown when mouse hovers over container.
+    # Values 'yes' / 'no'.
+    define_attribute :autoshow
+
+    ##
+    # :attr: backcolor
+    # Color of background in title area, as "r g b".
+    define_attribute :backcolor
+
+    ##
+    # :attr: barposition
+    # Position of expander bar, as 'top' / 'bottom' / 'left' / 'right'.
+    define_attribute :barposition
+
+    ##
+    # :attr: barsize
+    # Size of bar - defaults to text line height + 5.
+    define_attribute :barsize
+
+    ##
+    # :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: forecolor
+    # Color of text in title area, as "r g b".
+    define_attribute :forecolor
+
+    ##
+    # :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: state
+    # Show or hide child, as 'open' / 'close'.
+    define_attribute :state
+
+    ##
+    # :attr: title
+    # Displayed on box in title area.
+    define_attribute :title
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: action
+    # Callback called after the expander state is interactively changed.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def action= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'action callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'ACTION', :plain
+    end
+
+    ##
+    # :attr_writer: openclose_cb
+    # Callback called before the expander state is interactively changed.
+    # Callback must respond to +call+ and take no arguments, returning 
+    # new state or Iup::IGNORE.
+
+    # --
+    def openclose_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'openclose_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'OPENCLOSE_CB', :plain
+    end
+  end
+end