iup-ffi 0.13.0-x86_64-linux

data/lib/wrapped/constants.rb

@@ -0,0 +1,504 @@
+# Iup is the main module, in which all controls and widgets are named.
+#
+# The module also provides constants and supporting methods.
+#
+module Iup
+
+  # :section: Callback return values
+
+  # Used by some actions so that callback is ignored.
+  IGNORE = -1
+  # Continues with user interaction: this is the return value to use, if in
+  # doubt. 
+  DEFAULT = -2
+  # Calls +IupExitLoop+ on returning; in most cases, this closes the
+  # application.
+  CLOSE = -3
+  # Used by some action to pass control to parent.
+  CONTINUE = -4
+
+  # :section: Dialog show position
+
+  # To place at center of screen.
+  CENTER = 0xFFFF # 65535 
+
+  # To place at left border of screen.
+  LEFT = 0xFFFE # 65534 
+  
+  # To place at right border of screen.
+  RIGHT = 0xFFFD # 65533 
+  
+  # To center on the mouse cursor.
+  MOUSEPOS = 0xFFFC # 65532 
+  
+  # To center on the current dialog's position.
+  CURRENT = 0xFFFB # 65531 
+  
+  # To center on the parent dialog.
+  CENTERPARENT = 0xFFFA # 65530 
+  
+  # To place at top border of screen.
+  TOP = LEFT
+  
+  # To place at bottom border of screen.
+  BOTTOM = RIGHT
+
+  # :section: Dialog show_cb state 
+
+  # When shown
+  IUP_SHOW = 0
+  # When restored
+  IUP_RESTORE = 1
+  # When minimized
+  IUP_MINIMIZE = 2
+  # When maximized
+  IUP_MAXIMIZE = 3
+  # When hidden
+  IUP_HIDE = 4
+
+  # :section: Button values
+
+  # Left mouse button
+  BUTTON1 = '1'
+  # Middle mouse button
+  BUTTON2 = '2'
+  # Right mouse button
+  BUTTON3 = '3'
+  # Extra button
+  BUTTON4 = '4'
+  # Extra button
+  BUTTON5 = '5'
+
+  # :section: Masks
+
+  MASK_FLOAT = "[+/-]?(/d+/.?/d*|/./d+)"
+  MASK_UFLOAT = "(/d+/.?/d*|/./d+)"
+  MASK_EFLOAT = "[+/-]?(/d+/.?/d*|/./d+)([eE][+/-]?/d+)?"
+  MASK_INT = "[+/-]?/d+"
+  MASK_UINT = "/d+"
+  MASK_FLOATCOMMA = "[+/-]?(/d+/,?/d*|/,/d+)"
+  MASK_UFLOATCOMMA = "(/d+/,?/d*|/,/d+)"
+
+  # :section: Key definitions
+
+  K_SP =         ' '.ord
+  K_exclam  =    '!'.ord
+  K_quotedbl =   "\"".ord
+  K_numbersign = '#'.ord
+  K_dollar =     '$'.ord
+  K_percent =    '%'.ord
+  K_ampersand =  '&'.ord
+  K_apostrophe = "\'".ord
+  K_parentleft = '('.ord
+  K_parentright =')'.ord
+  K_plus =       '+'.ord
+  K_comma =      ','.ord
+  K_minus =      '-'.ord
+  K_period =     '.'.ord
+  K_slash =      '/'.ord
+  K_0 =          '0'.ord
+  K_1 =          '1'.ord
+  K_2 =          '2'.ord
+  K_3 =          '3'.ord
+  K_4 =          '4'.ord
+  K_5 =          '5'.ord
+  K_6 =          '6'.ord
+  K_7 =          '7'.ord
+  K_8 =          '8'.ord
+  K_9 =          '9'.ord
+  K_colon =      ':'.ord
+  K_semicolon =  ';'.ord
+  K_less =       '<'.ord
+  K_equal =      '='.ord
+  K_greater =    '>'.ord
+  K_question =   '?'.ord
+  K_at =         '@'.ord
+  K_A =          'A'.ord
+  K_B =          'B'.ord
+  K_C =          'C'.ord
+  K_D =          'D'.ord
+  K_E =          'E'.ord
+  K_F =          'F'.ord
+  K_G =          'G'.ord
+  K_H =          'H'.ord
+  K_I =          'I'.ord
+  K_J =          'J'.ord
+  K_K =          'K'.ord
+  K_L =          'L'.ord
+  K_M =          'M'.ord
+  K_N =          'N'.ord
+  K_O =          'O'.ord
+  K_P =          'P'.ord
+  K_Q =          'Q'.ord
+  K_R =          'R'.ord
+  K_S =          'S'.ord
+  K_T =          'T'.ord
+  K_U =          'U'.ord
+  K_V =          'V'.ord
+  K_W =          'W'.ord
+  K_X =          'X'.ord
+  K_Y =          'Y'.ord
+  K_Z =          'Z'.ord
+  K_bracketleft ='['.ord
+  K_backslash =  "\\".ord
+  K_bracketright =']'.ord
+  K_circum =     '^'.ord
+  K_underscore = '_'.ord
+  K_grave =      '`'.ord
+  K_a =          'a'.ord
+  K_b =          'b'.ord
+  K_c =          'c'.ord
+  K_d =          'd'.ord
+  K_e =          'e'.ord
+  K_f =          'f'.ord
+  K_g =          'g'.ord
+  K_h =          'h'.ord
+  K_i =          'i'.ord
+  K_j =          'j'.ord
+  K_k =          'k'.ord
+  K_l =          'l'.ord
+  K_m =          'm'.ord
+  K_n =          'n'.ord
+  K_o =          'o'.ord
+  K_p =          'p'.ord
+  K_q =          'q'.ord
+  K_r =          'r'.ord
+  K_s =          's'.ord
+  K_t =          't'.ord
+  K_u =          'u'.ord
+  K_v =          'v'.ord
+  K_w =          'w'.ord
+  K_x =          'x'.ord
+  K_y =          'y'.ord
+  K_z =          'z'.ord
+  K_braceleft =  '{'.ord
+  K_bar =        '|'.ord
+  K_braceright = '}'.ord
+  K_tilde =      '~'.ord
+
+  K_BS =    "\b".ord
+  K_TAB =   "\t".ord
+  K_LF =    "\n".ord
+  K_CR =    "\r".ord
+
+  K_PAUSE =    0xFF13
+  K_ESC =      0xFF1B
+  K_HOME =     0xFF50           
+  K_LEFT =     0xFF51
+  K_UP =       0xFF52
+  K_RIGHT =    0xFF53
+  K_DOWN =     0xFF54 
+  K_PGUP =     0xFF55
+  K_PGDN =     0xFF56
+  K_END =      0xFF57
+  K_MIDDLE =   0xFF0B
+  K_Print =    0xFF61 
+  K_INS =      0xFF63
+  K_Menu =     0xFF67
+  K_DEL =      0xFFFF
+  K_F1 =       0xFFBE
+  K_F2 =       0xFFBF
+  K_F3 =       0xFFC0
+  K_F4 =       0xFFC1
+  K_F5 =       0xFFC2
+  K_F6 =       0xFFC3
+  K_F7 =       0xFFC4
+  K_F8 =       0xFFC5
+  K_F9 =       0xFFC6
+  K_F10 =      0xFFC7
+  K_F11 =      0xFFC8
+  K_F12 =      0xFFC9
+
+  K_LSHIFT =   0xFFE1
+  K_RSHIFT =   0xFFE2
+  K_LCTRL =    0xFFE3
+  K_RCTRL =    0xFFE4
+  K_LALT =     0xFFE9
+  K_RALT =     0xFFEA
+
+  K_NUM =      0xFF7F
+  K_SCROLL =   0xFF14
+  K_CAPS =     0xFFE5
+
+  # :section: Scrollbar operations
+
+  # Operation on vertical scrollbar - used in scroll_cb callback.
+  IUP_SBUP = 0
+  # Operation on vertical scrollbar - used in scroll_cb callback.
+  IUP_SBDN = 1
+  # Operation on vertical scrollbar - used in scroll_cb callback.
+  IUP_SBPGUP = 2
+  # Operation on vertical scrollbar - used in scroll_cb callback.
+  IUP_SBPGDN = 3
+  # Operation on vertical scrollbar - used in scroll_cb callback.
+  IUP_SBPOSV = 4
+  # Operation on vertical scrollbar - used in scroll_cb callback.
+  IUP_SBDRAGV = 5
+
+  # Operation on horizontal scrollbar - used in scroll_cb callback.
+  IUP_SBLEFT = 6 
+  # Operation on horizontal scrollbar - used in scroll_cb callback.
+  IUP_SBRIGHT = 7
+  # Operation on horizontal scrollbar - used in scroll_cb callback.
+  IUP_SBPGLEFT = 8
+  # Operation on horizontal scrollbar - used in scroll_cb callback.
+  IUP_SBPGRIGHT = 9
+  # Operation on horizontal scrollbar - used in scroll_cb callback.
+  IUP_SBPOSH = 10
+  # Operation on horizontal scrollbar - used in scroll_cb callback.
+  IUP_SBDRAGH = 11
+
+  # :section: CD library
+
+  CD_QUERY = -1 
+
+  # :section: CD bitmap type
+
+  CD_RGB = 0
+  CD_MAP = 1
+  CD_RGBA = 0x100 
+
+  # :section: CD bitmap data
+
+  CD_IRED = 0
+  CD_IGREEN = 1
+  CD_IBLUE = 2
+  CD_IALPHA = 3
+  CD_INDEX = 4
+  CD_COLORS = 5
+
+  # :section: CD status report
+
+  CD_ERROR = -1
+  CD_OK    =  0
+
+  # :section: CD clip mode 
+
+  CD_CLIPOFF = 0
+  CD_CLIPAREA = 1
+  CD_CLIPPOLYGON = 2
+  CD_CLIPREGION = 3
+
+  # :section: CD region combine mode
+
+  CD_UNION =  0
+  CD_INTERSECT = 1
+  CD_DIFFERENCE = 2
+  CD_NOTINTERSECT = 3
+
+  # :section: CD polygon mode
+
+  CD_FILL = 0
+  CD_OPEN_LINES = 1
+  CD_CLOSED_LINES = 2
+  CD_CLIP = 3
+  CD_BEZIER = 4
+  CD_REGION = 5
+  CD_PATH = 6
+
+  CD_POLYCUSTOM = 10
+
+  # :section: CD path action
+
+  CD_PATH_NEW = 0
+  CD_PATH_MOVETO = 1
+  CD_PATH_LINETO = 2
+  CD_PATH_ARC = 3
+  CD_PATH_CURVETO = 4
+  CD_PATH_CLOSE = 5
+  CD_PATH_FILL = 6
+  CD_PATH_STROKE = 7
+  CD_PATH_FILLSTROKE = 7
+  CD_PATH_CLIP = 8
+
+  # :section: CD fill mode
+
+  CD_EVENODD = 0
+  CD_WINDING = 1
+
+  # :section: CD line join
+
+  CD_MITER = 0
+  CD_BEVEL = 1
+  CD_ROUND = 2
+
+  # :section: CD line cap 
+
+  CD_CAPFLAT = 0
+  CD_CAPSQUARE = 1
+  CD_CAPROUND = 2
+
+  # :section: CD background opacity mode 
+
+  CD_OPAQUE = 0
+  CD_TRANSPARENT = 1
+
+  # :section: CD write mode 
+
+  CD_REPLACE = 0
+  CD_XOR = 1
+  CD_NOT_XOR = 2
+
+  # :section: CD color allocation mode (palette)
+
+  CD_POLITE = 0
+  CD_FORCE = 1
+
+  # :section: CD line style 
+
+  CD_CONTINUOUS = 0
+  CD_DASHED = 1
+  CD_DOTTED = 2
+  CD_DASH_DOT = 3
+  CD_DASH_DOT_DOT = 4
+  CD_CUSTOM = 5
+
+  # :section: CD mark type 
+
+  CD_PLUS = 0
+  CD_STAR = 1
+  CD_CIRCLE = 2
+  CD_X = 3
+  CD_BOX = 4
+  CD_DIAMOND = 5
+  CD_HOLLOW_CIRCLE = 6
+  CD_HOLLOW_BOX = 7
+  CD_HOLLOW_DIAMOND = 8
+
+  # :section: CD hatch type
+
+  CD_HORIZONTAL = 0
+  CD_VERTICAL = 1
+  CD_FDIAGONAL = 2
+  CD_BDIAGONAL = 3
+  CD_CROSS = 4
+  CD_DIAGCROSS = 5 
+
+  # :section: CD interior style
+
+  CD_SOLID = 0
+  CD_HATCH = 1
+  CD_STIPPLE = 2
+  CD_PATTERN = 3
+  CD_HOLLOW = 4
+
+  # :section: CD text alignment 
+
+  CD_NORTH = 0
+  CD_SOUTH = 1
+  CD_EAST = 2
+  CD_WEST = 3 
+  CD_NORTH_EAST = 4
+  CD_NORTH_WEST = 5
+  CD_SOUTH_EAST = 6
+  CD_SOUTH_WEST = 7
+  CD_CENTER = 8
+  CD_BASE_LEFT = 9
+  CD_BASE_CENTER = 10
+  CD_BASE_RIGHT = 11
+
+  # :section: CD text style 
+
+  CD_PLAIN  = 0
+  CD_BOLD   = 1
+  CD_ITALIC = 2
+  CD_UNDERLINE = 4
+  CD_STRIKEOUT = 8
+
+  # compatibility name
+  CD_BOLD_ITALIC  = (CD_BOLD|CD_ITALIC)  
+
+  # :section: CD font sizes
+
+  CD_SMALL    =  8
+  CD_STANDARD = 12
+  CD_LARGE    = 18
+
+  # :section: CD context capabilities
+
+  CD_CAP_NONE = 0x00000000
+  CD_CAP_FLUSH = 0x00000001
+  CD_CAP_CLEAR = 0x00000002
+  CD_CAP_PLAY = 0x00000004
+  CD_CAP_YAXIS = 0x00000008
+  CD_CAP_CLIPAREA = 0x00000010
+  CD_CAP_CLIPPOLY = 0x00000020
+  CD_CAP_REGION = 0x00000040
+  CD_CAP_RECT = 0x00000080
+  CD_CAP_CHORD = 0x00000100
+  CD_CAP_IMAGERGB = 0x00000200
+  CD_CAP_IMAGERGBA = 0x00000400
+  CD_CAP_IMAGEMAP = 0x00000800
+  CD_CAP_GETIMAGERGB = 0x00001000
+  CD_CAP_IMAGESRV = 0x00002000
+  CD_CAP_BACKGROUND = 0x00004000
+  CD_CAP_BACKOPACITY = 0x00008000
+  CD_CAP_WRITEMODE = 0x00010000
+  CD_CAP_LINESTYLE = 0x00020000
+  CD_CAP_LINEWITH = 0x00040000
+  CD_CAP_FPRIMTIVES = 0x00080000
+  CD_CAP_HATCH = 0x00100000
+  CD_CAP_STIPPLE = 0x00200000
+  CD_CAP_PATTERN = 0x00400000
+  CD_CAP_FONT = 0x00800000
+  CD_CAP_FONTDIM = 0x01000000
+  CD_CAP_TEXTSIZE = 0x02000000
+  CD_CAP_TEXTORIENTATION = 0x04000000
+  CD_CAP_PALETTE = 0x08000000
+  CD_CAP_LINECAP = 0x10000000
+  CD_CAP_LINEJOIN = 0x20000000
+  CD_CAP_PATH = 0x40000000
+  CD_CAP_BEZIER = 0x80000000
+  CD_CAP_ALL = 0xFFFFFFFF
+
+  # :section: CD simulation flags 
+
+  CD_SIM_NONE = 0x0000
+  CD_SIM_LINE = 0x0001
+  CD_SIM_RECT = 0x0002
+  CD_SIM_BOX = 0x0004
+  CD_SIM_ARC = 0x0008
+  CD_SIM_SECTOR = 0x0010
+  CD_SIM_CHORD = 0x0020
+  CD_SIM_POLYLINE = 0x0040
+  CD_SIM_POLYGON = 0x0080
+  CD_SIM_TEXT = 0x0100
+  CD_SIM_ALL = 0xFFFF
+
+  CD_SIM_LINES = (CD_SIM_LINE | CD_SIM_RECT | CD_SIM_ARC | CD_SIM_POLYLINE)
+  CD_SIM_FILLS = (CD_SIM_BOX | CD_SIM_SECTOR | CD_SIM_CHORD | CD_SIM_POLYGON)
+
+  # :section: CD colors
+
+  CD_RED =           0xFF0000   # 255,  0,  0
+  CD_DARK_RED =      0x800000   # 128,  0,  0
+  CD_GREEN =         0x00FF00   #   0,255,  0
+  CD_DARK_GREEN =    0x008000   #   0,128,  0
+  CD_BLUE =          0x0000FF   #   0,  0,255
+  CD_DARK_BLUE =     0x000080   #   0,  0,128
+
+  CD_YELLOW =        0xFFFF00   # 255,255,  0
+  CD_DARK_YELLOW =   0x808000   # 128,128,  0
+  CD_MAGENTA =       0xFF00FF   # 255,  0,255
+  CD_DARK_MAGENTA =  0x800080   # 128,  0,128
+  CD_CYAN =          0x00FFFF   #   0,255,255
+  CD_DARK_CYAN =     0x008080   #   0,128,128
+
+  CD_WHITE =         0xFFFFFF   # 255,255,255
+  CD_BLACK =         0x000000   #   0,  0,  0
+
+  CD_DARK_GRAY =     0x808080   # 128,128,128
+  CD_GRAY =          0xC0C0C0   # 192,192,192
+
+  # :section: CD conversion factors 
+
+  # milimeters to points (pt = CD_MM2PT * mm) 
+  CD_MM2PT   =  2.834645669   
+  # radians to degrees (deg = CD_RAD2DEG * rad) 
+  CD_RAD2DEG = 57.295779513   
+  # degrees to radians (rad = CD_DEG2RAD * deg) 
+  CD_DEG2RAD = 0.01745329252  
+
+  # :section:
+end
+

