Module: Studium::Colours

Included in:
Studium, Base, CurriculumDisplayer, Exams, GUI::Gtk::Frame
Defined in:
lib/studium/colours/simp.rb,
lib/studium/colours/sfile.rb,
lib/studium/colours/sfancy.rb,
lib/studium/colours/colours.rb,
lib/studium/colours/use_colours.rb,
lib/studium/colours/use_this_colour_for_exam_questions_and_exam_answers.rb

Overview

Studium::Colours

Constant Summary collapse

COLOURS =
#

COLOURS

#
::Colours::AllColourMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.crimson(i) ⇒ Object

#

Studium::Colours.crimson

#


343
344
345
346
 
# File 'lib/studium/colours/colours.rb', line 343

def self.crimson(i)
  return COLOURS.crimson(i) if use_colours?
  i
end

.darkgreen(i) ⇒ Object

#

Studium::Colours.darkgreen

#


130
131
132
133
 
# File 'lib/studium/colours/colours.rb', line 130

def self.darkgreen(i)
  return COLOURS.darkgreen(i) if Colours.use_colours?
  i
end

.darkseagreen(i) ⇒ Object

#

Studium::Colours.darkseagreen

#


138
139
140
141
 
# File 'lib/studium/colours/colours.rb', line 138

def self.darkseagreen(i)
  return COLOURS.darkseagreen(i) if Colours.use_colours?
  i
end

.deepskyblue(i = '') ⇒ Object

#

Studium::Colours.deepskyblue

#


399
400
401
402
 
# File 'lib/studium/colours/colours.rb', line 399

def self.deepskyblue(i = '')
  return COLOURS.deepskyblue(i) if Colours.use_colours?
  i
end

.default_colour ⇒ Object

#

Studium::Colours.default_colour

#


72
73
74
 
# File 'lib/studium/colours/colours.rb', line 72

def self.default_colour
  ::Colours::GREEN
end

.disable_colours ⇒ Object

#

Studium::Colours.disable_colours

Disable the colours through this method here. Should happen when we are running in :www mode (as in .cgi scripts).

#


57
58
59
 
# File 'lib/studium/colours/colours.rb', line 57

def self.disable_colours
  @use_colours = false
end

.e(i = '') ⇒ Object

#

Studium::Colours.e (e tag)

#


36
37
38
39
40
41
42
 
# File 'lib/studium/colours/colours.rb', line 36

def self.e(i = '')
  if Colours.use_colours?
    Colours::E.e(i)
  else
    puts i
  end
end

.enable_colours ⇒ Object

#

Studium::Colours.enable_colours

#


47
48
49
 
# File 'lib/studium/colours/colours.rb', line 47

def self.enable_colours
  @use_colours = true
end

.gold(i) ⇒ Object

#

Studium::Colours.gold

#


383
384
385
386
 
# File 'lib/studium/colours/colours.rb', line 383

def self.gold(i)
  return COLOURS.gold(i) if use_colours?
  i
end

.lightblue(i) ⇒ Object

#

Studium::Colours.lightblue

#


146
147
148
149
 
# File 'lib/studium/colours/colours.rb', line 146

def self.lightblue(i)
  return COLOURS.lightblue(i) if Colours.use_colours?
  i
end

.lightgreen(i) ⇒ Object

#

Studium::Colours.lightgreen

#


122
123
124
125
 
# File 'lib/studium/colours/colours.rb', line 122

def self.lightgreen(i)
  return COLOURS.lightgreen(i) if Colours.use_colours?
  i
end

.orange(i) ⇒ Object

#

Studium::Colours.orange

#


90
91
92
93
 
# File 'lib/studium/colours/colours.rb', line 90

def self.orange(i)
  return COLOURS.orange(i) if Colours.use_colours?
  i
end

.orangered(i) ⇒ Object

#

Studium::Colours.orangered

#


162
163
164
165
 
# File 'lib/studium/colours/colours.rb', line 162

def self.orangered(i)
  return COLOURS.orangered(i) if Colours.use_colours?
  i
end

.palevioletred(i) ⇒ Object

#

Studium::Colours.palevioletred

#


64
65
66
67
 
# File 'lib/studium/colours/colours.rb', line 64

