Module Fox
In: rdoc-sources/FX4Splitter.rb
rdoc-sources/FX7Segment.rb
rdoc-sources/FXAccelTable.rb
rdoc-sources/FXApp.rb
rdoc-sources/FXArrowButton.rb
rdoc-sources/FXBitmap.rb
rdoc-sources/FXBitmapFrame.rb
rdoc-sources/FXBitmapView.rb
rdoc-sources/FXBMPIcon.rb
rdoc-sources/FXBMPImage.rb
rdoc-sources/FXButton.rb
rdoc-sources/FXCanvas.rb
rdoc-sources/FXCheckButton.rb
rdoc-sources/FXChoiceBox.rb
rdoc-sources/FXColorBar.rb
rdoc-sources/FXColorDialog.rb
rdoc-sources/FXColorList.rb
rdoc-sources/FXColorRing.rb
rdoc-sources/FXColorSelector.rb
rdoc-sources/FXColorWell.rb
rdoc-sources/FXColorWheel.rb
rdoc-sources/FXComboBox.rb
rdoc-sources/FXComposite.rb
rdoc-sources/FXCURCursor.rb
rdoc-sources/FXCursor.rb
rdoc-sources/FXDataTarget.rb
rdoc-sources/FXDC.rb
rdoc-sources/FXDCPrint.rb
rdoc-sources/FXDCWindow.rb
rdoc-sources/FXDebugTarget.rb
rdoc-sources/fxdefs.rb
rdoc-sources/FXDelegator.rb
rdoc-sources/FXDial.rb
rdoc-sources/FXDialogBox.rb
rdoc-sources/FXDict.rb
rdoc-sources/FXDirBox.rb
rdoc-sources/FXDirDialog.rb
rdoc-sources/FXDirList.rb
rdoc-sources/FXDirSelector.rb
rdoc-sources/FXDockBar.rb
rdoc-sources/FXDockHandler.rb
rdoc-sources/FXDockSite.rb
rdoc-sources/FXDockTitle.rb
rdoc-sources/FXDocument.rb
rdoc-sources/FXDragCorner.rb
rdoc-sources/FXDrawable.rb
rdoc-sources/FXDriveBox.rb
rdoc-sources/FXExtentd.rb
rdoc-sources/FXExtentf.rb
rdoc-sources/FXFileDialog.rb
rdoc-sources/FXFileDict.rb
rdoc-sources/FXFileList.rb
rdoc-sources/FXFileSelector.rb
rdoc-sources/FXFileStream.rb
rdoc-sources/FXFoldingList.rb
rdoc-sources/FXFont.rb
rdoc-sources/FXFontDialog.rb
rdoc-sources/FXFontSelector.rb
rdoc-sources/FXFrame.rb
rdoc-sources/FXGIFCursor.rb
rdoc-sources/FXGIFIcon.rb
rdoc-sources/FXGIFImage.rb
rdoc-sources/FXGLCanvas.rb
rdoc-sources/FXGLContext.rb
rdoc-sources/FXGLObject.rb
rdoc-sources/FXGLShape.rb
rdoc-sources/FXGLViewer.rb
rdoc-sources/FXGLVisual.rb
rdoc-sources/FXGradientBar.rb
rdoc-sources/FXGroupBox.rb
rdoc-sources/FXHeader.rb
rdoc-sources/FXHorizontalFrame.rb
rdoc-sources/FXICOIcon.rb
rdoc-sources/FXICOImage.rb
rdoc-sources/FXIcon.rb
rdoc-sources/FXIconDict.rb
rdoc-sources/FXIconList.rb
rdoc-sources/FXIconSource.rb
rdoc-sources/FXId.rb
rdoc-sources/FXImage.rb
rdoc-sources/FXImageFrame.rb
rdoc-sources/FXImageView.rb
rdoc-sources/FXInputDialog.rb
rdoc-sources/FXJPGIcon.rb
rdoc-sources/FXJPGImage.rb
rdoc-sources/FXKnob.rb
rdoc-sources/FXLabel.rb
rdoc-sources/FXList.rb
rdoc-sources/FXListBox.rb
rdoc-sources/FXMainWindow.rb
rdoc-sources/FXMatrix.rb
rdoc-sources/FXMDIButton.rb
rdoc-sources/FXMDIChild.rb
rdoc-sources/FXMDIClient.rb
rdoc-sources/FXMemoryBuffer.rb
rdoc-sources/FXMemoryStream.rb
rdoc-sources/FXMenuBar.rb
rdoc-sources/FXMenuButton.rb
rdoc-sources/FXMenuCaption.rb
rdoc-sources/FXMenuCascade.rb
rdoc-sources/FXMenuCheck.rb
rdoc-sources/FXMenuCommand.rb
rdoc-sources/FXMenuPane.rb
rdoc-sources/FXMenuRadio.rb
rdoc-sources/FXMenuSeparator.rb
rdoc-sources/FXMenuTitle.rb
rdoc-sources/FXMessageBox.rb
rdoc-sources/FXObject.rb
rdoc-sources/FXOptionMenu.rb
rdoc-sources/FXPacker.rb
rdoc-sources/FXPCXIcon.rb
rdoc-sources/FXPCXImage.rb
rdoc-sources/FXPicker.rb
rdoc-sources/FXPNGIcon.rb
rdoc-sources/FXPNGImage.rb
rdoc-sources/FXPopup.rb
rdoc-sources/FXPPMIcon.rb
rdoc-sources/FXPPMImage.rb
rdoc-sources/FXPrintDialog.rb
rdoc-sources/FXProgressBar.rb
rdoc-sources/FXProgressDialog.rb
rdoc-sources/FXQuatd.rb
rdoc-sources/FXQuatf.rb
rdoc-sources/FXRadioButton.rb
rdoc-sources/FXRanged.rb
rdoc-sources/FXRangef.rb
rdoc-sources/FXRealSlider.rb
rdoc-sources/FXRealSpinner.rb
rdoc-sources/FXRecentFiles.rb
rdoc-sources/FXRectangle.rb
rdoc-sources/FXRegion.rb
rdoc-sources/FXRegistry.rb
rdoc-sources/FXReplaceDialog.rb
rdoc-sources/FXRGBIcon.rb
rdoc-sources/FXRGBImage.rb
rdoc-sources/FXRootWindow.rb
rdoc-sources/FXRuler.rb
rdoc-sources/FXRulerView.rb
rdoc-sources/FXScintilla.rb
rdoc-sources/FXScrollArea.rb
rdoc-sources/FXScrollBar.rb
rdoc-sources/FXScrollPane.rb
rdoc-sources/FXScrollWindow.rb
rdoc-sources/FXSearchDialog.rb
rdoc-sources/FXSeparator.rb
rdoc-sources/FXSettings.rb
rdoc-sources/FXShell.rb
rdoc-sources/FXShutter.rb
rdoc-sources/FXSize.rb
rdoc-sources/FXSlider.rb
rdoc-sources/FXSphered.rb
rdoc-sources/FXSpheref.rb
rdoc-sources/FXSpinner.rb
rdoc-sources/FXSplashWindow.rb
rdoc-sources/FXSplitter.rb
rdoc-sources/FXSpring.rb
rdoc-sources/FXStatusBar.rb
rdoc-sources/FXStatusLine.rb
rdoc-sources/FXStream.rb
rdoc-sources/FXStringDict.rb
rdoc-sources/FXSwitcher.rb
rdoc-sources/FXTabBar.rb
rdoc-sources/FXTabBook.rb
rdoc-sources/FXTabItem.rb
rdoc-sources/FXTable.rb
rdoc-sources/FXText.rb
rdoc-sources/FXTextField.rb
rdoc-sources/FXTGAIcon.rb
rdoc-sources/FXTGAImage.rb
rdoc-sources/FXTIFIcon.rb
rdoc-sources/FXTIFImage.rb
rdoc-sources/FXToggleButton.rb
rdoc-sources/FXToolBar.rb
rdoc-sources/FXToolBarGrip.rb
rdoc-sources/FXToolBarShell.rb
rdoc-sources/FXToolBarTab.rb
rdoc-sources/FXToolTip.rb
rdoc-sources/FXTopWindow.rb
rdoc-sources/FXTranslator.rb
rdoc-sources/FXTreeList.rb
rdoc-sources/FXTreeListBox.rb
rdoc-sources/FXTriStateButton.rb
rdoc-sources/FXVec2d.rb
rdoc-sources/FXVec2f.rb
rdoc-sources/FXVec3d.rb
rdoc-sources/FXVec3f.rb
rdoc-sources/FXVec4d.rb
rdoc-sources/FXVec4f.rb
rdoc-sources/FXVerticalFrame.rb
rdoc-sources/FXVisual.rb
rdoc-sources/FXWindow.rb
rdoc-sources/FXWizard.rb
rdoc-sources/FXXBMIcon.rb
rdoc-sources/FXXBMImage.rb
rdoc-sources/FXXPMIcon.rb
rdoc-sources/FXXPMImage.rb

