Module: Sickill::Rainbow

### Home Classes Methods

### In Files

- lib/rainbow.rb
- lib/ansi_color.rb
- lib/ansi_rgb.rb

### Namespace

- CLASS Sickill::Rainbow::AnsiColor
- CLASS Sickill::Rainbow::AnsiRgb
- CLASS Sickill::Rainbow::RGB

### Methods

- #background
- #blink
- #bright
- #color
- #colour
- #foreground
- #hide
- #inverse
- #italic
- #reset
- #underline

### Class/Module Index

Quicksearch

- Sickill
- Sickill::Rainbow
- Sickill::Rainbow::AnsiColor
- Sickill::Rainbow::AnsiRgb
- Sickill::Rainbow::RGB

No matching classes.

# Sickill::Rainbow

### Constants

TERM_COLORS
TERM_EFFECTS

### Attributes

enabled[RW]

### Public Instance Methods

background(*color) click to toggle source

Sets background color of this text.

    # File lib/rainbow.rb, line 40
    def background(*color)
      wrap_with_code(AnsiColor.new(:background, *color).code)
    end

blink() click to toggle source

Turns on blinking attribute for this text (not well supported by terminal emulators).

    # File lib/rainbow.rb, line 70
    def blink
      wrap_with_code(TERM_EFFECTS[:blink])
    end

bright() click to toggle source

Turns on bright/bold for this text.

    # File lib/rainbow.rb, line 53
    def bright
      wrap_with_code(TERM_EFFECTS[:bright])
    end

color(*color) click to toggle source
Alias for: foreground
colour(*color) click to toggle source
Alias for: foreground
foreground(*color) click to toggle source

Sets foreground color of this text.

    # File lib/rainbow.rb, line 32
    def foreground(*color)
      wrap_with_code(AnsiColor.new(:foreground, *color).code)
    end

Also aliased as: color, colour
hide() click to toggle source

Hides this text (set its color to the same as background).

    # File lib/rainbow.rb, line 80
    def hide
      wrap_with_code(TERM_EFFECTS[:hide])
    end

inverse() click to toggle source

Inverses current foreground/background colors.

    # File lib/rainbow.rb, line 75
    def inverse
      wrap_with_code(TERM_EFFECTS[:inverse])
    end

italic() click to toggle source

Turns on italic style for this text (not well supported by terminal emulators).

    # File lib/rainbow.rb, line 59
    def italic
      wrap_with_code(TERM_EFFECTS[:italic])
    end

reset() click to toggle source

Resets terminal to default colors/backgrounds.

It shouldn't be needed to use this method because all methods append terminal reset code to end of string.

    # File lib/rainbow.rb, line 48
    def reset
      wrap_with_code(TERM_EFFECTS[:reset])
    end

underline() click to toggle source

Turns on underline decoration for this text.

    # File lib/rainbow.rb, line 64
    def underline
      wrap_with_code(TERM_EFFECTS[:underline])
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.