fxruby 1.6.22 → 1.6.23

data/rdoc-sources/FXScrollPane.rb

@@ -17,9 +17,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +owner+::	owner window for this menu pane [FXWindow]
-    # +nvis+::	maximum number of visible items [Integer]
-    # +opts+::	options [Integer]
+    # +owner+:: owner window for this menu pane {FXWindow}
+    # +nvis+:: maximum number of visible items [Integer]
+    # +opts+:: options [Integer]
     #
     def initialize(owner, nvis, opts=0) # :yields: theScrollPane
     end

data/rdoc-sources/FXScrollWindow.rb

@@ -19,12 +19,12 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +p+::	the parent window for this scroll window [FXComposite]
-    # +opts+::	the options [Integer]
-    # +x+::	initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer]
-    # +y+::	initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer]
-    # +width+::	initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
-    # +height+::	initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [Integer]
+    # +p+:: the parent window for this scroll window {FXComposite}
+    # +opts+:: the options [Integer]
+    # +x+:: initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer]
+    # +y+:: initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer]
+    # +width+:: initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
+    # +height+:: initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [Integer]
     #
     def initialize(p, opts=0, x=0, y=0, width=0, height=0) # :yields: theScrollWindow
     end

data/rdoc-sources/FXSearchDialog.rb

@@ -8,14 +8,14 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +owner+::		the owner window for this dialog box [FXWindow]
-    # +caption+::	the caption (title) string for this dialog box [String]
-    # +ic+::		the icon [FXIcon]
-    # +opts+::		the options [Integer]
-    # +x+::		initial x-position [Integer]
-    # +y+::		initial y-position [Integer]
-    # +width+::		initial width [Integer]
-    # +height+::		initial height [Integer]
+    # +owner+::  the owner window for this dialog box {FXWindow}
+    # +caption+:: the caption (title) string for this dialog box [String]
+    # +ic+::  the icon {FXIcon}
+    # +opts+::  the options [Integer]
+    # +x+::  initial x-position [Integer]
+    # +y+::  initial y-position [Integer]
+    # +width+::  initial width [Integer]
+    # +height+::  initial height [Integer]
     #
     def initialize(owner, caption, ic=nil, opts=0, x=0, y=0, width=0, height=0) # :yields: theSearchDialog
     end

data/rdoc-sources/FXSeparator.rb

@@ -8,10 +8,10 @@ module Fox
   #
   # === Separator options
   #
-  # +SEPARATOR_NONE+::		Nothing visible
-  # +SEPARATOR_GROOVE+::	Etched-in looking groove
-  # +SEPARATOR_RIDGE+::		Embossed looking ridge
-  # +SEPARATOR_LINE+::		Simple line
+  # +SEPARATOR_NONE+::  Nothing visible
+  # +SEPARATOR_GROOVE+:: Etched-in looking groove
+  # +SEPARATOR_RIDGE+::  Embossed looking ridge
+  # +SEPARATOR_LINE+::  Simple line
   #
   class FXSeparator < FXFrame
 
@@ -32,16 +32,16 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +p+::	the parent widget for this separator [FXComposite]
-    # +opts+::	the 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 widget for this separator {FXComposite}
+    # +opts+:: the 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, opts=SEPARATOR_GROOVE|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=1, padRight=1, padTop=0, padBottom=0) # :yields: theHorizontalSeparator
     end
@@ -56,16 +56,16 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +p+::	the parent widget for this separator [FXComposite]
-    # +opts+::	the 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 widget for this separator {FXComposite}
+    # +opts+:: the 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, opts=SEPARATOR_GROOVE|LAYOUT_FILL_Y, x=0, y=0, width=0, height=0, padLeft=0, padRight=0, padTop=1, padBottom=1) # :yields: theVerticalSeparator
     end

data/rdoc-sources/FXSettings.rb

@@ -30,7 +30,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +pos+::	the section number of interest [Integer]
+    # +pos+:: the section number of interest [Integer]
     #
     def data(pos) ; end
 
@@ -41,7 +41,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name of interest [String]
+    # +section+:: the section name of interest [String]
     #
     def find(section) ; end
 
@@ -57,9 +57,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for the setting of interest [String]
-    # +default+::	the default value to return if _key_ is not found [String]
+    # +section+:: the section name [String]
+    # +key+::  the key for the setting of interest [String]
+    # +default+:: the default value to return if _key_ is not found [String]
     #
     def readStringEntry(section, key, default="") ; end
 
@@ -69,9 +69,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for the setting of interest [String]
-    # +default+::	the default value to return if _key_ is not found [Integer]
+    # +section+:: the section name [String]
+    # +key+::  the key for the setting of interest [String]
+    # +default+:: the default value to return if _key_ is not found [Integer]
     #
     def readIntEntry(section, key, default=0) ; end
 
