fxruby 1.2.2

data/rdoc-sources/FXStatusLine.rb

@@ -0,0 +1,60 @@
+module Fox
+  #
+  # The status line normally shows its permanent or "normal" message; when
+  # moving the mouse over a widget which provides status line help, the status line
+  # temporarily replaces its normal message with the help information; the status
+  # line obtains this help message by sending the widget a +ID_QUERY_HELP+ message
+  # with type +SEL_UPDATE+.
+  # If this query does not result in a new status string, the target of
+  # the status line is tried via an ordinary +SEL_UPDATE+ message.
+  # If _none_ of the above work, the status line will display the normal text
+  # (i.e. the string set via the #normalText= accessor method).
+  # If the message contains a newline character, then the part before the newline
+  # will be displayed in the highlight color, while the part after the newline
+  # will be shown using the normal text color.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXStatusLine to its target:
+  #
+  # +SEL_UPDATE+::
+  #   Sent when the widget currently under the mouse cursor doesn't respond
+  #   to a +SEL_UPDATE+ message with identifier +ID_QUERY_HELP+, as described
+  #   above.
+  #
+  class FXStatusLine < FXFrame
+
+    # Temporary status message [String]
+    attr_accessor :text
+    
+    # Permanent status message [String]
+    attr_accessor :normalText
+    
+    # Text font [FXFont]
+    attr_accessor :font
+    
+    # Text color [FXColor]
+    attr_accessor :textColor
+    
+    # Highlight text color [FXColor]
+    attr_accessor :textHighlightColor
+
+    #
+    # Return an initialized FXStatusLine instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this shutter [FXComposite]
+    # +tgt+::	the message target, if any, for this shutter [FXObject]
+    # +sel+::	the message identifier for this shutter [Integer]
+    #
+    def initialize(p, tgt=nil, sel=0) # :yields: theStatusLine
+    end
+    
+    # Returns the temporary status message (i.e. same as _text_)
+    def to_s
+      text
+    end
+  end
+end
+

data/rdoc-sources/FXStream.rb

@@ -0,0 +1,115 @@
+module Fox
+  #
+  # Persistent store definition
+  #
+  # === Stream status codes
+  #
+  # +FXStreamOK+::		OK
+  # +FXStreamEnd+::		Try read past end of stream
+  # +FXStreamFull+::		Filled up stream buffer or disk full
+  # +FXStreamNoWrite+::		Unable to open for write
+  # +FXStreamNoRead+::		Unable to open for read
+  # +FXStreamFormat+::		Stream format error
+  # +FXStreamUnknown+::		Trying to read unknown class
+  # +FXStreamAlloc+::		Alloc failed
+  # +FXStreamFailure+::		General failure
+  #
+  # === Stream data flow direction
+  #
+  # +FXStreamDead+::		Unopened stream
+  # +FXStreamSave+::		Saving stuff to stream
+  # +FXStreamLoad+::		Loading stuff from stream
+  #
+  # === Stream seeking
+  #
+  # +FXFromStart+::		Seek from start position
+  # +FXFromCurrent+::		Seek from current position
+  # +FXFromEnd+::		Seek from end position
+  #
+  class FXStream
+
+    # Stream status [Integer]
+    attr_reader :status
+
+    # Stream direction, one of +FXStreamSave+, +FXStreamLoad+ or +FXStreamDead+.
+    attr_reader :direction
+  
+    # Parent object [FXObject]
+    attr_reader :container
+
+    # Available buffer space
+    attr_accessor :space
+
+    # Stream position (an offset from the beginning of the stream) [Integer]
+    attr_accessor :position
+  
+    #
+    # Construct stream with given container object.  The container object
+    # is an object that will itself not be saved to or loaded from the stream,
+    # but which may be referenced by other objects.  These references will be
+    # properly saved and restored.
+    #
+    # ==== Parameters:
+    #
+    # +cont+::	the container object, or +nil+ if there is none [FXObject].
+    #
+    def initialize(cont=nil) # :yields: theStream
+    end
+  
+    #
+    # Open stream for reading or for writing.
+    # An initial buffer size may be given, which must be at least 16 bytes.
+    # If _data_ is not +nil+, it is expected to point to an external data buffer
+    # of length _size_; otherwise the stream will use an internally managed buffer.
+    # Returns +true+ on success, +false+ otherwise.
+    #
+    # ==== Parameters:
+    #
+    # +save_or_load+::	access mode, either +FXStreamSave+ or +FXStreamLoad+ [Integer]
+    # +size+::		initial buffer size [Integer]
+    # +data+::		external data buffer (if any) [String]
+    #
+    def open(save_or_load, size=8192, data=nil); end
+  
+    #
+    # Close stream; returns +true+ if OK.
+    #
+    def close(); end
+  
+    #
+    # Flush buffer
+    #
+    def flush(); end
+
+    #
+    # Get available buffer space
+    #
+    def getSpace(); end
+  
+    #
+    # Set available buffer space
+    #
+    def setSpace(sp); end
+
+    #
+    # Return +true+ if at end of file or error.
+    #
+    def eof?; end
+
+    #
+    # Set status code, where _err_ is one of the stream status
+    # codes listed above.
+    #
+    def error=(err); end
+
+    # Set the byte-swapped flag to +true+ or +false+.
+    def bytesSwapped=(swapBytes); end
+    
+    # Returns +true+ if bytes are swapped for this stream
+    def bytesSwapped?; end
+  
+    # Returns +true+ if little-endian architecture
+    def FXStream.littleEndian?; end
+  end
+end
+

