fxruby 1.6.22 → 1.6.23

data/rdoc-sources/FXId.rb

@@ -4,7 +4,7 @@ module Fox
   #
   class FXId < FXObject
 
-    # Application [FXApp]
+    # Application {FXApp}
     attr_reader :app
 
     # User data [Object]

data/rdoc-sources/FXImage.rb

@@ -39,8 +39,8 @@ module Fox
 
   class FXImage < FXDrawable
 
-    # [deprecated] Pixel data [FXMemoryBuffer]
-    attr_reader	:data
+    # [deprecated] Pixel data {FXMemoryBuffer}
+    attr_reader :data
 
     # Array of colors of all image pixels. Can also be written as String of raw [RGBA] values.
     attr_accessor :pixels
@@ -55,16 +55,16 @@ module Fox
     # If the +IMAGE_OWNED+ flag is set but a +nil+ pixel buffer is
     # passed, a pixel buffer will be automatically created and will be owned
     # by the image. The flags +IMAGE_SHMI+ and +IMAGE_SHMP+ may be specified for
-    # large images to instruct #render to use shared memory to communicate
+    # large images to instruct {#render} to use shared memory to communicate
     # with the server.
     #
     # ==== Parameters:
     #
-    # +a+::		an application instance [FXApp]
-    # +pixels+::	pixels [Array of FXColor values or string of raw [RGBA] values]
-    # +opts+::		image options [Integer]
-    # +width+::		image width [Integer]
-    # +height+::		image height [Integer]
+    # +a+::  an application instance {FXApp}
+    # +pixels+:: pixels [Array of FXColor values or string of raw [RGBA] values]
+    # +opts+::  image options [Integer]
+    # +width+::  image width [Integer]
+    # +height+::  image height [Integer]
     #
     def initialize(a, pixels=nil, opts=0, width=1, height=1) # :yields: theImage
     end
@@ -99,8 +99,8 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +x+::	x-coordinate of the pixel of interest [Integer]
-    # +y+::	y-coordinate of the pixel of interest [Integer]
+    # +x+:: x-coordinate of the pixel of interest [Integer]
+    # +y+:: y-coordinate of the pixel of interest [Integer]
     #
     def getPixel(x, y) ; end
 
@@ -109,9 +109,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +x+::	x-coordinate of the pixel of interest [Integer]
-    # +y+::	y-coordinate of the pixel of interest [Integer]
-    # +clr+::	new color value for this pixel [FXColor]
+    # +x+:: x-coordinate of the pixel of interest [Integer]
+    # +y+:: y-coordinate of the pixel of interest [Integer]
+    # +clr+:: new color value for this pixel {FXColor}
     #
     def setPixel(x, y, clr) ; end
 
@@ -122,7 +122,7 @@ module Fox
     # Restore client-side pixel buffer from image.
     # This operation overwrites any current values for the client-side
     # pixel buffer with values corresponding to the server-side image.
-    # If the image data is +nil+ at the time #restore is called, the
+    # If the image data is +nil+ at the time {#restore} is called, the
     # image will first allocate an (owned) pixel buffer to use for this
     # operation.
     #
@@ -149,15 +149,15 @@ module Fox
     # transform the image.
     #
     # The optional third argument specifies the _quality_ of the scaling algorithm
-    # used. By default, #scale uses a fast (but low quality) nearest-neighbor algorithm
+    # used. By default, {#scale} uses a fast (but low quality) nearest-neighbor algorithm
     # for scaling the image to its new size. To use the higher-quality scaling algorithm
-    # from FOX 1.0, you should pass in a value of 1 as the third argument to #scale.
+    # from FOX 1.0, you should pass in a value of 1 as the third argument to {#scale}.
     #
     # ==== Parameters:
     #
-    # +width+::		new image width, in pixels [Integer]
-    # +height+::		new image height, in pixels [Integer]
-    # +quality+::	scaling algorithm quality, either 0 or 1 (see above) [Integer]
+    # +width+::  new image width, in pixels [Integer]
+    # +height+::  new image height, in pixels [Integer]
+    # +quality+:: scaling algorithm quality, either 0 or 1 (see above) [Integer]
     #
     def scale(w, h, quality=0) ; end
 
