fxruby 1.6.14-universal-darwin-9

data/rdoc-sources/FXMenuTitle.rb

@@ -0,0 +1,27 @@
+module Fox
+  #
+  # A menu title is a child of a menu bar which is responsible
+  # for popping up a pulldown menu.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXMenuTitle 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.
+  #
+  class FXMenuTitle < FXMenuCaption
+
+    # The popup menu [FXPopup]
+    attr_accessor :menu
+
+    #
+    # Constructor
+    #
+    def initialize(parent, text, icon=nil, popupMenu=nil, opts=0) # :yields: theMenuTitle
+    end
+  end
+end
+

data/rdoc-sources/FXMessageBox.rb

@@ -0,0 +1,72 @@
+module Fox
+  #
+  # A Message Box is a convenience class which provides a dialog for
+  # very simple common yes/no type interactions with the user.
+  # The message box has an optional icon, a title string, and the question
+  # which is presented to the user.  It also has up to three buttons which
+  # furnish standard responses to the question.
+  # Message boxes are usually run modally: the question must be answered
+  # before the program may continue.
+  #
+  # === Message box buttons
+  #
+  # +MBOX_OK+::				Message box has a only an *Ok* button
+  # +MBOX_OK_CANCEL+::			Message box has *Ok* and *Cancel* buttons
+  # +MBOX_YES_NO+::			Message box has *Yes* and *No* buttons
+  # +MBOX_YES_NO_CANCEL+::		Message box has *Yes*, *No*, and *Cancel* buttons
+  # +MBOX_QUIT_CANCEL+::		Message box has *Quit* and *Cancel* buttons
+  # +MBOX_QUIT_SAVE_CANCEL+::		Message box has *Quit*, *Save*, and *Cancel* buttons
+  # +MBOX_SKIP_SKIPALL_CANCEL+::	Message box has *Skip*, *Skip All* and *Cancel* buttons
+  # +MBOX_SAVE_CANCEL_DONTSAVE+::	Message box has *Don't Save*, *Cancel* and *Save* buttons
+  #
+  # === Return values
+  #
+  # +MBOX_CLICKED_YES+::	The *Yes* button was clicked
+  # +MBOX_CLICKED_NO+::		The *No* button was clicked
+  # +MBOX_CLICKED_OK+::		The *Ok* button was clicked
+  # +MBOX_CLICKED_CANCEL+::	The *Cancel* button was clicked
+  # +MBOX_CLICKED_QUIT+::	The *Quit* button was clicked
+  # +MBOX_CLICKED_SAVE+::	The *Save* button was clicked
+  # +MBOX_CLICKED_SKIP+::	The *Skip* button was clicked
+  # +MBOX_CLICKED_SKIPALL+::	The *Skip All* button was clicked
+  #
+  class FXMessageBox < FXDialogBox
+    #
+    # Construct message box with given caption, icon, and message text.
+    # If _owner_ is a window, the message box will float over that window.
+    # If _owner_ is the application, the message box will be free-floating.
+    #
+    def initialize(owner, caption, text, ic=nil, opts=0, x=0, y=0) # :yields: theMessageBox
+    end
+
+    #
+    # Show a modal error message; returns one of the return values listed above.
+    # If _owner_ is a window, the message box will float over that window.
+    # If _owner_ is the application, the message box will be free-floating.
+    #
+    def FXMessageBox.error(owner, opts, caption, message); end
+  
+    #
+    # Show a modal warning message; returns one of the return values listed above.
+    # If _owner_ is a window, the message box will float over that window.
+    # If _owner_ is the application, the message box will be free-floating.
+    #
+    def FXMessageBox.warning(owner, opts, caption, message); end
+  
+    #
+    # Show a modal question dialog; returns one of the return values listed above.
+    # If _owner_ is a window, the message box will float over that window.
+    # If _owner_ is the application, the message box will be free-floating.
+    #
+    def FXMessageBox.question(owner, opts, caption, message); end
+  
+    #
+    # Show a modal information dialog; returns one of the return values listed above.
+    # If _owner_ is a window, the message box will float over that window.
+    # If _owner_ is the application, the message box will be free-floating.
+    #
+    def FXMessageBox.information(owner, opts, caption, message); end
+
+  end
+end
+

data/rdoc-sources/FXObject.rb

