iup-ffi 0.13.0-x86_64-linux

data/lib/wrapped/menuitem.rb

@@ -0,0 +1,150 @@
+module Iup
+
+  # A menu item is the interactive part of a menu, and acts like a button.
+  # The menu item can display a simple text label, an image, 
+  # or act as a check box. When placed within a menu with the +radio+ 
+  # flag set, several menu items can act as a radio button group within
+  # a menu.
+  #
+  # === Example
+  #
+  # (1) Item with text and action.
+  #
+  #   item_exit = Iup::MenuItem.new('Exit', ->{ Iup::CLOSE })
+  #
+  # (2) Checkbox
+  #
+  #  show_toolbar = Iup::MenuItem.new('Show toolbar') do |i|
+  #    i.value = :off # assign a value to make menu item a checkbox
+  #    i.autotoggle = :yes # allow value to change when menu item clicked
+  #  end
+  #
+  # Placing a set of checkbox menuitems into a Menu with +radio+ set
+  # turns the menuitems into a linked radio group.
+  #
+  # See also: Menu, Separator, SubMenu.
+  #
+  class MenuItem < Iup::Widget
+
+    # Creates a new instance.
+    # If a block is given, the new instance is yielded to it.
+    #
+    # * +title+ - text to display
+    # * +callback+ - Optional action to call when clicked with left button.
+    def initialize(title, callback = nil)                   
+      @handle = IupLib.IupItem(title, nil)
+
+      self.action = callback unless callback.nil?
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: autotoggle
+    # Sets auto toggle for item when menu activated, values 'yes' / 'no'.
+    # i.e. the menu item's check status is inverted when clicked.
+    define_attribute :autotoggle
+
+    ##
+    # :attr: hidemark
+    # If set, hides the mark. Values 'yes' / 'no'.
+    define_attribute :hidemark
+
+    ##
+    # :attr: image
+    # Image name or instance to show on menu when check enabled.
+    # 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
+    # Image name or instance to show on menu when check disabled.
+    # 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: title
+    # Title text to display on menu item.
+    define_attribute :title
+
+    ##
+    # :attr: titleimage
+    # Image name or instance to show on menu item.
+    # This can use an actual image object, or the name of an image 
+    # from +IupImageLib+.
+
+    # --
+    def titleimage
+      attribute_reference('TITLEIMAGE', ImageWidget, nil)
+    end
+
+    def titleimage= val # :nodoc:
+      attribute_reference('TITLEIMAGE', ImageWidget, val)
+    end
+
+    ##
+    # :attr: value
+    # Determines if check is enabled or not, values 'off' / 'on'.
+    define_attribute :value
+
+    ##
+    # :attr_reader: wid
+    # Native widget identifier.
+    define_attribute :wid
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: action
+    # Callback called when the element is activated.
+    # 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: highlight_cb
+    # Callback called when the item is highlighted.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    def highlight_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'highlight_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'HIGHLIGHT_CB', :plain
+    end
+  end
+end

data/lib/wrapped/messagedialog.rb

@@ -0,0 +1,127 @@
+module Iup
+
+  # Creates and shows an AlarmDialog, returning the number of the button clicked.
+  #
+  # * +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
+  #
+  # Returns index of clicked button (1, 2 or 3).
+  #
+  #   result = Iup.alarm("Vegetable time", "Pick a vegetable", "cabbage", "carrots", "peas")
+  #
+  # Also see: MessageDialog
+  #
+  def self.alarm title, msg, button1, button2=nil, button3=nil
+    IupLib.IupAlarm(title, msg, button1, button2, button3)
+  end
+
+  # Convenience function to show a MessageDialog with given title and displayed
+  # message value. This is an "information" dialog, with a single button
+  # labelled "ok".
+  #
+  #    Iup.message("About", <<MSG)
+  #        My Ruby Application
+  #  
+  #       Date: January 2026
+  #    MSG
+  #
+  # Also see: MessageDialog
+  #
+  def self.message(title, value)
+    IupLib.IupMessage(title, value)
+  end
+
+  # A predefined modal dialog used to display a message and requesting
+  # one of a constrained choice of responses.
+  #
+  # === Example
+  #
+  # The following example shows off many of the features, setting up a 
+  # question-type dialog with three buttons and a default response of "no":
+  #
+  #   md = Iup::MessageDialog.new do |d|
+  #     d.title = "Example MessageDialog" 
+  #     d.dialogtype = 'question' 
+  #     d.value = "Should we do this?"
+  #     d.buttons = 'yesnocancel' 
+  #     d.buttondefault = 2
+  #   end
+  #   md.popup 
+  #   puts "Clicked button is: #{md.buttonresponse}"
+  #
+  # Note that +popup+ must be used to show the dialog.
+  #
+  # Also see: Iup.message 
+  #
+  class MessageDialog < Iup::Widget
+
+    # Creates a new dialog.
+    # If a block is given, the new instance is yielded to it.
+    def initialize 
+      @handle = IupLib.IupMessageDlg
+
+      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: buttondefault
+    # Index of default button, '1' / '2' / '3'.
+    define_attribute :buttondefault
+
+    ##
+    # :attr: buttonresponse
+    # Index of the pressed button, '1' / '2' / '3'.
+    define_attribute :buttonresponse
+
+    ##
+    # :attr: buttons
+    # Choice of buttons to display: 'OK' / 'OKCANCEL' / 'RETRYCANCEL' / 'YESNO' / 'YESNOCANCEL'. 
+    # If help_cb is defined, then a 'help' button is also displayed.
+    define_attribute :buttons
+
+    ##
+    # :attr: dialogtype
+    # Selects the icon to display: 
+    # 'error' / 'information' / 'message' / 'question' / 'warning'.
+    define_attribute :dialogtype
+
+    ##
+    # :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: title
+    # Title text for the message dialog.
+    define_attribute :title
+
+    ##
+    # :attr: value
+    # Message text to display within the dialog.
+    define_attribute :value
+  end
+end
+

