fxruby 1.6.22 → 1.6.23

data/rdoc-sources/FXDCPrint.rb

@@ -26,27 +26,27 @@ module Fox
   #
   # === Printer flags
   #
-  # +PRINT_DEST_PAPER+::	Send print to paper
-  # +PRINT_DEST_FILE+::		Send print to file
-  # +PRINT_PAGES_ALL+::		Print all pages
-  # +PRINT_PAGES_EVEN+::	Print even pages only
-  # +PRINT_PAGES_ODD+::		Print odd pages only
-  # +PRINT_PAGES_RANGE+::	Print range of pages
-  # +PRINT_COLLATE_NORMAL+::	Normal collate order
-  # +PRINT_COLLATE_REVERSED+::	Reversed collate order
-  # +PRINT_PORTRAIT+::		Portrait orientation
-  # +PRINT_LANDSCAPE+::		Landscape orientation
-  # +PRINT_BLACKANDWHITE+::	Black and white output
-  # +PRINT_COLOR+::		Color output
-  # +PRINT_NOBOUNDS+::		Must determine bounding box
+  # +PRINT_DEST_PAPER+:: Send print to paper
+  # +PRINT_DEST_FILE+::  Send print to file
+  # +PRINT_PAGES_ALL+::  Print all pages
+  # +PRINT_PAGES_EVEN+:: Print even pages only
+  # +PRINT_PAGES_ODD+::  Print odd pages only
+  # +PRINT_PAGES_RANGE+:: Print range of pages
+  # +PRINT_COLLATE_NORMAL+:: Normal collate order
+  # +PRINT_COLLATE_REVERSED+:: Reversed collate order
+  # +PRINT_PORTRAIT+::  Portrait orientation
+  # +PRINT_LANDSCAPE+::  Landscape orientation
+  # +PRINT_BLACKANDWHITE+:: Black and white output
+  # +PRINT_COLOR+::  Color output
+  # +PRINT_NOBOUNDS+::  Must determine bounding box
   #
   # === Printer media size
   #
-  # +MEDIA_CUSTOM+::		Custom paper size
-  # +MEDIA_USLETTER+::		US Letter size
-  # +MEDIA_LEGAL+::		US Legal size
-  # +MEDIA_A4+::		A4
-  # +MEDIA_ENVELOPE+::		#10 Envelope
+  # +MEDIA_CUSTOM+::  Custom paper size
+  # +MEDIA_USLETTER+::  US Letter size
+  # +MEDIA_LEGAL+::  US Legal size
+  # +MEDIA_A4+::  A4
+  # +MEDIA_ENVELOPE+::  #10 Envelope
   #
   class FXPrinter
     # Printer name [String]
@@ -111,13 +111,13 @@ module Fox
 
     #
     # Generate print job epilog.
-    # See also #beginPrint.
+    # See also {#beginPrint}.
     #
     def endPrint(); end
 
     #
     # Generate end of page.
-    # See also #beginPage.
+    # See also {#beginPage}.
     #
     def endPage(); end
 

data/rdoc-sources/FXDCWindow.rb

@@ -14,9 +14,9 @@ module Fox
     # If _event_ is a reference to an FXEvent, the device context is constructed for
     # painting in response to an expose; this sets the clip rectangle to the exposed rectangle.
     # If an optional code block is provided, the new device context will be passed into the block as an
-    # argument and #end will be called automatically when the block terminates.
+    # argument and {#end} will be called automatically when the block terminates.
     #
-    def initialize(drawable, event=nil)	# :yields: dc
+    def initialize(drawable, event=nil) # :yields: dc
     end
 
     #

data/rdoc-sources/FXDataTarget.rb

@@ -44,7 +44,7 @@ module Fox
   #
   class FXDataTarget < FXObject
 
-    # The message target object for this data target [FXObject]
+    # The message target object for this data target {FXObject}
     attr_accessor :target
 
     # The message identifier for this data target [Integer]

data/rdoc-sources/FXDebugTarget.rb

@@ -9,7 +9,7 @@ module Fox
     # Returns an array of strings containing the names of the message types.
     # So, for example,
     #