@@ -167,8 +167,8 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +horizontal+::	if +true+, the image will be flipped from left to right [Boolean]
-    # +vertical+::	if +true+, the image will be flipped from top to bottom [Boolean]
+    # +horizontal+:: if +true+, the image will be flipped from left to right [Boolean]
+    # +vertical+:: if +true+, the image will be flipped from top to bottom [Boolean]
     #
     def mirror(horizontal, vertical) ; end
 
@@ -178,7 +178,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +degrees+::	number of degrees by which to rotate the image [Integer]
+    # +degrees+:: number of degrees by which to rotate the image [Integer]
     #
     def rotate(degrees) ; end
 
@@ -191,11 +191,11 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +x+::	x-coordinate for top left corner of the clip rectangle [Integer]
-    # +y+::	y-coordinate for top left corner of the clip rectangle [Integer]
-    # +width+::	width of the clip rectangle [Integer]
-    # +height+::	height of the clip rectangle [Integer]
-    # +color+::	fill color for blank areas after crop [FXColor]
+    # +x+:: x-coordinate for top left corner of the clip rectangle [Integer]
+    # +y+:: y-coordinate for top left corner of the clip rectangle [Integer]
+    # +width+:: width of the clip rectangle [Integer]
+    # +height+:: height of the clip rectangle [Integer]
+    # +color+:: fill color for blank areas after crop {FXColor}
     #
     def crop(x, y, w, h, color=0) ; end
 
@@ -209,8 +209,8 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +color+::   the fade color [FXColor]
-    # +factor+::	fading factor [Integer]
+    # +color+::   the fade color {FXColor}
+    # +factor+:: fading factor [Integer]
     #
     def fade(color, factor=255); end
 
@@ -223,7 +223,7 @@ module Fox
     # ==== Parameters:
     #
     # +shear+::   how far to shear [Integer]
-    # +color+::	  fill color for areas outside the sheared image [FXColor]
+    # +color+::   fill color for areas outside the sheared image {FXColor}
     #
     def xshear(shear, color=0); end
 
@@ -236,7 +236,7 @@ module Fox
     # ==== Parameters:
     #
     # +shear+::   how far to shear [Integer]
-    # +color+::	  fill color for areas outside the sheared image [FXColor]
+    # +color+::   fill color for areas outside the sheared image {FXColor}
     #
     def yshear(shear, color=0); end
 
@@ -245,8 +245,8 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +left+::   starting color, for leftmost pixels [FXColor]
-    # +right+::  ending color, for rightmost pixels [FXColor]
+    # +left+::   starting color, for leftmost pixels {FXColor}
+    # +right+::  ending color, for rightmost pixels {FXColor}
     #
     def hgradient(left, right); end
 
@@ -255,8 +255,8 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +top+::      starting color, for topmost pixels [FXColor]
-    # +bottom+::	 ending color, for bottommost pixels [FXColor]
+    # +top+::      starting color, for topmost pixels {FXColor}
+    # +bottom+::  ending color, for bottommost pixels {FXColor}
     #
     def vgradient(top, bottom); end
 
@@ -265,10 +265,10 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +topleft+::      pixel color for top-left corner [FXColor]
-    # +topright+::	   pixel color for top-right corner [FXColor]
-    # +bottomleft+::   pixel color for bottom-left corner [FXColor]
-    # +bottomright+::  pixel color for bottom-right corner [FXColor]
+    # +topleft+::      pixel color for top-left corner {FXColor}
+    # +topright+::    pixel color for top-right corner {FXColor}
+    # +bottomleft+::   pixel color for bottom-left corner {FXColor}
+    # +bottomright+::  pixel color for bottom-right corner {FXColor}
     #
     def gradient(topleft, topright, bottomleft, bottomright); end
 
@@ -277,7 +277,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +color+::	  the blended color [FXColor]
+    # +color+::   the blended color {FXColor}
     #
     def blend(color); end
 
@@ -285,17 +285,17 @@ module Fox
     # Save pixel data to a stream.
     #
     # Note that the base class version of
-    # #savePixels saves the pixel data as-is, without any image format
+    # {#savePixels} saves the pixel data as-is, without any image format
     # specific information. For example, if you have a 1024x768 image
     # without an alpha channel (and thus only the red, green and blue
     # channels) the total number of bytes written to the stream will be
-    # 1024*768*3*8. The behavior of #savePixels is different for subclasses
-    # such as FXPNGImage, where #savePixels will instead save the image
+    # 1024*768*3*8. The behavior of {#savePixels} is different for subclasses
+    # such as FXPNGImage, where {#savePixels} will instead save the image
     # data in a specific image file format (i.e. the PNG file format).
     #
     # ==== Parameters:
     #