def self.palevioletred(i)
  return COLOURS.palevioletred(i) if use_colours?
  i
end

.rev ⇒ Object

#

Studium::Colours.rev

#


79
80
81
82
83
84
85
 
# File 'lib/studium/colours/colours.rb', line 79

def self.rev
  if use_colours?
    ::Colours.rev
  else
    ''
  end
end

.royalblue(i) ⇒ Object

#

Studium::Colours.royalblue

#


98
99
100
101
 
# File 'lib/studium/colours/colours.rb', line 98

def self.royalblue(i)
  return COLOURS.royalblue(i) if Colours.use_colours?
  i
end

.sdir(i) ⇒ Object

#

Studium::Colours.sdir

#


170
171
172
173
 
# File 'lib/studium/colours/colours.rb', line 170

def self.sdir(i)
  return ::Colours.sdir(i) if Colours.use_colours?
  i
end

.sfancy(i = '') ⇒ Object

#

Studium::Colours.sfancy

To test this method e. g. in IRB, do:

puts Studium::Colours.sfancy("yo there")
#


21
22
23
24
 
# File 'lib/studium/colours/sfancy.rb', line 21

def self.sfancy(i = '')
  return ::Colours.sfancy(i) if Colours.use_colours?
  return i
end

.sfile(i = '') ⇒ Object

#

Studium::Colours.sfile

#


14
15
16
17
 
# File 'lib/studium/colours/sfile.rb', line 14

def self.sfile(i = '')
  return ::Colours.sfile(i) if Colours.use_colours?
  return i
end

.simp(i) ⇒ Object

#

Studium::Colours.simp

To test this method e. g. in IRB, do:

puts Studium::Colours.simp("yo there")
#


19
20
21
22
 
# File 'lib/studium/colours/simp.rb', line 19

def self.simp(i)
  return ::Colours.simp(i) if Colours.use_colours?
  return i
end

.slateblue(i) ⇒ Object

#

Studium::Colours.slateblue

#


106
107
108
109
 
# File 'lib/studium/colours/colours.rb', line 106

def self.slateblue(i)
  return COLOURS.slateblue(i) if Colours.use_colours?
  i
end

.steelblue(i) ⇒ Object

#

Studium::Colours.steelblue

#


114
115
116
117
 
# File 'lib/studium/colours/colours.rb', line 114

def self.steelblue(i)
  return COLOURS.steelblue(i) if Colours.use_colours?
  i
end

.swarn(i) ⇒ Object

#

Studium::Colours.swarn

#


209
210
211
212
 
# File 'lib/studium/colours/colours.rb', line 209

def self.swarn(i)
  return ::Colours.swarn(i) if Colours.use_colours?
  i
end

.turquoise(i) ⇒ Object

#

Studium::Colours.turquoise

#


154
155
156
157
 
# File 'lib/studium/colours/colours.rb', line 154

def self.turquoise(i)
  return COLOURS.turquoise(i) if Colours.use_colours?
  i
end

.use_colours? ⇒ Boolean

#

Studium::Colours.use_colours?

Query whether we will use colours or whether we will not.

#

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/studium/colours/use_colours.rb', line 35

def self.use_colours?
  @use_colours
end

.use_this_colour_for_exam_answers(i) ⇒ Object

#

Studium::Colours.use_this_colour_for_exam_answers

This method can be used to modify the colours for exam-answers. It will write into the respective .yml file.

Invocation example from the commandline:

studium --use-this-colour-for-exam-answers=slateblue
#


27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/studium/colours/use_this_colour_for_exam_questions_and_exam_answers.rb', line 27

def self.use_this_colour_for_exam_answers(i)
  into = FILE_CUSTOM_COLOURS
  if File.exist? into
    use_this_regex = /(colour_for_answers: )(.+)$/
    dataset = ::Studium.file_read_with_proper_encoding(into)
    dataset.sub!(use_this_regex, '\1'+i)
    e "Now writing into the file `#{sfile(into)}`."
    ::Studium.save_what_into(dataset, into)
    if ::Studium.is_on_roebe?
      into = "#{RUBY_SRC_STUDIUM_LIB}studium/yaml/"\
             "#{File.basename(into)}"
      e "Now also writing into the file `#{sfile(into)}`."
      ::Studium.save_what_into(dataset, into)
    end
  else
    e 'No file called '+into+' exists.'
  end
