fxruby 1.6.22 → 1.6.23

data/rdoc-sources/FXGroupBox.rb

@@ -6,10 +6,10 @@ module Fox
   #
   # === Group box options
   #
-  # +GROUPBOX_TITLE_LEFT+::	Title is left-justified
-  # +GROUPBOX_TITLE_CENTER+::	Title is centered
-  # +GROUPBOX_TITLE_RIGHT+::	Title is right-justified
-  # +GROUPBOX_NORMAL+::		same as <tt>GROUPBOX_TITLE_LEFT</tt>
+  # +GROUPBOX_TITLE_LEFT+:: Title is left-justified
+  # +GROUPBOX_TITLE_CENTER+:: Title is centered
+  # +GROUPBOX_TITLE_RIGHT+:: Title is right-justified
+  # +GROUPBOX_NORMAL+::  same as <tt>GROUPBOX_TITLE_LEFT</tt>
 
   class FXGroupBox < FXPacker
 
@@ -19,10 +19,10 @@ module Fox
     # Group box style [Integer]
     attr_accessor :groupBoxStyle
 
-    # Title font [FXFont]
+    # Title font {FXFont}
     attr_accessor :font
 
-    # Title text color [FXColor]
+    # Title text color {FXColor}
     attr_accessor :textColor
 
     # Construct group box layout manager

data/rdoc-sources/FXHeader.rb

@@ -4,33 +4,33 @@ module Fox
   #
   # === Alignment hints
   #
-  # +RIGHT+::		Align on right
-  # +LEFT+::		Align on left
-  # +CENTER_X+::	Align centered horizontally (default)
-  # +TOP+::		Align on top
-  # +BOTTOM+::		Align on bottom
-  # +CENTER_Y+::	Align centered vertically (default)
+  # +RIGHT+::  Align on right
+  # +LEFT+::  Align on left
+  # +CENTER_X+:: Align centered horizontally (default)
+  # +TOP+::  Align on top
+  # +BOTTOM+::  Align on bottom
+  # +CENTER_Y+:: Align centered vertically (default)
   #
   # === Icon position
   #
-  # +BEFORE+::		Icon before the text
-  # +AFTER+::		Icon after the text
-  # +ABOVE+::		Icon above the text
-  # +BELOW+::		Icon below the text
+  # +BEFORE+::  Icon before the text
+  # +AFTER+::  Icon after the text
+  # +ABOVE+::  Icon above the text
+  # +BELOW+::  Icon below the text
   #
   # === Arrow
   #
-  # +ARROW_NONE+::	No arrow
-  # +ARROW_UP+::	Arrow pointing up
-  # +ARROW_DOWN+::	Arrow pointing down
-  # +PRESSED+::		Pressed down
+  # +ARROW_NONE+:: No arrow
+  # +ARROW_UP+:: Arrow pointing up
+  # +ARROW_DOWN+:: Arrow pointing down
+  # +PRESSED+::  Pressed down
   #
   class FXHeaderItem < FXObject
 
     # Item's text label [String]
     attr_accessor :text
 
-    # Item's icon [FXIcon]
+    # Item's icon {FXIcon}
     attr_accessor :icon
 
     # Item's user data [Object]
@@ -116,24 +116,24 @@ module Fox
   # +SEL_CLICKED+::
   #   sent when a header item is clicked; the message data is an integer
   #   indicating the index of the current item.
-  # +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_REPLACED+::		sent when a header item is about to be replaced; the message data is an Integer indicating the index of the item to be replaced.
-  # +SEL_INSERTED+::		sent after a header item is inserted; the message data is an Integer indicating the index of the item that was inserted.
-  # +SEL_DELETED+::		sent when a header item is about to be removed; the message data is an Integer indicating the index of the item to be removed.
+  # +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_REPLACED+::  sent when a header item is about to be replaced; the message data is an Integer indicating the index of the item to be replaced.
+  # +SEL_INSERTED+::  sent after a header item is inserted; the message data is an Integer indicating the index of the item that was inserted.
+  # +SEL_DELETED+::  sent when a header item is about to be removed; the message data is an Integer indicating the index of the item to be removed.
   #
   # === Header style options
   #
