fxruby 1.6.22 → 1.6.23

data/rdoc-sources/FXGIFCursor.rb

@@ -23,11 +23,11 @@ module Fox
   #
   # ==== Parameters:
   #
-  # +store+::	stream to which to write the image data [FXStream]
-  # +data+::	the image pixel data [Array of FXColor]
-  # +width+::	width [Integer]
-  # +height+::	height [Integer]
-  # +fast+::	if +true+, use faster Floyd-Steinberg algorithm [Boolean]
+  # +store+:: stream to which to write the image data {FXStream}
+  # +data+:: the image pixel data [Array of FXColor]
+  # +width+:: width [Integer]
+  # +height+:: height [Integer]
+  # +fast+:: if +true+, use faster Floyd-Steinberg algorithm [Boolean]
   #
   def Fox.fxsaveGIF(store, data, width, height, fast=true); end
 
@@ -39,7 +39,7 @@ module Fox
   #
   # ==== Parameters:
   #
-  # +store+::	stream from which to read the file data [FXStream]
+  # +store+:: stream from which to read the file data {FXStream}
   #
   def Fox.fxloadGIF(store); end
 

data/rdoc-sources/FXGIFIcon.rb

@@ -18,12 +18,12 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +a+::	an application instance [FXApp]
-    # +pix+::	a memory buffer formatted in GIF file format [String]
-    # +clr+::	transparency color [FXColor]
-    # +opts+::	options [Integer]
-    # +width+::	width [Integer]
-    # +height+::	height [Integer]
+    # +a+:: an application instance {FXApp}
+    # +pix+:: a memory buffer formatted in GIF file format [String]
+    # +clr+:: transparency color {FXColor}
+    # +opts+:: options [Integer]
+    # +width+:: width [Integer]
+    # +height+:: height [Integer]
     #
     def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: theGIFIcon
     end

data/rdoc-sources/FXGIFImage.rb

@@ -16,11 +16,11 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +a+::	an application instance [FXApp]
-    # +pix+::	a memory buffer formatted in GIF file format [String]
-    # +opts+::	options [Integer]
-    # +width+::	width [Integer]
-    # +height+::	height [Integer]
+    # +a+:: an application instance {FXApp}
+    # +pix+:: a memory buffer formatted in GIF file format [String]
+    # +opts+:: options [Integer]
+    # +width+:: width [Integer]
+    # +height+:: height [Integer]
     #
     def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: theGIFImage
     end

data/rdoc-sources/FXGLContext.rb

@@ -11,7 +11,7 @@ module Fox
   #
   class FXGLContext < FXId
 
-    # The visual [FXGLVisual]
+    # The visual {FXGLVisual}
     attr_reader :visual
 
     # Construct an OpenGL context.

data/rdoc-sources/FXGLObject.rb

@@ -24,7 +24,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +viewer+::	the viewer window into which we're drawing [FXGLViewer]
+    # +viewer+:: the viewer window into which we're drawing {FXGLViewer}
     #
     def draw(viewer); end
 
@@ -33,7 +33,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +viewer+::	the viewer window into which we're drawing [FXGLViewer]
+    # +viewer+:: the viewer window into which we're drawing {FXGLViewer}
     #
     def hit(viewer); end
 
@@ -53,11 +53,11 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +viewer+::	the viewer window in which we're dragging [FXGLViewer]
-    # +fx+::		x-coordinate for position we're dragging from [Integer]
-    # +fy+::		y-coordinate for position we're dragging from [Integer]
-    # +tx+::		x-coordinate for position we're dragging to [Integer]
-    # +ty+::		y-coordinate for position we're dragging to [Integer]
+    # +viewer+:: the viewer window in which we're dragging {FXGLViewer}
+    # +fx+::  x-coordinate for position we're dragging from [Integer]
+    # +fy+::  y-coordinate for position we're dragging from [Integer]
+    # +tx+::  x-coordinate for position we're dragging to [Integer]
+    # +ty+::  y-coordinate for position we're dragging to [Integer]
     #
     def drag(viewer, fx, fy, tx, ty); end
 
@@ -67,7 +67,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +path+::	an array of integers [Array]
+    # +path+:: an array of integers [Array]
     #
     def identify(path); end
   end

data/rdoc-sources/FXGLShape.rb

@@ -4,38 +4,38 @@ module Fox
   #
   # === Shape drawing options
   #