end

.use_this_colour_for_exam_questions(i) ⇒ Object

#

Studium::Colours.use_this_colour_for_exam_questions

This method can be used to modify the colours for exam-questions. It will write into the respective .yml file.

Invocation example from the commandline:

studium --use-this-colour-for-exam-questions=slateblue
#


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/studium/colours/use_this_colour_for_exam_questions_and_exam_answers.rb', line 57

def self.use_this_colour_for_exam_questions(i)
  into = FILE_CUSTOM_COLOURS
  if File.exist? into
    use_this_regex = /(colour_for_questions: )(.+)$/
    dataset = ::Studium.file_read_with_proper_encoding(into)
    dataset.sub!(use_this_regex, '\1'+i)
    e 'Now writing into the file `'+sfile(into)+'`.'
    ::Studium.save_what_into(dataset, into)
    if ::Studium.is_on_roebe?
      into = "#{RUBY_SRC_STUDIUM_LIB}studium/yaml/"\
             "#{File.basename(into)}"
      e 'Now also writing into the file `'+sfile(into)+'`.'
      ::Studium.save_what_into(dataset, into)
    end
  else
    e "No file called #{into} exists."
  end
end

Instance Method Details

#bold_blue(i) ⇒ Object

#

bold_blue

#


233
234
235
236
 
# File 'lib/studium/colours/colours.rb', line 233

def bold_blue(i)
  return COLOURS.bold_blue(i.to_s.dup) if Colours.use_colours?
  i
end

#bold_red(i) ⇒ Object

#

bold_red

#


241
242
243
244
 
# File 'lib/studium/colours/colours.rb', line 241

def bold_red(i)
  return COLOURS.beautify('bold red')+i.to_s+Colours.rev if Colours.use_colours?
  i
end

#bold_yellow(i) ⇒ Object

#

bold_yellow

#


225
226
227
228
 
# File 'lib/studium/colours/colours.rb', line 225

def bold_yellow(i)
  return COLOURS.bold_yellow(i) if Colours.use_colours?
  i
end

#cadetblue(i) ⇒ Object

#

cadetblue

#


327
328
329
330
 
# File 'lib/studium/colours/colours.rb', line 327

def cadetblue(i)
  return COLOURS.cadetblue(i) if use_colours?
  i
end

#chartreuse(i) ⇒ Object

#

chartreuse

#


319
320
321
322
 
# File 'lib/studium/colours/colours.rb', line 319

def chartreuse(i)
  return COLOURS.chartreuse(i) if use_colours?
  i
end

#darkgray(i) ⇒ Object

#

darkgray

#


287
288
289
290
 
# File 'lib/studium/colours/colours.rb', line 287

def darkgray(i)
  return COLOURS.darkgray(i) if use_colours?
  i
end

#deepskyblue(i = '') ⇒ Object

#

deepskyblue

#


407
408
409
410
 
# File 'lib/studium/colours/colours.rb', line 407

def deepskyblue(i = '')
  return COLOURS.deepskyblue(i) if Colours.use_colours?
  i
end

#dimgray(i) ⇒ Object

#

dimgray

#


351
352
353
354
 
# File 'lib/studium/colours/colours.rb', line 351

def dimgray(i)
  return COLOURS.dimgray(i) if use_colours?
  i
end

#dodgerblue(i) ⇒ Object

#

dodgerblue

#


311
312
313
314
 
# File 'lib/studium/colours/colours.rb', line 311

def dodgerblue(i)
  return COLOURS.dodgerblue(i) if use_colours?
  i
end

#efancy(i) ⇒ Object

#

efancy

#


249
250
251
 
# File 'lib/studium/colours/colours.rb', line 249

def efancy(i)
  e sfancy(i)
end

#ewarn(i) ⇒ Object

#

ewarn

#


256
257
258
 
# File 'lib/studium/colours/colours.rb', line 256

def ewarn(i)
  e swarn(i)
end

#forestgreen(i) ⇒ Object

#

forestgreen

#


359
360
361
362
 
