fxruby 1.6.13-mswin32

data/rdoc-sources/FXCheckButton.rb

@@ -0,0 +1,58 @@
+module Fox
+  #
+  # A Check button is a tri-state button.  Normally, it is either
+  # +TRUE+ or +FALSE+, and toggles between +TRUE+ or +FALSE+ whenever it is pressed.
+  # A third state +MAYBE+ may be set to indicate that no selection has been made yet
+  # by the user, or that the state is ambiguous.
+  # When pressed, the Check Button sends a <tt>SEL_COMMAND</tt> to its target, and the
+  # message data represents the state of the check button.
+  # The option <tt>CHECKBUTTON_AUTOGRAY</tt> (<tt>CHECKBUTTON_AUTOHIDE</tt>) causes the button to be
+  # grayed out (hidden) if its handler does not respond to the <tt>SEL_UPDATE</tt> message.
+  # With the <tt>CHECKBUTTON_PLUS</tt> option, the Check Button will draw a + or - sign instead
+  # of a check. You can use this to make collapsible panels, by hooking up a Check
+  # Button to a layout manager via the <tt>ID_TOGGLE_SHOWN</tt> message. This will give a
+  # similar visual element as collapsing folders in a Tree List.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXCheckButton 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_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_COMMAND+::		sent when the button is clicked.
+  #
+  # === CheckButton styles
+  #
+  # +CHECKBUTTON_AUTOGRAY+::  Automatically gray out when not updated
+  # +CHECKBUTTON_AUTOHIDE+::  Automatically hide when not updated
+  # +CHECKBUTTON_PLUS+::      Draw a plus sign for unchecked and minus sign for checked
+  # +CHECKBUTTON_NORMAL+::    <tt>JUSTIFY_NORMAL|ICON_BEFORE_TEXT</tt>
+  
+  class FXCheckButton < FXLabel
+
+    # Check button state (+TRUE+, +FALSE+ or +MAYBE+) [Integer]
+    attr_accessor :checkState
+    
+    # Check button style [Integer]
+    attr_accessor :checkButtonStyle
+    
+    # Box background color [FXColor]
+    attr_accessor :boxColor
+    
+    # Box check color [FXColor]
+    attr_accessor :checkColor
+
+    # Construct new check button
+    def initialize(parent, text, target=nil, selector=0, opts=CHECKBUTTON_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theCheckButton
+    end
+    
+    #
+    # Set the check button state to one of +TRUE+, +FALSE+ or +MAYBE+.
+    # If _notify_ is +true+, send a +SEL_COMMAND+ message to the message target
+    # after the state has been updated.
+    #
+    def setCheck(state, notify=false); end
+  end
+end

data/rdoc-sources/FXChoiceBox.rb

@@ -0,0 +1,49 @@
+module Fox
+  #
+  # The Choice Box provides a dialog panel to select one item out of a list
+  # of choices.  The choices are provided as a list of text strings.
+  # When the dialog closes, the index of the selected choice is returned,
+  # while a -1 is returned if the dialog was canceled,
+  #
+  class FXChoiceBox < FXDialogBox
+    #
+    # Construct choice box with given caption, icon, message text, and with choices from array of strings.
+    # If _owner_ is another FXWindow, the dialog box is created as a child of that window. If _owner_
+    # is an FXApp instance, it's created as a free-floating dialog box.
+    #
+    # ==== Parameters:
+    #
+    # +owner+::		Owner for this dialog box [FXWindow or FXApp]
+    # +caption+::	Caption for this dialog box [String]
+    # +text+::		Message text for this dialog box [String]
+    # +icon+::		Icon for this dialog box [FXIcon]
+    # +choices+::	Array of strings containing choices [Array]
+    # +opts+::		Dialog box options [Integer]
+    # +x+::		x-coordinate
+    # +y+::		y-coordinate
+    # +width+::		width
+    # +height+::		height
+    #
+    def initialize(owner, caption, text, icon, choices, opts=0, x=0, y=0, width=0, height=0) # :yields: theChoiceBox
+    end
+
+    #
+    # Show a modal choice dialog.
+    # Prompt the user using a dialog with given caption, icon,
+    # message text, and choices from array of strings.
+    # Returns -1 if the dialog box is cancelled, otherwise returns the index of the selected choice
+    #
+    # ==== Parameters:
+    #
+    # +owner+::		Owner for this dialog box [FXWindow or FXApp]
+    # +opts+::		Dialog box options [Integer]
+    # +caption+::	Caption for this dialog box [String]
+    # +text+::		Message text for this dialog box [String]
+    # +icon+::		Icon for this dialog box [FXIcon]
+    # +choices+::	Array of strings containing choices [Array]
+    #
+    def FXChoiceBox.ask(owner, opts, caption, text, icon, choices); end
+
+  end
+end
+

data/rdoc-sources/FXColorBar.rb

@@ -0,0 +1,48 @@
+module Fox
+  #
+  # A Color Bar is a widget which controls the brightness (value) of a
+  # color by means of the hue, saturation, value specification system.
+  # It is most useful when used together with the Color Wheel which controls
+  # the hue and saturation.
+  # The options <tt>COLORBAR_HORIZONTAL</tt> and <tt>COLORBAR_VERTICAL</tt> control the orientation
+  # of the bar.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXColorBar to its target:
+  #
+  # +SEL_CHANGED+::		sent continuously while the user is dragging the spot around; the message data is a three-element array containing the hue, saturation and value values.
+  # +SEL_COMMAND+::		sent when the user releases the mouse button and "drops" the spot at its new location; the message data is a three-element array containing the hue, saturation and value values.
+  # +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.
+  #
+  # === Color bar orientation
+  #
+  # +COLORBAR_HORIZONTAL+::	Color bar shown horizontally
+  # +COLORBAR_VERTICAL+::	Color bar shown vertically
+
+  class FXColorBar < FXFrame
+
+    # Hue [Float]
+    attr_accessor :hue
+    
+    # Saturation [Float]
+    attr_accessor :sat
+    
+    # Value [Float]
+    attr_accessor :val
+    
+    # Color bar style (one of +COLORBAR_HORIZONTAL+ or +COLORBAR_VERTICAL+) [Integer]
+    attr_accessor	:barStyle
+    
+    # Status line help text [String]
+    attr_accessor	:helpText
+    
+    # Tool tip message [String]
+    attr_accessor	:tipText
+
+    # Construct color bar
+    def initialize(parent, target=nil, selector=0, opts=FRAME_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theColorBar
+    end
+  end
+end

data/rdoc-sources/FXColorDialog.rb

@@ -0,0 +1,37 @@
+module Fox
+  #
+  # FXColorDialog is a standard dialog panel used to edit colors.
+  # Colors can be edited via RGB (Red, Green, Blue additive color model),
+  # via HSV (Hue, Saturation, Value color modal), via CMY (Cyan, Magenta,
+  # Yellow subtractive color model), or by name.
+  # Commonly used colors can be dragged into a number of small color wells
+  # to be used repeatedly; colors dropped into the small color wells are
+  # automatically saved into the registry for future use.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXColorDialog to its target:
+  #
+  # +SEL_CHANGED+::	sent continuously, while the color selector's color is changing
+  # +SEL_COMMAND+::	sent when the new color is set
+  #
+  # === Message identifiers
+  #
+  # +ID_COLORSELECTOR+::	used internally to identify messages from the FXColorSelector
+
+  class FXColorDialog < FXDialogBox
+
+    # The color [FXColor]
+    attr_accessor :rgba
+   
+    # Only opaque colors allowed [Boolean]
+    attr_writer :opaqueOnly
+
+    # Construct color dialog
+    def initialize(owner, title, opts=0, x=0, y=0, width=0, height=0) # :yields: theColorDialog
+    end
+  
+    # Return +true+ if only opaque colors allowed
+    def opaqueOnly?() ; end
+  end
+end

data/rdoc-sources/FXColorList.rb

@@ -0,0 +1,55 @@
+module Fox
+  # Color item
+  class FXColorItem < FXListItem
+    # Item color [FXColor]
+    attr_accessor :color
+    
+    # Return a new color item, initialized with the given text, color and
+    # user data.
+    def initialize(text, clr, data=nil) # :yields: theColorItem
+    end
+  end
+  
+  # Displays a list of colors
+  class FXColorList < FXList
+
+    #
+    # Return an initially empty list of colors.
+    #
+    def initialize(p, target=nil, selector=0, opts=LIST_BROWSESELECT, x=0, y=0, width=0, height=0) # :yields: theColorList
+    end
+
+    #
+    # Fill list by appending color items from array of strings and array of colors.
+    #
+    def fillItems(strings, colors=nil, ptr=nil, notify=false); end
+
+    #
+    # Insert item at index with given text, color, and user-data pointer
+    #
+    def insertItem(index, text, color=0, ptr=nil, notify=false); end
+
+    #
+    # Append new item with given text, color, and user-data pointer
+    #
+    def appendItem(text, color=0, ptr=nil, notify=false); end
+
+    #
+    # Prepend new item with given text, color, and user-data pointer
+    #
+    def prependItem(text, color=0, ptr=nil, notify=false); end
+
+    #
+    # Change item color for the item at _index_.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def setItemColor(index, color); end
+
+    #
+    # Return item color for the item at _index_.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def getItemColor(index); end
+  end
+end
+

data/rdoc-sources/FXColorRing.rb

@@ -0,0 +1,49 @@
+module Fox
+  #
+  # A Color Ring widget provides an intuitive way to specify a color.
+  # The outer ring of the widget is rotated to control the hue of the color
+  # being specified, while the inner triangle varies the color saturation
+  # and the brightness of the color.  The color saturation axis of the
+  # triangle goes from a fully saturated "pure" color to "pastel" color;
+  # the brightness goes from black to a bright color.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXColorRing to its target:
+  #
+  # +SEL_CHANGED+::		sent continuously while the user is dragging the spot around; the message data is a three-element array containing the hue, saturation and value values.
+  # +SEL_COMMAND+::		sent when the user releases the mouse button and "drops" the spot at its new location; the message data is a three-element array containing the hue, saturation and value values.
+  # +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.
+  #
+  class FXColorRing < FXFrame
+  
+    # Hue [Float]
+    attr_accessor :hue
+    
+    # Saturation [Float]
+    attr_accessor :sat
+    
+    # Value [Float]
+    attr_accessor :val
+    
+    # Width of hue ring in pixels [Integer]
+    attr_accessor :ringWidth
+    
+    # Status line help text [String]
+    attr_accessor :helpText
+    
+    # Tool tip message [String]
+    attr_accessor :tipText
+    
+    #
+    # Return an initialized FXColorRing instance.
+    #
+    def initialize(p, target=nil, selector=0, opts=FRAME_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theColorRing
+    end
+    
+    # Set the hue, saturation and value (all floating point values)
+    def setHueSatVal(h, s, v); end
+  end
+end
+

data/rdoc-sources/FXColorSelector.rb

@@ -0,0 +1,65 @@
+module Fox
+  # Color selection widget
+  #
+  # === Events
+  #
+  # The following messages are sent by FXColorSelector to its target:
+  #
+  # +SEL_CHANGED+::	sent continuously, while the color is changing
+  # +SEL_COMMAND+::	sent when the new color is set
+  #
+  # === Message identifiers
+  #
+  # +ID_CUSTOM_FIRST+::			x
+  # +ID_CUSTOM_LAST+::			x
+  # +ID_RGB_RED_SLIDER+::		x
+  # +ID_RGB_GREEN_SLIDER+::		x
+  # +ID_RGB_BLUE_SLIDER+::		x
+  # +ID_RGB_RED_TEXT+::			x
+  # +ID_RGB_GREEN_TEXT+::		x
+  # +ID_RGB_BLUE_TEXT+::		x
+  # +ID_HSV_HUE_SLIDER+::		x
+  # +ID_HSV_SATURATION_SLIDER+::	x
+  # +ID_HSV_VALUE_SLIDER+::		x
+  # +ID_HSV_HUE_TEXT+::			x
+  # +ID_HSV_SATURATION_TEXT+::		x
+  # +ID_HSV_VALUE_TEXT+::		x
+  # +ID_CMY_CYAN_SLIDER+::		x
+  # +ID_CMY_MAGENTA_SLIDER+::		x
+  # +ID_CMY_YELLOW_SLIDER+::		x
+  # +ID_CMY_CYAN_TEXT+::		x
+  # +ID_CMY_MAGENTA_TEXT+::		x
+  # +ID_CMY_YELLOW_TEXT+::		x
+  # +ID_DIAL_WHEEL+::			x
+  # +ID_COLOR_BAR+::			x
+  # +ID_COLOR_LIST+::			x
+  # +ID_WELL_CHANGED+::			x
+  # +ID_COLOR+::			x
+  # +ID_ACTIVEPANE+::			x
+  # +ID_ALPHA_SLIDER+::			x
+  # +ID_ALPHA_TEXT+::			x
+  # +ID_ALPHA_LABEL+::			x
+  # +ID_COLORPICK+::			x
+  
+  class FXColorSelector < FXPacker
+
+    # The "Accept" button [FXButton]
+    attr_reader	:acceptButton
+    
+    # The "Cancel" button [FXButton]
+    attr_reader	:cancelButton
+  
+    # The color [FXColor]
+    attr_accessor :rgba
+    
+    # Only opaque colors allowed [Boolean]
+    attr_writer	:opaqueOnly
+
+    # Construct a new color selector
+    def initialize(parent, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theColorSelector
+    end
+
+    # Return +true+ if only opaque colors allowed
+    def opaqueOnly?() ; end
+  end
+end

data/rdoc-sources/FXColorWell.rb

@@ -0,0 +1,65 @@
+module Fox
+  #
+  # A Color Well is a widget which controls color settings.
+  # Colors may be dragged and dropped from one color well to another.
+  # A double-click inside a color well will bring up the standard
+  # color dialog panel to edit the color well's color.
+  # Colors may be also pasted by name using middle-mouse click into/out of
+  # color wells from/to other selection-capable applications; for example,
+  # you can highlight the word `red' and paste it into a color well.
+  #
+  # === Events
+  #
+  # The following messages are sent from FXColorWell to its target:
+  #
+  # +SEL_COMMAND+::		sent when a new color is applied; the message data is the color value.
+  # +SEL_CHANGED+::		sent when the color changes; the message data is the color value.
+  # +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.
+  # +SEL_CLICKED+::		sent when the color well is single-clicked; the message data is the color value.
+  # +SEL_DOUBLECLICKED+::	sent when the color well is double-clicked; the message data is the color value.
+  #
+  # === Color Well Styles
+  #
+  # +COLORWELL_OPAQUEONLY+::	Colors must be opaque
+  # +COLORWELL_SOURCEONLY+::	This color well is never a target
+  # +COLORWELL_NORMAL+::	Same as +JUSTIFY_NORMAL+
+  #
+  # === Message identifiers
+  #
+  # +ID_COLORDIALOG+::		x
+  
+  class FXColorWell < FXFrame
+
+    # The color [FXColor]
+    attr_accessor :rgba
+    
+    # Status line help text [String]
+    attr_accessor :helpText
+    
+    # Tool tip message [String]
+    attr_accessor :tipText
+    
+    # Only opaque colors allowed [Boolean]
+    attr_writer :opaqueOnly
+
+    # Construct color well with initial _color_.
+    def initialize(parent, color=0, target=nil, selector=0, opts=COLORWELL_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theColorWell
+    end
+
+    # Set the color for this color well to _clr_.
+    # If _notify_ is +true+, a <tt>SEL_COMMAND</tt> message is sent to the color
+    # well's message target after the color is changed.
+    def setRGBA(clr, notify=false); end
+
+    # Return the color for this color well.
+    def getRGBA; end
+
+    # Return +true+ if only opaque colors allowed
+    def opaqueOnly?() ; end
+  end
+end

data/rdoc-sources/FXColorWheel.rb

@@ -0,0 +1,57 @@
+module Fox
+  #
+  # A Color Wheel is a widget which controls the hue and saturation values of a
+  # color. It is most often used together with a Color Bar which controls the
+  # brightness.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXColorWheel to its target:
+  #
+  # +SEL_CHANGED+::		sent continuously, while the color is changing; the message data is a 3-element array of floats containing the hue, saturation and value.
+  # +SEL_COMMAND+::		sent when the new color is set; the message data is a 3-element array of floats containing the hue, saturation and value.
+  # +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.
+  #
+  class FXColorWheel < FXFrame
+
+    # Hue [Float]
+    attr_accessor :hue
+    
+    # Saturation [Float]
+    attr_accessor :sat
+    
+    # Value [Float]
+    attr_accessor :val
+  
+    # Status line help text [String]  
+    attr_accessor :helpText
+  
+    # Tool tip message [String]  
+    attr_accessor :tipText
+
+    #
+    # Construct color wheel
+    #
+    # ==== Parameters:
+    #
+    # +p+::	Parent widget [FXComposite]
+    # +target+::	Message target object [FXObject]
+    # +selector+::	Message identifier [Integer]
+    # +opts+::	Options [Integer]
+    # +x+::
+    # +y+::
+    # +width+::
+    # +height+::
+    # +padLeft+::
+    # +padRight+::
+    # +padTop+::
+    # +padBottom+::
+    #
+    def initialize(p, target=nil, selector=0, opts=FRAME_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theColorWheel
+    end
+
+    # Set hue, saturation and value all in one shot.
+    def setHueSatVal(h, s, v); end
+  end
+end