-    #	puts FXDebugTarget.messageTypeName[SEL_COMMAND]
+    # puts FXDebugTarget.messageTypeName[SEL_COMMAND]
     #
     # should print the text "SEL_COMMAND".
     #

data/rdoc-sources/FXDelegator.rb

@@ -10,8 +10,8 @@ module Fox
   #
   class FXDelegator < FXObject
 
-    # The object to which all messages are delegated [FXObject]
-    attr_accessor	:delegate
+    # The object to which all messages are delegated {FXObject}
+    attr_accessor :delegate
 
     #
     # Construct a new delegator

data/rdoc-sources/FXDial.rb

@@ -13,12 +13,12 @@ module Fox
   #
   # The following messages are sent by FXDial 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_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_CHANGED+::             sent when the dial's value changes; the message data is the new value (an integer).
-  # +SEL_COMMAND+::		sent when the user stops changing the dial's value and releases the mouse button; the message data is the new value (an integer).
+  # +SEL_COMMAND+::  sent when the user stops changing the dial's value and releases the mouse button; the message data is the new value (an integer).
   #
   # === Dial style options
   #
@@ -60,7 +60,7 @@ module Fox
     # Current dial style [Integer]
     attr_accessor :dialStyle
 
-    # Center notch color [FXColor]
+    # Center notch color {FXColor}
     attr_accessor :notchColor
 
     # Status line help text for this dial [String]
@@ -74,9 +74,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +p+::	parent widget for this dial [FXComposite]
-    # +target+::	message target object for this dial [FXObject]
-    # +selector+::	message identifier [Integer]
+    # +p+:: parent widget for this dial {FXComposite}
+    # +target+:: message target object for this dial {FXObject}
+    # +selector+:: message identifier [Integer]
     # +opts+::
     # +x+::
     # +y+::

data/rdoc-sources/FXDialogBox.rb

@@ -7,12 +7,12 @@ module Fox
   # loop and returns a completion code of either 0 or 1, respectively.
   #
   # To close a dialog box when it's not running modally, simply call
-  # FXDialogBox#hide (or send it the +ID_HIDE+ command message).
+  # {#hide} (or send it the +ID_HIDE+ command message).
   #
   # === Message identifiers
   #
-  # +ID_CANCEL+::	Close the dialog, cancel the entry
-  # +ID_ACCEPT+::	Close the dialog, accept the entry
+  # +ID_CANCEL+:: Close the dialog, cancel the entry
+  # +ID_ACCEPT+:: Close the dialog, accept the entry
   #
   class FXDialogBox < FXTopWindow
     #

data/rdoc-sources/FXDict.rb

@@ -2,9 +2,8 @@ module Fox
   #
   # The dictionary class maintains a fast-access hash table of entities
   # indexed by a character string.
-  # It is typically used to map strings to pointers; however, overloading
-  # the #createData and #deleteData members allows any type of data to
-  # be indexed by strings.
+  # It is typically used to map strings to pointers; however, derived classes
+  # may allow any type of data to be indexed by strings.
   #
   class FXDict < FXObject
 

data/rdoc-sources/FXDirBox.rb

@@ -10,7 +10,7 @@ module Fox
   #
   # === Options
   #
-  # +DIRBOX_NO_OWN_ASSOC+::	do not create associations for files
+  # +DIRBOX_NO_OWN_ASSOC+:: do not create associations for files
   #
   # === Events
   #
@@ -24,7 +24,7 @@ module Fox
     # Current directory [String]
     attr_accessor :directory
 
-    # File associations [FXFileDict]
+    # File associations {FXFileDict}
     attr_accessor :associations
 
     # Return an initialized FXDirBox instance.

data/rdoc-sources/FXDirList.rb

@@ -3,7 +3,7 @@ module Fox
   # Directory item
   #
   class FXDirItem < FXTreeItem
-    # File associations [FXFileAssoc]
+    # File associations {FXFileAssoc}
     attr_reader :assoc
 
     # File size [Integer]
@@ -56,21 +56,21 @@ module Fox
   #
   # === Directory List options
   #
