fxruby-commits

[Lyle J. <ly...@us...>]

Update of /cvsroot/fxruby/FXRuby/rdoc-sources
In directory usw-pr-cvs1:/tmp/cvs-serv18923

Modified Files:
	FX4Splitter.rb FXApp.rb FXComposite.rb 
Added Files:
	FXComboBox.rb FXHorizontalFrame.rb FXTextField.rb 
	FXVerticalFrame.rb 
Log Message:
More documentation updates.


--- NEW FILE: FXComboBox.rb ---
module Fox
  # Combobox
  #
  # = ComboBox styles
  #
  # COMBOBOX_NO_REPLACE::     Leave the list the same
  # COMBOBOX_REPLACE::        Replace current item with typed text
  # COMBOBOX_INSERT_BEFORE::  Typed text inserted before current
  # COMBOBOX_INSERT_AFTER::   Typed text inserted after current
  # COMBOBOX_INSERT_FIRST::   Typed text inserted at begin of list
  # COMBOBOX_INSERT_LAST::    Typed text inserted at end of list
  # COMBOBOX_STATIC::         Unchangable text box
  # COMBOBOX_NORMAL::         Default options for comboboxes
  #
  # = Message identifiers
  #
  # ID_LIST::
  # ID_TEXT::
  #
  class FXComboBox < FXPacker
    # Handles the +SEL_FOCUS_UP+ message
    def onFocusUp(sender, selector, event) ; end
    # Handles the +SEL_FOCUS_DOWN+ message
    def onFocusDown(sender, selector, event) ; end
    # Handles the +SEL_COMMAND+ message from the button
    def onTextButton(sender, selector, ptr) ; end
    # Handles the +SEL_CHANGED+ message from the text field
    def onTextChanged(sender, selector, string) ; end
    # Handles the +SEL_COMMAND+ message from the text field
    def onTextCommand(sender, selector, string) ; end
    # Handles the +SEL_CLICKED+ message for the list
    def onListClicked(sender, selector, listIndex) ; end
    # Handles something else
    def onFwdToText(sender, selector, ptr) ; end
    # Handles the +SEL_UPDATE+ message from the text field
    def onUpdFmText(sender, selector, ptr);

    # Constructor
    def initialize(p, cols, nvis, tgt, sel, opts=COMBOBOX_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) ; end

    # Return true if combobox is editable
    def editable?() ; end

    # Set editable state
    def editable=(editable=true) ; end

    # Set the text
    def text=(text) ; end

    # Get the text
    def text() ; end

    # Set the number of columns
    def numColumns=(cols) ; end

    # Get the number of columns
    def numColumns() ; end

    # Return the number of items in the list
    def numItems() ; end

    # Return the number of visible items
    def numVisible() ; end

    # Set the number of visible items
    def numVisible=(nvis) ; end

    # Return true if current item
    def itemCurrent?(index) ; end

    # Set the current item (index is zero-based)
    def currentItem=(indexz) ; end

    # Get the current item's index
    def currentItem() ; end

    # Return the item at the given index
    def retrieveItem(index) ; end

    # Replace the item at index
    def replaceItem(index, text, data=nil) ; end

    # Insert a new item at index
    def insertItem(index, text, data=nil) ; end

    # Append an item to the list
    def appendItem(text, data=nil) ; end

    # Prepend an item to the list
    def prependItem(text, data=nil) ; end

    # Remove this item from the list
    def removeItem(index) ; end

    # Remove all items from the list
    def clearItems() ; end

    # Set text for specified item
    def setItemText(index, text) ; end

    # Get text for specified item
    def getItemText(index) ; end

    # Set data pointer for specified item
    def setItemData(index, data) ; end

    # Get data pointer for specified item
    def getItemData(index) ; end

    # Is the pane shown
    def paneShown?() ; end

    # Sort items using current sort function
    def sortItems() ; end

    # Set text font
    def font=(fnt) ; end

    # Get text font
    def font() ; end

    # Set the combobox style.
    def comboStyle=(comboStyle) ; end

    # Get the combobox style.
    def comboStyle() ; end

    # Set window background color
    def backColor=(color) ; end
  
    # Get background color
    def backColor() ; end

    # Change text color
    def textColor=(color) ; end
  
    # Return text color
    def textColor() ; end

    # Change selected background color
    def selBackColor=(color) ; end
  
    # Return selected background color
    def selBackColor() ; end

    # Change selected text color
    def selTextColor=(color) ; end
  
    # Return selected text color
    def selTextColor() ; end

    # Set the combobox help text
    def helpText=(txt) ; end

    # Get the combobox help text
    def helpText() ; end

    # Set the tool tip message for this combobox
    def tipText=(txt) ; end

    # Get the tool tip message for this combobox
    def tipText() ; end
    
    # Iterate over the list items
    def each # :yields: text, data
    end
  end
