fxruby 1.2.2

data/rdoc-sources/FXTextField.rb

@@ -0,0 +1,141 @@
+module Fox
+  # A text field is a single-line text entry widget.
+  # The text field widget supports clipboard for cut-and-paste
+  # operations.
+  #
+  # === 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
+
+    # Width of this text field, in terms of number of columns * 'm' [Integer]
+    attr_accessor	:numColumns
+
+    # Text justification mode [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]
+    # +tgt+::	the message target, if any, for this text field [FXObject]
+    # +sel+::	the message identifier for this text field [Integer]
+    # +opts+::	text field options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    # +pl+::	internal padding on the left side, in pixels [Integer]
+    # +pr+::	internal padding on the right side, in pixels [Integer]
+    # +pt+::	internal padding on the top side, in pixels [Integer]
+    # +pb+::	internal padding on the bottom side, in pixels [Integer]
+    #
+    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) # :yields: theTextField
+    end
+  
+    # Return +true+ if text field may be edited
+    def editable?() ; 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]
+    # +tgt+::		the message target, if any, for this toggle button [FXObject]
+    # +sel+::		the message identifier for this toggle button [Integer]
+    # +opts+::		toggle button options [Integer]
+    # +x+::		initial x-position [Integer]
+    # +y+::		initial y-position [Integer]
+    # +w+::		initial width [Integer]
+    # +h+::		initial height [Integer]
+    # +pl+::		internal padding on the left side, in pixels [Integer]
+    # +pr+::		internal padding on the right side, in pixels [Integer]
+    # +pt+::		internal padding on the top side, in pixels [Integer]
+    # +pb+::		internal padding on the bottom side, in pixels [Integer]
+    #
+    def initialize(p, text1, text2, icon1=nil, icon2=nil, tgt=nil, sel=0, opts=TOGGLEBUTTON_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theToggleButton
+    end
+  end
+end

data/rdoc-sources/FXToolBar.rb

@@ -0,0 +1,121 @@
+module Fox
+  #
+  # Toolbar control.
+  #
+  # === Message identifiers
+  #
+  # +ID_UNDOCK+::	Undock the tool bar
+  # +ID_DOCK_TOP+::	Dock on the top
+  # +ID_DOCK_BOTTOM+::	Dock on the bottom
+  # +ID_DOCK_LEFT+::	Dock on the left
+  # +ID_DOCK_RIGHT+::	Dock on the right
+  # +ID_TOOLBARGRIP+::	Notifications from tool bar grip
+  #
+  class FXToolBar < FXPacker
+
+    # Parent window when the tool bar is docked [FXComposite]
+    attr_reader	:dryDock
+    
+    # Parent window when the tool bar is undocked (or "floating") [FXComposite]
+    attr_reader	:wetDock
+    
+    # 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]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    # +pl+::	internal padding on the left side, in pixels [Integer]
+    # +pr+::	internal padding on the right side, in pixels [Integer]
+    # +pt+::	internal padding on the top side, in pixels [Integer]
+    # +pb+::	internal padding on the bottom side, in pixels [Integer]
+    # +hs+::	horizontal spacing between widgets, in pixels [Integer]
+    # +vs+::	vertical spacing between widgets, in pixels [Integer]
+    #
+    def initialize(p, q, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, w=0, h=0, pl=3, pr=3, pt=2, pb=2, hs=DEFAULT_SPACING, vs=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]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    # +pl+::	internal padding on the left side, in pixels [Integer]
+    # +pr+::	internal padding on the right side, in pixels [Integer]
+    # +pt+::	internal padding on the top side, in pixels [Integer]
+    # +pb+::	internal padding on the bottom side, in pixels [Integer]
+    # +hs+::	horizontal spacing between widgets, in pixels [Integer]
+    # +vs+::	vertical spacing between widgets, in pixels [Integer]
+    #
+    def initialize(p, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, w=0, h=0, pl=3, pr=3, pt=2, pb=2, hs=DEFAULT_SPACING, vs=DEFAULT_SPACING) # :yields: theToolBar
+    end
+
+    #
+    # Dock the bar against the given _side_, after some other widget.
+    # However, if _after_ is -1, it will be docked as the innermost toolbar just before
+    # the work-area, while if _after_ is 0, if will be docked as the outermost toolbar.
+    #
+    # ==== Parameters:
+    #
+    # +side+::
+    #   side of the parent window against which to dock the tool bar, one of
+    #   +LAYOUT_SIDE_TOP+, +LAYOUT_SIDE_BOTTOM+, +LAYOUT_SIDE_LEFT+ or +LAYOUT_SIDE_RIGHT+ [Integer].
+    # +after+::
+    #   sibling window (i.e. inside the parent) after which to dock this tool bar [FXWindow].
+    #   Also see exceptions described above for the cases when _after_ is 0 or -1.
+    #
+    def dock(side=LAYOUT_SIDE_TOP, after=-1); end
+    
+    #
+    # Undock or "float" the toolbar.
+    # The initial position of the wet dock is a few pixels
+    # below and to the right of the original docked position.
+    #
+    def undock; end
+
+    #
+    # Set parent when docked.
+    # If it was already docked, reparent under the new docking window.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	new "dry dock" parent window for this tool bar [FXComposite]
+    #
+    def setDryDock(p); end
+
+    #
+    # Set parent when floating.
+    # If it was already undocked, then reparent under the new floating window.
+    #
+    # ==== Parameters:
+    #
+    # +q+::	new "wet dock" parent window for this tool bar [FXComposite]
+    #
+    def setWetDock(q); end
+
+    #
+    # Return +true+ if toolbar is docked
+    #
+    def docked? ; end
+  end
+end
+

data/rdoc-sources/FXToolBarGrip.rb

@@ -0,0 +1,55 @@
+module Fox
+  #
+  # A tool bar grip is used to move its parent (an FXToolBar). 
+  # 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 tool bar widget.
+  #
+  # === Toolbar Grip styles
+  #
+  # +TOOLBARGRIP_SINGLE+::	Single bar mode for movable tool bars
+  # +TOOLBARGRIP_DOUBLE+::	Double bar mode for dockable tool bars
+  # +TOOLBARGRIP_SEPARATOR+::	Separator mode
+  #
+  class FXToolBarGrip < FXWindow
+
+    # Indicates whether the grip is displayed as a double-bar [Boolean]
+    attr_writer	:doubleBar
+    
+    # Highlight color [FXColor]
+    attr_accessor :hiliteColor
+    
+    # Shadow color [FXColor]
+    attr_accessor :shadowColor
+    
+    # Active color [FXColor]
+    attr_accessor :activeColor
+
+    #
+    # Return an initialized FXToolBarGrip instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this tool bar grip [FXComposite]
+    # +tgt+::	the message target, if any, for this tool bar grip [FXObject]
+    # +sel+::	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]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    #
+    def initialize(p, tgt=nil, sel=0, opts=TOOLBARGRIP_SINGLE, x=0, y=0, w=0, h=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]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    # +hs+::	horizontal spacing between widgets, in pixels [Integer]
+    # +vs+::	vertical spacing between widgets, in pixels [Integer]
+    #
+    def initialize(owner, opts=FRAME_RAISED|FRAME_THICK, x=0, y=0, w=0, h=0, hs=4, vs=4) # :yields: theToolBarShell
+    end
+  end
+end
+

data/rdoc-sources/FXToolTip.rb

@@ -0,0 +1,36 @@
+module Fox
+  # Hopefully Helpful Hint message
+  #
+  # = Tooltip styles
+  # TOOLTIP_PERMANENT:: Tooltip stays up indefinitely
+  # TOOLTIP_VARIABLE::  Tooltip stays up variable time, depending on the length of the string
+  # TOOLTIP_NORMAL::
+  #
+  # = Message identifiers
+  #
+  # ID_TIP_SHOW:: Show it
+  # ID_TIP_HIDE:: Hide it
+  #
+  class FXTooltip < FXShell
+    # Construct a tool tip
+    def initialize(app, opts=TOOLTIP_NORMAL, x=0, y=0, w=0, h=0); end
+
+    # Set the text for this tip
+    def text=(text); end
+
+    # Get the text for this tip
+    def text() ; end
+
+    # Set the tip text font
+    def font=(font) ; end
+
+    # Get the tip text font
+    def font() ; end
+
+    # Get the current tip text color
+    def textColor() ; end
+
+    # Set the current tip text color
+    def textColor=(color); end
+  end
+end