iup-ffi 0.12.0

data/lib/wrapped/canvas.rb

@@ -0,0 +1,467 @@
+module Iup
+
+  # A Canvas is a working area for the application.
+  # 
+  # Many methods working on the Canvas are drawn from the CD library:
+  # http://webserver2.tecgraf.puc-rio.br/cd/
+  #
+  # In this example, notice how the dialog is mapped, the canvas initialised,
+  # and finally the dialog is shown. 
+  #
+  #   mainloop do
+  #     cnv = Canvas.new do
+  #       rastersize '300x200'
+  #       action ->(x, y){ # called on redraw: (x,y) refer to scrollbar positions, if used
+  #         clear
+  #         foreground CD_BLUE
+  #         box 10, 100, 10, 100
+  #         foreground CD_RED
+  #         rectangle 10, 100, 10, 100
+  #         text 200, 180, 'hello from Ruby'
+  #         DEFAULT
+  #       }
+  #     end
+  #   
+  #     dlg = Dialog.new VBox.new(cnv){ margin '10x10' } do
+  #       title 'IupCanvas + Canvas Draw'
+  #       size '350x220'
+  #     end.map
+  #   
+  #     cnv.init # this has to be done after mapping the dialog
+  #   
+  #     dlg.show
+  #   end
+  #   
+  #
+  # == Attributes
+  #
+  # canfocus:: Enables the control to gain focus. Values 'yes' / 'no'.
+  # cursor:: Defines the mouse shape / cursor for the canvas.
+  # drawsize:: Size of the drawing area in pixels, as "widthxheight".
+  # expand:: Allows canvas to fill available space in indicated direction.
+  #          Values 'no' / 'horizontal' / 'vertical' / 'yes'.
+  # 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".
+  # rastersize:: Size of the canvas, in pixels, value as "widthxheight".
+  # screenposition:: <b>read-only</b> returns position in pixels on screen
+  # scrollbar:: Selects 'no' / 'horizontal' / 'vertical' / 'yes' (for both) scrollbars.
+  # tip:: Tooltip string.
+  #
+  class Canvas < Widget
+    include DragDropAttributes
+    include ScrollBarAttributes
+
+    # Creates an instance of the canvas.
+    # handle:: an optional Canvas handle.
+    # block:: optional block to set up Canvas attributes.
+    def initialize handle = IupLib.IupCanvas(''), &block
+      @handle = handle
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # This must be called after the widget is mapped, to create and
+    # setup the canvas.
+    def init
+      @canvas = CdLib.cdCreateCanvas CdLib.cdContextIup, @handle
+    end
+
+    # -- attributes
+
+    define_attribute :border
+    define_attribute :canfocus
+    define_attribute :cursor
+    define_attribute :drawsize
+    define_attribute :expand
+    define_attribute :padding
+    define_readonly :position
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :tip
+
+    # -- CD method calls
+
+    # --- initialisation
+
+    # call when canvas no longer needed.
+    def kill
+      CdLib.cdKillCanvas @canvas
+    end
+
+    # call to activate canvas. 
+    # (Not usually needed - depends on driver.)
+    def activate
+      CdLib.cdCanvasActivate @canvas
+    end
+    
+    # call to deactivate canvas. 
+    # (Not usually needed - depends on driver.)
+    def deactivate
+      CdLib.cdCanvasDeactivate @canvas
+    end
+
+    # Used to set coordinates of a viewport (the canvas coordinates).
+    def viewport x1, y1, x2, y2
+      CdLib.wdCanvasViewport @canvas, x1, y1, x2, y2
+    end
+
+    # Used to set coordinates of a window (the world coordinates).
+    def window x1, y1, x2, y2
+      CdLib.wdCanvasWindow @canvas, x1, y1, x2, y2
+    end
+
+    # redraws the underlying canvas.
+    def redraw
+      IupLib.IupRedraw @handle
+    end
+
+    # --- general attributes
+
+    # Sets the foreground colour, if a value is given, else returns current value.
+    #
+    # Colour may be one of:
+    # * string, in form "RR GG BB"
+    # * colour constant, e.g. CD_BLACK, as listed in Iup
+    def foreground colour=CD_QUERY
+      case colour
+      when String # assume in form 'RR GG BB'
+        r, g, b = colour.split(' ').collect &:to_i
+        CdLib.cdCanvasForeground @canvas, CdLib.cdEncodeColor(r, g, b)
+      else
+        CdLib.cdCanvasForeground @canvas, colour
+      end
+    end
+
+    # Sets the background colour, if a value is given, else returns current value.
+    #
+    # Colour may be one of:
+    # * string, in form "RR GG BB"
+    # * colour constant, e.g. CD_BLACK, as listed in Iup
+    def background colour=CD_QUERY
+      case colour
+      when String # assume in form 'RR GG BB'
+        r, g, b = colour.split(' ').collect &:to_i
+        CdLib.cdCanvasBackground @canvas, CdLib.cdEncodeColor(r, g, b)
+      else
+        CdLib.cdCanvasBackground @canvas, colour
+      end
+    end
+
+    # Sets the writing mode for all primitives, if a value is given. 
+    # Else returns the current value. 
+    # See Iup for a list of available writemode values.
+    def writemode mode=CD_QUERY
+      CdLib.cdCanvasWriteMode @canvas, mode
+    end
+
+    # --- control
+  
+    # Clears the canvas.
+    def clear
+      CdLib.cdCanvasClear @canvas
+    end
+
+
+    # --- begin/end blocks
+
+    # Begin the definition of a sequence of vertices.
+    # Valid polygon mode values are listed in Iup.
+    def begin_block mode
+      CdLib.cdCanvasBegin @canvas, mode
+    end
+
+    # Specify a vertex at position (x, y).
+    def vertex x, y
+      CdLib.cdCanvasVertex @canvas, x, y
+    end
+
+    # End the definition of a sequence of vertices.
+    def end_block 
+      CdLib.cdCanvasEnd @canvas
+    end
+
+    # Specify action for next point on path.
+    # Valid path actions are listed in Iup.
+    def pathset action
+      CdLib.cdCanvasPathSet @canvas, action
+    end
+
+    # --- marks
+
+    # Configures pixel (x, y) with colour.
+    def pixel x, y, colour
+      CdLib.cdCanvasPixel @canvas, x, y, colour
+    end
+
+    # Draws a mark at position (x, y).
+    def mark x, y
+      CdLib.cdCanvasMark @canvas, x, y
+    end
+
+    # Sets the marktype, if a value is given, else returns the current value.
+    # See Iup for available marktype values.
+    def marktype type=CD_QUERY
+      CdLib.cdCanvasMarkType @canvas, type
+    end
+
+    # Sets the marksize, if a pixel value is given,
+    # else, returns the current value.
+    def marksize size=CD_QUERY
+      CdLib.cdCanvasMarkSize size
+    end
+
+    # --- lines
+
+    # Draws a line from (x1, y1) to (x2, y2).
+    def line x1, y1, x2, y2
+      CdLib.cdCanvasLine @canvas, x1, y1, x2, y2
+    end
+
+    # Draws a rectangle bounding (xmin, ymin) to (xmax, ymax).
+    def rectangle xmin, xmax, ymin, ymax
+      CdLib.cdCanvasRect @canvas, xmin, xmax, ymin, ymax
+    end
+
+    # Draws an arc of an ellipse - a pie-shaped slice.
+    # Angles are in degrees, counterclockwise.
+    def arc xc, yc, w, h, angle1, angle2
+      CdLib.cdCanvasArc @canvas, xc, yc, w, h, angle1, angle2
+    end
+
+    # Sets linestyle, if a value is given, else returns the current style.
+    # See Iup for available linestyle values.
+    def linestyle style=CD_QUERY
+      CdLib.cdCanvasLineStyle @canvas, style
+    end
+
+    # Sets linewidth, if a pixel value is given, else returns the current width.
+    def linewidth width=CD_QUERY
+      CdLib.cdCanvasLineWidth @canvas, width
+    end
+    
+    # Sets linejoin, if a value is given, else returns the current value.
+    # See Iup for available linejoin values.
+    def linejoin style=CD_QUERY
+      CdLib.cdCanvasLineJoin @canvas, style
+    end
+
+    # Sets linecap, if a value is given, else returns the current value.
+    # See Iup for available linecap values.
+    def linecap style=CD_QUERY
+      CdLib.cdCanvasLineCap @canvas, style
+    end
+
+    # -- filled areas
+
+    # Fills a rectangle, according to current interior style.
+    def box xmin, xmax, ymin, ymax
+      CdLib.cdCanvasBox @canvas, xmin, xmax, ymin, ymax
+    end
+
+    # Fills a sector, according to current interior style.
+    # A sector is an arc of an ellipse - a pie-shaped slice.
+    # Angles are in degrees, counterclockwise.
+    def sector xc, yc, w, h, angle1, angle2
+      CdLib.cdCanvasSector @canvas, xc, yc, w, h, angle1, angle2
+    end
+
+    # Fills a chord, according to current interior style.
+    # A chord is an arc of an ellipse - with the arc points connected.
+    # Angles are in degrees, counterclockwise.
+    def chord xc, yc, w, h, angle1, angle2
+      CdLib.cdCanvasChord @canvas, xc, yc, w, h, angle1, angle2
+    end
+
+    # Sets the opacity, if a value is given, else returns current value.
+    # See Iup for background opacity mode values.
+    def backopacity opacity=CD_QUERY
+      CdLib.cdCanvasBackOpacity @canvas, opacity
+    end
+
+    # Sets the fill mode, if a value is given, else returns current value.
+    # See Iup for fill mode values.
+    def fillmode mode=CD_QUERY
+      CdLib.cdCanvasFillMode @canvas, mode
+    end
+
+    # Sets the interior style, if a value is given, else returns current value.
+    # See Iup for interior style values.
+    def interiorstyle style=CD_QUERY
+      CdLib.cdCanvasInteriorStyle @canvas, style
+    end
+
+    # Sets the hatch style, if a value is given, else returns current value.
+    # See Iup for hatch style values.
+    def hatch style=CD_QUERY
+      CdLib.cdCanvasHatch @canvas, style
+    end
+
+    # fgbg is a string representing the stipple pattern in binary
+    def stipple w, h, fgbg
+      CdLib.cdCanvasStipple @canvas, w, h, fgbg
+    end
+
+    # -- text
+
+    # Draw text str at position (x, y). Expects an ANSI-string.
+    def text x, y, str
+      CdLib.cdCanvasText @canvas, x, y, str
+    end
+
+    # Sets text font.
+    # typeface:: 'Courier', 'Helvetica', 'Times' built-in, but any known 
+    #            font can be used
+    # style:: see Iup for list of text styles.
+    # size:: the font height, default is 12.
+    def font typeface, style, size
+      CdLib.cdCanvasFont @canvas, typeface, style, size
+    end
+
+    # Sets the current font.
+    def nativefont font
+      CdLib.cdCanvasNativefont @canvas, font
+    end
+
+    # Sets vertical and horizontal alignment if a value is given, 
+    # else returns current value.
+    # See Iup for text alignment values.
+    def textalignment alignment=CD_QUERY
+      CdLib.cdCanvasTextAlignment @canvas, alignment
+    end
+
+    # Sets orientation angle if a value is given, 
+    # else returns current value.
+    def textorientation orientation=CD_QUERY
+      CdLib.cdCanvasTextOrientation @canvas, orientation
+    end
+
+    # -- vector text
+
+    # Draws str as vector text at position (x, y).
+    # Respects 
+    def vectortext x, y, str
+      CdLib.cdCanvasVectorText @canvas, x, y, str
+    end
+
+    # Defines the text direction using two points: (x1, y1) and (x2, y2).
+    def vectortext_direction x1, y1, x2, y2
+      CdLib.cdCanvasVectorTextDirection @canvas, x1, y1, x2, y2
+    end
+
+    # Modifies font size so str fits within a box width x height in size.
+    def vectortext_size width, height, str
+      CdLib.cdCanvasVectorTextSize @canvas, width, height, str
+    end
+
+    # If a size is given, then the font size is given that height.
+    # Otherwise, the current value is returned.
+    def vectortext_charsize size=CD_QUERY
+      CdLib.cdCanvasVectorCharSize @canvas, size
+    end
+
+    # Directly modifies the font size.
+    def vectortext_fontsize size_x, size_y
+      CdLib.cdCanvasVectorFontSize @canvas, size_x, size_y
+    end
+
+    # Replaces current vector font with that loaded from given filename.
+    # Returns the font name, or null.
+    def vectortext_loadfont filename
+      CdLib.cdCanvasVectorFont @canvas, filename
+    end
+
+    # -- callbacks
+
+    # Action generated when the canvas needs to be redrawn.
+    # Action takes a callback which accepts 2 arguments (posx, posy).
+    # posx, posy are the position of the horizontal and vertical thumbs of the scrollbar.
+    def action callback
+      unless callback.arity == 2
+        raise ArgumentError, 'action must take 2 arguments: (posx, posy)'
+      end
+      cb = Proc.new do |ih, posx, posy|
+        callback.call posx, posy
+      end
+      define_callback cb, 'ACTION', :ff_i
+    end
+ 
+    include ButtonCallback
+
+    # Called when the canvas gets or loses the keyboard focus.
+    # Callback takes a single parameter: (focus)
+    # focus:: non-zero if canvas gaining focus, else zero.
+    def focus_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'focus_cb callback must take 1 argument, the focus'
+      end
+      cb = Proc.new do |ih, focus|
+        callback.call focus
+      end
+      define_callback cb, 'FOCUS_CB', :i_i
+    end
+
+    # Action generated when a key is pressed or released.
+    # keypress_cb takes a 2-argument callback: (character, pressed).
+    # pressed == 1 if key is pressed, 
+    # pressed == 0 if key is released.
+    def keypress_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'keypress_cb callback must take 2 arguments: (char, press)'
+      end
+      cb = Proc.new do |ih, char, press|
+        callback.call char, press
+      end
+      define_callback cb, 'KEYPRESS_CB', :ii_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 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
+
+    # Action generated when the mouse wheel is rotated.
+    # wheel_cb a 4-argument callback: (delta, x, y, status).
+    # delta:: the amount the wheel was rotated in notches.
+    # x, y:: position in the canvas where the event has occurred, in pixels.
+    # status:: status of mouse buttons and certain keyboard keys at the moment the event was generated.
+    def wheel_cb callback
+      unless callback.arity == 4
+        raise ArgumentError, 'wheel_cb callback must take 4 arguments: (delta, x, y, status)'
+      end
+      cb = Proc.new do |ih, delta, x, y, status_ptr|
+        status = FFI::Pointer.new(status_ptr).read_string
+        callback.call delta, x, y, status
+      end
+      define_callback cb, 'WHEEL_CB', :fiis_i
+    end
+  end
+end

