iup-ffi 0.12.0

data/lib/wrapped/menuitem.rb

@@ -0,0 +1,80 @@
+module Iup
+
+  # A menu item is 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.
+  #
+  # == Attributes
+  #
+  # autotoggle:: Sets auto toggle for item when menu activated, values 'yes' / 'no'.
+  # hidemark:: If set, hides the mark. Values 'yes' / 'no'.
+  # image:: Image used when check enabled.
+  # impress:: Image used when check disabled.
+  # title:: Label to display on menu item.
+  # titleimage:: Image to show on menu item.
+  # value:: Determines if check is enabled or not, values 'off' / 'on'.
+  # wid:: <b>read-only</b> Native widget identifier.
+  #
+  class MenuItem < Widget
+
+    # Creates an instance of MenuItem.
+    #
+    # title:: Label to display
+    # callback:: Optional action to call when MenuItem is clicked.
+    # block:: Optional block to set up menu item's attributes.
+    def initialize title, callback = nil, &block
+      @handle = IupLib.IupItem title, nil
+
+      action callback unless callback.nil?
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_attribute :autotoggle
+    define_attribute :hidemark
+
+    def image val=nil # :nodoc:
+      attribute_reference 'IMAGE', ImageWidget, val
+    end
+
+    def iminactive val=nil # :nodoc:
+      attribute_reference 'IMINACTION', ImageWidget, val
+    end
+
+    define_attribute :title
+
+    def titleimage val=nil # :nodoc:
+      attribute_reference 'TITLEIMAGE', ImageWidget, val
+    end
+
+    define_attribute :value
+    define_attribute :wid
+
+    # -- callbacks
+
+    # Action generated when the element is activated.
+    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
+
+    # Action generated when the item is highlighted.
+    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,51 @@
+module Iup
+
+  # A MessageDialog is used to display a message along with one or more buttons.
+  #
+  # Also see: Iup#message 
+  #
+  # == Attributes
+  #
+  # buttondefault:: Index of default button, '1' / '2' / '3'.
+  # buttonresponse:: Index of the pressed button, '1' / '2' / '3'.
+  # buttons:: Choice of buttons to display: 'OK' / 'OKCANCEL' / 'RETRYCANCEL' / 'YESNO' / 'YESNOCANCEL'. 
+  #           If help_cb is defined, then a 'help' button is also displayed.
+  # dialogtype:: Selects the icon to display: 
+  #              'error' / 'information' / 'message' / 'question' / 'warning'.
+  # 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.
+  # title:: Title text for the message dialog.
+  # value:: Message text to display within the dialog.
+  #
+  class MessageDialog < Widget
+
+    # Creates a dialog, using the optional block to set its attributes.
+    def initialize &block
+      @handle = IupLib.IupMessageDlg
+
+      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 :buttondefault
+    define_attribute :buttonresponse
+    define_attribute :buttons
+    define_attribute :dialogtype
+
+    def parentdialog parent=nil # :nodoc:
+      attribute_reference 'PARENTDIALOG', Dialog, parent
+    end
+
+    define_attribute :title
+    define_attribute :value
+  end
+end
+

data/lib/wrapped/progressbar.rb

@@ -0,0 +1,48 @@
+module Iup
+
+  # A progress bar control, showing a percent-complete value.
+  #
+  # == Attributes
+  #
+  # dashed:: Changes style of progress bar to a dashed pattern, as 'yes' / 'no'.
+  # expand:: Allows bar to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # marquee:: Displays an undefined state if set. Values 'yes' / 'no'.
+  # max:: maximum value, default 1.
+  # min:: minimum value, default 0.
+  # orientation:: 'horizontal' / 'vertical'.
+  # 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".
+  # screenposition:: <b>read-only</b> returns position in pixels on screen
+  #                  as "x,y".
+  # tip:: Tooltip string.
+  # value:: number between +min+ and +max+, for current position.
+  #
+  class ProgressBar < Widget
+
+    # Creates an instance of a progress bar.
+    # block:: optional block to set up the widget's appearance.
+    def initialize &block
+      @handle = IupLib.IupProgressBar
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_attribute :dashed
+    define_attribute :expand
+    define_attribute :marquee
+    define_attribute :max
+    define_attribute :min
+    define_attribute :orientation
+    define_readonly :position
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :tip
+    define_attribute :value
+
+  end
+end

data/lib/wrapped/progressdialog.rb