@@ -0,0 +1,28 @@
+module Fox
+  #
+  # FXObject is the base class for all objects in FOX; in order to receive
+  # messages from the user interface, your class must derive from FXObject.
+  # The FXObject class also provides serialization facilities, with which
+  # you can save and restore the object's state.  If you've subclassed
+  # from FXObject, you can save your subclasses' state by overloading the
+  # save() and load() functions and use the stream API to serialize its
+  # member data.
+  #
+  class FXObject
+    #
+    # Handle a message sent from _sender_, with given _selector_
+    # and message _data_.
+    #
+    def handle(sender, selector, data); end
+
+    #
+    # Save object to stream.
+    #
+    def save(stream) ; end
+
+    #
+    # Load object from _stream_.
+    #
+    def load(stream) ; end
+  end
+end

data/rdoc-sources/FXOptionMenu.rb

@@ -0,0 +1,83 @@
+module Fox
+  #
+  # Option Menu Button
+  #
+  # === Events
+  #
+  # The following messages are sent by FXOption 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 this option is clicked; the message data is an FXEvent instance.
+  #
+  class FXOption < FXLabel
+    # Selection background color [FXColor]
+    attr_accessor :selBackColor
+    
+    # Selection text color [FXColor]
+    attr_accessor :selTextColor
+
+    #
+    # Returns an initialized FXOption instance.
+    #
+    def initialize(p, text, ic=nil, target=nil, selector=0, opts=JUSTIFY_NORMAL|ICON_BEFORE_TEXT, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theOption
+    end
+  end
+
+  #
+  # Option Menu
+  #
+  # === Events
+  #
+  # The following messages are sent by FXOptionMenu 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 this an option is selected; the message data is the option number.
+  #
+  class FXOptionMenu < FXLabel
+  
+    # The current option, or +nil+ if none [FXOption]
+    attr_accessor :current
+    
+    # The current option number, or -1 if none [Integer]
+    attr_accessor :currentNo
+    
+    # The pane which will be popped up [FXPopup]
+    attr_accessor :menu
+    
+    #
+    # Returns an initialized FXOptionMenu instance.
+    #
+    def initialize(p, pup=nil, opts=JUSTIFY_NORMAL|ICON_BEFORE_TEXT, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theOptionMenu
+    end
+  
+    #
+    # Set the current option.
+    #
+    def setCurrent(win, notify=false); end
+    
+    #
+    # Return a reference to the current option (an FXOption instance).
+    #
+    def getCurrent(); end
+  
+    #
+    # Set the current option number.
+    #
+    def setCurrentNo(no, notify=false); end
+    
+    #
+    # Get the current option number.
+    #
+    def getCurrentNo(); end
+
+    # Return +true+ if popped up
+    def popped?; end
+  end
+end
+

data/rdoc-sources/FXPCXIcon.rb

@@ -0,0 +1,63 @@
+module Fox
+  #
+  # PCX icon
+  #
+  class FXPCXIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("pcx").
+    #
+    def FXPCXIcon.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPCXIcon.mimeType; end
+
+    #
+    # Return an initialized FXPCXIcon instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in PCX file format [String]
+    # +clr+::	transparency color [FXColor]
+    # +opts+::	options [Integer]
+    # +width+::	width [Integer]
+    # +height+::	height [Integer]
+    #
+    def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: thePCXIcon
+    end
+  end
+
+  #
+  # Load a PCX file from a stream.
+  # If successful, returns an array containing the image pixel data (as a
+  # String), the transparency color, the image width and the image height.
+  # If it fails, the function returns +nil+.
+  #
+  # ==== Parameters:
+  #
+  # +store+::	stream from which to read the file data [FXStream]
+  #
+  def Fox.fxloadPCX(store); end
+
+  #
+  # Save a PCX image to a stream.
+  # Returns +true+ on success, +false+ on failure.
+  #
+  # ==== Parameters:
+  #
+  # +store+::	stream to which to write the image data [FXStream]
+  # +data+::	the image pixel data [String]
+  # +transp+::	transparency color [FXColor]
+  # +width+::	width [Integer]
+  # +height+::	height [Integer]
+  #
+  def Fox.fxsavePCX(store, data, transp, width, height); end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a PCX image.
+  #
+  def Fox.fxcheckPCX(store); end
+end
+

data/rdoc-sources/FXPCXImage.rb

@@ -0,0 +1,31 @@
+module Fox
+  #
+  # PCX graphics file
+  #
+  class FXPCXImage < FXImage
+    #
+    # Return the suggested file extension for this image type ("pcx").
+    #
+    def FXPCXImage.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPCXImage.mimeType; end
+
+    #
+    # Return an initialized FXPCXImage instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in PCX file format [String]
+    # +opts+::	options [Integer]
+    # +width+::	width [Integer]
+    # +height+::	height [Integer]
+    #
+    def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: thePCXImage
+    end
+  end
+end
+

data/rdoc-sources/FXPNGIcon.rb

@@ -0,0 +1,66 @@
+module Fox
+  #
+  # Portable Network Graphics (PNG) Icon
+  #
+  class FXPNGIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("png").
+    #
+    def FXPNGIcon.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPNGIcon.mimeType; end
+
+    # Return +true+ if PNG image file format is supported.
+    def FXPNGIcon.supported? ; end
+
+    #
+    # Return an initialized FXPNGIcon instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in PNG file format [String]
+    # +clr+::	transparency color [FXColor]
+    # +opts+::	options [Integer]
+    # +width+::	width [Integer]
+    # +height+::	height [Integer]
+    #
+    def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: thePNGIcon
+    end
+  end
+  
+  #
+  # Load a PNG file from a stream.
+  # If successful, returns an array containing the image pixel data (as a
+  # String), the transparency color, the image width and the image height.
+  # If it fails, the function returns +nil+.
+  #
+  # ==== Parameters:
+  #
+  # +store+::	stream from which to read the file data [FXStream]
+  #
+  def Fox.fxloadPNG(store); end
+
+  #
+  # Save a PNG image to a stream.
+  # Returns +true+ on success, +false+ on failure.
+  #
+  # ==== Parameters:
+  #
+  # +store+::	stream to which to write the image data [FXStream]
+  # +data+::	the image pixel data [String]
+  # +transp+::	transparency color [FXColor]
+  # +width+::	width [Integer]
+  # +height+::	height [Integer]
+  #
+  def Fox.fxsavePNG(store, data, transp, width, height); end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a PNG image.
+  #
+  def Fox.fxcheckPNG(store); end
+end
+

data/rdoc-sources/FXPNGImage.rb

@@ -0,0 +1,34 @@
+module Fox
+  #
+  # Portable Network Graphics (PNG) Image
+  #
+  class FXPNGImage < FXImage
+    #
+    # Return the suggested file extension for this image type ("png").
+    #
+    def FXPNGImage.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPNGImage.mimeType; end
+
+    # Return +true+ if PNG image file format is supported.
+    def FXPNGImage.supported? ; end
+
+    #
+    # Return an initialized FXPNGImage instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in PNG file format [String]
+    # +opts+::	options [Integer]
+    # +width+::	width [Integer]
+    # +height+::	height [Integer]
+    #
+    def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: thePNGImage
+    end
+  end
+end
+

data/rdoc-sources/FXPPMIcon.rb

@@ -0,0 +1,36 @@
+module Fox
+  #
+  # Portable Pixmap (PPM) icon class.
+  #
+  class FXPPMIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("ppm").
+    #
+    def FXPPMIcon.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPPMIcon.mimeType; end
+
+    #
+    # Return an initialized FXPPMIcon instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in PPM file format [String]
+    # +clr+::	transparency color [FXColor]
+    # +opts+::	options [Integer]
+    # +width+::	width [Integer]
+    # +height+::	height [Integer]
+    #
+    def initialize(a, pix=nil, clr=0, opts=0, width=1, height=1) # :yields: thePPMIcon
+    end
+  end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a PPM image.
+  #
+  def Fox.fxcheckPPM(store); end
+end

data/rdoc-sources/FXPPMImage.rb

@@ -0,0 +1,31 @@
+module Fox
+  #
+  # Portable Pixmap (PPM) Image
+  #
+  class FXPPMImage < FXImage
+    #
+    # Return the suggested file extension for this image type ("ppm").
+    #
+    def FXPPMImage.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPNGImage.mimeType; end
+
+    #
+    # Return an initialized FXPPMImage instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in PPM file format [String]
+    # +opts+::	options [Integer]
+    # +width+::	width [Integer]
+    # +height+::	height [Integer]
+    #
+    def initialize(a, pix=nil, opts=0, width=1, height=1) # :yields: thePPMImage
+    end
+  end
+end
+

data/rdoc-sources/FXPacker.rb

@@ -0,0 +1,63 @@
+module Fox
+  #
+  # FXPacker is a layout manager which automatically places child windows
+  # inside its area against the left, right, top, or bottom side.
+  # Each time a child is placed, the remaining space is decreased by the
+  # amount of space taken by the child window.
+  # The side against which a child is placed is determined by the +LAYOUT_SIDE_TOP+,
+  # +LAYOUT_SIDE_BOTTOM+, +LAYOUT_SIDE_LEFT+, and +LAYOUT_SIDE_RIGHT+ hints given by
+  # the child window.  Other layout hints from the child are observed as far as
+  # sensible.  So for example, a child placed against the right edge can still
+  # have +LAYOUT_FILL_Y+ or +LAYOUT_TOP+, and so on.
+  # The last child may have both +LAYOUT_FILL_X+ and +LAYOUT_FILL_Y+, in which
+  # case it will be placed to take all remaining space.
+  #
+  class FXPacker < FXComposite
+  
+    # Current frame style [Integer]
+    attr_accessor :frameStyle
+    
+    # Packing hints [Integer]
+    attr_accessor :packingHints
+    
+    # Border width, in pixels [Integer]
+    attr_reader :borderWidth
+    
+    # Top padding, in pixels [Integer]
+    attr_accessor :padTop
+    
+    # Bottom padding, in pixels [Integer]
+    attr_accessor :padBottom
+    
+    # Left padding, in pixels [Integer]
+    attr_accessor :padLeft
+    
+    # Right padding, in pixels [Integer]
+    attr_accessor :padRight
+    
+    # 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
+    
+    # Horizontal inter-child spacing, in pixels [Integer]
+    attr_accessor :hSpacing
+    
+    # Vertical inter-child spacing, in pixels [Integer]
+    attr_accessor :vSpacing
+
+    #
+    # Construct a packer layout manager
+    #
+    def initialize(parent, opts=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: thePacker
+    end
+  end
+end
+

data/rdoc-sources/FXPicker.rb

@@ -0,0 +1,27 @@
+module Fox
+  #
+  # A picker button allows you to identify an arbitrary
+  # location on the screen.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXPicker to its target:
+  #
+  # +SEL_CHANGED+::
+  #   sent continuously while the position is changing; the message data is an
+  #   FXPoint instance indicating the current root window position of the mouse
+  #   pointer.
+  # +SEL_COMMAND+::
+  #   sent when the left mouse button is clicked the second time (i.e. to
+  #   "pick" a position); the message data is an FXPoint instance indicating
+  #   the picked position in root window coordinates.
+  #
+  class FXPicker < FXButton
+    #
+    # Constructor
+    #
+    def initialize(p, text, ic=nil, target=nil, selector=0, opts=BUTTON_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: thePicker
+    end
+  end
+end
+

data/rdoc-sources/FXPopup.rb

@@ -0,0 +1,53 @@
+module Fox
+  #
+  # Popup window
+  #
+  # === Popup internal orientation
+  #
+  # +POPUP_VERTICAL+::          Vertical orientation
+  # +POPUP_HORIZONTAL+::        Horizontal orientation
+  # +POPUP_SHRINKWRAP+::        Shrinkwrap to content
+  #
+  class FXPopup < FXShell
+  
+    # 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 color [FXColor]
+    attr_accessor :baseColor
+    
+    # Current grab owner [FXWindow]
+    attr_reader :grabOwner
+    
+    # Popup orientation [Integer]
+    attr_accessor :orientation
+    
+    # Shrinkwrap mode [Boolean]
+    attr_accessor :shrinkWrap
+    
+    #
+    # Construct popup pane
+    #
+    def initialize(owner, opts=POPUP_VERTICAL|FRAME_RAISED|FRAME_THICK, x=0, y=0, width=0, height=0) # :yields: thePopup
+    end
+  
+    # Pop it up
+    def popup(grabto, x, y, width=0, height=0); end
+    
+    # Pop it down
+    def popdown(); end
+  end
+end
+

data/rdoc-sources/FXPrintDialog.rb

@@ -0,0 +1,36 @@
+module Fox
+  #
+  # Printer selection dialog
+  #
+  # == Message identifiers
+  #
+  # +ID_TO_PRINTER+::		x
+  # +ID_TO_FILE+::		x
+  # +ID_PRINTER_NAME+::		x
+  # +ID_FILE_NAME+::		x
+  # +ID_LANDSCAPE+::		x
+  # +ID_PORTRAIT+::		x
+  # +ID_MEDIA+::		x
+  # +ID_COLLATE_NORMAL+::	x
+  # +ID_COLLATE_REVERSED+::	x
+  # +ID_PAGES_ALL+::		x
+  # +ID_PAGES_EVEN+::		x
+  # +ID_PAGES_ODD+::		x
+  # +ID_PAGES_RANGE+::		x
+  # +ID_PAGES_FIRST+::		x
+  # +ID_PAGES_LAST+::		x
+  # +ID_BROWSE_FILE+::		x
+  # +ID_PROPERTIES+::		x
+  # +ID_COLOR_PRINTER+::	x
+  # +ID_GRAY_PRINTER+::		x
+  # +ID_NUM_COPIES+::		x
+  #
+  class FXPrintDialog < FXDialogBox
+    # Printer information [FXPrinter]
+    attr_accessor :printer
+
+    # Construct print dialog
+    def initialize(owner, name, opts=0, x=0, y=0, width=0, height=0) # :yields: thePrintDialog
+    end
+  end
+end