-  # +SURFACE_SINGLESIDED+::	Single-sided [both sides same]
-  # +SURFACE_DUALSIDED+::	Dual-sided surface
-  # +SHADING_NONE+::		No light source
-  # +SHADING_SMOOTH+::		Smooth shaded
-  # +SHADING_FLAT+::		Flag shaded
-  # +FACECULLING_OFF+::		No face culling
-  # +FACECULLING_ON+::		Cull backward facing surfaces
-  # +STYLE_SURFACE+::		Draw filled surfaces
-  # +STYLE_WIREFRAME+::		Draw wire frame
-  # +STYLE_POINTS+::		Draw as points
-  # +STYLE_BOUNDBOX+::		Draw bounding box
+  # +SURFACE_SINGLESIDED+:: Single-sided [both sides same]
+  # +SURFACE_DUALSIDED+:: Dual-sided surface
+  # +SHADING_NONE+::  No light source
+  # +SHADING_SMOOTH+::  Smooth shaded
+  # +SHADING_FLAT+::  Flag shaded
+  # +FACECULLING_OFF+::  No face culling
+  # +FACECULLING_ON+::  Cull backward facing surfaces
+  # +STYLE_SURFACE+::  Draw filled surfaces
+  # +STYLE_WIREFRAME+::  Draw wire frame
+  # +STYLE_POINTS+::  Draw as points
+  # +STYLE_BOUNDBOX+::  Draw bounding box
   #
   # === Message identifiers
   #
-  # +ID_SHADEOFF+::		x
-  # +ID_SHADEON+::		x
-  # +ID_SHADESMOOTH+::		x
-  # +ID_TOGGLE_SIDED+::		x
-  # +ID_TOGGLE_CULLING+::	x
-  # +ID_STYLE_POINTS+::		x
-  # +ID_STYLE_WIREFRAME+::	x
-  # +ID_STYLE_SURFACE+::	x
-  # +ID_STYLE_BOUNDINGBOX+::	x
-  # +ID_FRONT_MATERIAL+::	x
-  # +ID_BACK_MATERIAL+::	x
+  # +ID_SHADEOFF+::  x
+  # +ID_SHADEON+::  x
+  # +ID_SHADESMOOTH+::  x
+  # +ID_TOGGLE_SIDED+::  x
+  # +ID_TOGGLE_CULLING+:: x
+  # +ID_STYLE_POINTS+::  x
+  # +ID_STYLE_WIREFRAME+:: x
+  # +ID_STYLE_SURFACE+:: x
+  # +ID_STYLE_BOUNDINGBOX+:: x
+  # +ID_FRONT_MATERIAL+:: x
+  # +ID_BACK_MATERIAL+:: x
   #
   class FXGLShape < FXGLObject
 
     # Tool tip message for this shape [String]
     attr_accessor :tipText
 
-    # Position [FXVec3f]
+    # Position {FXVec3f}
     attr_accessor :position
 
     #

data/rdoc-sources/FXGLViewer.rb

@@ -31,19 +31,19 @@ module Fox
 
   # OpenGL Light Source
   class FXLight
-    # Ambient light color [FXVec4f]
+    # Ambient light color {FXVec4f}
     attr_accessor :ambient
 
-    # Diffuse light color [FXVec4f]
+    # Diffuse light color {FXVec4f}
     attr_accessor :diffuse
 
-    # Specular light color [FXVec4f]
+    # Specular light color {FXVec4f}
     attr_accessor :specular
 
-    # Light position [FXVec4f]
+    # Light position {FXVec4f}
     attr_accessor :position
 
-    # Spot direction [FXVec3f]
+    # Spot direction {FXVec3f}
     attr_accessor :direction
 
     # Spotlight exponent [Float]
@@ -67,16 +67,16 @@ module Fox
 
   # OpenGL Material Description
   class FXMaterial
-    # Ambient material color [FXVec4f]
+    # Ambient material color {FXVec4f}
     attr_accessor :ambient
 
-    # Diffuse material color [FXVec4f]
+    # Diffuse material color {FXVec4f}
     attr_accessor :diffuse
 
-    # Specular material color [FXVec4f]
+    # Specular material color {FXVec4f}
     attr_accessor :specular
 
-    # Emissive material color [FXVec4f]
+    # Emissive material color {FXVec4f}
     attr_accessor :emission
 
     # Specular shininess [Float]
@@ -93,44 +93,44 @@ module Fox
   #
   # The following messages are sent by FXGLViewer to its message target:
   #