Methods

Classes and Modules

Class Fox::FX4Splitter
Class Fox::FX7Segment
Class Fox::FXAccelTable
Class Fox::FXApp
Class Fox::FXArc
Class Fox::FXArrowButton
Class Fox::FXBMPIcon
Class Fox::FXBMPImage
Class Fox::FXBitmap
Class Fox::FXBitmapFrame
Class Fox::FXBitmapView
Class Fox::FXButton
Class Fox::FXCURCursor
Class Fox::FXCanvas
Class Fox::FXCheckButton
Class Fox::FXChoiceBox
Class Fox::FXColorBar
Class Fox::FXColorDialog
Class Fox::FXColorItem
Class Fox::FXColorList
Class Fox::FXColorRing
Class Fox::FXColorSelector
Class Fox::FXColorWell
Class Fox::FXColorWheel
Class Fox::FXComboBox
Class Fox::FXComposite
Class Fox::FXCursor
Class Fox::FXDC
Class Fox::FXDCPrint
Class Fox::FXDCWindow
Class Fox::FXDataTarget
Class Fox::FXDebugTarget
Class Fox::FXDelegator
Class Fox::FXDial
Class Fox::FXDialogBox
Class Fox::FXDict
Class Fox::FXDirBox
Class Fox::FXDirDialog
Class Fox::FXDirItem
Class Fox::FXDirList
Class Fox::FXDirSelector
Class Fox::FXDockBar
Class Fox::FXDockHandler
Class Fox::FXDockSite
Class Fox::FXDockTitle
Class Fox::FXDocument
Class Fox::FXDragCorner
Class Fox::FXDrawable
Class Fox::FXDriveBox
Class Fox::FXEvent
Class Fox::FXExtentd
Class Fox::FXExtentf
Class Fox::FXFileAssoc
Class Fox::FXFileDialog
Class Fox::FXFileDict
Class Fox::FXFileItem
Class Fox::FXFileList
Class Fox::FXFileSelector
Class Fox::FXFileStream
Class Fox::FXFoldingItem
Class Fox::FXFoldingList
Class Fox::FXFont
Class Fox::FXFontDesc
Class Fox::FXFontDialog
Class Fox::FXFontSelector
Class Fox::FXFrame
Class Fox::FXGIFCursor
Class Fox::FXGIFIcon
Class Fox::FXGIFImage
Class Fox::FXGLCanvas
Class Fox::FXGLContext
Class Fox::FXGLObject
Class Fox::FXGLShape
Class Fox::FXGLViewer
Class Fox::FXGLVisual
Class Fox::FXGradient
Class Fox::FXGradientBar
Class Fox::FXGroupBox
Class Fox::FXHeader
Class Fox::FXHeaderItem
Class Fox::FXHiliteStyle
Class Fox::FXHorizontalFrame
Class Fox::FXHorizontalSeparator
Class Fox::FXICOIcon
Class Fox::FXICOImage
Class Fox::FXIcon
Class Fox::FXIconDict
Class Fox::FXIconItem
Class Fox::FXIconList
Class Fox::FXIconSource
Class Fox::FXId
Class Fox::FXImage
Class Fox::FXImageFrame
Class Fox::FXImageView
Class Fox::FXInputDialog
Class Fox::FXJPGIcon
Class Fox::FXJPGImage
Class Fox::FXKnob
Class Fox::FXLabel
Class Fox::FXLight
Class Fox::FXList
Class Fox::FXListBox
Class Fox::FXListItem
Class Fox::FXMDIChild
Class Fox::FXMDIClient
Class Fox::FXMDIDeleteButton
Class Fox::FXMDIMaximizeButton
Class Fox::FXMDIMenu
Class Fox::FXMDIMinimizeButton
Class Fox::FXMDIRestoreButton
Class Fox::FXMDIWindowButton
Class Fox::FXMainWindow
Class Fox::FXMaterial
Class Fox::FXMatrix
Class Fox::FXMemoryBuffer
Class Fox::FXMemoryStream
Class Fox::FXMenuBar
Class Fox::FXMenuButton
Class Fox::FXMenuCaption
Class Fox::FXMenuCascade
Class Fox::FXMenuCheck
Class Fox::FXMenuCommand
Class Fox::FXMenuPane
Class Fox::FXMenuRadio
Class Fox::FXMenuSeparator
Class Fox::FXMenuTitle
Class Fox::FXMessageBox
Class Fox::FXObject
Class Fox::FXOption
Class Fox::FXOptionMenu
Class Fox::FXPCXIcon
Class Fox::FXPCXImage
Class Fox::FXPNGIcon
Class Fox::FXPNGImage
Class Fox::FXPPMIcon
Class Fox::FXPPMImage
Class Fox::FXPSBounds
Class Fox::FXPacker
Class Fox::FXPicker
Class Fox::FXPopup
Class Fox::FXPrintDialog
Class Fox::FXPrinter
Class Fox::FXProgressBar
Class Fox::FXProgressDialog
Class Fox::FXQuatd
Class Fox::FXQuatf
Class Fox::FXRGBIcon
Class Fox::FXRGBImage
Class Fox::FXRadioButton
Class Fox::FXRanged
Class Fox::FXRangef
Class Fox::FXRealSlider
Class Fox::FXRealSpinner
Class Fox::FXRecentFiles
Class Fox::FXRectangle
Class Fox::FXRegion
Class Fox::FXRegistry
Class Fox::FXReplaceDialog
Class Fox::FXRootWindow
Class Fox::FXRuler
Class Fox::FXRulerView
Class Fox::FXScintilla
Class Fox::FXScrollArea
Class Fox::FXScrollBar
Class Fox::FXScrollCorner
Class Fox::FXScrollPane
Class Fox::FXScrollWindow
Class Fox::FXSearchDialog
Class Fox::FXSegment
Class Fox::FXSeparator
Class Fox::FXSettings
Class Fox::FXShell
Class Fox::FXShutter
Class Fox::FXShutterItem
Class Fox::FXSize
Class Fox::FXSlider
Class Fox::FXSphered
Class Fox::FXSpheref
Class Fox::FXSpinner
Class Fox::FXSplashWindow
Class Fox::FXSplitter
Class Fox::FXSpring
Class Fox::FXStatusBar
Class Fox::FXStatusLine
Class Fox::FXStream
Class Fox::FXStringDict
Class Fox::FXSwitcher
Class Fox::FXTGAIcon
Class Fox::FXTGAImage
Class Fox::FXTIFIcon
Class Fox::FXTIFImage
Class Fox::FXTabBar
Class Fox::FXTabBook
Class Fox::FXTabItem
Class Fox::FXTable
Class Fox::FXTableItem
Class Fox::FXTablePos
Class Fox::FXTableRange
Class Fox::FXText
Class Fox::FXTextChange
Class Fox::FXTextField
Class Fox::FXToggleButton
Class Fox::FXToolBar
Class Fox::FXToolBarGrip
Class Fox::FXToolBarShell
Class Fox::FXToolBarTab
Class Fox::FXToolTip
Class Fox::FXTopWindow
Class Fox::FXTranslator
Class Fox::FXTreeItem
Class Fox::FXTreeList
Class Fox::FXTreeListBox
Class Fox::FXTriStateButton
Class Fox::FXVec2d
Class Fox::FXVec2f
Class Fox::FXVec3d
Class Fox::FXVec3f
Class Fox::FXVec4d
Class Fox::FXVec4f
Class Fox::FXVerticalFrame
Class Fox::FXVerticalSeparator
Class Fox::FXViewport
Class Fox::FXVisual
Class Fox::FXWindow
Class Fox::FXWizard
Class Fox::FXXBMIcon
Class Fox::FXXBMImage
Class Fox::FXXPMIcon
Class Fox::FXXPMImage
Class Fox::NotifyHeader
Class Fox::SCNotification
Class Fox::TextRange