data/lib/wrapped/colourbar.rb

@@ -0,0 +1,94 @@
+module Iup
+
+  # Colour bar
+  #
+  class ColorBar < Widget
+    def initialize &block
+      open_controls
+      @handle = ControlsLib.IupColorbar
+
+      # run any provided block on instance, to set up further attributes
+      self.instance_eval &block if block_given?
+    end
+
+    # -- attributes
+
+    define_attribute :bufferize
+    define_id_attribute :cell
+    define_attribute :num_cells
+    define_readonly :count
+    define_attribute :num_parts
+    define_attribute :orientation
+    define_attribute :preview_size
+    define_attribute :show_preview
+    define_attribute :show_secondary
+    define_attribute :primary_cell
+    define_attribute :secondary_cell
+    define_attribute :squared
+    define_attribute :shadowed
+    define_attribute :transparency
+
+    define_attribute :expand
+    define_readonly :position
+    define_attribute :rastersize
+    define_readonly :screenposition
+    define_attribute :tip
+
+    # -- callbacks
+
+    # Called when the user double clicks a color cell to change its value.
+    # Callback is a 1-argument function: (cell_index),
+    # returns a new colour (as a string), or nil if no change.
+    def cell_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'cell_cb callback must take 1 argument: (cell_index)'
+      end
+      cb = Proc.new do |ih, cell_index|
+        callback.call cell_index 
+      end
+      define_callback cb, 'CELL_CB', :i_s
+    end
+
+    # Called when the user right click a cell with the Shift key pressed
+    # Callback is a 1-argument function: (cell_index).
+    def extended_cb callback
+      unless callback.arity == 1
+        raise ArgumentError, 'extended_cb callback must take 1 argument: (cell_index)'
+      end
+      cb = Proc.new do |ih, cell_index|
+        callback.call cell_index 
+      end
+      define_callback cb, 'EXTENDED_CB', :i_i
+    end
+
+    # Called when a colour is selected. 
+    # The primary colour is selected with the left mouse button, and if 
+    # existent the secondary is selected with the right mouse button.
+    # Callback is a 2-argument function: (cell_index / type).
+    def select_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'select_cb callback must take 2 arguments: (cell_index, type)'
+      end
+      cb = Proc.new do |ih, cell_index, type|
+        callback.call cell_index, type 
+      end
+      define_callback cb, 'SELECT_CB', :ii_i
+    end
+
+    # called when the user double clicks the preview area outside the preview cells to 
+    # switch the primary and secondary selections. It is only called if SHOW_SECONDARY=YES.
+    # Callback takes 2 arguments: index of primary and secondary cells.
+    def switch_cb callback
+      unless callback.arity == 2
+        raise ArgumentError, 'switch_cb callback must take 2 arguments: (prim_cell, sec_cell)'
+      end
+      cb = Proc.new do |ih, cell_index, type|
+        callback.call cell_index, type 
+      end
+      define_callback cb, 'SWITCH_CB', :ii_i
+    end
+  end
+
+  ColourBar = ColorBar
+end
+

