fxruby 1.4.7 → 1.6.0

data/rdoc-sources/FXText.rb

@@ -51,7 +51,15 @@ module Fox
     attr_accessor :del
   end
 
-  # Multiline text widget
+  #
+  # The text widget supports editing of multiple lines of text.
+  # An optional style table can provide text coloring based on
+  # the contents of an optional parallel style buffer, which is
+  # maintained as text is edited.  In a typical scenario, the
+  # contents of the style buffer is either directly written when
+  # the text is added to the widget, or is continually modified
+  # by editing the text via syntax-based highlighting engine which
+  # colors the text based on syntactical patterns.
   #
   # === Events
   #
@@ -67,12 +75,13 @@ module Fox
   # +SEL_RIGHTBUTTONRELEASE+::	sent when the right mouse button goes up; the message data is an FXEvent instance.
   # +SEL_INSERTED+::
   #   sent after text is inserted into the text buffer; the message data
-  #   is a two-element array indicating the position at which
-  #   the text was inserted and the number of characters inserted.
+  #   is a reference to an FXTextChange instance.
   # +SEL_DELETED+::
-  #   sent before text is removed from the text buffer; the message data is
-  #   a two-element array indicating the position at which
-  #   text will be removed and the number of characters to be removed.
+  #   sent after text is removed from the text buffer; the message data is
+  #   a reference to an FXTextChange instance.
+  # +SEL_REPLACED+::
+  #   sent after some text is replaced in the text buffer; the message data is
+  #   a reference to an FXTextChange instance.
   # +SEL_CHANGED+::
   #   sent when the contents of the text buffer change in any way;
   #   the message data is an integer indicating the cursor position.
@@ -94,6 +103,7 @@ module Fox
   # +TEXT_NO_TABS+::	Insert spaces for tabs
   # +TEXT_AUTOINDENT+::	Autoindent
   # +TEXT_SHOWACTIVE+::	Show active line
+  # +TEXT_AUTOSCROLL+::	Logging mode, keeping last line visible
   #
   # === Selection modes
   #
@@ -320,19 +330,31 @@ module Fox
     # Return +true+ if text is editable
     def editable? ; end
     
+    # Set overstrike mode to +true+ or +false+.
+    def overstrike=(os); end
+    
+    # Return +true+ if overstrike mode is activated.
+    def overstrike? ; end
+
     # Return +true+ if styled text
     def styled? ; end
 
     # Get character at position _pos_ in text buffer
-    def getChar(pos); end
+    def getByte(pos); end
   
+    # Get wide character at position _pos_.
+    def getChar(pos); end
+
+    # Get length of wide character at position _pos_.
+    def getCharLen(pos); end
+
     # Get style at position _pos_ in style buffer
     def getStyle(pos); end
 
-    # Extract _n_ characters of text from position _pos_ in the text buffer
+    # Extract _n_ bytes of text from position _pos_ in the text buffer
     def extractText(pos, n); end
     
-    # Extract _n_ characters of style info from position _pos_ in the style buffer
+    # Extract _n_ bytes of style info from position _pos_ in the style buffer
     def extractStyle(pos, n); end
 
     # Replace the _m_ characters at _pos_ with _text_.
@@ -380,11 +402,15 @@ module Fox
     def removeText(pos, n, notify=false); end
   
     # Change the style of _n_ characters at position _pos_ in the text
-    # buffer to _style_. Here, _style_ is either an integer into the
+    # buffer to _style_. Here, _style_ is  an integer index into the
     # style table, indicating the new style for all the affected characters;
-    # or _style_ is a String...
     def changeStyle(pos, n, style); end
   
+    # Change the style of text range at position _pos_ in the text
+    # buffer to _style_. Here, _style_ an array of bytes indicating
+    # the new style.
+    def changeStyle(pos, style); end
+
     # Change the text
     # If _notify_ is +true+, +SEL_INSERTED+ and +SEL_CHANGED+ messages
     # are sent to the text widget's message target after the new text is
@@ -471,9 +497,15 @@ module Fox
     # Return end of word
     def wordEnd(pos); end
   
-    # Return validated position
+    # Return validated UTF8 character start position
     def validPos(pos); end
 
+    # Retreat to the previous valid UTF8 character start
+    def dec(pos); end
+  
+    # Advance to the next valid UTF8 character start
+    def inc(pos); end
+
     # Make line containing _pos_ the top line
     def setTopLine(pos); end
   
