fxruby 1.2.2

data/rdoc-sources/FXId.rb

@@ -0,0 +1,34 @@
+module Fox
+  #
+  # Encapsulates a server side resource.
+  #
+  class FXId < FXObject
+
+    # Application [FXApp]
+    attr_reader :app
+
+    # User data [Object]  
+    attr_accessor :userData
+
+    # XID handle for the server-side resource [Integer]
+    attr_reader :xid
+
+    #
+    # Create resource.
+    #
+    def create(); end
+
+    # Returns true if this resource has been created.
+    def created?; end
+
+    #
+    # Detach resource.
+    #
+    def detach(); end
+
+    #
+    # Destroy resource.
+    #
+    def destroy(); end
+  end
+end

data/rdoc-sources/FXImage.rb

@@ -0,0 +1,198 @@
+module Fox
+  #
+  # An Image is a rectangular array of pixels.  It supports two representations
+  # of these pixels: a client-side pixel buffer which is stored as an array of
+  # FXColor, and a server-side pixmap which is stored in an organization directly
+  # compatible with the screen, for fast drawing onto the device.
+  # The server-side representation is not directly accessible from the current
+  # process as it lives in the process of the X Server or GDI.
+  #
+  # === Image rendering hints
+  #
+  # +IMAGE_KEEP+::
+  #   Keep pixel data in client. By default, FOX discards of the client-side
+  #   pixel data for an image after you call create() for that image. When the
+  #   +IMAGE_KEEP+ option is set for FXImage (or one of its subclasses), the
+  #   client-side buffer is maintained. You will typically want to set this option
+  #   if you intend to do repeated re-rendering of the image after it has been
+  #   created.
+  # +IMAGE_OWNED+::
+  #   If the +IMAGE_OWNED+ option is set, the FXImage object assumes ownership
+  #   of its client-side pixel data (if any).
+  # +IMAGE_DITHER+::
+  #   Dither image to look better
+  # +IMAGE_NEAREST+::
+  #   Turn off dithering and map to nearest color
+  # +IMAGE_ALPHA+::
+  #   Data has alpha channel
+  # +IMAGE_OPAQUE+::
+  #   Force opaque background
+  # +IMAGE_ALPHACOLOR+::
+  #   By default, FOX will use the transparency color obtained from the image
+  #   file as the transparency (alpha) color. If you pass the +IMAGE_ALPHACOLOR+
+  #   flag, the user-specified transparency color will be used instead.
+  # +IMAGE_SHMI+::
+  #   Using shared memory image
+  # +IMAGE_SHMP+::
+  #   Using shared memory pixmap
+  # +IMAGE_ALPHAGUESS+::
+  #   Guess transparency color from corners
+  #
+
+  class FXImage < FXDrawable
+
+    # Pixel data [FXMemoryBuffer]
+    attr_reader	:data
+    
+    # Option flags [Integer]
+    attr_accessor :options
+    
+    #
+    # Create an image.  If a client-side pixel buffer has been specified,
+    # the image does not own the pixel buffer unless the +IMAGE_OWNED+ flag is
+    # set.  If the +IMAGE_OWNED+ flag is set but a +nil+ pixel buffer is
+    # passed, a pixel buffer will be automatically created and will be owned
+    # by the image. The flags +IMAGE_SHMI+ and +IMAGE_SHMP+ may be specified for
+    # large images to instruct #render to use shared memory to communicate
+    # with the server.
+    #
+    #
+    # ==== Parameters:
+    #
+    # +a+::		an application instance [FXApp]
+    # +pixels+::	pixels [String or FXMemoryBuffer]
+    # +opts+::		image options [Integer]
+    # +w+::		image width [Integer]
+    # +h+::		image height [Integer]
+    #
+    def initialize(a, pixels=nil, opts=0, w=1, h=1) # :yields: theImage
+    end
+
+    #
+    # Return the color of the pixel at (_x_, _y_).
+    #
+    # ==== Parameters:
+    #
+    # +x+::	x-coordinate of the pixel of interest [Integer]
+    # +y+::	y-coordinate of the pixel of interest [Integer]
+    #
+    def getPixel(x, y) ; end
+
+    #
+    # Set pixel at (_x_, _y_) to _clr_.
+    #
+    # ==== Parameters:
+    #
+    # +x+::	x-coordinate of the pixel of interest [Integer]
+    # +y+::	y-coordinate of the pixel of interest [Integer]
+    # +clr+::	new color value for this pixel [FXColor]
+    #
+    def setPixel(x, y, clr) ; end
+    
+    # Scan the image and return +false+ if it's fully opaque.
+    def hasAlpha?; end
+
+    #
+    # Restore client-side pixel buffer from image.
+    #
+    def restore() ; end
+
+    #
+    # Render the image from client-side pixel buffer.
+    #
+    def render() ; end
+  
+    #
+    # Release the client-side pixels buffer, free it if it was owned.
+    # If it is not owned, the image just forgets about the buffer.
+    #
+    def release(); end
+
+    #
+    # Rescale pixels image to the specified width and height. Note that this
+    # serves a slightly different purpose than the base class resize() method,
+    # which simply resizes the client-side pixel data buffer but doesn't
+    # transform the image.
+    #
+    # The optional third argument specifies the _quality_ of the scaling algorithm
+    # used. By default, #scale uses a fast (but low quality) nearest-neighbor algorithm
+    # for scaling the image to its new size. To use the higher-quality scaling algorithm
+    # from FOX 1.0, you should pass in a value of 1 as the third argument to #scale.
+    #
+    # ==== Parameters:
+    #
+    # +w+::		new image width, in pixels [Integer]
+    # +h+::		new image height, in pixels [Integer]
+    # +quality+::	scaling algorithm quality, either 0 or 1 (see above) [Integer]
+    #
+    def scale(w, h, quality=0) ; end
+  
+    #
+    # Mirror image horizontally and/or vertically.
+    #
+    # ==== Parameters:
+    #
+    # +horizontal+::	if +true+, the image will be flipped from left to right [Boolean]
+    # +vertical+::	if +true+, the image will be flipped from top to bottom [Boolean]
+    #
+    def mirror(horizontal, vertical) ; end
+  
+    #
+    # Rotate image counter-clockwise by some number of degrees.
+    #
+    # ==== Parameters:
+    #
+    # +degrees+::	number of degrees by which to rotate the image [Integer]
+    #
+    def rotate(degrees) ; end
+  
+    #
+    # Crop image to given rectangle
+    #
+    # ==== Parameters:
+    #
+    # +x+::	x-coordinate for top left corner of the clip rectangle [Integer]
+    # +y+::	y-coordinate for top left corner of the clip rectangle [Integer]
+    # +w+::	width of the clip rectangle [Integer]
+    # +h+::	height of the clip rectangle [Integer]
+    #
+    def crop(x, y, w, h) ; end
+  
+    #
+    # Save pixel data to a stream.
+    #
+    # Note that the base class version of
+    # #savePixels saves the pixel data as-is, without any image format
+    # specific information. For example, if you have a 1024x768 image
+    # without an alpha channel (and thus only the red, green and blue
+    # channels) the total number of bytes written to the stream will be
+    # 1024*768*3*8. The behavior of #savePixels is different for subclasses
+    # such as FXPNGImage, where #savePixels will instead save the image
+    # data in a specific image file format (i.e. the PNG file format).
+    #
+    # ==== Parameters:
+    #
+    # +store+::	opened stream to which to save the pixel data [FXStream]
+    #
+    def savePixels(store) ; end
+  
+    #
+    # Load pixel data from a stream.
+    #
+    # Note that the base class version of
+    # #loadPixels expects to read the the pixel data in a neutral format
+    # (i.e. without any image format specific information). For example, if
+    # you have a 1024x768 image without an alpha channel (and thus only the
+    # red, green and blue channels), #loadPixels will attempt to read a total
+    # of 1024*768*3*8 bytes from the stream. The behavior of #loadPixels is
+    # different for subclasses such as FXPNGImage, where #loadPixels will instead
+    # expects to read the image data in a specific image file format (i.e. the
+    # PNG file format).
+    #
+    # ==== Parameters:
+    #
+    # +store+::	opened stream from which to read the pixel data [FXStream]
+    #
+    def loadPixels(store) ; end
+  end
+end