data/lib/wrapped/colourdialog.rb

@@ -0,0 +1,63 @@
+module Iup
+
+  # A ColourDialog allows the user to select a colour.
+  #
+  # Also see: Iup#get_colour
+  #
+  # == Attributes
+  #
+  # alpha:: If defined, enables alpha selection in dialog. 
+  #         Returns value if user pressed 'OK'.
+  # colortable:: "m;n;..." gives a list of values for the palette.
+  # 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.
+  # showalpha:: If set, shows the colour table. Values 'yes' / 'no'.
+  # showcolortable:: If set, shows the colour table. Values 'yes' / 'no'.
+  # showhelp:: Shows a help button if +help_cb+ defined. Values 'yes' / 'no'.
+  # showhex:: If set, shows a hexadecimal representation of colour. Values 'yes' / 'no'.
+  # status:: <b>read-only</b> Returns '1' if 'OK' pressed, or null.
+  # title:: Title text for the dialog.
+  # value:: Initial value for dialog, and return value if 'OK' pressed, 
+  #         as 'r g b' or 'r g b a'.
+  # valuehex:: Initial value for dialog, and return value if 'OK' pressed, 
+  #            as 'rrggbb'.
+  # valuehsi:: Initial value for dialog, and return value if 'OK' pressed, 
+  #            as 'H S I'.
+  #
+  class ColourDialog < Widget
+
+    # Creates a dialog, using the optional block to set its attributes.
+    def initialize &block
+      @handle = IupLib.IupColorDlg
+
+      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 :alpha
+    define_attribute :colortable
+    
+    def parentdialog parent=nil # :nodoc:
+      attribute_reference 'PARENTDIALOG', Dialog, parent
+    end
+
+    define_attribute :showalpha
+    define_attribute :showcolortable
+    define_attribute :showhelp
+    define_attribute :showhex
+    define_readonly :status
+    define_attribute :title
+    define_attribute :value
+    define_attribute :valuehex
+    define_attribute :valuehsi
+  end
+end
+