data/rdoc-sources/FXStringDict.rb

@@ -0,0 +1,38 @@
+module Fox
+  #
+  # An FXStringDict (string dictionary) object maps one string to another
+  # string. The inserted strings are copied when they're inserted.
+  #
+  class FXStringDict < FXDict
+    #
+    # Return an initialized FXStringDict instance.
+    #
+    def initialize; end
+  
+    #
+    # Insert a new string indexed by key, with given mark flag.
+    #
+    def insert(key, value, mrk=false); end
+  
+    #
+    # Replace or insert a new string indexed by key, unless given mark is lower than the existing mark.
+    #
+    def replace(key, value, mrk=false); end
+  
+    #
+    # Remove entry indexed by key.
+    #
+    def remove(key); end
+  
+    #
+    # Return the entry indexed by _key_, or nil if the key does not exist.
+    #
+    def find(key); end
+  
+    #
+    # Return the string at integer position _pos_.
+    #
+    def data(pos); end
+  end
+end
+

data/rdoc-sources/FXSwitcher.rb

@@ -0,0 +1,78 @@
+module Fox
+  #
+  # The FXSwitcher layout manager automatically arranges its child
+  # windows such that one of them is placed on top; all other
+  # child windows are hidden.
+  # Switcher provides a convenient method to conserve screen
+  # real-estate by arranging several GUI panels to appear in the 
+  # same space, depending on context.
+  # Switcher ignores all layout hints from its children; all
+  # children are stretched according to the switcher layout
+  # managers own size.
+  # When the +SWITCHER_HCOLLAPSE+ or +SWITCHER_VCOLLAPSE+ options
+  # are used, the switcher's default size is based on the width or
+  # height of the current child, instead of the maximum width
+  # or height of all of the children.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXSwitcher to its target:
+  #
+  # +SEL_COMMAND+::
+  #   sent whenever the current (topmost) child window changes;
+  #   the message data is an integer indicating the new current window's index.
+  #
+  # === Switcher options
+  #
+  # +SWITCHER_HCOLLAPSE+::	Collapse horizontally to width of current child
+  # +SWITCHER_VCOLLAPSE+::	Collapse vertically to height of current child
+  #
+  # === Message identifiers
+  #
+  # +ID_OPEN_FIRST+::	x
+  # +ID_OPEN_SECOND+::	x
+  # +ID_OPEN_THIRD+::	x
+  # +ID_OPEN_FOURTH+::	x
+  # +ID_OPEN_FIFTH+::	x
+  # +ID_OPEN_SIXTH+::	x
+  # +ID_OPEN_SEVENTH+::	x
+  # +ID_OPEN_EIGHTH+::	x
+  # +ID_OPEN_NINETH+::	x
+  # +ID_OPEN_TENTH+::	x
+  # +ID_OPEN_LAST+::	x
+  #
+  class FXSwitcher < FXPacker
+    # Current child window's index [Integer]
+    attr_accessor :current
+
+    # Switcher style flags [Integer]
+    attr_accessor :switcherStyle
+
+    #
+    # Return an initialized FXSwitcher instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this switcher [FXComposite]
+    # +opts+::	switcher 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, opts=0, x=0, y=0, w=0, h=0, pl=DEFAULT_SPACING, pr=DEFAULT_SPACING, pt=DEFAULT_SPACING, pb=DEFAULT_SPACING) # :yields: theSwitcher
+    end
+  
+    #
+    # Raise the child window at _index_ to the top of the stack.
+    # If _notify_ is +true+, a +SEL_COMMAND+ message is sent to the switcher's message target
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def setCurrent(index, notify=false); end
+  end
+end
+

data/rdoc-sources/FXTGAIcon.rb