# File 'lib/studium/colours/colours.rb', line 359

def forestgreen(i)
  return COLOURS.forestgreen(i) if use_colours?
  i
end

#grey(i) ⇒ Object

#

grey

#


193
194
195
196
 
# File 'lib/studium/colours/colours.rb', line 193

def grey(i)
  return COLOURS.grey(i) if Colours.use_colours?
  i
end

#lightslategray(i) ⇒ Object

#

lightslategray

#


263
264
265
266
 
# File 'lib/studium/colours/colours.rb', line 263

def lightslategray(i)
  return COLOURS.lightslategray(i) if use_colours?
  i
end

#lightsteelblue(i) ⇒ Object

#

lightsteelblue

#


303
304
305
306
 
# File 'lib/studium/colours/colours.rb', line 303

def lightsteelblue(i)
  return COLOURS.lightsteelblue(i) if use_colours?
  i
end

#mediumorchid(i) ⇒ Object

#

mediumorchid

#


375
376
377
378
 
# File 'lib/studium/colours/colours.rb', line 375

def mediumorchid(i)
  return COLOURS.mediumorchid(i) if use_colours?
  i
end

#mediumseagreen(i) ⇒ Object

#

mediumseagreen

#


295
296
297
298
 
# File 'lib/studium/colours/colours.rb', line 295

def mediumseagreen(i)
  return COLOURS.mediumseagreen(i) if use_colours?
  i
end

#oldlace(i) ⇒ Object

#

oldlace

#


279
280
281
282
 
# File 'lib/studium/colours/colours.rb', line 279

def oldlace(i)
  return COLOURS.oldlace(i) if use_colours?
  i
end

#olivedrab(i) ⇒ Object

#

olivedrab

#


391
392
393
394
 
# File 'lib/studium/colours/colours.rb', line 391

def olivedrab(i)
  return COLOURS.olivedrab(i) if use_colours?
  i
end

#orchid(i) ⇒ Object

#

orchid

#


367
368
369
370
 
# File 'lib/studium/colours/colours.rb', line 367

def orchid(i)
  return COLOURS.orchid(i) if use_colours?
  i
end

#papayawhip(i) ⇒ Object

#

papayawhip

#


271
272
273
274
 
# File 'lib/studium/colours/colours.rb', line 271

def papayawhip(i)
  return COLOURS.papayawhip(i) if use_colours?
  i
end

#sdir(i = '') ⇒ Object

#

sdir

#


178
179
180
 
# File 'lib/studium/colours/colours.rb', line 178

def sdir(i = '')
  ::Studium::Colours.sdir(i)
end

#sfancy(i) ⇒ Object

#

sfancy

#


29
30
31
 
# File 'lib/studium/colours/sfancy.rb', line 29

def sfancy(i)
  return ::Studium::Colours.sfancy(i)
end

#sfile(i = '') ⇒ Object

#

sfile

#


22
23
24
 
# File 'lib/studium/colours/sfile.rb', line 22

def sfile(i = '')
  return ::Studium::Colours.sfile(i)
end

#simp(i) ⇒ Object

#

simp

#


27
28
29
 
# File 'lib/studium/colours/simp.rb', line 27

def simp(i)
  return ::Studium::Colours.simp(i)
end

#steelblue(i) ⇒ Object

#

steelblue

#


335
336
337
338
 
# File 'lib/studium/colours/colours.rb', line 335

def steelblue(i)
  return COLOURS.steelblue(i) if use_colours?
  i
end

#swarn(i = '') ⇒ Object

#

swarn

#


201
202
203
204
 
# File 'lib/studium/colours/colours.rb', line 201

def swarn(i = '')
  return ::Colours.swarn(i) if Colours.use_colours?
  i
end

#teal(i) ⇒ Object

#

teal

#


185
186
187
188
 
# File 'lib/studium/colours/colours.rb', line 185

def teal(i)
  return COLOURS.teal(i) if Colours.use_colours?
  i
end

#yellow(i) ⇒ Object

#

yellow

#


217
218
219
220
 
# File 'lib/studium/colours/colours.rb', line 217

def yellow(i)
  return COLOURS.yellow(i) if Colours.use_colours?
  i
end