Public Class methods

Return the red value from an FXColor value

Return the red value from an FXColor value

Return the red value from an FXColor value

Return the red value from an FXColor value

Construct an FXColor value from its red, green and blue components

Construct an FXColor value from its red, green, blue and alpha (transparency) components

Return the specified component value for this FXColor value, where component is either 0, 1, 2 or 3.

Return the message identifier for a selector

Return the message type for a selector

Make an unsigned int out of two unsigned shorts

Controls tracing level

Return true if store (an FXStream instance) contains a BMP image.

Return true if store (an FXStream instance) contains a GIF image.

Return true if store (an FXStream instance) contains a ICO image.

Return true if store (an FXStream instance) contains a JPEG image.

Return true if store (an FXStream instance) contains a PCX image.

Return true if store (an FXStream instance) contains a PNG image.

Return true if store (an FXStream instance) contains a PPM image.

Return true if store (an FXStream instance) contains a RGB image.

Return true if store (an FXStream instance) contains a TGA image.

Return true if store (an FXStream instance) contains a TIFF image.

Return true if store (an FXStream instance) contains an XBM image.

Return true if store (an FXStream instance) contains an XPM image.

Return the RGB value for this color name.

Locate hot key underline offset from begin of string

Convert HSV to RGB

Load a BMP 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]

