Sha256: 05ec32b38c3c474c642529d123b4f81a9c3d1cb42594b8aa38b60ed62888f0c8

Contents?: true

Size: 1.68 KB

Versions: 55

Compression:

Stored size: 1.68 KB

Contents

module Fox
  #
  # The dictionary class maintains a fast-access hash table of entities
  # indexed by a character string.  
  # It is typically used to map strings to pointers; however, overloading
  # the #createData and #deleteData members allows any type of data to
  # be indexed by strings.
  #
  class FXDict < FXObject
  
    # Total number of entries in the table [Integer]
    attr_reader :length

    # Position of first filled slot, or >= total [Integer]
    attr_reader :first

    # Position of last filled slot, or -1 [Integer]
    attr_reader :last

    alias size length
    
    #
    # Construct an empty dictionary.
    #
    def initialize ; end
    
    #
    # Return key at position _pos_.
    #
    def key(pos) ; end

    #
    # Return mark flag of entry at position _pos_.
    #
    def marked?(pos) ; end

    #
    # Return position of next filled slot after _pos_ in the hash table,
    # or a value greater than or equal to total if no filled 
    # slot was found.
    #
    def next(pos) ; end

    #
    # Return position of previous filled slot before _pos_ in the hash table,
    # or a -1 if no filled slot was found.
    #
    def prev(pos) ; end

    #
    # Clear all entries
    #
    def clear() ; end

    #
    # Iterate over the keys in this dictionary.
    #
    def each_key # :yields: key
    end

    #
    # Returns a new array populated with the keys from this dictionary.
    #
    def keys() ; end

    #
    # Returns +true+ if the given _key_ is present.
    #
    def has_key?(key) ; end
    
    alias include? has_key?
    alias member?  has_key?
    
    #
    # Returns +true+ if this dictionary contains no key-value pairs.
    #
    def empty?() ; end
  end
end

Version data entries

55 entries across 55 versions & 2 rubygems

Version Path
fxruby-1.6.22.pre2-x86-mingw32 rdoc-sources/FXDict.rb
fxruby-1.6.22.pre2 rdoc-sources/FXDict.rb
fxrubi-1.6.22.pre1-x86-mingw32 rdoc-sources/FXDict.rb
fxrubi-1.6.22.pre1 rdoc-sources/FXDict.rb
fxruby-1.6.20-x86-mingw32 rdoc-sources/FXDict.rb
fxruby-1.6.20-x86-linux rdoc-sources/FXDict.rb
fxruby-1.6.20 rdoc-sources/FXDict.rb
fxruby-1.6.20-universal-darwin-10 rdoc-sources/FXDict.rb
fxruby-1.6.19-x86-mingw32 rdoc-sources/FXDict.rb
fxruby-1.6.14-mswin32 rdoc-sources/FXDict.rb
fxruby-1.6.13-mswin32 rdoc-sources/FXDict.rb
fxruby-1.2.3 rdoc-sources/FXDict.rb
fxruby-1.2.2 rdoc-sources/FXDict.rb
fxruby-1.2.4 rdoc-sources/FXDict.rb
fxruby-1.2.5 rdoc-sources/FXDict.rb
fxruby-1.2.6 rdoc-sources/FXDict.rb
fxruby-1.4.0 rdoc-sources/FXDict.rb
fxruby-1.4.1 rdoc-sources/FXDict.rb
fxruby-1.4.2 rdoc-sources/FXDict.rb
fxruby-1.4.3 rdoc-sources/FXDict.rb