end

--- NEW FILE: FXHorizontalFrame.rb ---
module Fox
  # Horizontal frame layout manager widget is used to automatically
  # place child-windows horizontally from left-to-right, or right-to-left,
  # depending on the child window's layout hints.
  class FXHorizontalFrame < FXPacker
    # Construct a horizontal frame layout manager
    def initialize(p,opts=0,x=0,y=0,w=0,h=0,pl=DEFAULT_SPACING,pr=DEFAULT_SPACING,pt=DEFAULT_SPACING,pb=DEFAULT_SPACING,hs=DEFAULT_SPACING,vs=DEFAULT_SPACING); end
  end
end

--- NEW FILE: FXTextField.rb ---
module Fox
  # A text field is a single-line text entry widget.
  # The text field widget supports clipboard for cut-and-paste
  # operations.
  #
  # = Textfield styles
  #
  # TEXTFIELD_PASSWD::      Password mode
  # TEXTFIELD_INTEGER::     Integer mode
  # TEXTFIELD_REAL::        Real mode
  # TEXTFIELD_READONLY::    NOT editable
  # TEXTFIELD_ENTER_ONLY::  Only callback when enter hit
  # TEXTFIELD_LIMITED::     Limit entry to given number of columns
  # TEXTFIELD_OVERSTRIKE::  Overstrike mode
  # TEXTFIELD_NORMAL::      FRAME_SUNKEN|FRAME_THICK
  #
  # = Message identifiers
  #
  # ID_CURSOR_HOME::
  # ID_CURSOR_END::
  # ID_CURSOR_RIGHT::
  # ID_CURSOR_LEFT::
  # ID_MARK::
  # ID_EXTEND::
  # ID_SELECT_ALL::
  # ID_DESELECT_ALL::
  # ID_CUT_SEL::
  # ID_COPY_SEL::
  # ID_PASTE_SEL::
  # ID_DELETE_SEL::
  # ID_OVERST_STRING::
  # ID_INSERT_STRING::
  # ID_BACKSPACE::
  # ID_DELETE::
  # ID_TOGGLE_EDITABLE::
  # ID_TOGGLE_OVERSTRIKE::
  # ID_BLINK::
  #
  class FXTextField < FXFrame
    # Handles the +SEL_PAINT+ message
    def onPaint(sender, selector, event) ; end
    # Handles the +SEL_KEYPRESS+ message
    def onKeyPress(sender, selector, event) ; end
    # Handles the +SEL_KEYRELEASE+ message
    def onKeyRelease(sender, selector, event) ; end
    # Handles the +SEL_LEFTBUTTONPRESS+ message
    def onLeftBtnPress(sender, selector, event) ; end
    # Handles the +SEL_LEFTBUTTONRELEASE+ message
    def onLeftBtnRelease(sender, selector, event) ; end
    # Handles the +SEL_MIDDLEBUTTONPRESS+ message
    def onMiddleBtnPress(sender, selector, event) ; end
    # Handles the +SEL_MIDDLEBUTTONRELEASE+ message
    def onMiddleBtnRelease(sender, selector, event) ; end
    # Handles the +SEL_VERIFY+ message
    def onVerify(sender, selector, string) ; end
    # Handles the +SEL_MOTION+ message
    def onMotion(sender, selector, event) ; end
    # Handles the +SEL_SELECTION_LOST+ message
    def onSelectionLost(sender, selector, event) ; end
    # Handles the +SEL_SELECTION_GAINED+ message
    def onSelectionGained(sender, selector, event) ; end
    # Handles the +SEL_SELECTION_REQUEST+ message
    def onSelectionRequest(FXObject*,FXSelector,void* ptr) ; end
    # Handles the +SEL_CLIPBOARD_LOST+ message
    def onClipboardLost(sender, selector, event) ; end
    # Handles the +SEL_CLIPBOARD_GAINED+ message
    def onClipboardGained(sender, selector, event) ; end
    # Handles the +SEL_CLIPBOARD_REQUEST+ message
    def onClipboardRequest(sender, selector, event) ; end
    # Handles the +SEL_FOCUS_SELF+ message
    def onFocusSelf(sender, selector, event) ; end
    # Handles the +SEL_FOCUS_IN+ message
    def onFocusIn(sender, selector, event) ; end
    # Handles the +SEL_FOCUS_OUT+ message
    def onFocusOut(sender, selector, event) ; end
    def onBlink(sender, selector, ptr) ; end
    def onAutoScroll(sender, selector, ptr) ; end
    def onQueryHelp(sender, selector, ptr) ; end
    def onQueryTip(sender, selector, ptr) ; end
    def onCmdSetValue(sender, selector, string) ; end
    def onCmdSetIntValue(sender, selector, int) ; end
    def onCmdSetRealValue(sender, selector, float) ; end
    def onCmdSetStringValue(sender, selector, string) ; end
    def onCmdGetIntValue(sender, selector, ptr) ; end
    def onCmdGetRealValue(sender, selector, ptr) ; end
    def onCmdGetStringValue(sender, selector, ptr) ; end
    def onCmdCursorHome(sender, selector, ptr) ; end
    def onCmdCursorEnd(sender, selector, ptr) ; end
    def onCmdCursorRight(sender, selector, ptr) ; end
    def onCmdCursorLeft(sender, selector, ptr) ; end
    def onCmdMark(sender, selector, ptr) ; end
    def onCmdExtend(sender, selector, ptr) ; end
    def onCmdSelectAll(sender, selector, ptr) ; end
    def onCmdDeselectAll(sender, selector, ptr) ; end
    def onCmdCutSel(sender, selector, ptr) ; end
    def onCmdCopySel(sender, selector, ptr) ; end
    def onCmdPasteSel(sender, selector, ptr) ; end
    def onCmdDeleteSel(sender, selector, ptr) ; end
    def onCmdOverstString(sender, selector, character) ; end
    def onCmdInsertString(sender, selector, string) ; end
    def onCmdBackspace(sender, selector, ptr) ; end
    def onCmdDelete(sender, selector, ptr) ; end
    def onCmdToggleEditable(sender, selector, ptr) ; end
    def onUpdToggleEditable(sender, selector, ptr) ; end
    def onCmdToggleOverstrike(sender, selector, ptr) ; end
    def onUpdToggleOverstrike(sender, selector, ptr) ; end

    # Construct text field wide enough to display ncols columns
    def initialize(p, ncols, tgt=nil, sel=0, opts=TEXTFIELD_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) ; end
  
    # Return TRUE if text field may be edited
    def editable?() ; end
  
    # Change text field editability 
    def editable=(editable=true) ; end
  
    # Set cursor position
    def cursorPos=(pos) ; end
  
    # Return cursor position
    def cursorPos() ; end
  
    # Change anchor position
    def anchorPos=(pos) ; end
  
    # Return anchor position
    def anchorPos() ; end
  
    # Set the text for this label
    def text=(text) ; end
  
    # Get the text for this label
    def text() ; end
  
    # Set the text font
    def font=(fnt) ; end
  
    # Get the text font
    def font() ; end
  
    # Change text color
    def textColor=(clr) ; end
  
    # Return text color
    def textColor() ; end
  
    # Change selected background color
    def selBackColor=(clr) ; end
  
    # Return selected background color
    def selBackColor() ; end
  
    # Change selected text color
    def selTextColor=(clr) ; end
  
    # Return selected text color
    def selTextColor() ; end
  
    # Change width of text field in terms of number of columns * `m'
    def numColumns=(cols) ; end
  
    # Return number of columns
    def numColumns() ; end
  
    # Change text justification mode
    def justify=(mode) ; end
  
    # Return text justification mode
    def justify() ; end
  
    # Set the status line help text for this label
    def helpText=(text) ; end
  
    # Get the status line help text for this label
    def helpText() ; end
  
    # Set the tool tip message for this text field
    def tipText=(text) ; end
  
    # Get the tool tip message for this text field
    def tipText() ; end
  
    # Change text style
    def textStyle=(style) ; end
  
    # Return text style
    def textStyle() ; end
  
    # Select all text
    def selectAll(); end
  
    # Select len characters starting at given position pos
    def setSelection(pos, len) ; end
  
    # Extend the selection from the anchor to the given position
    def extendSelection(pos) ; end
  
    # Unselect the text
    def killSelection() ; end
  
    # Return true if position _pos_ is selected
    def posSelected?(pos) ; end
  
    # Return true if position is fully visible
    def posVisible?(pos) ; end
  
    # Scroll text to make the given position visible
    def makePositionVisible(pos) ; end
  end