@@ -0,0 +1,111 @@
+module Iup
+
+  # A dialog to show the progress of an operation.
+  #
+  # == Attributes
+  #
+  # count:: n, number of iterations completed so far.
+  # description:: The text to show within the dialog, describing operation.
+  # inc:: n, <b>write-only</b> increases progress by +n+.
+  # 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.
+  # percent:: n, current percent of iterations.
+  # state:: current state of the iteration, values 'idle' / 'processing' / 
+  #         'undefined' / 'aborted'.
+  # title:: Title text for the progress dialog.
+  # totalcount:: n, total number of iterations to complete.
+  #
+  class ProgressDialog < Widget
+    include AttributeReference
+
+    # Creates an instance of the dialog.
+    # block:: optional block to set up the dialog's attributes.
+    def initialize &block
+      @handle = IupLib.IupProgressDlg
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given? 
+    end
+
+    # Hides the dialog.
+    def hide
+      IupLib.IupHide @handle
+    end
+
+    # Shows the dialog, at an optional (x, y) 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
+
+    define_attribute :count
+    define_attribute :description
+    define_writeonly :inc
+
+    def parentdialog parent=nil # :nodoc:
+      attribute_reference 'PARENTDIALOG', Dialog, parent
+    end
+
+    define_attribute :percent
+    define_attribute :state
+    define_attribute :title
+    define_attribute :totalcount
+
+    # -- callbacks
+
+    # Action generated when the user clicked on the Cancel button.
+    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
+
+    # 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 dialog 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/radio.rb

@@ -0,0 +1,43 @@
+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, which 
+  # is the child widget.
+  #
+  # == Attributes
+  #
+  # clientoffset:: read-only, returns current offset of frame in its client
+  #                as "widthxheight".
+  # clientsize:: read-only, returns current size of frame as "widthxheight".
+  # expand:: Allows container to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # position:: <b>read-only</b> returns position in pixels within client window
+  #            as "x,y".
+  # value:: Name identifier of the active toggle.
+  # value_handle:: Changes the active toggle to given name.
+  #
+  class Radio < Widget
+
+    # Creates an instance of the radio container.
+    # toggles:: a vbox or hbox containing the toggle controls
+    # block:: optional block to set up the container's attributes.
+    def initialize toggles, &block
+      @handle = IupLib.IupRadio toggles.handle
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_readonly :clientoffset
+    define_readonly :clientsize
+    define_attribute :expand
+    define_readonly :position
+    define_attribute :value
+    define_attribute :value_handle
+  end
+end
+

data/lib/wrapped/scintilla.rb

