fxruby 1.6.13-mswin32

data/rdoc-sources/FXTextField.rb

@@ -0,0 +1,151 @@
+module Fox
+  #
+  # A text field is a single-line text entry widget.
+  # The text field widget supports clipboard for cut-and-paste
+  # operations.
+  # The text field also sends SEL_COMMAND when the focus moves to another control.
+  # TEXTFIELD_ENTER_ONLY can be passed to suppress this feature. Typically, this
+  # flag is used in dialogs that close when ENTER is hit in a text field.
+  #
+  # === Events
+  #
+  # The following messages are sent from FXTextField to its target:
+  #
+  # +SEL_COMMAND+::		sent when the user presses the *Enter* key or tabs out of the text field; the message data is a String containing the text.
+  # +SEL_CHANGED+::		sent when the text changes; the message data is a String containing the text.
+  # +SEL_VERIFY+::		sent when the user attempts to enter new text in the text field; the message data is a String containing the proposed new text.
+  # +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_MIDDLEBUTTONPRESS+::	sent when the middle mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_MIDDLEBUTTONRELEASE+::	sent when the middle mouse button goes up; the message data is an FXEvent instance.
+  #
+  # === 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+::      <tt>FRAME_SUNKEN|FRAME_THICK</tt>
+  #
+  # === 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
+
+    # Text field editability [Boolean]
+    attr_writer		:editable
+
+    # Cursor position [Integer]
+    attr_accessor	:cursorPos
+
+    # Anchor position [Integer]
+    attr_accessor	:anchorPos
+
+    # Text [String]
+    attr_accessor	:text
+
+    # Text font [FXFont]
+    attr_accessor	:font
+
+    # Text color [FXColor]
+    attr_accessor	:textColor
+
+    # Background color for selected text [FXColor]
+    attr_accessor	:selBackColor
+
+    # Foreground color for selected text [FXColor]
+    attr_accessor	:selTextColor
+
+    # Default width of this text field, in terms of a number of columns times the width of the numeral '8' [Integer]
+    attr_accessor	:numColumns
+
+    # Text justification mode, a combination of horizontal justification (JUSTIFY_LEFT, JUSTIFY_RIGHT, or JUSTIFY_CENTER_X), and vertical justification (JUSTIFY_TOP, JUSTIFY_BOTTOM, JUSTIFY_CENTER_Y) [Integer]
+    attr_accessor	:justify
+
+    # Status line help text [String]
+    attr_accessor	:helpText
+
+    # Tool tip message [String]
+    attr_accessor	:tipText
+
+    # Text style [Integer]
+    attr_accessor	:textStyle
+
+    #
+    # Return an initialized FXTextField instance.
+    # It should be wide enough to display _ncols_ columns.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this text field [FXComposite]
+    # +ncols+::	number of visible items [Integer]
+    # +target+::	the message target, if any, for this text field [FXObject]
+    # +selector+::	the message identifier for this text field [Integer]
+    # +opts+::	text field 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, ncols, target=nil, selector=0, opts=TEXTFIELD_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theTextField
+    end
+  
+    # 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
+  
+    # Select _len_ characters starting at given position _pos_.
+    def setSelection(pos, len) ; end
+  
+    # Extend the selection from the anchor to the given position _pos_.
+    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 _pos_ is fully visible.
+    def posVisible?(pos) ; end
+  
+    # Scroll text to make the given position _pos_ visible.
+    def makePositionVisible(pos) ; end
+  end
+end

data/rdoc-sources/FXToggleButton.rb