-    # +store+::	opened stream to which to save the pixel data [FXStream]
+    # +store+:: opened stream to which to save the pixel data {FXStream}
     #
     def savePixels(store) ; end
 
@@ -303,18 +303,18 @@ module Fox
     # Load pixel data from a stream.
     #
     # Note that the base class version of
-    # #loadPixels expects to read the the pixel data in a neutral format
+    # {#loadPixels} expects to read the the pixel data in a neutral format
     # (i.e. without any image format specific information). For example, if
     # you have a 1024x768 image without an alpha channel (and thus only the
-    # red, green and blue channels), #loadPixels will attempt to read a total
-    # of 1024*768*3*8 bytes from the stream. The behavior of #loadPixels is
-    # different for subclasses such as FXPNGImage, where #loadPixels will instead
+    # red, green and blue channels), {#loadPixels} will attempt to read a total
+    # of 1024*768*3*8 bytes from the stream. The behavior of {#loadPixels} is
+    # different for subclasses such as FXPNGImage, where {#loadPixels} will instead
     # expects to read the image data in a specific image file format (i.e. the
     # PNG file format).
     #
     # ==== Parameters:
     #
-    # +store+::	opened stream from which to read the pixel data [FXStream]
+    # +store+:: opened stream from which to read the pixel data {FXStream}
     #
     def loadPixels(store) ; end
   end

data/rdoc-sources/FXImageFrame.rb

@@ -4,7 +4,7 @@ module Fox
   #
   class FXImageFrame < FXFrame
 
-    # The current image being displayed [FXImage]
+    # The current image being displayed {FXImage}
     attr_accessor :image
 
     #
@@ -18,17 +18,17 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +p+::         the parent window for this image frame [FXComposite]
-    # +img+::       the image to display [FXImage]
-    # +opts+::	    frame options [Integer]
-    # +x+::	        initial x-position [Integer]
-    # +y+::	        initial y-position [Integer]
-    # +width+::	    initial width [Integer]
-    # +height+::	  initial height [Integer]
-    # +padLeft+::	  internal padding on the left side, in pixels [Integer]
-    # +padRight+::	internal padding on the right side, in pixels [Integer]
-    # +padTop+::	  internal padding on the top side, in pixels [Integer]
-    # +padBottom+::	internal padding on the bottom side, in pixels [Integer]
+    # +p+::         the parent window for this image frame {FXComposite}
+    # +img+::       the image to display {FXImage}
+    # +opts+::     frame options [Integer]
+    # +x+::         initial x-position [Integer]
+    # +y+::         initial y-position [Integer]
+    # +width+::     initial width [Integer]
+    # +height+::   initial height [Integer]
+    # +padLeft+::   internal padding on the left side, in pixels [Integer]
+    # +padRight+:: internal padding on the right side, in pixels [Integer]
+    # +padTop+::   internal padding on the top side, in pixels [Integer]
+    # +padBottom+:: internal padding on the bottom side, in pixels [Integer]
     #
     def initialize(p, img, opts=FRAME_SUNKEN|FRAME_THICK, x=0, y=0, width=0, height=0, padLeft=0, padRight=0, padTop=0, padBottom=0) # :yields: theImageFrame
     end

data/rdoc-sources/FXImageView.rb

@@ -4,22 +4,22 @@ module Fox
   #
   # === Image alignment styles
   #
-  # +IMAGEVIEW_NORMAL+::	Normal mode is centered
-  # +IMAGEVIEW_CENTER_X+::	Centered horizontally
-  # +IMAGEVIEW_LEFT+::		Left-aligned
-  # +IMAGEVIEW_RIGHT+::		Right-aligned
-  # +IMAGEVIEW_CENTER_Y+::	Centered vertically
-  # +IMAGEVIEW_TOP+::		Top-aligned
-  # +IMAGEVIEW_BOTTOM+::	Bottom-aligned
+  # +IMAGEVIEW_NORMAL+:: Normal mode is centered
+  # +IMAGEVIEW_CENTER_X+:: Centered horizontally
+  # +IMAGEVIEW_LEFT+::  Left-aligned
+  # +IMAGEVIEW_RIGHT+::  Right-aligned
+  # +IMAGEVIEW_CENTER_Y+:: Centered vertically
+  # +IMAGEVIEW_TOP+::  Top-aligned
+  # +IMAGEVIEW_BOTTOM+:: Bottom-aligned
   #
   # === Events
   #