data/lib/wrapped/common-attributes.rb

@@ -0,0 +1,64 @@
+module Iup
+
+  # Defines attributes common to most widgets
+  #
+  # == Attributes
+  #
+  # active:: Enables or prevents user interaction.
+  #          Typically, a widget will appear greyed-out when inactive.
+  #          Values 'yes' / 'no'.
+  # bgcolor:: Specify RGB values for background colour, as "r g b".
+  # fgcolor:: Specify RGB values for foreground colour, as "r g b".
+  # font:: Sets the widget's font, using a font description.
+  # maxsize:: Maximum size of widget, value as "widthxheight".
+  # minsize:: Minimum size of widget, value as "widthxheight".
+  # size:: Size of the widget, in character units, value as "widthxheight".
+  # visible:: Shows or hides the widget. Values 'yes' / 'no'.
+  # wid:: <b>read-only</b> Native widget identifier.
+  # zorder:: <b>write-only</b> Alters z-order, values as 'top' / 'bottom'.
+  #
+  module CommonAttributes
+    extend AttributeBuilders
+    
+    define_attribute :active
+    define_attribute :bgcolor
+    define_attribute :fgcolor
+    define_attribute :font
+    define_attribute :visible
+
+    define_attribute :maxsize
+    define_attribute :minsize
+    define_attribute :size
+
+    define_readonly :wid
+    define_writeonly :zorder
+
+  end
+
+  # Standard callback method for when a mouse button is pressed or released.
+  module ButtonCallback
+
+    # Action generated when any mouse button is pressed or released.
+    # button_cb takes a callback which accepts 5 arguments (button, state, x, y, status)
+    # button:: the number of the button that changed, one of: BUTTON1 (left), BUTTON2 (middle), BUTTON3 (right)
+    # state:: 1 for 'pressed', 0 for 'released'
+    # x:: x-coordinate 
+    # y:: y-coordinate
+    # status:: status of the mouse buttons and some keyboard keys at the moment the event is generated.
+    #-- 
+    # TODO: include status test methods iup_iscontrol etc
+    #
+    def button_cb callback
+      unless callback.arity == 5
+        raise ArgumentError, 'button_cb callback must take 5 arguments: (button, state, x, y, status)'
+      end
+      cb = Proc.new do |ih, b, p, x, y, status|
+        callback.call b.chr, p, x, y, status
+      end
+      define_callback cb, 'BUTTON_CB', :iiiis_i
+    end
+
+  end
+
+end
+