end

--- NEW FILE: FXVerticalFrame.rb ---
module Fox
  # Vertical frame layout manager widget is used to automatically
  # place child-windows vertically from top-to-bottom, or bottom-to-top,
  # depending on the child window's layout hints.
  class FXVerticalFrame < FXPacker
    # Construct a horizontal frame layout manager
    def initialize(p,opts=0,x=0,y=0,w=0,h=0,pl=DEFAULT_SPACING,pr=DEFAULT_SPACING,pt=DEFAULT_SPACING,pb=DEFAULT_SPACING,hs=DEFAULT_SPACING,vs=DEFAULT_SPACING); end
  end
end

Index: FX4Splitter.rb
===================================================================
RCS file: /cvsroot/fxruby/FXRuby/rdoc-sources/FX4Splitter.rb,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** FX4Splitter.rb	26 Mar 2002 21:36:22 -0000	1.3
--- FX4Splitter.rb	27 Mar 2002 18:03:04 -0000	1.4
***************
*** 20,24 ****
    # FOURSPLITTER_NORMAL::     Normal mode (no continuous tracking)
    #
!   # = Messages understood by FX4Splitter
    #
    # ID_EXPAND_ALL::           Expand all four panes
--- 20,24 ----
    # FOURSPLITTER_NORMAL::     Normal mode (no continuous tracking)
    #