@@ -0,0 +1,277 @@
+module Iup
+
+  # Scintilla widget
+  #--
+  # TODO: This class's actions are incomplete
+  #
+  class Scintilla < Widget
+    @@opened = false
+
+    def initialize &block
+      unless @@opened
+        # make sure the scintilla library is opened on first use
+        ScintillaLib.IupScintillaOpen
+        @@opened = true
+      end
+      @handle = ScintillaLib.IupScintilla
+
+      self.instance_eval &block if block_given?
+    end
+
+    # -- general
+
+    define_attribute :border
+    define_attribute :canfocus
+    define_attribute :clipboard
+    define_attribute :cursor
+    define_attribute :overwrite
+    define_attribute :readonly
+    define_attribute :savedstate
+    define_attribute :size
+    define_attribute :usepopup
+    define_attribute :visiblecolumns
+    define_attribute :visiblelines
+    define_readonly :visiblelinescount
+    define_attribute :wordwrap
+    define_attribute :wordwrapvisualflags
+
+    # -- text retrieval / modification
+
+    define_writeonly :append
+    define_id_readonly :char
+    define_writeonly :clearall
+    define_readonly :count
+    define_writeonly :deleterange
+    define_id_writeonly :insert
+    define_id_readonly :line
+    define_readonly :linecount
+    define_readonly :linevalue
+    define_writeonly :prepend
+    define_attribute :value
+
+    # -- annotation
+
+    define_id_attribute :annotationtext
+    define_id_attribute :annotationstyle
+    define_attribute :annotationstyleoffset
+    define_attribute :annotationvisible
+    define_attribute :annotationclearall
+
+    # -- auto-completion
+
+    define_id_writeonly :autocshow
+    define_writeonly :autoccancel
+    define_readonly :autocactive
+    define_readonly :autocposstart
+    define_writeonly :autoccomplete
+    define_writeonly :autocselect
+    define_readonly :autocselectedindex
+    define_attribute :autocdroprestofword
+    define_attribute :autocmaxheight
+    define_attribute :autocmaxwidth
+
+    # -- brace highlighting
+
+    define_writeonly :bracehighlight
+    define_writeonly :bracebadlight
+    define_id_readonly :bracematch
+
+    # -- caret and selection
+
+    define_attribute :caret
+    define_attribute :caretpos
+    define_writeonly :carettoview
+    define_attribute :selectedtext
+    define_attribute :selection
+    define_attribute :selectionpos
+
+    # -- folding
+
+    define_writeonly :foldflags
+    define_id_attribute :foldlevel
+    define_writeonly :foldtoggle
+
+    # -- lexer
+
+    define_id_writeonly :keywords
+    define_readonly :keywordsets
+    define_attribute :lexerlanguage
+    define_writeonly :loadlexerlibrary
+    define_property_attribute :property
+    define_attribute :propertynames     # TODO: better syntax needed
+
+    # -- margins
+
+    define_id_attribute :marginmaskfolders
+    define_id_attribute :marginsensitive
+    define_id_attribute :margintype
+    define_id_attribute :marginwidth
+    define_id_attribute :marginleft
+    define_id_attribute :marginright
+    define_id_attribute :margintext
+    define_id_attribute :margintextstyle
+    define_id_attribute :margintextclearall
+    define_id_attribute :margincursor
+
+    # -- markers
+
+    define_property_writeonly :markerdefine
+    define_id_attribute :markersymbol
+    define_id_writeonly :markerfgcolor
+    define_id_writeonly :bgcolor
+    define_id_writeonly :markerbgcolorsel
+    define_id_writeonly :markeralpha
+    define_id_writeonly :markerrgbimage
+    define_id_writeonly :markerrgbimagescale
+    define_attribute :markerhighlight
+    define_id_writeonly :markeradd
+    define_id_writeonly :markerdelete
+    define_id_writeonly :markerdeleteall
+    define_id_readonly :markerget
+    define_id_writeonly :markernext
+    define_id_writeonly :markerprevious
+    define_id_readonly :markerlinefromhandle
+    define_writeonly :markerdeletehandle
+    define_readonly :lastmarkeraddhandle
+    define_readonly :lastmarkerfound
+
+    # -- scrolling
+
+    define_attribute :scrollbar
+    define_writeonly :scrollto
+    define_writeonly :scrolltocaret
+    define_writeonly :scrolltopos
+    define_attribute :scrollwidth
+
+    # -- search and replace
+
+    define_writeonly :searchintarget
+    define_attribute :searchflags
+    define_attribute :targetstart
+    define_attribute :targetend
+    define_writeonly :targetfromselection
+    define_writeonly :replacetarget
+
+    # -- style definition
+
+    define_id_attribute :stylebgcolor
+    define_id_attribute :stylebold
+    define_id_attribute :stylecase
+    define_id_attribute :stylecharset
+    define_attribute :styleclearall
+    define_id_attribute :styleeolfilled
+    define_id_attribute :stylefgcolor
+    define_id_attribute :stylefont
+    define_id_attribute :stylefontsize
+    define_id_attribute :stylefontsizefrac
+    define_id_attribute :stylehotspot
+    define_id_attribute :styleitalic
+    define_id_attribute :stylereset
+    define_id_attribute :styleunderline
+    define_id_attribute :stylevisible
+    define_id_attribute :styleweight
+
+    # -- styling
+
+    define_writeonly :cleardocumentstyle
+    define_writeonly :startstyling
+    define_id_writeonly :styling
+
+    # -- tabs and indentation
+
+    define_attribute :tabsize
+    define_attribute :indentationguides
+    define_attribute :highlightguide
+    define_attribute :usetabs
+
+    # -- undo and redo
+
+    define_attribute :redo
+    define_attribute :undo
+    define_attribute :undocollect
+
+    # -- white space
+
+    define_attribute :extraascent
+    define_attribute :extradescent
+    define_attribute :whitespaceview
+    define_attribute :whitespacesize
+    define_writeonly :whitespacefgcolor
+    define_writeonly :whitespacebgcolor
+
+    # -- zooming
+
+    define_writeonly :zoomin
+    define_writeonly :zoomout
+    define_attribute :zoom
+
+    # -- standard
+
+    define_attribute :expand
+    define_readonly :position
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :tip
+
+    # -- callbacks
+
+    # Action generated when the text is edited, but before its value is actually changed.
+    # action takes a 4-argument callback: code, position, length, text
+    # called when indexed item is selected
+    # code is 1 for inserted text, 0 for deleted text
+    # note: text will be null if code is 0 (deleted)
+    def action callback
+      unless callback.arity == 4
+        raise ArgumentError, 'action callback must take 4 arguments: (code, position, length, text)'
+      end
+      cb = Proc.new do |ih, insert, pos, length, text|
+        callback.call insert, pos, length, text
+      end
+      define_callback cb, 'ACTION', :iiis_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
+
+    # 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