data/lib/wrapped/dial.rb

@@ -0,0 +1,129 @@
+module Iup
+
+  # Creates a dial for setting an angular variable.
+  #
+  # === Example
+  #
+  # The following creates a horizontal dial which updates a label whenever its value
+  # changes.
+  #
+  #   Iup::Dial.new do |d|
+  #     d.valuechanged_cb = ->{
+  #     label.title = "dial value: #{'%0.2f' % d.value}"
+  #     Iup::DEFAULT
+  #     }
+  #   end
+  #
+  class Dial < Iup::Canvas
+
+    # Creates a new instance. 
+    # If a block is given, the new instance is yielded to it.
+    # * +orientation+ - 'horizontal' / 'vertical' / 'circular'
+    def initialize(orientation = 'horizontal')
+      open_controls
+      @handle = ControlsLib.IupDial(orientation)
+
+      # run any provided block on instance, to set up further attributes
+      yield self if block_given?
+    end
+
+    # -- attributes
+
+    ##
+    # :attr: orientation
+    # Value one of 'horizontal' / 'vertical' / 'circular'.
+    # Horizontal or vertical orientations show a dial to be scrolled across;
+    # a circular orientation shows a round dial to be rotated.
+    define_attribute :orientation
+
+    ##
+    # :attr: unit
+    # 'radians' / 'degrees' - used in the callbacks.
+    define_attribute :unit
+
+    ##
+    # :attr: value
+    # Angular value of dial in radians. Except for circular dials, the value
+    # resets to 0 when interaction begins.
+
+    # --
+    def value
+      IupLib.IupGetAttribute(@handle, 'VALUE').first.to_f
+    end
+
+    def value= val # :nodoc:
+      IupLib.IupSetAttribute(@handle, 'VALUE', val.to_s)
+    end
+
+    # :section: Callbacks
+
+    include ButtonCallback
+
+    ##
+    # :attr_writer: button_press_cb
+    # Called when the user presses the left mouse button over the dial. 
+    # Callback must respond to +call+ and is a 1-argument function: (angle)
+    # * +angle+ - zero when interaction starts, except for the circular dial.
+
+    # --
+    def button_press_cb= callback
+      unless callback.arity == 1
+        raise ArgumentError, 'button_press_cb callback must take 1 argument: (angle)'
+      end
+      cb = Proc.new do |ih, angle|
+        callback.call angle 
+      end
+      define_callback cb, 'BUTTON_PRESS_CB', :d_i
+    end
+
+    ##
+    # :attr_writer: button_release_cb
+    # Called when the user releases the left mouse button after pressing it over the dial.
+    # Callback must respond to +call+ and is a 1-argument function: (angle)
+    # * +angle+ - the dial value, converted according to #unit.
+
+    # --
+    def button_release_cb= callback
+      unless callback.arity == 1
+        raise ArgumentError, 'button_release_cb callback must take 1 argument: (angle)'
+      end
+      cb = Proc.new do |ih, angle|
+        callback.call angle
+      end
+      define_callback cb, 'BUTTON_RELEASE_CB', :d_i
+    end
+
+    ##
+    # :attr_writer: mousemove_cb
+    # Called each time the user moves the dial with the mouse button pressed. 
+    # Callback must respond to +call+ and is a 1-argument function: (angle)
+    # * +angle+ - the dial value, converted according to #unit.
+
+    # --
+    def mousemove_cb= callback
+      unless callback.arity == 1
+        raise ArgumentError, 'mousemove_cb callback must take 1 argument: (angle)'
+      end
+      cb = Proc.new do |ih, angle|
+        callback.call angle
+      end
+      define_callback cb, 'MOUSEMOVE_CB', :d_i
+    end
+
+    ##
+    # :attr_writer: valuechanged_cb
+    # Called after the value was interactively changed by the user.
+    # Callback must respond to +call+ and take no arguments.
+
+    # --
+    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