@@ -81,9 +81,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for the setting of interest [String]
-    # +default+::	the default value to return if _key_ is not found [Integer]
+    # +section+:: the section name [String]
+    # +key+::  the key for the setting of interest [String]
+    # +default+:: the default value to return if _key_ is not found [Integer]
     #
     def readUnsignedEntry(section, key, default=0) ; end
 
@@ -93,9 +93,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for the setting of interest [String]
-    # +default+::	the default value to return if _key_ is not found [Float]
+    # +section+:: the section name [String]
+    # +key+::  the key for the setting of interest [String]
+    # +default+:: the default value to return if _key_ is not found [Float]
     #
     def readRealEntry(section, key, default=0.0) ; end
 
@@ -105,9 +105,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for the setting of interest [String]
-    # +default+::	the default value to return if _key_ is not found [FXColor]
+    # +section+:: the section name [String]
+    # +key+::  the key for the setting of interest [String]
+    # +default+:: the default value to return if _key_ is not found {FXColor}
     #
     def readColorEntry(section, key, default=0) ; end
 
@@ -117,9 +117,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for the setting of interest [String]
-    # +default+::	the default value to return if _key_ is not found [true or false]
+    # +section+:: the section name [String]
+    # +key+::  the key for the setting of interest [String]
+    # +default+:: the default value to return if _key_ is not found [true or false]
     #
     def readBoolEntry(section, key, default=false) ; end
 
@@ -129,9 +129,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for this setting [String]
-    # +value+::		the value for this setting [String]
+    # +section+:: the section name [String]
+    # +key+::  the key for this setting [String]
+    # +value+::  the value for this setting [String]
     #
     def writeStringEntry(section, key, value) ; end
 
@@ -141,9 +141,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for this setting [String]
-    # +value+::		the value for this setting [Integer]
+    # +section+:: the section name [String]
+    # +key+::  the key for this setting [String]
+    # +value+::  the value for this setting [Integer]
     #
     def writeIntEntry(section, key, value) ; end
 
@@ -153,9 +153,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for this setting [String]
-    # +value+::		the value for this setting [Integer]
+    # +section+:: the section name [String]
+    # +key+::  the key for this setting [String]
+    # +value+::  the value for this setting [Integer]
     #
     def writeUnsignedEntry(section, key, value) ; end
 
@@ -165,9 +165,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for this setting [String]
-    # +value+::		the value for this setting [Float]
+    # +section+:: the section name [String]
+    # +key+::  the key for this setting [String]
+    # +value+::  the value for this setting [Float]
     #
     def writeRealEntry(section, key, value) ; end
 
@@ -177,9 +177,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for this setting [String]
-    # +value+::		the value for this setting [FXColor]
+    # +section+:: the section name [String]
+    # +key+::  the key for this setting [String]
+    # +value+::  the value for this setting {FXColor}
     #
     def writeColorEntry(section, key, value) ; end
 
@@ -189,9 +189,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section name [String]
-    # +key+::		the key for this setting [String]
-    # +value+::		the value for this setting [true or false]
+    # +section+:: the section name [String]
+    # +key+::  the key for this setting [String]
+    # +value+::  the value for this setting [true or false]
     #
     def writeBoolEntry(section, key, value) ; end
 
@@ -201,8 +201,8 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section containing the key to be deleted [String]
-    # +key+::		the key to be deleted [String]
+    # +section+:: the section containing the key to be deleted [String]
+    # +key+::  the key to be deleted [String]
     #
     def deleteEntry(section, key) ; end
 
@@ -211,8 +211,8 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the section containing the key of interest [String]
-    # +key+::		the key of interest [String]
+    # +section+:: the section containing the key of interest [String]
+    # +key+::  the key of interest [String]
     #
     def existingEntry?(section, key) ; end
 
@@ -222,7 +222,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the name of the section to be deleted [String]
+    # +section+:: the name of the section to be deleted [String]
     #
     def deleteSection(section) ; end
 
@@ -231,7 +231,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +section+::	the name of the section of interest [String]
+    # +section+:: the name of the section of interest [String]
     #
     def existingSection?(section) ; end
 

data/rdoc-sources/FXShutter.rb

@@ -7,15 +7,15 @@ module Fox
   #
   # === Message identifiers
   #
-  # +ID_SHUTTERITEM_BUTTON+::	x
+  # +ID_SHUTTERITEM_BUTTON+:: x
   #
   class FXShutterItem < FXVerticalFrame
     #
-    # The button for this shutter item [FXButton]
+    # The button for this shutter item {FXButton}
     #
     attr_reader :button
 
-    # The contents for this shutter item [FXVerticalFrame]
+    # The contents for this shutter item {FXVerticalFrame}
     attr_reader :content
 
     # Status line help text for this shutter item [String]