data/rdoc-sources/FXImageFrame.rb

@@ -0,0 +1,22 @@
+module Fox
+  #
+  # An FXImageFrame is a simple frame widget that displays an FXImage image.
+  #
+  class FXImageFrame < FXFrame
+  
+    # The current image being displayed [FXImage]
+    attr_accessor :image
+    
+    #
+    # The current justification mode, some combination of the flags
+    # +JUSTIFY_LEFT+, +JUSTIFY_RIGHT+, +JUSTIFY_TOP+ and +JUSTIFY_BOTTOM+ [Integer]
+    #
+    attr_accessor :justify
+    
+    #
+    # Return an initialized FXImageFrame instance.
+    #
+    def initialize(p, img, opts=FRAME_SUNKEN|FRAME_THICK, x=0, y=0, w=0, h=0, pl=0, pr=0, pt=0, pb=0) # :yields: theImageFrame
+    end
+  end
+end

data/rdoc-sources/FXImageView.rb

@@ -0,0 +1,35 @@
+module Fox
+  #
+  # The FXImageView widget displays a scrollable view of an image.
+  #
+  # === Image alignment styles
+  #
+  # +IMAGEVIEW_NORMAL+::	Normal mode is centered
+  # +IMAGEVIEW_CENTER_X+::	Centered horizontally
+  # +IMAGEVIEW_LEFT+::		Left-aligned
+  # +IMAGEVIEW_RIGHT+::		Right-aligned
+  # +IMAGEVIEW_CENTER_Y+::	Centered vertically
+  # +IMAGEVIEW_TOP+::		Top-aligned
+  # +IMAGEVIEW_BOTTOM+::	Bottom-aligned
+  #
+  # === Events
+  #
+  # +SEL_RIGHTBUTTONPRESS+::	sent when the right mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_RIGHTBUTTONRELEASE+::	sent when the right mouse button goes up; the message data is an FXEvent instance.
+  #
+  class FXImageView < FXScrollArea
+  
+    # The image [FXImage]
+    attr_accessor :image
+    
+    # Current alignment [Integer]
+    attr_accessor :alignment
+
+    #
+    # Return an initialized FXImageView instance.
+    #
+    def initialize(p, img=nil, tgt=nil, sel=0, opts=0, x=0, y=0, w=0, h=0) # :yields: theImageView
+    end
+  end
+end
+