data/lib/wrapped/progressbar.rb

@@ -0,0 +1,91 @@
+module Iup
+
+  # A progress bar control, showing a percent-complete value.
+  # Typically used to show the progress of a long-running task 
+  # running within a Timer.
+  #
+  # === Example
+  #
+  # The following creates a vertical bar, starting at a value of 25 out of 50.
+  #
+  #   Iup::ProgressBar.new do |p|
+  #     p.orientation = 'vertical'
+  #     p.bgcolor = '255 0 128'
+  #     p.fgcolor = '0 128 0'
+  #     p.rastersize = '30x100'
+  #     p.max = 50
+  #     p.value = 25
+  #   end
+  # 
+  # Also see: ProgressDialog, Timer.
+  #
+  class ProgressBar < Iup::Widget
+
+    # Creates an instance of a progress bar.
+    # If a block is given, the new instance is yielded to it.
+    def initialize
+      @handle = IupLib.IupProgressBar
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: dashed
+    # Changes style of progress bar to a dashed pattern, as 'yes' / 'no'.
+    define_attribute :dashed
+
+    ##
+    # :attr: expand
+    # Allows bar to fill available space in indicated direction.
+    # Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+    define_attribute :expand
+
+    ##
+    # :attr: marquee
+    # Displays an undefined state if set. Values 'yes' / 'no'.
+    define_attribute :marquee
+
+    ##
+    # :attr: max
+    # maximum value, default 1.
+    define_attribute :max
+
+    ##
+    # :attr: min
+    # minimum value, default 0.
+    define_attribute :min
+
+    ##
+    # :attr: orientation
+    # '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 widget, 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: value
+    # number between +min+ and +max+, for current position.
+    define_attribute :value
+  end
+end

data/lib/wrapped/progressdialog.rb

@@ -0,0 +1,85 @@
+module Iup
+
+  # A predefined dialog to show the progress of an operation.
+  # It is often used alongside a Iup::Timer, which triggers 
+  # updates at regular intervals.
+  #
+  # === Example
+  #
+  #   dlg = Iup::ProgressDialog.new do |d|
+  #     d.title = "Progress on task ..."
+  #     d.description = "... taking a long time"
+  #     d.totalcount = 100
+  #     d.count = 30
+  #     d.cancel_cb = ->{
+  #       puts "Task cancelled"
+  #       Iup::CLOSE
+  #     }
+  #   end
+  #   dlg.show
+  #
+  # The dialog is meant to be shown using +show+.
+  #
+  class ProgressDialog < Iup::Dialog
+
+    # Creates an instance of the dialog.
+    # If a block is given, the new instance is yielded to it.
+    def initialize
+      @handle = IupLib.IupProgressDlg
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given? 
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: count
+    # n, number of iterations completed so far.
+    define_attribute :count
+
+    ##
+    # :attr: description
+    # The text to show within the dialog, describing operation.
+    define_attribute :description
+
+    ##
+    # :attr_writer: inc
+    # n, increases progress by +n+.
+    define_writer :inc
+
+    ##
+    # :attr: percent
+    # n, current percent of iterations.
+    define_attribute :percent
+
+    ##
+    # :attr: state
+    # current state of the iteration, values 'idle' / 'processing' / 'undefined' / 'aborted'.
+    define_attribute :state
+
+    ##
+    # :attr: totalcount
+    # n, total number of iterations to complete.
+    define_attribute :totalcount
+
+    # :section: Callbacks
+
+    ##
+    # :attr_writer: cancel_cb
+    # Callback called when the user clicked on the Cancel button.
+    # Callback must respond to +call+ and take no arguments.
+    # Returns different to Iup::CONTINUE will set state to 'aborted'.
+
+    # --
+    def cancel_cb= callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'cancel_cb callback must take 0 arguments'
+      end
+      cb = Proc.new do |ih|
+        callback.call
+      end
+      define_callback cb, 'CANCEL_CB', :plain
+    end
+  end
+end

data/lib/wrapped/radio.rb

@@ -0,0 +1,74 @@
+module Iup
+
+  # A Radio container is used to group toggle controls together, so that only one 
+  # out of the group will be active at a time.
+  #
+  # To use the Radio control, place the toggle controls within a vbox/hbox and 
+  # add to the radio control.
+  #
+  # === Example
+  #
+  # This example sets up two options: Perl and Ruby. Notice the use of 
+  # +assign_handle+ in the toggles to provide a meaningful name to the radio
+  # group's current +value+:
+  # 
+  #   perl = Iup::Toggle.new('Perl') do |t|
+  #     t.assign_handle 'perl'
+  #   end
+  # 
+  #   ruby = Iup::Toggle.new('Ruby') do |t|
+  #     t.assign_handle 'ruby'
+  #   end
+  # 
+  #   exclusive = Iup::Radio.new(Iup::VBox.new(perl, ruby)) do |r|
+  #     r.value = 'ruby'
+  #   end
+  #
+  class Radio < Iup::Widget
+    include DynamicFillMethods
+
+    # Creates an instance of the radio container.
+    # If a block is given, the new instance is yielded to it.
+    # * +toggles+ - a vbox or hbox containing the toggle controls
+    def initialize toggles
+      @handle = IupLib.IupRadio(toggles.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 container 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: value
+    # Name identifier of the active toggle.
+    define_attribute :value
+
+    ##
+    # :attr: value_handle
+    # Changes the active toggle to given name.
+    define_attribute :value_handle
+  end
+end
+