-  # +HEADER_BUTTON+::		Button style can be clicked
-  # +HEADER_HORIZONTAL+::	Horizontal header control (default)
-  # +HEADER_VERTICAL+::		Vertical header control
-  # +HEADER_TRACKING+::		Tracks continuously while moving
-  # +HEADER_RESIZE+::		Allow resizing sections
-  # +HEADER_NORMAL+::		Normal options, same as <tt>HEADER_HORIZONTAL|FRAME_NORMAL</tt>
+  # +HEADER_BUTTON+::  Button style can be clicked
+  # +HEADER_HORIZONTAL+:: Horizontal header control (default)
+  # +HEADER_VERTICAL+::  Vertical header control
+  # +HEADER_TRACKING+::  Tracks continuously while moving
+  # +HEADER_RESIZE+::  Allow resizing sections
+  # +HEADER_NORMAL+::  Normal options, same as <tt>HEADER_HORIZONTAL|FRAME_NORMAL</tt>
   #
   # === Message identifiers
   #
-  # +ID_TIPTIMER+::		x
+  # +ID_TIPTIMER+::  x
   #
   class FXHeader < FXFrame
 
@@ -146,10 +146,10 @@ module Fox
     # Current position [Integer]
     attr_accessor :position
 
-    # Text font [FXFont]
+    # Text font {FXFont}
     attr_accessor :font
 
-    # Text color [FXColor]
+    # Text color {FXColor}
     attr_accessor :textColor
 
     # Header style options [Integer]
@@ -190,7 +190,7 @@ module Fox
     #
     # Replace the item at _index_ with a new item with the specified
     # text, icon, size and user data object, and return the index of the replaced
-    # item. The new item is created by calling the FXHeader#createItem method.
+    # item.
     # If _notify_ is +true+, a +SEL_REPLACED+ message is sent to the header's
     # message target before the item is replaced.
     # Raises IndexError if _index_ is out of bounds.
@@ -215,7 +215,6 @@ module Fox
     #
     # Insert a new item at the specified _index_ with the specified text, icon, size
     # and user data object, and return the index of the inserted item.
-    # The new item is created by calling the FXHeader#createItem method.
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the header's
     # message target after the item is inserted.
     # Raises IndexError if _index_ is out of bounds.
@@ -233,7 +232,6 @@ module Fox
     #
     # Append a new item with the specified text, icon, size and user data object,
     # and return the index of the appended item.
-    # The new item is created by calling the FXHeader#createItem method.
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the header's
     # message target after the item is appended.
     #
@@ -250,7 +248,6 @@ module Fox
     #
     # Prepend a new item with the specified text, icon, size and user data object,
     # and return the index of the appended item.
-    # The new item is created by calling the FXHeader#createItem method.
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the header's
     # message target after the item is appended.
     #

data/rdoc-sources/FXHorizontalFrame.rb

