iup-ffi 0.12.0

data/lib/wrapped/text.rb

@@ -0,0 +1,225 @@
+module Iup
+
+  # A Text control is one of the more complex controls, because it can be 
+  # displayed in a variety of ways:
+  #
+  # (1) a single line, for inputting a single line of text.
+  #
+  #   Text.new do
+  #     expand 'horizontal'
+  #     nc 5
+  #   end
+  #
+  # (2) a multi-line control, to act more like an editor.
+  #
+  #   Text.new do
+  #     multiline 'yes'
+  #     expand 'yes'
+  #     size '200x100'
+  #   end
+  #
+  # (3) a spin box, for selecting one of several values.
+  #
+  #   Text.new do
+  #     spin 'yes'
+  #     spinmax 20
+  #     spinmin 10
+  #     expand 'horizontal'
+  #     spin_cb ->(v){
+  #       puts "spin control is now #{v}"
+  #       DEFAULT
+  #     }
+  #   end
+  #
+  # == Attributes
+  #
+  # alignment:: Sets the alignment of text within control,
+  #             options ALEFT, ACENTER, ARIGHT or none.
+  # append:: <b>write-only</b> appends given string to end of text.
+  # autohide:: If set, scrollbars are only shown if necessary, values 'yes' / 'no'.
+  # border:: Sets border around text, values 'yes' / 'no'.
+  # canfocus:: If set, the control can gain focus, values 'yes' / 'no'.
+  # caret:: 'col' in single-line mode, sets column number of caret;
+  #         'lin,col' in multi-line mode, sets line and column number of caret.
+  # caretpos:: Index of character of the insertion point.
+  # clipboard:: 'clear' / 'copy' / 'cut' / 'paste', <b>write-only</b> access the 
+  #             clipboard with the current selection.
+  # count:: <b>read-only</b> number of characters in text.
+  # expand:: Allows control to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # formatting:: Set to 'yes' in multi-line mode, to allow control to use 
+  #              formatting of text.
+  # insert:: <b>write-only</b> Places a given string at current caret position, 
+  #          overwriting any current selection.
+  # linecount:: <b>read-only</b> returns number of lines of text.
+  # linevalue:: <b>read-only</b> returns line of text where the caret is.
+  # mask:: Defines a mask to filter text input.
+  # multiline:: 'no' / 'yes'
+  # nc:: Maximum number of characters allowed for keyboard input (0 allows an indefinite number).
+  # overwrite:: 'off' / 'on', used when formatting=yes.
+  # padding:: Margin in x and y directions, value as "mxn".
+  # password:: 'yes' / 'no', if set, masks the input text as "*". 
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # rastersize:: Size of the list, in pixels, value as "widthxheight".
+  # readonly:: 'yes' / 'no'.
+  # screenposition:: <b>read-only</b> returns position in pixels on screen
+  #                  as "x,y".
+  # scrollbar:: In multi-line mode, selects 'no' / 'horizontal' / 'vertical' / 'yes' (for both) scrollbars.
+  # scrollto:: <b>write-only</b> 
+  #            'col' Scrolls to make given column number visible, 
+  #            in single-line mode.
+  #            'lin/col' Scrolls to make line and column number visible,
+  #            in multi-line mode.
+  # scrolltopos:: <b>write-only</b> Scrolls to make character 'number' visible.
+  # selectedtext:: Reads or overwrites the current selection. 
+  #                Does nothing if no text is selected.
+  # selection:: Selects text as 'col1:col2' (single-line) / 'lin1,col1:lin2,col2' (multi-line) / 'all' / 'none'.
+  # selectionpos:: Selects text between character positions: 'pos1:pos2' / 'all' / 'none'.
+  # spin:: 'no' / 'yes', attaches a spin control to the text box.
+  # spinalign:: 'right' / 'left', with respect to the text (GTK always 'right').
+  # spinauto:: 'yes' / 'no', updates value of control when spin buttons used.
+  #            When 'no', "spin_cb" must adjust the value.
+  # spininc:: Increment value, defaults to 1.
+  # spinmax:: Maximum spin value, defaults to 100.
+  # spinmin:: Minimum spin value, defaults to 1.
+  # spinvalue:: Current value of spin, defaults to 1.
+  # spinwrap:: 'no' / 'yes', automatically wraps spin at ends of range, when set.
+  # tabsize:: In multi-line mode, controls number of spaces used for a tab, defaults to 8.
+  # tip:: Tooltip string.
+  # value:: Retrieves or sets the text.
+  # valuemasked:: Retrieves or sets the text, applying +MASK+ when setting.
+  # visiblecolumns:: The minimum number of visible columns, defaults to 5.
+  # visiblelines:: The minimum number of visible lines, when dropdown=no.
+  # wordwrap:: 'no' / 'yes', when multiline=yes.
+  #
+  #--
+  # TODO Formatting
+  #
+  class Text < Widget
+    include DragDropAttributes
+
+    def initialize &block
+      @handle = IupLib.IupText nil
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_attribute :alignment
+    define_writeonly :append
+    define_attribute :autohide
+    define_attribute :border
+    define_attribute :canfocus
+    define_attribute :caret
+    define_attribute :caretpos
+    define_attribute :clipboard
+    define_readonly :count
+    define_attribute :expand
+    define_attribute :formatting
+    define_writeonly :insert
+    define_readonly :linecount
+    define_readonly :linevalue
+    define_attribute :mask
+    define_attribute :multiline
+    define_attribute :nc
+    define_attribute :overwrite
+    define_attribute :padding
+    define_attribute :password
+    define_attribute :position
+    define_attribute :rastersize
+    define_attribute :readonly
+    define_readonly :scrollbar
+    define_attribute :scrollto
+    define_attribute :scrolltopos
+    define_attribute :selectedtext
+    define_attribute :selection
+    define_attribute :selectionpos
+    define_attribute :spin
+    define_attribute :spinalign
+    define_attribute :spinauto
+    define_attribute :spininc
+    define_attribute :spinmax
+    define_attribute :spinmin
+    define_attribute :spinvalue
+    define_attribute :spinwrap
+    define_attribute :tabsize
+    define_attribute :tip
+    define_attribute :value
+    define_attribute :valuemasked
+    define_attribute :visiblecolumns
+    define_attribute :visiblelines
+    define_attribute :wordwrap
+
+    # -- callbacks
+
+    # Action generated when the text is edited, but before its value is actually changed.
+    # action takes a 2-argument callback, the character typed and the new value.
+    def action callback
+      unless callback.arity == 2
+        raise ArgumentError, 'action callback must take 2 argument: (character, new-text)'
+      end
+      cb = Proc.new do |ih, c, text|
+        callback.call c, text
+      end
+      define_callback cb, 'ACTION', :is_i
+    end
+
+    include ButtonCallback
+
+    # Action generated when the caret/cursor position is changed. 
+    # caret_cb takes a callback which accepts 3 arguments (line, column, position) of caret
+    def caret_cb callback
+      unless callback.arity == 3
+        raise ArgumentError, 'caret_cb callback must take 3 arguments: (line, column, position)'
+      end
+      cb = Proc.new do |ih, lin, col, pos|
+        callback.call lin, col, pos
+      end
+      define_callback cb, 'CARET_CB', :iii_i
+    end
+
+    # Action generated when the mouse is moved.
+    # Callback 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.
+    #--
+    # TODO: include functions, as in button_cb
+    #
+    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
+
+    # Action generated when a spin button is pressed. Valid only when SPIN=YES.
+    # spin takes a 1-argument callback, the value of spin.
+    def spin_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'spin_cb callback must take 1 argument, the value'
+      end
+      cb = Proc.new do |ih, val|
+        callback.call val
+      end
+      define_callback cb, 'SPIN_CB', :i_i
+    end
+
+    # Called after the value was interactively changed by the user.
+    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/timer.rb