-  # +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_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.
   #
   class FXImageView < FXScrollArea
 
-    # The image [FXImage]
+    # The image {FXImage}
     attr_accessor :image
 
     # Current alignment [Integer]

data/rdoc-sources/FXInputDialog.rb

@@ -6,10 +6,10 @@ module Fox
   #
   # === Input dialog options
   #
-  # +INPUTDIALOG_STRING+::	Ask for a string
-  # +INPUTDIALOG_INTEGER+::	Ask for an integer number
-  # +INPUTDIALOG_REAL+::	Ask for a real number
-  # +INPUTDIALOG_PASSWORD+::	Do not reveal key-in
+  # +INPUTDIALOG_STRING+:: Ask for a string
+  # +INPUTDIALOG_INTEGER+:: Ask for an integer number
+  # +INPUTDIALOG_REAL+:: Ask for a real number
+  # +INPUTDIALOG_PASSWORD+:: Do not reveal key-in
   #
   class FXInputDialog < FXDialogBox
 

data/rdoc-sources/FXJPGIcon.rb

@@ -25,12 +25,12 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +a+::	an application instance [FXApp]
-    # +pix+::	a memory buffer formatted in JPEG 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 JPEG file format [String]
+    # +clr+:: transparency color {FXColor}
+    # +opts+:: options [Integer]
+    # +width+:: width [Integer]
+    # +height+:: height [Integer]
     # +quality+:: JPEG image quality [Integer]
     #
     def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1, quality=75) # :yields: theJPGIcon
@@ -44,7 +44,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.fxloadJPG(store); end
 
@@ -54,12 +54,12 @@ module Fox
   #
   # ==== Parameters:
   #
-  # +store+::	stream to which to write the image data [FXStream]
-  # +data+::	the image pixel data [String]
-  # +transp+::	transparency color [FXColor]
-  # +width+::	width [Integer]
-  # +height+::	height [Integer]
-  # +quality+::	image quality [Integer]
+  # +store+:: stream to which to write the image data {FXStream}
+  # +data+:: the image pixel data [String]
+  # +transp+:: transparency color {FXColor}
+  # +width+:: width [Integer]
+  # +height+:: height [Integer]
+  # +quality+:: image quality [Integer]
   #
   def Fox.fxsaveJPG(store, data, transp, width, height, quality); end
 

data/rdoc-sources/FXJPGImage.rb

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

data/rdoc-sources/FXKnob.rb

@@ -9,12 +9,12 @@ module Fox
   #
   # The following messages are sent by FXKnob to its 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_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_COMMAND+::
   #   sent at the end of a knob move; the message data is the new value of the knob.
   # +SEL_CHANGED+::
@@ -23,11 +23,11 @@ module Fox
   #
   # === Knob Control styles
   #
-  # +KNOB_NEEDLE+::	Use a needle as indicator
-  # +KNOB_DOT+::	Use a dot as indicator
-  # +KNOB_TICKS+::	Show ticks around the knob
-  # +KNOB_INDICATOR+::	Show only the indicator (like a speedometer)
-  # +KNOB_NORMAL+::	Normal knob looks
+  # +KNOB_NEEDLE+:: Use a needle as indicator
+  # +KNOB_DOT+:: Use a dot as indicator
+  # +KNOB_TICKS+:: Show ticks around the knob
+  # +KNOB_INDICATOR+:: Show only the indicator (like a speedometer)
+  # +KNOB_NORMAL+:: Normal knob looks
   #
   class FXKnob < FXFrame
 
@@ -46,7 +46,7 @@ module Fox
     # Delta between ticks [Integer]
     attr_accessor :tickDelta
 
-    # Indicator needle color [FXColor]
+    # Indicator needle color {FXColor}
     attr_accessor :lineColor
 
     # Help text displayed on the status line [String]

data/rdoc-sources/FXLabel.rb

@@ -41,13 +41,13 @@ module Fox
     # The text for this label [String]
     attr_accessor :text
 
-    # The icon for this label [FXIcon]
+    # The icon for this label {FXIcon}
     attr_accessor :icon
 
-    # The text font [FXFont]
+    # The text font {FXFont}
     attr_accessor :font
 
-    # The text color [FXColor]
+    # The text color {FXColor}
     attr_accessor :textColor
 
     # Text justification mode [Integer]