@@ -0,0 +1,69 @@
+module Fox
+  #
+  # The toggle button provides a two-state button, which toggles between the
+  # on and the off state each time it is pressed.  For each state, the toggle
+  # button has a unique icon and text label.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXToggleButton to its target:
+  #
+  # +SEL_COMMAND+::		sent when the toggle button is pressed.
+  # +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.
+  #
+  # === Toggle button flags
+  #
+  # +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_NORMAL+::	<tt>FRAME_RAISED|FRAME_THICK|JUSTIFY_NORMAL|ICON_BEFORE_TEXT</tt>
+  #
+  class FXToggleButton < FXLabel
+
+    # Alternate text, shown when toggled [String]
+    attr_accessor	:altText
+
+    # Alternate icon, shown when toggled [FXIcon]
+    attr_accessor	:altIcon
+
+    # Toggled state [+true+ or +false+]
+    attr_accessor	:state
+
+    # Alternate status line help text, shown when toggled [String]
+    attr_accessor	:altHelpText
+
+    # Alternate tool tip message, shown when toggled [String]
+    attr_accessor	:altTipText
+
+    # Toggle button style [Integer]
+    attr_accessor	:toggleStyle
+
+    #
+    # Return an initialized FXToggleButton instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::		the parent window for this toggle button [FXComposite]
+    # <tt>text1</tt>::	the text for this toggle button's first state [String]
+    # <tt>text2</tt>::	the text for this toggle button's second state [String]
+    # <tt>icon1</tt>::	the icon, if any, for this toggle button's first state [FXIcon]
+    # <tt>icon2</tt>::	the icon, if any, for this toggle button's second state [FXIcon]
+    # +target+::		the message target, if any, for this toggle button [FXObject]
+    # +selector+::		the message identifier for this toggle button [Integer]
+    # +opts+::		toggle 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, icon1=nil, icon2=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: theToggleButton
+    end
+  end
+end

data/rdoc-sources/FXToolBar.rb

@@ -0,0 +1,61 @@
+module Fox
+  #
+  # A tool bar widget can be docked in a dock site; it automatically
+  # adjusts its orientation based on the orientation of the dock site,
+  # and adjusts the layout options accordingly.
+  # See FXDockBar widget for more information on the docking behavior.
+  #
+  class FXToolBar < FXDockBar
+
+    # Docking side, one of +LAYOUT_SIDE_LEFT+, +LAYOUT_SIDE_RIGHT+, +LAYOUT_SIDE_TOP+ or +LAYOUT_SIDE_BOTTOM+ [Integer]
+    attr_accessor :dockingSide
+
+    #
+    # Return an initialized, floatable FXToolBar instance.
+    # Normally, the tool bar is docked under window _p_.
+    # When floated, the tool bar can be docked under window _q_, which is
+    # typically an FXToolBarShell window.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the "dry dock" window for this tool bar [FXComposite]
+    # +q+::	the "wet dock" window for this tool bar [FXComposite]
+    # +opts+::	tool 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: theToolBar
+    end
+  
+    #
+    # Return an initialized, stationary FXToolBar instance.
+    # The tool bar can not be undocked.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this tool bar [FXComposite]
+    # +opts+::	tool 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: theToolBar
+    end
+  end
+end
+

data/rdoc-sources/FXToolBarGrip.rb

@@ -0,0 +1,50 @@
+module Fox
+  #
+  # A tool bar grip is used to move its container, a dock bar.
+  # The grip draws either a single or double bar; it is customary
+  # to use the single bar grip for toolbar-rearrangements only,
+  # and use the double-bar when the toolbar needs to be floated
+  # or docked.
+  # The tool bar grip is automatically oriented properly by the
+  # the toolbar widget, similar to the FXSeparator widget.
+  # Holding the Control Key while dragging the grip will prevent
+  # the toolbar from docking when it is near a dock site.
+  #
+  # === Toolbar Grip styles
+  #
+  # +TOOLBARGRIP_SINGLE+::	Single bar mode for movable tool bars
+  # +TOOLBARGRIP_DOUBLE+::	Double bar mode for dockable tool bars
+  #
+  class FXToolBarGrip < FXDockHandler
+
+    # Indicates whether the grip is displayed as a double-bar [Boolean]
+    attr_writer	:doubleBar
+    
+    # Active color [FXColor]
+    attr_accessor :activeColor
+
+    #
+    # Return an initialized FXToolBarGrip instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this tool bar grip [FXComposite]
+    # +target+::	the message target, if any, for this tool bar grip [FXObject]
+    # +selector+::	the message identifier for this tool bar grip [Integer]
+    # +opts+::	tool bar grip options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +width+::	initial width [Integer]
+    # +height+::	initial height [Integer]
+    #
+    def initialize(p, target=nil, selector=0, opts=TOOLBARGRIP_SINGLE, x=0, y=0, width=0, height=0) # :yields: theToolBarGrip
+    end
+
+    #
+    # Return +true+ if this tool bar grip is displayed as a double bar (i.e. as
+    # opposed to a single bar).
+    #
+    def doubleBar? ; end
+  end
+end
+

