Class: RubyRTF::Colour

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-rtf/colour.rb

Overview

Holds information about a colour

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(red = 0, green = 0, blue = 0) ⇒ RubyRTF::Colour

Create a new colour

Parameters:

  • red (Integer) (defaults to: 0) —

    Red value between 0 and 255 (default: 0)

  • green (Integer) (defaults to: 0) —

    Green value between 0 and 255 (default: 0)

  • blue (Integer) (defaults to: 0) —

    Blue value between 0 and 255 (default: 0)



32
33
34
35
36
37
 
# File 'lib/ruby-rtf/colour.rb', line 32

def initialize(red = 0, green = 0, blue = 0)
  @red = red
  @green = green
  @blue = blue
  @use_default = false
end

Instance Attribute Details

#blue ⇒ Integer

Returns The blue value.

Returns:

  • (Integer) —

    The blue value



11
12
13
 
# File 'lib/ruby-rtf/colour.rb', line 11

def blue
  @blue
end

#green ⇒ Integer

Returns The green value.

Returns:

  • (Integer) —

    The green value



8
9
10
 
# File 'lib/ruby-rtf/colour.rb', line 8

def green
  @green
end

#red ⇒ Integer

Returns The red value.

Returns:

  • (Integer) —

    The red value



5
6
7
 
# File 'lib/ruby-rtf/colour.rb', line 5

def red
  @red
end

#shade ⇒ Integer

Returns The shade value.

Returns:

  • (Integer) —

    The shade value



14
15
16
 
# File 'lib/ruby-rtf/colour.rb', line 14

def shade
  @shade
end

#theme ⇒ Symbol

Returns The theme information.

Returns:

  • (Symbol) —

    The theme information



20
21
22
 
# File 'lib/ruby-rtf/colour.rb', line 20

def theme
  @theme
end

#tint ⇒ Integer

Returns The tint value.

Returns:

  • (Integer) —

    The tint value



17
18
19
 
# File 'lib/ruby-rtf/colour.rb', line 17

def tint
  @tint
end

#use_default ⇒ Boolean Also known as: use_default?

Returns True if reader should use it’s default colour.

Returns:

  • (Boolean) —

    True if reader should use it’s default colour



23
24
25
 
# File 'lib/ruby-rtf/colour.rb', line 23

def use_default
  @use_default
end

Instance Method Details

#to_s ⇒ String

Convert the colour to a string

Returns:

  • (String) —

    The string representation of the colour



42
43
44
45
 
# File 'lib/ruby-rtf/colour.rb', line 42

def to_s
  return "default" if use_default?
  "[#{red}, #{green}, #{blue}]"
end