Load a GIF 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]

Load a ICO file from store (an FXStream instance). On success, returns an array whose elements are the image data (a String), transparency color, icon width, icon height, and the icon hotspot x and y coordinates. If the operation fails, this method returns nil.

Parameters:

store:stream from which to read the file data [FXStream]

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]

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]

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]

Load a RGB 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]

Load a Targa file from a stream. If successful, returns an array containing the image pixel data (as a String), the number of channels (either 3 or 4), 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]

Load a TIFF file from a stream. If successful, returns an array containing the image pixel data (as a String), transparency color, width, height and codec setting. If it fails, the function returns nil.

Parameters:

store:stream from which to read the file data [FXStream]

Load a XPM file from a stream. If successful, returns an array containing the image pixel data (as an array of FXColor values), the transparency color (another FXColor) and 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]

Return the name of the closest color to the input RGB value.

Return a "hot key" code value that represents the accelerator key described in the string str. The string can contain some combination of the modifiers Ctrl, Alt and Shift, plus the key of interest. For example, to get the accelerator key for Ctrl+Alt+F7, you‘d use:

  hotKey = fxparseAccel("Ctrl+Alt+F7")

Return a hot key value that represents the hot key described in the string str. This method is less flexible than the similar Fox.fxparseAccel, and is mainly used internally for parsing the labels for FXButton and FXMenuCommand widgets. For example, this:

  fxparseHotKey("&File")