@@ -0,0 +1,48 @@
+module Fox
+  #
+  # Targa Icon
+  #
+  class FXTGAIcon < FXIcon
+    #
+    # Return an initialized FXTGAIcon instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in Targa 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: theTGAIcon
+    end
+  end
+  
+  #
+  # 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]
+  #
+  def fxloadTGA(store); end
+
+  #
+  # 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]
+  #
+  def fxsaveTGA(store, data, channels, width, height); end
+end
+

data/rdoc-sources/FXTGAImage.rb

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

data/rdoc-sources/FXTIFIcon.rb

@@ -0,0 +1,52 @@
+module Fox
+  #
+  # Tagged Image File Format (TIFF) Icon
+  #
+  class FXTIFIcon < FXIcon
+    # Codec setting [Integer]
+    attr_accessor :codec
+
+    #
+    # Return an initialized FXTIFIcon instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in TIFF 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: theTIFIcon
+    end
+  end
+  
+  #
+  # 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]
+  #
+  def fxloadTIF(store); end
+
+  #
+  # 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]
+  #
+  def fxsaveTIF(store, data, transp, width, height, codec); end
+end
+

data/rdoc-sources/FXTIFImage.rb

@@ -0,0 +1,24 @@
+module Fox
+  #
+  # Tagged Image File Format (TIFF) Image
+  #
+  class FXTIFImage < FXImage
+    # Codec setting [Integer]
+    attr_accessor :codec
+    
+    #
+    # Return an initialized FXTIFImage instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in TIF file format [String]
+    # +opts+::	options [Integer]
+    # +w+::	width [Integer]
+    # +h+::	height [Integer]
+    #
+    def initialize(a, pix=nil, opts=0, w=1, h=1) # :yields: theTIFImage
+    end
+  end
+end
+

data/rdoc-sources/FXTabBar.rb

@@ -0,0 +1,76 @@
+module Fox
+  #
+  # The FXTabBar layout manager arranges tab items side by side,
+  # and raises the active tab item above the neighboring tab items.
+  # In a the horizontal arrangement, the tab bar can have the tab
+  # items on the top or on the bottom.  In the vertical arrangement,
+  # the tabs can be on the left or on the right.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXTabBar to its target:
+  #
+  # +SEL_COMMAND+::
+  #   sent whenever the current tab item changes;
+  #   the message data is an integer indicating the new current tab item's index.
+  #
+  # === Tab book options
+  #
+  # +TABBOOK_TOPTABS+::		Tabs on top (default)
+  # +TABBOOK_BOTTOMTABS+::	Tabs on bottom
+  # +TABBOOK_SIDEWAYS+::	Tabs on left
+  # +TABBOOK_LEFTTABS+::	Tabs on left
+  # +TABBOOK_RIGHTTABS+::	Tabs on right
+  # +TABBOOK_NORMAL+::		same as <tt>TABBOOK_TOPTABS</tt>
+  #
+  # === Message identifiers
+  #
+  # +ID_OPEN_ITEM+::	Sent from one of the FXTabItems
+  # +ID_OPEN_FIRST+::	Switch to the first panel
+  # +ID_OPEN_SECOND+::	x
+  # +ID_OPEN_THIRD+::	x
+  # +ID_OPEN_FOURTH+::	x
+  # +ID_OPEN_FIFTH+::	x
+  # +ID_OPEN_SIXTH+::	x
+  # +ID_OPEN_SEVENTH+::	x
+  # +ID_OPEN_EIGHTH+::	x
+  # +ID_OPEN_NINETH+::	x
+  # +ID_OPEN_TENTH+::	x
+  # +ID_OPEN_LAST+::	x
+  #
+  class FXTabBar < FXPacker
+    # Currently active tab item's index [Integer]
+    attr_accessor :current
+    
+    # Tab bar style [Integer]
+    attr_accessor :tabStyle
+
+    #
+    # Return an initialized FXTabBar instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this tar bar [FXComposite]
+    # +tgt+::	the message target, if any, for this tar bar [FXObject]
+    # +sel+::	the message identifier for this tab bar [Integer]
+    # +opts+::	tar 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]
+    #
+    def initialize(p, tgt=nil, sel=0, opts=TABBOOK_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_SPACING, pr=DEFAULT_SPACING, pt=DEFAULT_SPACING, pb=DEFAULT_SPACING) # :yields: theTabBar
+    end
+
+    #
+    # Set the current tab item to the one at _index_.
+    # If _notify_ is +true+, a +SEL_COMMAND+ message is sent to the tab bar's message target
+    #
+    def setCurrent(index, notify=false); end
+  end
+end
+