-  # +SEL_KEYPRESS+::		sent when a key goes down; the message data is an FXEvent instance.
-  # +SEL_KEYRELEASE+::		sent when a key goes up; the message data is an FXEvent instance.
-  # +SEL_LEFTBUTTONPRESS+::	sent when the left mouse button goes down; the message data is an FXEvent instance.
-  # +SEL_LEFTBUTTONRELEASE+::	sent when the left mouse button goes up; the message data is an FXEvent instance.
-  # +SEL_MIDDLEBUTTONPRESS+::	sent when the middle mouse button goes down; the message data is an FXEvent instance.
-  # +SEL_MIDDLEBUTTONRELEASE+::	sent when the middle mouse button goes up; the message data is an FXEvent instance.
-  # +SEL_RIGHTBUTTONPRESS+::	sent when the right mouse button goes down; the message data is an FXEvent instance.
-  # +SEL_RIGHTBUTTONRELEASE+::	sent when the right mouse button goes up; the message data is an FXEvent instance.
-  # +SEL_MOTION+::		sent when the mouse pointer is moved; the message data is an FXEvent instance.
-  # +SEL_MOUSEWHEEL+::		sent when the mouse wheel is spun; the message data is an FXEvent instance.
-  # +SEL_CLICKED+::		sent when the mouse is single-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
-  # +SEL_DOUBLECLICKED+::	sent when the mouse is double-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
-  # +SEL_TRIPLECLICKED+::	sent when the mouse is triple-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
-  # +SEL_PICKED+::		sent when an object is picked; the message data is an FXEvent instance.
-  # +SEL_SELECTED+::		sent when object(s) are selected in the viewer; the message data is an array of references to the selected objects.
-  # +SEL_DESELECTED+::		sent when object(s) are deselected in the viewer; the message data is an array of references to the deselected objects.
-  # +SEL_LASSOED+::		sent when a lasso-selection has been completed; the message data is an FXEvent instance.
-  # +SEL_INSERTED+::		sent when the viewer receives a +SEL_INSERTED+ message.
-  # +SEL_DELETED+::		sent when the viewer receives a +SEL_COMMAND+ message with the +ID_DELETE_SEL+ identifier; the message data is an array of references to the selected object(s).
-  # +SEL_DRAGGED+::		sent when the selected object is dragged around in the viewer; the message data is a reference to the selected object.
-  # +SEL_COMMAND+::		sent when the mouse is clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
-  # +SEL_CHANGED+::		sent when the selection changes; the message data is a reference to the newly selected object (or +nil+).
+  # +SEL_KEYPRESS+::  sent when a key goes down; the message data is an FXEvent instance.
+  # +SEL_KEYRELEASE+::  sent when a key goes up; the message data is an FXEvent instance.
+  # +SEL_LEFTBUTTONPRESS+:: sent when the left mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_LEFTBUTTONRELEASE+:: sent when the left mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_MIDDLEBUTTONPRESS+:: sent when the middle mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_MIDDLEBUTTONRELEASE+:: sent when the middle mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_RIGHTBUTTONPRESS+:: sent when the right mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_RIGHTBUTTONRELEASE+:: sent when the right mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_MOTION+::  sent when the mouse pointer is moved; the message data is an FXEvent instance.
+  # +SEL_MOUSEWHEEL+::  sent when the mouse wheel is spun; the message data is an FXEvent instance.
+  # +SEL_CLICKED+::  sent when the mouse is single-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_DOUBLECLICKED+:: sent when the mouse is double-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_TRIPLECLICKED+:: sent when the mouse is triple-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_PICKED+::  sent when an object is picked; the message data is an FXEvent instance.
+  # +SEL_SELECTED+::  sent when object(s) are selected in the viewer; the message data is an array of references to the selected objects.
+  # +SEL_DESELECTED+::  sent when object(s) are deselected in the viewer; the message data is an array of references to the deselected objects.
+  # +SEL_LASSOED+::  sent when a lasso-selection has been completed; the message data is an FXEvent instance.
+  # +SEL_INSERTED+::  sent when the viewer receives a +SEL_INSERTED+ message.
+  # +SEL_DELETED+::  sent when the viewer receives a +SEL_COMMAND+ message with the +ID_DELETE_SEL+ identifier; the message data is an array of references to the selected object(s).
+  # +SEL_DRAGGED+::  sent when the selected object is dragged around in the viewer; the message data is a reference to the selected object.
+  # +SEL_COMMAND+::  sent when the mouse is clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_CHANGED+::  sent when the selection changes; the message data is a reference to the newly selected object (or +nil+).
   #
   # === FXGLViewer options
   #