@@ -538,5 +570,8 @@ module Fox
   
     # Scroll text to make the given position visible
     def makePositionVisible(pos); end
+    
+    # Return number of rows in buffer.
+    def numRows; end
   end
 end

data/rdoc-sources/FXTextField.rb

@@ -121,6 +121,12 @@ module Fox
     # Return +true+ if text field may be edited
     def editable?() ; end
   
+    # Set overstrike mode to +true+ or +false+.
+    def overstrike=(os); end
+    
+    # Return +true+ if overstrike mode is set.
+    def overstrike?; end
+
     # Select all text
     def selectAll(); end
   

data/rdoc-sources/FXToggleButton.rb

@@ -19,7 +19,6 @@ module Fox
   # +TOGGLEBUTTON_AUTOGRAY+::	Automatically gray out when not updated
   # +TOGGLEBUTTON_AUTOHIDE+::	Automatically hide toggle button when not updated
   # +TOGGLEBUTTON_TOOLBAR+::	Toolbar style toggle button [flat look]
-  # +TOGGLEBUTTON_KEEPSTATE+::	Draw button according to state
   # +TOGGLEBUTTON_NORMAL+::	<tt>FRAME_RAISED|FRAME_THICK|JUSTIFY_NORMAL|ICON_BEFORE_TEXT</tt>
   #
   class FXToggleButton < FXLabel

data/rdoc-sources/FXTopWindow.rb

@@ -1,14 +1,52 @@
 module Fox
   #
-  # Abstract base class for all top-level windows
+  # Abstract base class for all top-level windows.
+  #
+  # TopWindows are usually managed by a Window Manager under X11 and
+  # therefore borders and window-menus and other decorations like resize-
+  # handles are subject to the Window Manager's interpretation of the
+  # decoration hints.
+  # When a TopWindow is closed, it sends a SEL_CLOSE message to its
+  # target.  The target should return 0 in response to this message if
+  # there is no objection to proceed with the closing of the window, and
+  # return 1 otherwise.  After the SEL_CLOSE message has been sent and
+  # no objection was raised, the window will delete itself.
+  # When the session is closed, the window will send a SEL_SESSION_NOTIFY
+  # message to its target, allowing the application to write any unsaved
+  # data to the disk.  If the target returns 0, then the system will proceed
+  # to close the session.  Subsequently a SEL_SESSION_CLOSED will be received
+  # which causes the window to be closed with prejudice by calling the
+  # function close(FALSE).
+  # When receiving a SEL_UPDATE, the target can update the title string
+  # of the window, so that the title of the window reflects the name
+  # of the document, for example.
+  # For convenience, TopWindow provides the same layout behavior as
+  # the Packer widget, as well as docking and undocking of toolbars.
+  # TopWindows can be owned by other windows, or be free-floating.
+  # Owned TopWindows will usually remain stacked on top of the owner
+  # windows. The lifetime of an owned window should not exceed that of
+  # the owner.
   #
   # === Events
   #
   # The following messages are sent by FXTopWindow to its target:
   #
+  # +SEL_MINIMIZE+::
+  #   sent when the user clicks the minimize button in the upper right-hand
+  #   corner of the top-level window.
+  # +SEL_MAXIMIZE+::
+  #   sent when the user clicks the maximize button in the upper right-hand
+  #   corner of the top-level window.
+  # +SEL_RESTORE+::
+  #   sent when the user clicks the restore button in the upper right-hand
+  #   corner of the top-level window.
   # +SEL_CLOSE+::
   #   sent when the user clicks the close button in the upper right-hand
   #   corner of the top-level window.
+  # +SEL_SESSION_NOTIFY+:
+  #   sent when the session is closed.:
+  # +SEL_SESSION_CLOSED+::
+  #   sent after the session is closed.
   #
   # === Title and border decorations
   #
@@ -114,7 +152,11 @@ module Fox
     def restore(notify=false); end
     
     #
-    # Close window and return +true+ if actually closed.
+    # Close the window, return +true+ if actually closed. If _notify_ is +true+, the target
+    # will receive a +SEL_CLOSE+ message to determine if it is OK to close the window.
+    # If the target ignores the +SEL_CLOSE+ message or returns 0, the window will
+    # be closed, and subsequently deleted. When the last main window has been
+    # closed, the application will receive an +ID_QUIT+ message and will be closed.
     #
     def close(notify=false); end
   end

data/rdoc-sources/FXTranslator.rb