@@ -0,0 +1,42 @@
+module Iup
+
+  class Timer
+    extend AttributeBuilders
+    include CallbackSetter
+
+    attr_reader :handle
+
+    def initialize &block
+      @handle = IupLib.IupTimer
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # must be called when Timer is finished with
+    def destroy
+      IupLib.IupDestroy @handle
+    end
+
+    # -- attributes
+
+    define_attribute :time
+    define_attribute :run
+    define_readonly :wid
+
+    # -- callbacks
+
+    # Called when the time is up.
+    # Return CLOSE to end application.
+    def action_cb callback
+      unless callback.arity.zero?
+        raise ArgumentError, 'action_cb 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/toggle.rb

@@ -0,0 +1,98 @@
+module Iup
+
+  # A Toggle control is a control that can have two or three states.
+  # The toggle control will display some text or an image.
+  #
+  # == Attributes
+  #
+  # alignment:: Sets the horizontal and vertical alignment.
+  #             The value is a string "horizontal:vertical", with 
+  #             options ALEFT, ACENTER, ARIGHT or none.
+  # canfocus:: Enables the control to gain focus. Values 'yes' / 'no'.
+  # expand:: Allows control to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # flat:: If set, hides the control's border until mouse enters the button area.
+  #        Values 'yes' / 'no'.
+  # image:: Sets the image to display. 
+  #         This can be an actual image object, or the name of an image.
+  # iminactive:: Sets the image to display when inactive.
+  # impress:: Sets the image to display when pressed.
+  # padding:: Margin in x and y directions, value as "mxn".
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # radio:: <b>read-only</b> Returns 'yes' / 'no' if toggle within a radio control.
+  # rastersize:: Size of the control, in pixels, value as "widthxheight".
+  # screenposition:: <b>read-only</b> returns position in pixels on screen
+  #                  as "x,y".
+  # three_state:: 'no' / 'yes', 3-state only for text labels
+  # tip:: Tooltip string.
+  # title:: text to display.
+  # value:: 'on' / 'off' / 'toggle' / 'notdef' (for 3-state toggles).
+  #
+  class Toggle < Widget
+    include ImageAttributes
+
+    # Creates an instance of a Toggle control.
+    # title:: optional text to display
+    # arg:: optional name of action to perform when state changed
+    # block:: optional block to set up attributes.
+    def initialize title=nil, arg='', &block
+      @handle = IupLib.IupToggle title, arg
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_attribute :alignment
+    define_attribute :canfocus
+    define_attribute :expand
+    define_attribute :flat
+    define_attribute :padding
+    define_readonly :position
+    define_attribute :radio
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :tip
+    define_attribute :title
+    define_attribute :value
+
+    def three_state val=nil # :nodoc:
+      if val.nil?
+        IupLib.IupGetAttribute(@handle, '3STATE').first
+      else
+        IupLib.IupGetAttribute(@handle, '3STATE', val).first
+      end
+    end
+
+    # -- callbacks
+
+    # Action generated when the toggle's state (on/off) was changed.
+    # action takes a 1-argument callback, the argument 
+    # indicating the state change.
+    # state_change == 1 if state changed to "on"
+    # state_change == 0 if state changed to "off"
+    def action callback
+      unless callback.arity == 1 
+        raise ArgumentError, 'action callback must take 1 argument, the state_change'
+      end
+      cb = Proc.new do |ih, state_change|
+        callback.call state_change.to_i
+      end
+      define_callback cb, 'ACTION', :i_i
+    end
+
+    # Called after the value was interactively changed by the user. 
+    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
+