-  # +VIEWER_LIGHTING+::	Lighting is on
-  # +VIEWER_FOG+::	Fog mode on
-  # +VIEWER_DITHER+::	Dithering
+  # +VIEWER_LIGHTING+:: Lighting is on
+  # +VIEWER_FOG+:: Fog mode on
+  # +VIEWER_DITHER+:: Dithering
   #
   # === Projection modes (class constants)
   #
-  # +PARALLEL+::	Parallel projection
-  # +PERSPECTIVE+::	Perspective projection
+  # +PARALLEL+:: Parallel projection
+  # +PERSPECTIVE+:: Perspective projection
   #
   # === Message identifiers
   #
-  # +ID_PERSPECTIVE+::		x
-  # +ID_PARALLEL+::		x
+  # +ID_PERSPECTIVE+::  x
+  # +ID_PARALLEL+::  x
   # +ID_FRONT+:: x
   # +ID_BACK+:: x
   # +ID_LEFT+:: x
@@ -179,10 +179,10 @@ module Fox
     # Size of pixel in model coordinates [Float]
     attr_reader :modelPix
 
-    # The viewport for this viewer [FXViewport]
+    # The viewport for this viewer {FXViewport}
     attr_reader :viewport
 
-    # Default object material setting [FXMaterial]
+    # Default object material setting {FXMaterial}
     attr_accessor :material
 
     # Camera field of view angle (in degrees) [Float]
@@ -194,19 +194,19 @@ module Fox
     # Target point distance [Float]
     attr_accessor :distance
 
-    # Current scaling factors [FXVec3f]
+    # Current scaling factors {FXVec3f}
     attr_accessor :scale
 
-    # Camera orientation [FXQuatf]
+    # Camera orientation {FXQuatf}
     attr_accessor :orientation
 
-    # Object center [FXVec3f]
+    # Object center {FXVec3f}
     attr_accessor :center
 
-    # Eyesight vector [FXVec3f]
+    # Eyesight vector {FXVec3f}
     attr_reader :eyeVector
 
-    # Eye position [FXVec3f]
+    # Eye position {FXVec3f}
     attr_reader :eyePosition
 
     # Status line help text [String]
@@ -215,22 +215,22 @@ module Fox
     # Tool tip text [String]
     attr_accessor :tipText
 
-    # The current transformation matrix [FXMat4f]
+    # The current transformation matrix {FXMat4f}
     attr_reader :transform
 
-    # The inverse of the current transformation matrix [FXMat4f]
+    # The inverse of the current transformation matrix {FXMat4f}
     attr_reader :invTransform
 
-    # The current scene object [FXGLObject]
+    # The current scene object {FXGLObject}
     attr_accessor :scene
 
-    # The selection [FXGLObject]
+    # The selection {FXGLObject}
     attr_accessor :selection
 
     # The projection mode (either +FXGLViewer::PERSPECTIVE+ or +FXGLViewer::PARALLEL+)
     attr_accessor :projection
 
-    # Global ambient light color [FXMat4f]
+    # Global ambient light color {FXMat4f}
     attr_accessor :ambientColor
 
     # The maximum hits, i.e. the maximum size of the pick buffer [Integer].
@@ -240,7 +240,7 @@ module Fox
     # Set turbo mode [Boolean]
     attr_writer :turboMode
 
-    # Light source settings [FXLight]
+    # Light source settings {FXLight}
     attr_accessor :light
 
     # Returns the FXDragType for FXGLObject

data/rdoc-sources/FXGLVisual.rb

@@ -68,6 +68,7 @@ module Fox
     # Construct default visual
     #
     def initialize(app, flags) # :yields: theGLVisual
+    end
 
     #
     # Test if OpenGL is possible, and what level is supported.

data/rdoc-sources/FXGradientBar.rb

@@ -16,10 +16,10 @@ module Fox
     # Upper value [Float]
     attr_accessor :upper
 
-    # Lower color [FXColor]
+    # Lower color {FXColor}
     attr_accessor :lowerColor
 
-    # Upper color [FXColor]
+    # Upper color {FXColor}
     attr_accessor :upperColor
 
     # Blend mode [Integer]
@@ -34,43 +34,43 @@ module Fox
   #
   # The following messages are sent by FXGradientBar to its target:
   #