-  # +DIRLIST_SHOWFILES+::	Show files as well as directories
-  # +DIRLIST_SHOWHIDDEN+::	Show hidden files or directories
-  # +DIRLIST_NO_OWN_ASSOC+::	Do not create associations for files
+  # +DIRLIST_SHOWFILES+:: Show files as well as directories
+  # +DIRLIST_SHOWHIDDEN+:: Show hidden files or directories
+  # +DIRLIST_NO_OWN_ASSOC+:: Do not create associations for files
   #
   # === Message identifiers
   #
-  # +ID_REFRESH+::		x
-  # +ID_SHOW_FILES+::		x
-  # +ID_HIDE_FILES+::		x
-  # +ID_TOGGLE_FILES+::		x
-  # +ID_SHOW_HIDDEN+::		x
-  # +ID_HIDE_HIDDEN+::		x
-  # +ID_TOGGLE_HIDDEN+::	x
-  # +ID_SET_PATTERN+::		x
-  # +ID_SORT_REVERSE+::		x
+  # +ID_REFRESH+::  x
+  # +ID_SHOW_FILES+::  x
+  # +ID_HIDE_FILES+::  x
+  # +ID_TOGGLE_FILES+::  x
+  # +ID_SHOW_HIDDEN+::  x
+  # +ID_HIDE_HIDDEN+::  x
+  # +ID_TOGGLE_HIDDEN+:: x
+  # +ID_SET_PATTERN+::  x
+  # +ID_SORT_REVERSE+::  x
   #
   class FXDirList < FXTreeList
 
@@ -86,7 +86,7 @@ module Fox
     # Wildcard matching mode, some combination of file matching flags [Integer]
     attr_accessor :matchMode
 
-    # File associations [FXFileDict]
+    # File associations {FXFileDict}
     attr_accessor :associations
 
     # Returns an initialized FXDirList instance

data/rdoc-sources/FXDirSelector.rb

@@ -8,25 +8,25 @@ module Fox
   #
   # === Message identifiers
   #
-  # +ID_DIRNAME+::	x
-  # +ID_DIRLIST+::	x
-  # +ID_HOME+::		x
-  # +ID_WORK+::		x
-  # +ID_DIRECTORY_UP+::	x
-  # +ID_BOOKMARK+::	x
-  # +ID_VISIT+::	x
-  # +ID_NEW+::		x
-  # +ID_DELETE+::	x
-  # +ID_MOVE+::		x
-  # +ID_COPY+::		x
-  # +ID_LINK+::		x
+  # +ID_DIRNAME+:: x
+  # +ID_DIRLIST+:: x
+  # +ID_HOME+::  x
+  # +ID_WORK+::  x
+  # +ID_DIRECTORY_UP+:: x
+  # +ID_BOOKMARK+:: x
+  # +ID_VISIT+:: x
+  # +ID_NEW+::  x
+  # +ID_DELETE+:: x
+  # +ID_MOVE+::  x
+  # +ID_COPY+::  x
+  # +ID_LINK+::  x
   #
   class FXDirSelector < FXPacker
 
-    # The "Accept" button [FXButton]
+    # The "Accept" button {FXButton}
     attr_reader :acceptButton
 
-    # The "Cancel" button [FXButton]
+    # The "Cancel" button {FXButton}
     attr_reader :cancelButton
 
     # Directory [String]

data/rdoc-sources/FXDockBar.rb

@@ -11,19 +11,19 @@ module Fox
   #
   # The following messages are sent by FXDockBar to its target:
   #
-  # +SEL_DOCKED+::		sent when the dock bar is docked; the message data is a reference to the new dock site (an FXDockSite instance).
-  # +SEL_FLOATED+::		sent when the dock bar is undocked; the message data is a reference to the previous dock site.
+  # +SEL_DOCKED+::  sent when the dock bar is docked; the message data is a reference to the new dock site (an FXDockSite instance).
+  # +SEL_FLOATED+::  sent when the dock bar is undocked; the message data is a reference to the previous dock site.
   #
   # === Dock Bar Options
   #