@@ -10,18 +10,18 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +p+::	the parent window for this horizontal frame [FXComposite]
-    # +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]
-    # +hSpacing+::	horizontal spacing between widgets, in pixels [Integer]
-    # +vSpacing+::	vertical spacing between widgets, in pixels [Integer]
+    # +p+:: the parent window for this horizontal frame {FXComposite}
+    # +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]
+    # +hSpacing+:: horizontal spacing between widgets, in pixels [Integer]
+    # +vSpacing+:: vertical spacing between widgets, in pixels [Integer]
     #
     def initialize(p, 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: theHorizontalFrame
     end

data/rdoc-sources/FXICOIcon.rb

@@ -18,12 +18,12 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +a+::	an application instance [FXApp]
-    # +pix+::	a memory buffer formatted in ICO 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 ICO 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: theICOIcon
     end
@@ -37,7 +37,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.fxloadICO(store); end
 
@@ -47,13 +47,13 @@ module Fox
   #
   # ==== Parameters:
   #
-  # +store+::	stream to which to write the image data [FXStream]
-  # +pixels+::	the image pixel data [String]
-  # +transp+::	transparency color [FXColor]
-  # +width+::	width [Integer]
-  # +height+::	height [Integer]
-  # +xspot+::	hotspot x-coordinate [Integer]
-  # +yspot+::	hotspot y-coordinate [Integer]
+  # +store+:: stream to which to write the image data {FXStream}
+  # +pixels+:: the image pixel data [String]
+  # +transp+:: transparency color {FXColor}
+  # +width+:: width [Integer]
+  # +height+:: height [Integer]
+  # +xspot+:: hotspot x-coordinate [Integer]
+  # +yspot+:: hotspot y-coordinate [Integer]
   #
   def Fox.fxsaveICO(store, pixels, transp, width, height, xspot=-1, yspot=-1); end
 

data/rdoc-sources/FXICOImage.rb

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

data/rdoc-sources/FXIcon.rb

@@ -7,7 +7,7 @@ module Fox
   #
   class FXIcon < FXImage
 
-    # Transparency color [FXColor]
+    # Transparency color {FXColor}
     attr_accessor :transparentColor
 
     #
@@ -25,12 +25,12 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +a+::	an application instance [FXApp]
-    # +pix+::	initial pixel buffer [String]
-    # +clr+::	transparency color [FXColor]
-    # +opts+::	options [Integer]
-    # +width+::	width [Integer]
-    # +height+::	height [Integer]
+    # +a+:: an application instance {FXApp}
+    # +pix+:: initial pixel buffer [String]
+    # +clr+:: transparency color {FXColor}
+    # +opts+:: options [Integer]
+    # +width+:: width [Integer]
+    # +height+:: height [Integer]
     #
     def initialize(app, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: theIcon
     end

data/rdoc-sources/FXIconDict.rb

@@ -22,6 +22,7 @@ module Fox
     # creates a default icon source object.
     #
     def initialize(app, path=FXIconDict.defaultIconPath);
+    end
 
     # Change icon source to _src_ (an FXIconSource instance).
     def iconSource=(src); end

data/rdoc-sources/FXIconList.rb

@@ -7,23 +7,23 @@ module Fox
     # Item text [String]
     attr_accessor :text
 
-    # Big icon [FXIcon]
+    # Big icon {FXIcon}
     attr_accessor :bigIcon
 
-    # Mini icon [FXIcon]
+    # Mini icon {FXIcon}
     attr_accessor :miniIcon
 
     # Item user data [Object]
     attr_accessor :data
 
     # Indicates whether this item is selected or not [Boolean]
-    attr_writer	:selected
+    attr_writer :selected
 
     # Indicates whether this item is enabled or not [Boolean]
-    attr_writer	:enabled
+    attr_writer :enabled
 
     # Indicates whether this item is draggable or not [Boolean]
-    attr_writer	:draggable
+    attr_writer :draggable
 
     # Constructor
     def initialize(text, bigIcon=nil, miniIcon=nil, data=nil) # :yields: theIconItem
@@ -87,73 +87,73 @@ module Fox
   #
   # The following messages are sent by FXIconList to its target:
   #
-  # +SEL_CHANGED+::		sent when the current list item changes; the message data is an Integer indicating the index of the current item.
-  # +SEL_COMMAND+::		sent when the current list item changes; the message data is an Integer indicating the index of the current item.
-  # +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_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_CLICKED+::		sent when a list item is single-clicked; the message data is an Integer indicating the index of the current item.
-  # +SEL_DOUBLECLICKED+::	sent when a list item is double-clicked; the message data is an Integer indicating the index of the current item.
-  # +SEL_TRIPLECLICKED+::	sent when a list item is triple-clicked; the message data is an Integer indicating the index of the current item.
-  # +SEL_SELECTED+::		sent when a list item is selected; the message data is an Integer indicating the index of the selected item.
-  # +SEL_DESELECTED+::		sent when a list item is deselected; the message data is an Integer indicating the index of the deselected item.
-  # +SEL_REPLACED+::		sent when a list item is about to be replaced; the message data is an Integer indicating the index of the item to be replaced.
-  # +SEL_INSERTED+::		sent after a list item is inserted; the message data is an Integer indicating the index of the item that was inserted.
-  # +SEL_DELETED+::		sent when a list item is about to be removed; the message data is an Integer indicating the index of the item to be removed.
+  # +SEL_CHANGED+::  sent when the current list item changes; the message data is an Integer indicating the index of the current item.
+  # +SEL_COMMAND+::  sent when the current list item changes; the message data is an Integer indicating the index of the current item.
+  # +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_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_CLICKED+::  sent when a list item is single-clicked; the message data is an Integer indicating the index of the current item.
+  # +SEL_DOUBLECLICKED+:: sent when a list item is double-clicked; the message data is an Integer indicating the index of the current item.
+  # +SEL_TRIPLECLICKED+:: sent when a list item is triple-clicked; the message data is an Integer indicating the index of the current item.
+  # +SEL_SELECTED+::  sent when a list item is selected; the message data is an Integer indicating the index of the selected item.
+  # +SEL_DESELECTED+::  sent when a list item is deselected; the message data is an Integer indicating the index of the deselected item.
+  # +SEL_REPLACED+::  sent when a list item is about to be replaced; the message data is an Integer indicating the index of the item to be replaced.
+  # +SEL_INSERTED+::  sent after a list item is inserted; the message data is an Integer indicating the index of the item that was inserted.
+  # +SEL_DELETED+::  sent when a list item is about to be removed; the message data is an Integer indicating the index of the item to be removed.
   #
   # === Icon list styles
   #
-  # +ICONLIST_EXTENDEDSELECT+::		Extended selection mode
-  # +ICONLIST_SINGLESELECT+::		At most one selected item
-  # +ICONLIST_BROWSESELECT+::		Always exactly one selected item
-  # +ICONLIST_MULTIPLESELECT+::		Multiple selection mode
-  # +ICONLIST_AUTOSIZE+::		Automatically size item spacing
-  # +ICONLIST_DETAILED+::		List mode
-  # +ICONLIST_MINI_ICONS+::		Mini Icon mode
-  # +ICONLIST_BIG_ICONS+::		Big Icon mode
-  # +ICONLIST_ROWS+::			Row-wise mode
-  # +ICONLIST_COLUMNS+::		Column-wise mode
-  # +ICONLIST_NORMAL+::			same as +ICONLIST_EXTENDEDSELECT+
+  # +ICONLIST_EXTENDEDSELECT+::  Extended selection mode
+  # +ICONLIST_SINGLESELECT+::  At most one selected item
+  # +ICONLIST_BROWSESELECT+::  Always exactly one selected item
+  # +ICONLIST_MULTIPLESELECT+::  Multiple selection mode
+  # +ICONLIST_AUTOSIZE+::  Automatically size item spacing
+  # +ICONLIST_DETAILED+::  List mode
+  # +ICONLIST_MINI_ICONS+::  Mini Icon mode
+  # +ICONLIST_BIG_ICONS+::  Big Icon mode
+  # +ICONLIST_ROWS+::   Row-wise mode
+  # +ICONLIST_COLUMNS+::  Column-wise mode
+  # +ICONLIST_NORMAL+::   same as +ICONLIST_EXTENDEDSELECT+
   #
   # === Message identifiers
   #
-  # +ID_SHOW_DETAILS+::		x
-  # +ID_SHOW_MINI_ICONS+::	x
-  # +ID_SHOW_BIG_ICONS+::	x
-  # +ID_ARRANGE_BY_ROWS+::	x
-  # +ID_ARRANGE_BY_COLUMNS+::	x
-  # +ID_HEADER_CHANGE+::	x
-  # +ID_TIPTIMER+::		x
-  # +ID_LOOKUPTIMER+::		x
-  # +ID_SELECT_ALL+::		x
-  # +ID_DESELECT_ALL+::		x
-  # +ID_SELECT_INVERSE+::	x
+  # +ID_SHOW_DETAILS+::  x
+  # +ID_SHOW_MINI_ICONS+:: x
+  # +ID_SHOW_BIG_ICONS+:: x
+  # +ID_ARRANGE_BY_ROWS+:: x
+  # +ID_ARRANGE_BY_COLUMNS+:: x
+  # +ID_HEADER_CHANGE+:: x
+  # +ID_TIPTIMER+::  x
+  # +ID_LOOKUPTIMER+::  x
+  # +ID_SELECT_ALL+::  x
+  # +ID_DESELECT_ALL+::  x
+  # +ID_SELECT_INVERSE+:: x
 
   class FXIconList < FXScrollArea
 
     # Number of items [Integer]
-    attr_reader	:numItems
+    attr_reader :numItems
 
     # Number of rows [Integer]
-    attr_reader	:numRows
+    attr_reader :numRows
 
     # Number of columns [Integer]
-    attr_reader	:numCols
+    attr_reader :numCols
 
-    # The header control [FXHeader]
-    attr_reader	:header
+    # The header control {FXHeader}
+    attr_reader :header
 
     # The number of header items in the header control [Integer]
-    attr_reader	:numHeaders
+    attr_reader :numHeaders
 
     # Item width [Integer]
-    attr_reader	:itemWidth
+    attr_reader :itemWidth
 
     # Item height [Integer]
-    attr_reader	:itemHeight
+    attr_reader :itemHeight
 
     # Index of current item, or -1 if none [Integer]
     attr_accessor :currentItem
@@ -162,18 +162,18 @@ module Fox
     attr_accessor :anchorItem
 
     # Index of item under the cursor, or -1 if none [Integer]
-    attr_reader	:cursorItem
+    attr_reader :cursorItem
 
-    # Text font [FXFont]
+    # Text font {FXFont}
     attr_accessor :font
 
-    # Normal text color [FXColor]
+    # Normal text color {FXColor}
     attr_accessor :textColor
 
-    # Background color for selected item(s) [FXColor]
+    # Background color for selected item(s) {FXColor}
     attr_accessor :selBackColor
 
-    # Text color for selected item(s) [FXColor]
+    # Text color for selected item(s) {FXColor}
     attr_accessor :selTextColor
 
     # Maximum item space (in pixels) for each item [Integer]
@@ -333,7 +333,7 @@ module Fox
     #
     # Scroll to bring item into view. The argument is either a reference to
     # an FXIconItem instance, or the integer index of an item in the list.
-    # For the latter case, #makeItemVisible raises IndexError if the index
+    # For the latter case, {#makeItemVisible} raises IndexError if the index
     # is out of bounds.
     #
     def makeItemVisible(itemOrIndex); end
@@ -364,7 +364,7 @@ module Fox
 
     # Change user _data_ for item at _index_.
     # Raises IndexError if _index_ is out of bounds.
-    def setItemData(index, data);
+    def setItemData(index, data); end
 
     # Return user data for item at _index_.
     # Raises IndexError if _index_ is out of bounds.
@@ -401,11 +401,11 @@ module Fox
 
     # Enable item at _index_.
     # Raises IndexError if _index_ is out of bounds.
-    def enableItem(index);
+    def enableItem(index); end
 
     # Disable item at _index_.
     # Raises IndexError if _index_ is out of bounds.
-    def disableItem(index);
+    def disableItem(index); end
 
     # Select item at _index_.
     # If _notify_ is +true+, a +SEL_SELECTED+ message is sent to the list's