Contents

###
# wxRuby3 Enum class
# Copyright (c) M.J.N. Corino, The Netherlands
###


module Wx

  # Base class for typed enums.
  # Derives from Numeric and behaves as such in math operations but provides
  # type safety for arguments requiring the specific enum class.
  class Enum < Numeric

    # Initialize a new enum value.
    # @param [Integer] val enum integer value
    def initialize(val)end

    # Coerces enum value to be compatible with other if possible. Raises TypeError if not compatible.
    # @param [Numeric] other numeric value
    # @return [Array<Integer, Integer>] the integer equivalences of other and enum value
    def coerce(other) end

    # Returns true.
    def integer?; end

    # Returns false.
    def real?; end

    # Redirects to the @value member attribute for any missing methods.
    def method_missing(sym, *args) end

    # Checks type and value equality.
    # @param [Object] o the object to compare
    # @return [true,false] true if o is instance of same enum class as self **and** integer values are equal; false otherwise
    def eql?(o) end

    # Compares integer values if possible. Raises ArgumentError if not compatible
    # @param [Enum,Numeric] o enum or numeric object to compare.
    # @return [-1,0,1]
    def <=>(o) end

    # Return next integer value from enum's value.
    # @return [Integer] next integer value
    def succ; end

    # Return string representation.
    def inspect; end

    # Return integer value of enum
    def to_int; end
    alias :to_i :to_int

    # Create a new class and associated enum values.
    # @param [String,Symbol] name name of new enum class
    # @param [Hash] enum_values hash with enum value name and enum integer value pairs
    # @return [Class] new enum class
    def self.create(name, enum_values) end

    # Returns enum class matching name or nil.
    # @param [String,Symbol] name name of enum class
    # @return [Class,nil] enum class
    def self.[](name) end

  end

end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
wxruby3-0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2	lib/wx/doc/enum.rb
wxruby3-0.9.0.pre.beta.1-x64-mingw-ucrt-3.2	lib/wx/doc/enum.rb