-  # +SEL_LEFTBUTTONPRESS+::	sent when the left mouse button goes down; the message data is an FXEvent instance.
-  # +SEL_LEFTBUTTONRELEASE+::	sent when the left mouse button goes up; the message data is an FXEvent instance.
-  # +SEL_CHANGED+::		sent when anything about a segment changes; the message data is an integer indicating the segment number
-  # +SEL_SELECTED+::		sent when one or more segments are selected.
-  # +SEL_DESELECTED+::		sent when one or more segments are deselected.
+  # +SEL_LEFTBUTTONPRESS+:: sent when the left mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_LEFTBUTTONRELEASE+:: sent when the left mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_CHANGED+::  sent when anything about a segment changes; the message data is an integer indicating the segment number
+  # +SEL_SELECTED+::  sent when one or more segments are selected.
+  # +SEL_DESELECTED+::  sent when one or more segments are deselected.
   #
   # === Gradient bar orientation
   #
-  # +GRADIENTBAR_HORIZONTAL+::		Gradient bar shown horizontally
-  # +GRADIENTBAR_VERTICAL+::		Gradient bar shown vertically
-  # +GRADIENTBAR_NO_CONTROLS+::		No controls shown
-  # +GRADIENTBAR_CONTROLS_TOP+::	Controls on top
-  # +GRADIENTBAR_CONTROLS_BOTTOM+::	Controls on bottom
-  # +GRADIENTBAR_CONTROLS_LEFT+::	Controls on left
-  # +GRADIENTBAR_CONTROLS_RIGHT+::	Controls on right
+  # +GRADIENTBAR_HORIZONTAL+::  Gradient bar shown horizontally
+  # +GRADIENTBAR_VERTICAL+::  Gradient bar shown vertically
+  # +GRADIENTBAR_NO_CONTROLS+::  No controls shown
+  # +GRADIENTBAR_CONTROLS_TOP+:: Controls on top
+  # +GRADIENTBAR_CONTROLS_BOTTOM+:: Controls on bottom
+  # +GRADIENTBAR_CONTROLS_LEFT+:: Controls on left
+  # +GRADIENTBAR_CONTROLS_RIGHT+:: Controls on right
   #
   # === Blend modes
   #
-  # +GRADIENT_BLEND_LINEAR+::		Linear blend
-  # +GRADIENT_BLEND_POWER+::		Power law blend
-  # +GRADIENT_BLEND_SINE+::		Sine blend
-  # +GRADIENT_BLEND_INCREASING+::	Quadratic increasing blend
-  # +GRADIENT_BLEND_DECREASING+::	Quadratic decreasing blend
+  # +GRADIENT_BLEND_LINEAR+::  Linear blend
+  # +GRADIENT_BLEND_POWER+::  Power law blend
+  # +GRADIENT_BLEND_SINE+::  Sine blend
+  # +GRADIENT_BLEND_INCREASING+:: Quadratic increasing blend
+  # +GRADIENT_BLEND_DECREASING+:: Quadratic decreasing blend
   #
   # === Message identifiers
   #
-  # +ID_LOWER_COLOR+::			write me
-  # +ID_UPPER_COLOR+::			write me
-  # +ID_BLEND_LINEAR+::			write me
-  # +ID_BLEND_POWER+::			write me
-  # +ID_BLEND_SINE+::			write me
-  # +ID_BLEND_INCREASING+::		write me
-  # +ID_BLEND_DECREASING+::		write me
-  # +ID_RECENTER+::			write me
-  # +ID_SPLIT+::			write me
-  # +ID_MERGE+::		 	write me
-  # +ID_UNIFORM+::			write me
+  # +ID_LOWER_COLOR+::   write me
+  # +ID_UPPER_COLOR+::   write me
+  # +ID_BLEND_LINEAR+::   write me
+  # +ID_BLEND_POWER+::   write me
+  # +ID_BLEND_SINE+::   write me
+  # +ID_BLEND_INCREASING+::  write me
+  # +ID_BLEND_DECREASING+::  write me
+  # +ID_RECENTER+::   write me
+  # +ID_SPLIT+::   write me
+  # +ID_MERGE+::    write me
+  # +ID_UNIFORM+::   write me
   #
   class FXGradientBar < FXFrame
 
@@ -82,7 +82,7 @@ module Fox
     #
     attr_accessor :barStyle
 
-    # Selection color [FXColor]
+    # Selection color {FXColor}
     attr_accessor :selectColor
 
     # Status line help text [String]