data/rdoc-sources/FXInputDialog.rb

@@ -0,0 +1,62 @@
+module Fox
+  #
+  # An FXInputDialog is a simple dialog which is used
+  # to obtain a text string, integer, or real number from the user.
+  # A "password" mode allows the key-in to remain hidden.
+  #
+  # === Input dialog options
+  #
+  # +INPUTDIALOG_STRING+::	Ask for a string
+  # +INPUTDIALOG_INTEGER+::	Ask for an integer number
+  # +INPUTDIALOG_REAL+::	Ask for a real number
+  # +INPUTDIALOG_PASSWORD+::	Do not reveal key-in
+  #
+  class FXInputDialog < FXDialogBox
+
+    # Input string [String]
+    attr_accessor :text
+
+    # Number of visible columns of text [Integer]
+    attr_accessor :numColumns
+
+    #
+    # Construct input dialog box with given caption, icon, and prompt text.
+    #
+    def initialize(owner, caption, label, ic=nil, opts=INPUTDIALOG_STRING, x=0, y=0, w=0, h=0) # :yields: theInputDialog
+    end
+  
+    #
+    # Change limits (where _lo_ and _hi_ are numbers).
+    #
+    def setLimits(lo, hi); end
+  
+    #
+    # Return limits (a two-element array of floats).
+    #
+    def getLimits(); end
+
+    #
+    # Prompt the user for a string, with the text field initialized
+    # to the specified _initial_ value. Return the input value if the
+    # user clicks *OK*, else return +nil+.
+    #
+    def FXInputDialog.getString(initial, owner, caption, label, ic=nil); end
+  
+    #
+    # Prompt the user for an integer number, starting from the specified _initial_ value.
+    # Return the input value if the user clicks *OK*, else return +nil+.
+    # The input is constrained between _lo_ and _hi_, unless _lo_ > _hi_, in which
+    # case the input can be any number.
+    #
+    def FXInputDialog.getInteger(initial, owner, caption, label, ic=nil, lo=1, hi=0); end
+  
+    #
+    # Prompt the user for a real number, starting from the specified _initial_ value.
+    # Return the input value if the user clicks *OK*, else return +nil+.
+    # The input is constrained between _lo_ and _hi_, unless _lo_ > _hi_, in which
+    # case the input can be any number.
+    #
+    def FXInputDialog.getReal(initial, owner, caption, label, ic=nil, lo=1.0, hi=0.0); end
+  end
+end
+

data/rdoc-sources/FXJPGIcon.rb