@@ -29,20 +29,20 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +p+::	the parent shutter for this shutter item [FXShutter]
-    # +text+::	the text, if any [String]
-    # +icon+::	the icon, if any [FXIcon]
-    # +opts+::	options [Integer]
-    # +x+::	initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer]
-    # +y+::	initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer]
-    # +width+::	initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
-    # +height+::	initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [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]
-    # +hSpacing+::	horizontal spacing between widgets, in pixels [Integer]
-    # +vSpacing+::	vertical spacing between widgets, in pixels [Integer]
+    # +p+:: the parent shutter for this shutter item {FXShutter}
+    # +text+:: the text, if any [String]
+    # +icon+:: the icon, if any {FXIcon}
+    # +opts+:: options [Integer]
+    # +x+:: initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer]
+    # +y+:: initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer]
+    # +width+:: initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
+    # +height+:: initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [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]
+    # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer]
+    # +vSpacing+:: vertical spacing between widgets, in pixels [Integer]
     #
     def initialize(p, text="", icon=nil, opts=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theShutterItem
     end
@@ -63,10 +63,10 @@ module Fox
   #
   # === Message identifiers
   #
-  # +ID_SHUTTER_TIMEOUT+::	x
-  # +ID_OPEN_SHUTTERITEM+::	x
-  # +ID_OPEN_FIRST+::		x
-  # +ID_OPEN_LAST+::		x
+  # +ID_SHUTTER_TIMEOUT+:: x
+  # +ID_OPEN_SHUTTERITEM+:: x
+  # +ID_OPEN_FIRST+::  x
+  # +ID_OPEN_LAST+::  x
   #
   class FXShutter < FXVerticalFrame
 
@@ -80,20 +80,20 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +p+::	the parent window for this shutter [FXComposite]
-    # +target+::	the message target, if any, for this shutter [FXObject]
-    # +selector+::	the message identifier for this shutter [Integer]
-    # +opts+::	shutter 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]
-    # +hSpacing+::	horizontal spacing between widgets, in pixels [Integer]
-    # +vSpacing+::	vertical spacing between widgets, in pixels [Integer]
+    # +p+:: the parent window for this shutter {FXComposite}
+    # +target+:: the message target, if any, for this shutter {FXObject}
+    # +selector+:: the message identifier for this shutter [Integer]
+    # +opts+:: shutter 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]
+    # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer]
+    # +vSpacing+:: vertical spacing between widgets, in pixels [Integer]
     #
     def initialize(p, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theShutter
     end

data/rdoc-sources/FXSize.rb

@@ -34,7 +34,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +margin+::	number of units to grow on each side [Integer]
+    # +margin+:: number of units to grow on each side [Integer]
     #
     def grow!(margin); end
 
@@ -43,8 +43,8 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +hormargin+::	number of units to grow on the left and right sides [Integer]
-    # +vermargin+::	number of units to grow on the top and bottom sides [Integer]
+    # +hormargin+:: number of units to grow on the left and right sides [Integer]
+    # +vermargin+:: number of units to grow on the top and bottom sides [Integer]
     #
     def grow!(hormargin, vermargin); end
 
@@ -53,10 +53,10 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +leftmargin+::	number of units to grow on the left side [Integer]
-    # +rightmargin+::	number of units to grow on the right side [Integer]
-    # +topmargin+::	number of units to grow on the top side [Integer]
-    # +bottommargin+::	number of units to grow on the bottom side [Integer]
+    # +leftmargin+:: number of units to grow on the left side [Integer]
+    # +rightmargin+:: number of units to grow on the right side [Integer]
+    # +topmargin+:: number of units to grow on the top side [Integer]
+    # +bottommargin+:: number of units to grow on the bottom side [Integer]
     #
     def grow!(leftmargin, rightmargin, topmargin, bottommargin); end
 
@@ -65,7 +65,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +margin+::	number of units to shrink on each side [Integer]
+    # +margin+:: number of units to shrink on each side [Integer]
     #
     def shrink!(margin); end
 
@@ -74,8 +74,8 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +hormargin+::	number of units to shrink on the left and right sides [Integer]
-    # +vermargin+::	number of units to shrink on the top and bottom sides [Integer]
+    # +hormargin+:: number of units to shrink on the left and right sides [Integer]
+    # +vermargin+:: number of units to shrink on the top and bottom sides [Integer]
     #
     def shrink!(hormargin, vermargin); end
 
@@ -84,10 +84,10 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +leftmargin+::	number of units to shrink on the left side [Integer]
-    # +rightmargin+::	number of units to shrink on the right side [Integer]
-    # +topmargin+::	number of units to shrink on the top side [Integer]
-    # +bottommargin+::	number of units to shrink on the bottom side [Integer]
+    # +leftmargin+:: number of units to shrink on the left side [Integer]
+    # +rightmargin+:: number of units to shrink on the right side [Integer]
+    # +topmargin+:: number of units to shrink on the top side [Integer]
+    # +bottommargin+:: number of units to shrink on the bottom side [Integer]
     #
     def shrink!(leftmargin, rightmargin, topmargin, bottommargin); end
   end