fxruby 1.6.13-mswin32

data/rdoc-sources/FXTreeListBox.rb

@@ -0,0 +1,219 @@
+module Fox
+  #
+  # The Tree List Box behaves very much like a List Box, except that
+  # it supports a hierarchical, tree structured display of the items.
+  # When an item is selected it issues a +SEL_COMMAND+ message with the
+  # pointer to the item. While manipulating the tree list, it may send
+  # +SEL_CHANGED+ messages to indicate which item the cursor is hovering over.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXTreeListBox to its target:
+  #
+  # +SEL_CHANGED+::
+  #   sent when the current list item changes; the message data is a reference to the new tree item.
+  # +SEL_COMMAND+::
+  #   sent when the current list item changes; the message data is a reference to the new tree item.
+  #
+  # === Tree list box styles
+  #
+  # +TREELISTBOX_NORMAL+::	Normal style
+  #
+  # === Message identifiers
+  #
+  # +ID_TREE+::		x
+  # +ID_FIELD+::	x
+  #
+  class FXTreeListBox < FXPacker
+
+    # Number of items [Integer]
+    attr_reader :numItems
+
+    # Number of visible items [Integer]
+    attr_accessor :numVisible
+
+    # First root-level item [FXTreeItem]
+    attr_reader :firstItem
+
+    # Last root-level item [FXTreeItem]
+    attr_reader :lastItem
+
+    # Current item, if any [FXTreeItem]
+    attr_accessor :currentItem
+
+    # Text font [FXFont]
+    attr_accessor :font
+    
+    # Tree list box style
+    attr_accessor :listStyle
+
+    # Status line help text for this tree list box [String]
+    attr_accessor :helpText
+
+    # Tool tip text for this tree list box [String]
+    attr_accessor :tipText
+
+    #
+    # Return an initially empty FXTreeListBox.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this tree list box [FXComposite]
+    # +target+::	the message target, if any, for this tree list box [FXObject]
+    # +selector+::	the message identifier for this tree list box [Integer]
+    # +opts+::	tree list 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, target=nil, selector=0, opts=FRAME_SUNKEN|FRAME_THICK|TREELISTBOX_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theTreeListBox
+    end
+
+    #
+    # Fill tree list box by appending items from array of strings and return the
+    # number of items added.
+    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list box's
+    # message target after each item is added.
+    #
+    def fillItems(father, strings, oi=nil, ci=nil, ptr=nil); end
+
+    # Insert a new (possibly subclassed) _item_ under _father_ before _other_ item.
+    # Returns a reference to the newly added item (an FXTreeItem instance).
+    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
+    # target after the item is added.
+    def insertItem(other, father, item, notify=false); end
+  
+    # Insert item with given text and optional icons, and user-data pointer under _father_ before _other_ item. 
+    # Returns a reference to the newly added item (an FXTreeItem instance).
+    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
+    # target after the item is added.
+    def insertItem(other, father, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
+
+    # Append a new (possibly subclassed) _item_ as last child of _father_.
+    # Returns a reference to the newly added item (an FXTreeItem instance).
+    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
+    # target after the item is added.
+    def appendItem(father, item, notify=false); end
+  
+    # Append item with given text and optional icons, and user-data pointer as last child of _father_.
+    # Returns a reference to the newly added item (an FXTreeItem instance).
+    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
+    # target after the item is added.
+    def appendItem(father, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
+  
+    # Prepend a new (possibly subclassed) _item_ as first child of _father_.
+    # Returns a reference to the newly added item (an FXTreeItem instance).
+    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
+    # target after the item is added.
+    def prependItem(father, item, notify=false); end
+  
+    # Prepend item with given text and optional icons, and user-data pointer as first child of _father_.
+    # Returns a reference to the newly added item (an FXTreeItem instance).
+    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
+    # target after the item is added.
+    def prependItem(father, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
+  
+    # Remove item.
+    # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message
+    # target before the item is removed.
+    def removeItem(item, notify=false);
+
+    # Remove items in range [_fromItem_, _toItem_] inclusively.
+    # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message
+    # target before each item is removed.
+    def removeItems(fromItem, toItem, notify=false); end
+
+    # Remove all items from the list.
+    # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message
+    # target before each item is removed.
+    def clearItems(notify=false); end
+
+    #
+    # Move _item_ under _father_ before _other_ item and return a reference to
+    # _item_.
+    #
+    def moveItem(other, father, item); end
+
+    #
+    # Extract item from list and return a reference to the item.
+    #
+    def extractItem(item); end
+
+    #
+    # Search items by _text_, beginning from item _start_.  If the
+    # start item is +nil+ the search will start at the first, top-most item
+    # in the list. Flags may be +SEARCH_FORWARD+ or +SEARCH_BACKWARD+ to control
+    # the search direction; this can be combined with +SEARCH_NOWRAP+ or +SEARCH_WRAP+
+    # to control whether the search wraps at the start or end of the list.
+    # The option +SEARCH_IGNORECASE+ causes a case-insensitive match.  Finally,
+    # passing +SEARCH_PREFIX+ causes searching for a prefix of the item text.
+    # Return +nil+ if no matching item is found.
+    #
+    def findItem(text, start=nil, flags=SEARCH_FORWARD|SEARCH_WRAP); end
+
+    #
+    # Search items by associated user _data_, beginning from item _start_.  If the
+    # start item is +nil+ the search will start at the first, top-most item
+    # in the list. Flags may be +SEARCH_FORWARD+ or +SEARCH_BACKWARD+ to control
+    # the search direction; this can be combined with +SEARCH_NOWRAP+ or +SEARCH_WRAP+
+    # to control whether the search wraps at the start or end of the list.
+    # Return +nil+ if no matching item is found.
+    #
+    def findItemByData(data, start=nil, flags=SEARCH_FORWARD|SEARCH_WRAP); end
+
+    # Return +true+ if item is current
+    def itemCurrent?(item); end
+
+    # Return +true+ if item is a leaf-item, i.e. has no children
+    def itemLeaf?(item); end
+
+    # Sort root items
+    def sortRootItems(); end
+
+    # Sort all items recursively.
+    def sortItems(); end
+
+    # Sort children of _item_
+    def sortChildItems(item); end
+
+    #
+    # Change current item.
+    # If _notify_ is +true+, a SEL_CHANGED message is sent to the tree list box's
+    # message target.
+    #
+    def setCurrentItem(item, notify=false); end
+    
+    # Change item's text
+    def setItemText(item, text); end
+    
+    # Return item's text
+    def getItemText(item); end
+  
+    # Change item's open icon
+    def setItemOpenIcon(item, openIcon); end
+    
+    # Return item's open icon
+    def getItemOpenIcon(item); end
+    
+    # Change item's closed icon
+    def setItemClosedIcon(item, closedIcon); end
+    
+    # Return item's closed icon
+    def getItemClosedIcon(item); end
+  
+    # Change item's user data
+    def setItemData(item, data); end
+  
+    # Return item's user data
+    def getItemData(item); end
+  
+    # Return +true+ if the pane is shown.
+    def paneShown?; end
+  end
+end
+

data/rdoc-sources/FXTriStateButton.rb

@@ -0,0 +1,49 @@
+module Fox
+  #
+  # The tri-state button provides a three-state button, which toggles between the
+  # on and the off state each time it is pressed. Programmatically, it may also be
+  # switched into the +MAYBE+ state. The +MAYBE+ state is useful to signify an
+  # "unknown" or "indeterminate" state in the application data.
+  #
+  class FXTriStateButton < FXToggleButton
+
+    # Maybe text, shown when toggled [String]
+    attr_accessor	:maybeText
+
+    # Maybe icon, shown when toggled [FXIcon]
+    attr_accessor	:maybeIcon
+
+    # Maybe status line help text, shown when toggled [String]
+    attr_accessor	:maybeHelpText
+
+    # Maybe tool tip message, shown when toggled [String]
+    attr_accessor	:maybeTipText
+
+    #
+    # Return an initialized FXTriStateButton instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::		the parent window for this tri-state button [FXComposite]
+    # <tt>text1</tt>::	the text for this tri-state button's first state [String]
+    # <tt>text2</tt>::	the text for this tri-state button's second state [String]
+    # <tt>text3</tt>::	the text for this tri-state button's third state [String]
+    # <tt>icon1</tt>::	the icon, if any, for this tri-state button's first state [FXIcon]
+    # <tt>icon2</tt>::	the icon, if any, for this tri-state button's second state [FXIcon]
+    # <tt>icon3</tt>::	the icon, if any, for this tri-state button's third state [FXIcon]
+    # +target+::		the message target, if any, for this tri-state button [FXObject]
+    # +selector+::		the message identifier for this tri-state button [Integer]
+    # +opts+::		tri-state button 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, text1, text2, text3, icon1=nil, icon2=nil, icon3=nil, target=nil, selector=0, opts=TOGGLEBUTTON_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theTriStateButton
+    end
+  end
+end

data/rdoc-sources/FXVec2d.rb

@@ -0,0 +1,96 @@
+module Fox
+  class FXVec2d
+    
+    attr_accessor :x
+    attr_accessor :y
+    
+    #
+    # Return an initialized FXVec2d instance.
+    #
+    def initialize(xx, yy); end
+  
+    #
+    # Returns the element at _index_, where _index_ is 0 or 1.
+    # Raises IndexError if _index_ is out of range.
+    #
+    def [](index); end
+
+    #
+    # Set the element at _index_ to _value_ and return _value_.
+    # Raises IndexError if _index_ is out of range.
+    #
+    def []=(index, value); end
+
+    # Returns a new FXVec2d instance which is the negation of this one.
+    def @-(); end
+
+    #
+    # Returns a new FXVec2d instance obtained by memberwise
+    # addition of the _other_ FXVec2d instance with this
+    # one.
+    #
+    def +(other); end
+
+    #
+    # Returns a new FXVec2d instance obtained by memberwise
+    # subtraction of the _other_ FXVec2d instance from this
+    # one.
+    #
+    def -(other); end
+
+    #
+    # Returns a new FXVec2d instance obtained by memberwise
+    # multiplication of this vector's elements by the scalar
+    # _n_.
+    #
+    def *(n); end
+
+    #
+    # Returns a new FXVec2d instance obtained by memberwise
+    # division of this vector's elements by the scalar
+    # _n_.
+    # Raises ZeroDivisionError if _n_ is identically zero.
+    #
+    def /(n); end
+
+    #
+    # Returns the dot (scalar) product of this vector and _other_.
+    #
+    def dot(other); end
+
+    # Return +true+ if this vector is equal to _other_.
+    def ==(other); end
+
+    #
+    # Return the square of the length of this vector.
+    #
+    def length2; end
+    
+    #
+    # Return the length (magnitude) of this vector.
+    #
+    def length; end
+
+    # Clamp the values of this vector between limits _lo_ and _hi_.
+    def clamp(lo, hi); end
+    
+    #
+    # Return a new FXVec2d instance which is a normalized version
+    # of this one.
+    #
+    def normalize; end
+
+    #
+    # Return a new FXVec2d instance which is the lesser of this
+    # vector and _other_.
+    #
+    def lo(other); end
+
+    #
+    # Return a new FXVec2d instance which is the greater of this
+    # vector and _other_.
+    #
+    def hi(other); end
+  end
+end
+

data/rdoc-sources/FXVec2f.rb

@@ -0,0 +1,96 @@
+module Fox
+  class FXVec2f
+    
+    attr_accessor :x
+    attr_accessor :y
+    
+    #
+    # Return an initialized FXVec2f instance.
+    #
+    def initialize(xx, yy); end
+  
+    #
+    # Returns the element at _index_, where _index_ is 0 or 1.
+    # Raises IndexError if _index_ is out of range.
+    #
+    def [](index); end
+
+    #
+    # Set the element at _index_ to _value_ and return _value_.
+    # Raises IndexError if _index_ is out of range.
+    #
+    def []=(index, value); end
+
+    # Returns a new FXVec2f instance which is the negation of this one.
+    def @-(); end
+
+    #
+    # Returns a new FXVec2f instance obtained by memberwise
+    # addition of the _other_ FXVec2f instance with this
+    # one.
+    #
+    def +(other); end
+
+    #
+    # Returns a new FXVec2f instance obtained by memberwise
+    # subtraction of the _other_ FXVec2f instance from this
+    # one.
+    #
+    def -(other); end
+
+    #
+    # Returns a new FXVec2f instance obtained by memberwise
+    # multiplication of this vector's elements by the scalar
+    # _n_.
+    #
+    def *(n); end
+
+    #
+    # Returns a new FXVec2f instance obtained by memberwise
+    # division of this vector's elements by the scalar
+    # _n_.
+    # Raises ZeroDivisionError if _n_ is identically zero.
+    #
+    def /(n); end
+
+    #
+    # Returns the dot (scalar) product of this vector and _other_.
+    #
+    def dot(other); end
+
+    # Return +true+ if this vector is equal to _other_.
+    def ==(other); end
+
+    #
+    # Return the square of the length of this vector.
+    #
+    def length2; end
+    
+    #
+    # Return the length (magnitude) of this vector.
+    #
+    def length; end
+
+    # Clamp the values of this vector between limits _lo_ and _hi_.
+    def clamp(lo, hi); end
+    
+    #
+    # Return a new FXVec2f instance which is a normalized version
+    # of this one.
+    #
+    def normalize; end
+
+    #
+    # Return a new FXVec2f instance which is the lesser of this
+    # vector and _other_.
+    #
+    def lo(other); end
+
+    #
+    # Return a new FXVec2f instance which is the greater of this
+    # vector and _other_.
+    #
+    def hi(other); end
+  end
+end
+