!   # = Messages identifiers
    #
    # ID_EXPAND_ALL::           Expand all four panes

Index: FXApp.rb
===================================================================
RCS file: /cvsroot/fxruby/FXRuby/rdoc-sources/FXApp.rb,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** FXApp.rb	26 Mar 2002 21:36:23 -0000	1.4
--- FXApp.rb	27 Mar 2002 18:03:04 -0000	1.5
***************
*** 39,47 ****
      def click_count ; end
      # Moved cursor since press
!     def moved ; end
      # Exposed rectangle for paint events
      def rect ; end
      # True if synthetic expose event
!     def synthetic ; end
      # Target drag type being requested
      def target ; end
--- 39,47 ----
      def click_count ; end
      # Moved cursor since press
!     def moved? ; end
      # Exposed rectangle for paint events
      def rect ; end
      # True if synthetic expose event
!     def synthetic? ; end
      # Target drag type being requested
      def target ; end
***************
*** 91,95 ****
    # DEF_ROTATE_CURSOR::     Rotate cursor
    #
!   # = Messages applications understand
    #
    # ID_QUIT::               Terminate the application normally
--- 91,95 ----
    # DEF_ROTATE_CURSOR::     Rotate cursor
    #
!   # = Messages identifiers
    #
    # ID_QUIT::               Terminate the application normally
***************
*** 204,208 ****
      # the event loop was terminated due to #stop() or #stopModal().
      # Except for the modal window and its children, user input to all windows 
!     #* is blocked; if the modal window is nil all user input is blocked.
      def runWhileEvents(window=nil); end
  