returns the equivalent of:

  fxparseAccel("Alt+F")

Convert RGB to HSV

Save a BMP 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]

Save a GIF (Graphics Interchange Format) image to a stream. If fast is true, the faster Floyd-Steinberg dither method will be used instead of the slower Wu quantization algorithm. Returns true on success, false on failure.

Parameters:

store:stream to which to write the image data [FXStream]
data:the image pixel data [Array of FXColor]
width:width [Integer]
height:height [Integer]
fast:if true, use faster Floyd-Steinberg algorithm [Boolean]

Save a ICO image to store (an FXStream instance). Returns true on success, false on failure.

Parameters:

store:stream to which to write the image data [FXStream]
pixels:the image pixel data [String]
transp:transparency color [FXColor]
width:width [Integer]
height:height [Integer]
xspot:hotspot x-coordinate [Integer]
yspot:hotspot y-coordinate [Integer]

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]

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]

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]

Save a RGB image to a stream. Returns true on success, false on failure.

Parameters:

store:stream to which to write the file data [FXStream]
data:the image pixel data [String]
transp:transparency color [FXColor]
opts:options [Integer]
width:width [Integer]
height:height [Integer]

Save a Targa 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]
channels:number of channels in the image pixel data: 3 for RGB data, or 4 for RGBA data [Integer]
width:width [Integer]
height:height [Integer]

Save a TIFF 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]
codec:codec setting [Integer]

Return the version number that the FOX library has been compiled with, as a String (e.g. "1.0.34").

Get highlight color

Get shadow color

Public Instance methods

Obtain hot key offset in string, or -1 if not found. For example, findHotKey("Salt && &Pepper!") yields 7. Note that this is the byte-offset, not the character index!

Save an XPM image to store (an FXStream instance). Returns true on success, false on failure.

Parameters:

store:stream to which to write the file data [FXStream]
data:the image pixel data, an array of FXColor values
transp:transparency color [FXColor]
width:width [Integer]
height:height [Integer]
fast:if true, use fast something

Parse accelerator from string, yielding modifier and key code. For example, parseAccel("Ctl+Shift+X") yields MKUINT(KEY_X,CONTROLMASK|SHIFTMASK).

Parse hot key from string, yielding modifier and key code. For example, parseHotKey(""Salt && &Pepper!"") yields MKUINT(KEY_p,ALTMASK).

Strip hot key combination from the string. For example, stripHotKey("Salt && &Pepper") should yield "Salt & Pepper".

Unparse hot key comprising modifier and key code back into a string suitable for parsing with parseHotKey.

[Validate]