-  # +ALLOW_NOWHERE+::		Don't allow docking anywhere
-  # +ALLOW_TOP+::		Docking at the top only
-  # +ALLOW_BOTTOM+::		Docking at the bottom only
-  # +ALLOW_LEFT+::		Docking at the left only
-  # +ALLOW_RIGHT+::		Docking at the right only
-  # +ALLOW_HORIZONTAL+::	Docking at the top and bottom
-  # +ALLOW_VERTICAL+::		Docking at the left and right
-  # +ALLOW_EVERYWHERE+::	Docking can be everywhere
+  # +ALLOW_NOWHERE+::  Don't allow docking anywhere
+  # +ALLOW_TOP+::  Docking at the top only
+  # +ALLOW_BOTTOM+::  Docking at the bottom only
+  # +ALLOW_LEFT+::  Docking at the left only
+  # +ALLOW_RIGHT+::  Docking at the right only
+  # +ALLOW_HORIZONTAL+:: Docking at the top and bottom
+  # +ALLOW_VERTICAL+::  Docking at the left and right
+  # +ALLOW_EVERYWHERE+:: Docking can be everywhere
   #
   class FXDockBar < FXPacker
 
@@ -41,19 +41,19 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +p+::	the "dry dock" window for this dock bar [FXComposite]
-    # +q+::	the "wet dock" window for this dock bar [FXComposite]
-    # +opts+::	dock bar 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 "dry dock" window for this dock bar {FXComposite}
+    # +q+:: the "wet dock" window for this dock bar {FXComposite}
+    # +opts+:: dock bar 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, q, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theDockBar
     end
@@ -64,18 +64,18 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +p+::	the parent window for this dock bar [FXComposite]
-    # +opts+::	dock bar 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 dock bar {FXComposite}
+    # +opts+:: dock bar 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, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theDockBar
     end

data/rdoc-sources/FXDockHandler.rb

@@ -7,8 +7,8 @@ module Fox
   #
   # The following messages are sent by FXDockHandler 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_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.
   #
   class FXDockHandler < FXFrame
     # Status line help text [String]

data/rdoc-sources/FXDockSite.rb

@@ -23,8 +23,8 @@ module Fox
   #
   # === Dock Site Options
   #
-  # +DOCKSITE_WRAP+::		Dockbars are wrapped to another galley when not enough space on current galley
-  # +DOCKSITE_NO_WRAP+::	Never wrap dockbars to another galley even if not enough space
+  # +DOCKSITE_WRAP+::  Dockbars are wrapped to another galley when not enough space on current galley
+  # +DOCKSITE_NO_WRAP+:: Never wrap dockbars to another galley even if not enough space
   #
   class FXDockSite < FXPacker
     #
@@ -42,9 +42,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +bar+::		a reference to the dockbar that's being dragged [FXDockBar]
-    # +barx+::		current x-coordinate of the dockbar [Integer]
-    # +bary+		current y-coordinate of the dockbar [Integer]
+    # +bar+::  a reference to the dockbar that's being dragged {FXDockBar}
+    # +barx+::  current x-coordinate of the dockbar [Integer]
+    # +bary+  current y-coordinate of the dockbar [Integer]
     #
     def moveToolBar(bar, barx, bary); end
 
@@ -56,8 +56,8 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +bar+::		a reference to the newly docked dockbar [FXDockBar]
-    # +before+::	a reference to the window that the dockbar was added before [FXWindow]
+    # +bar+::  a reference to the newly docked dockbar {FXDockBar}
+    # +before+:: a reference to the window that the dockbar was added before {FXWindow}
     #
     def dockToolBar(bar, before); end
 
@@ -69,9 +69,9 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +bar+::		a reference to the newly docked dockbar [FXDockBar][FXDockBar]
-    # +barx+::		x-coordinate of the docking position [Integer]
-    # +bary+::		y-coordinate of the docking position [Integer]
+    # +bar+::  a reference to the newly docked dockbar {FXDockBar}{FXDockBar}
+    # +barx+::  x-coordinate of the docking position [Integer]
+    # +bary+::  y-coordinate of the docking position [Integer]
     #
     def dockToolBar(bar, barx, bary); end
 
@@ -83,7 +83,7 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +bar+::	a reference to the removed dockbar [FXDockBar]
+    # +bar+:: a reference to the removed dockbar {FXDockBar}
     #
     def undockToolBar(bar); end