@@ -0,0 +1,32 @@
+module Fox
+  #
+  # A translator translates a message to another language.
+  #
+  class FXTranslator
+    
+    # The application associated with this translator [FXApp]
+    attr_reader :app
+    
+    #
+    # Return a new translator for the application _a_ (an FXApp instance).
+    #
+    def initialize(a); end
+    
+    #
+    # Translate a message.
+    #
+    def tr(context, message, hint=nil); end
+    
+    #
+    # Change the text codec used to decode the messages embedded in the
+    # source.
+    #
+    def textCodec=(codec); end
+    
+    #
+    # Return a reference to the text codec.
+    #
+    def textCodec; end
+  end
+end
+

data/rdoc-sources/FXTreeList.rb

@@ -320,6 +320,14 @@ module Fox
     #
     def moveItem(other, father, item); end
 
+    #
+    # Extract item from list and return a reference to the item.
+    # If _notify_ is  +true+ and the extraction causes the list's current item
+    # to change, a +SEL_CHANGED+ message is sent to the list's message target
+    # before the item is extracted from the list.
+    #
+    def extractItem(item, 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.

data/rdoc-sources/FXTreeListBox.rb

@@ -6,6 +6,15 @@ module Fox
   # 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
@@ -124,6 +133,17 @@ module Fox
     # 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

data/rdoc-sources/{FXVec.rb → FXVec2d.rb}

@@ -1,12 +1,16 @@
 module Fox
-  class FXVec
+  class FXVec2d
+    
+    attr_accessor :x
+    attr_accessor :y
+    
     #
-    # Return an initialized FXVec instance.
+    # Return an initialized FXVec2d instance.
     #
-    def initialize(x=0.0, y=0.0, z=0.0); end
+    def initialize(xx, yy); end
   
     #
-    # Returns the element at _index_, where _index_ is 0, 1 or 2.
+    # Returns the element at _index_, where _index_ is 0 or 1.
     # Raises IndexError if _index_ is out of range.
     #
     def [](index); end
@@ -17,35 +21,32 @@ module Fox
     #
     def []=(index, value); end
 
-    # Return +true+ if this vector is equal to _other_.
-    def ==(other); end
-
-    # Returns a new FXVec instance which is the negation of this one.
+    # Returns a new FXVec2d instance which is the negation of this one.
     def @-(); end
 
     #
-    # Returns a new FXVec instance obtained by memberwise
-    # addition of the _other_ FXVec instance with this
+    # Returns a new FXVec2d instance obtained by memberwise
+    # addition of the _other_ FXVec2d instance with this
     # one.
     #
     def +(other); end
 
     #
-    # Returns a new FXVec instance obtained by memberwise
-    # subtraction of the _other_ FXVec instance from this
+    # Returns a new FXVec2d instance obtained by memberwise
+    # subtraction of the _other_ FXVec2d instance from this
     # one.
     #
     def -(other); end
 
     #
-    # Returns a new FXVec instance obtained by memberwise
+    # Returns a new FXVec2d instance obtained by memberwise
     # multiplication of this vector's elements by the scalar
     # _n_.
     #
     def *(n); end
 
     #
-    # Returns a new FXVec instance obtained by memberwise
+    # 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.
@@ -57,41 +58,39 @@ module Fox
     #
     def dot(other); end
 
+    # Return +true+ if this vector is equal to _other_.
+    def ==(other); end
+
     #
-    # Return the cross product of this vector and _other_.
+    # Return the square of the length of this vector.
     #
-    def cross(other); end
-
+    def length2; end
+    
     #
     # Return the length (magnitude) of this vector.
     #
-    def len; end
+    def length; end
 
+    # Clamp the values of this vector between limits _lo_ and _hi_.
+    def clamp(lo, hi); end
+    
     #
-    # Return a new FXVec instance which is a normalized version
+    # Return a new FXVec2d instance which is a normalized version
     # of this one.
     #
     def normalize; end
 
     #
-    # Normalize this vector and return a reference to it.
-    #
-    def normalize!; end
-
-    #
-    # Return a new FXVec instance which is the lesser of this
+    # Return a new FXVec2d instance which is the lesser of this
     # vector and _other_.
     #
     def lo(other); end
 
     #
-    # Return a new FXVec instance which is the greater of this
+    # Return a new FXVec2d instance which is the greater of this
     # vector and _other_.
     #
     def hi(other); end
-
-    # Return a new Array instance with this vector's elements as its members.
-    def to_a; 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
+