data/rdoc-sources/FXToolBarShell.rb

@@ -0,0 +1,44 @@
+module Fox
+  #
+  # An FXToolBarShell is a widget floating around over the main window.
+  # It typically contains an undocked tool bar.
+  #
+  class FXToolBarShell < FXTopWindow
+  
+    # Frame style [Integer]  
+    attr_accessor :frameStyle
+    
+    # Border width [Integer]
+    attr_reader	:borderWidth
+    
+    # Highlight color [FXColor]
+    attr_accessor :hiliteColor
+    
+    # Shadow color [FXColor]
+    attr_accessor :shadowColor
+    
+    # Border color [FXColor]
+    attr_accessor :borderColor
+    
+    # Base GUI color [FXColor]
+    attr_accessor :baseColor
+
+    #
+    # Return an initialized FXToolBarShell instance.
+    #
+    # ==== Parameters:
+    #
+    # +owner+::	the owner window for this tool bar shell [FXWindow]
+    # +opts+::	tool bar shell options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +width+::	initial width [Integer]
+    # +height+::	initial height [Integer]
+    # +hSpacing+::	horizontal spacing between widgets, in pixels [Integer]
+    # +vSpacing+::	vertical spacing between widgets, in pixels [Integer]
+    #
+    def initialize(owner, opts=FRAME_RAISED|FRAME_THICK, x=0, y=0, width=0, height=0, hSpacing=4, vSpacing=4) # :yields: theToolBarShell
+    end
+  end
+end
+

data/rdoc-sources/FXToolBarTab.rb

@@ -0,0 +1,74 @@
+module Fox
+  #
+  # A toolbar tab is used to collapse or uncollapse a sibling
+  # widget. The sibling affected is the widget immediately following
+  # the toolbar tab or, if the toolbar tab is the last widget in the list,
+  # the widget immediately preceding the toolbar tab.
+  # Typically, the toolbar tab is paired with just one sibling widget
+  # inside a paired container, e.g.
+  #
+  #     FXHorizontalFrame.new(...) do |p|
+  #       FXToolBarTab.new(p)
+  #       FXLabel.new(p, "Hideable label", nil, LAYOUT_FILL_X)
+  #     end
+  #
+  # === Events
+  #
+  # The following messages are sent by FXToolBarTab 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_COMMAND+::	Sent after the toolbar tab is collapsed (or uncollapsed). The message data indicates the new collapsed state (i.e. it's +true+ if the toolbar tab is now collapsed, +false+ if it is now uncollapsed).
+  #
+  # === Toolbar tab styles
+  #
+  # +TOOLBARTAB_HORIZONTAL+::		Default is for horizontal toolbar
+  # +TOOLBARTAB_VERTICAL+::		For vertical toolbar
+  #
+  # === Message identifiers
+  # 
+  # +ID_COLLAPSE+::					Collapse the toolbar tab
+  # +ID_UNCOLLAPSE+::				Uncollapse the toolbar tab
+  #
+  class FXToolBarTab < FXFrame
+
+    # The tab style [Integer]
+    attr_accessor :tabStyle
+
+    # The active color [FXColor]
+    attr_accessor :activeColor
+    
+    # Tooltip message [String]
+    attr_accessor :tipText
+
+    #
+    # Return an initialized FXToolBarTab instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::		the parent window for this toolbar tab [FXWindow]
+    # +target+::	the message target [FXObject]
+    # +selector+::	the message identifier [Integer]
+    # +opts+::	the options [Integer]
+    # +x+::		x-coordinate of window upper left corner [Integer]
+    # +y+::		y-coordinate of window upper left corner [Integer]
+    # +width+::		window width [Integer]
+    # +height+::		window height [Integer]
+    #
+    def initialize(p, target=nil, selector=0, opts=FRAME_RAISED, x=0, y=0, width=0, height=0) # :yield: theToolBarTab
+    end
+
+    #
+    # Collapse (if _fold_ is +true+) or uncollapse the toolbar.
+    # If _notify_ is +true+, a +SEL_COMMAND+ message is sent to the toolbar
+    # tab's message target after the toolbar tab is collapsed (or uncollapsed).
+    #
+    def collapse(fold, notify=false); end
+  
+    #
+    # Return +true+ if the toolbar is collapsed, +false+ otherwise.
+    #
+    def collapsed?; end
+  end
+end
+