@@ -0,0 +1,52 @@
+module Fox
+  #
+  # JPEG icon class
+  #
+  class FXJPGIcon < FXIcon
+  
+    # Image quality setting [Integer]
+    attr_accessor :quality
+
+    #
+    # Return an initialized FXJPGIcon instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in JPEG file format [String]
+    # +clr+::	transparency color [FXColor]
+    # +opts+::	options [Integer]
+    # +w+::	width [Integer]
+    # +h+::	height [Integer]
+    #
+    def initialize(a, pix=nil, clr=0, opts=0, w=1, h=1) # :yields: theJPGIcon
+    end
+  end
+  #
+  # Load a JPEG file from a stream.
+  # If successful, returns an array containing the image pixel data (as a
+  # String), transparency color, image width, image height and quality.
+  # If it fails, the function returns +nil+.
+  #
+  # ==== Parameters:
+  #
+  # +store+::	stream from which to read the file data [FXStream]
+  #
+  def Fox.fxloadJPG(store); end
+  
+  #
+  # Save a JPEG 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]
+  # +quality+::	image quality [Integer]
+  #
+  def Fox.fxsaveJPG(store, data, transp, width, height, quality); end
+end
+

data/rdoc-sources/FXJPGImage.rb

@@ -0,0 +1,25 @@
+module Fox
+  #
+  # JPEG Image class
+  #
+  class FXJPGImage < FXImage
+  
+    # Image quality
+    attr_accessor :quality
+
+    #
+    # Return an initialized FXJPGImage instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in JPEG file format [String]
+    # +opts+::	options [Integer]
+    # +w+::	width [Integer]
+    # +h+::	height [Integer]
+    #
+    def initialize(a, pix=nil, opts=0, w=1, h=1) # :yields: theJPGImage
+    end
+  end
+end
+

data/rdoc-sources/FXLabel.rb

@@ -0,0 +1,66 @@
+module Fox
+  #
+  # A label widget can be used to place a text and/or icon for
+  # explanation purposes. The text label may have an optional tooltip
+  # and/or help string.
+  #
+  # === Justification modes
+  #
+  # +JUSTIFY_NORMAL+::      Default justification is centered text
+  # +JUSTIFY_CENTER_X+::    Text is centered horizontally
+  # +JUSTIFY_LEFT+::        Text is left-justified
+  # +JUSTIFY_RIGHT+::       Text is right-justified
+  # +JUSTIFY_HZ_APART+::    Combination of +JUSTIFY_LEFT+ & +JUSTIFY_RIGHT+
+  # +JUSTIFY_CENTER_Y+::    Text is centered vertically
+  # +JUSTIFY_TOP+::         Text is aligned with label top
+  # +JUSTIFY_BOTTOM+::      Text is aligned with label bottom
+  # +JUSTIFY_VT_APART+::    Combination of +JUSTIFY_TOP+ & +JUSTIFY_BOTTOM+
+  #
+  # === Relationship options for icon-labels
+  #
+  # +ICON_UNDER_TEXT+::    Icon appears under text
+  # +ICON_AFTER_TEXT+::    Icon appears after text (to its right)
+  # +ICON_BEFORE_TEXT+::   Icon appears before text (to its left)
+  # +ICON_ABOVE_TEXT+::    Icon appears above text
+  # +ICON_BELOW_TEXT+::    Icon appears below text
+  # +TEXT_OVER_ICON+::     Same as +ICON_UNDER_TEXT+
+  # +TEXT_AFTER_ICON+::    Same as +ICON_BEFORE_TEXT+
+  # +TEXT_BEFORE_ICON+::   Same as +ICON_AFTER_TEXT+
+  # +TEXT_ABOVE_ICON+::    Same as +ICON_BELOW_TEXT+
+  # +TEXT_BELOW_ICON+::    Same as +ICON_ABOVE_TEXT+
+  #
+  # === Normal way to show label
+  #
+  # +LABEL_NORMAL+::        Same as <tt>JUSTIFY_NORMAL|ICON_BEFORE_TEXT</tt>
+  #
+  class FXLabel < FXFrame
+
+    # The text for this label [String]
+    attr_accessor :text
+    
+    # The icon for this label [FXIcon]
+    attr_accessor :icon
+    
+    # The text font [FXFont]
+    attr_accessor :font
+    
+    # The text color [FXColor]
+    attr_accessor :textColor
+    
+    # Text justification mode [Integer]
+    attr_accessor :justify
+    
+    # Icon position [Integer]
+    attr_accessor :iconPosition
+    
+    # Status line help text [String]
+    attr_accessor :helpText
+    
+    # Tool tip message [String]
+    attr_accessor :tipText
+
+    # Construct label with given text and icon
+    def initialize(parent, text, icon=nil, opts=LABEL_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theLabel
+    end
+  end
+end