--- 204,208 ----
      # the event loop was terminated due to #stop() or #stopModal().
      # Except for the modal window and its children, user input to all windows 
!     # is blocked; if the modal window is nil all user input is blocked.
      def runWhileEvents(window=nil); end
  
***************
*** 305,334 ****
    
      # Change default cursor
!     def setDefaultCursor(which, cur); end
    
!     # Obtain application-wide settings
      def typingSpeed() ; end
      def clickSpeed() ; end
      def scrollSpeed() ; end
      def scrollDelay() ; end
      def blinkSpeed() ; end
      def animSpeed() ; end
      def menuPause() ; end
      def tooltipPause() ; end
      def tooltipTime() ; end
      def dragDelta() ; end
      def wheelLines() ; end
    
!     # Change application-wide settings
      def typingSpeed=(speed); end
      def clickSpeed=(speed); end
      def scrollSpeed=(speed); end
      def scrollDelay=(delay); end
      def blinkSpeed=(speed); end
      def animSpeed=(speed); end
      def menuPause=(pause); end
      def tooltipPause=(pause); end
      def tooltipTime=(time); end
      def dragDelta=(delta); end
      def wheelLines=(lines); end
    
--- 305,375 ----
    
      # Change default cursor
!     def setDefaultCursor(which, cursor); end
    
!     # Get typing speed used for the FXIconList, FXList and FXTreeList widgets' lookup features.
!     # Default value is 1000 millseconds.
      def typingSpeed() ; end
+     
+     # Get click speed
      def clickSpeed() ; end
+     
+     # Get scroll speed
      def scrollSpeed() ; end
+     
+     # Get scroll delay
      def scrollDelay() ; end
+     
+     # Get blink speed
      def blinkSpeed() ; end
+     
+     # Get animation speed
      def animSpeed() ; end
+     
+     # Get menu pause
      def menuPause() ; end
+     
+     # Get tooltip pause
      def tooltipPause() ; end
+     
+     # Get tooltip time
      def tooltipTime() ; end
+     
+     # Get drag delta (in pixels)
      def dragDelta() ; end
+     
+     # Get number of wheel lines
      def wheelLines() ; end
    
!     # Set typing speed
      def typingSpeed=(speed); end
+     
+     # Set click speed
      def clickSpeed=(speed); end
+     
+     # Set scroll speed
      def scrollSpeed=(speed); end
+     
+     # Set scroll delay
      def scrollDelay=(delay); end
+     
+     # Set blink speed
      def blinkSpeed=(speed); end
+     
+     # Set animation speed
      def animSpeed=(speed); end
+     
+     # Set menu pause
      def menuPause=(pause); end
+     
+     # Set tooltip pause
      def tooltipPause=(pause); end
+     
+     # Set tooltip time
      def tooltipTime=(time); end
+     
+     # Set drag delta (in pixels)
      def dragDelta=(delta); end
+     
+     # Set number of wheel lines
      def wheelLines=(lines); end
    

Index: FXComposite.rb
===================================================================
RCS file: /cvsroot/fxruby/FXRuby/rdoc-sources/FXComposite.rb,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** FXComposite.rb	7 Feb 2002 16:54:54 -0000	1.1
--- FXComposite.rb	27 Mar 2002 18:03:04 -0000	1.2
***************
*** 14,22 ****
      def onFocusPrev(sender, selector, event) ; end
      
!     # Handles the +SEL_COMMAND+ message with identifier +FXWindow::ID_UPDATE+
      def onCmdUpdate(sender, selector, event) ; end
    
      # Constructor
!     def initialize(p, opts=0, x=0, y=0, w=0, h=0);
    
      # Return the width of the widest child window
--- 14,22 ----
      def onFocusPrev(sender, selector, event) ; end
      
!     # Handles the +SEL_COMMAND+ message with identifier FXWindow::ID_UPDATE
      def onCmdUpdate(sender, selector, event) ; end
    
      # Constructor
!     def initialize(p, opts=0, x=0, y=0, w=0, h=0); end
    
      # Return the width of the widest child window