Class: Roebe::MrxvtOptions

Inherits:
Base show all
Defined in:
lib/roebe/classes/mrxvt_options.rb

Constant Summary collapse

DEBUG =
#

DEBUG

#
false
FILENAME =
#

FILENAME

#
File.basename(__FILE__)
SHOW_USAGE =
#

SHOW_USAGE

#
'Usage from '+FILENAME+':  $0  -option  [title]
    (meant  for  use  with  mrxvt  http://materm.sourceforge.net/)

-h    =>  this Help screen
-t    =>  set Title  to  [title]
-n    =>  New tab with title  [title]
-nt   =>  switch to Next Tab
-pt   =>  switch to Previous  Tab
-so   =>  Show/hide tool bar
-st   =>  Show/hide Tabs
-ss   =>  Show/hide Scroll bar
'+N
XTERM_TAB =
#

The following constants used to be #defines. I do not know from where they originated, but apparently mrxvt makes use of them.

#
61
XTERM_TABTERM =

change tab title

62
XTERM_NEWTAB =

change tab and terminal title

63
XTERM_PREVTAB =

create a new tab with title

64
XTERM_NEXTTAB =

switch to previous tab

65
XTERM_TINT =

switch to next tab

66
XTERM_SHADE =

change tinting color

67
XTERM_ENCODE =

change shade level

68
XTERM_HIDE =

change encoding

69
XTERM_OPACITY =

hide/show tabbar

70
XTERM_TABBTN =

set opacity level

71
XTERM_TABFG =

hide/show tabbar button

72
XTERM_TABBG =

change active tab fg

73
XTERM_ITABFG =

change tabbar/active tab bg

74
XTERM_ITABBG =

change inactive tab fg

75
XTERM_TRANS =

change inactive tab bg

76
XTERM_MOVELEFT =

toggle background transparency

77
XTERM_MOVERIGHT =

move active tab to left

78
XTERM_VERYBOLD =

move active tab to right

79
XTERM_HOTKEYS =

toggle bold font for color text

80
XTERM_SAVECONFIG =

toggle hotkeys

81
XTERM_BGFADE =

save configuration

82

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N, Base::NAMESPACE

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #complex_esystem, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkkhaki, #darkslateblue, #deeppink, #delete_symlink, #do_not_use_the_base_colours, #do_use_the_base_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #emphasis, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esteelblue, #etomato, #ewarn, #exit_program, #firebrick, #get_current_day, #get_current_month, #get_files_and_directories, #get_files_from, #get_german_name_for_this_weekday, #gold, #green, #grey, #hh_mm_ss, #hh_mm_ss_day_month_year, #home_dir?, #home_directory_of_user_x?, #infer_the_namespace, #internal_hash?, #is_a_directory?, #is_a_file?, #is_a_jpg_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_studium_available?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #le, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lightsteelblue, #lime, #limegreen, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mkdir_p, #mv, #n_days_in_this_month, #n_pages_in_this_pdf_file?, #namespace?, #no_file_exists_at, #ogrey, #olive, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #orev, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_dir?, #project_base_dir?, #random_html_colour, #rds, #read_file_in_iso_encoding, #read_file_via_the_default_encoding, #read_lines_via_iso_encoding, #readlines_with_main_encoding, #red, #register_sigint, #remove, #remove_directory, #remove_file, #rename_kde_konsole_tab, #replace_localhost_with_data, #report_pwd, #require_rescue, #reset_the_internal_hash, #return_all_directories_from_this_directory, #return_all_files_from_this_directory, #return_current_directory, #return_dd_mm_yyyy, #return_file_or_directory_of, #return_files_from_pwd, #return_last_part_of_the_current_directory, #return_utc, #rev, #right_arrow?, #right_colour, #roebe_log_directory?, #rosybrown, #royalblue, #ruby_base_directory?, #run, #run_in_background, #run_rcfiles_then_run_ata_via_qdbus, #sandybrown, #sdir, #seagreen, #set_be_verbose, #set_xorg_buffer, #sfancy, #sfile, #show_help, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #string_italic, #swarn, #symlink, #teal, #temp_dir?, #to_camelcase, #to_counted_hash, #tomato, #touch, #try_to_require_the_beautiful_url_gem, #try_to_require_the_html_template, #try_to_require_the_open_gem, #try_to_require_the_program_information_gem, #try_to_require_the_xorg_buffer, #use_colours?, #verbose_truth, #weekday?, #word_wrap, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#append_onto_the_commandline_arguments, #clear_commandline_arguments, #commandline_arguments?, #commandline_arguments_as_string?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_argument_without_leading_hyphens?, #has_an_argument_been_passed?, #remove_hyphened_arguments_from_the_commandline_arguments, #return_commandline_arguments_with_leading_hyphens, #second_argument?, #set_commandline_arguments

Constructor Details

#initialize(*args) ⇒ MrxvtOptions

#

initialize

#


71
72
73
74
75
76
77
78
79
 
# File 'lib/roebe/classes/mrxvt_options.rb', line 71

def initialize(
    *args
  )
  reset
  unless args.empty?
    @args = args.flatten.join(' ')
    @splitted = @args.split(' ')
  end
end

Instance Attribute Details

#be_verbose=(value) ⇒ Object (writeonly)

set bg fading degree



66
67
68
 
# File 'lib/roebe/classes/mrxvt_options.rb', line 66

def be_verbose=(value)
  @be_verbose = value
end

Class Method Details

.set_title(i) ⇒ Object

#

Roebe::MrxvtOptions.set_title

Usage example:

Roebe::MrxvtOptions.set_title('Hello world!')
#


200
201
202
 
# File 'lib/roebe/classes/mrxvt_options.rb', line 200

def self.set_title(i)
  Roebe::MrxvtOptions.new.set_title(i) { :be_quiet }
end

Instance Method Details

#check_on_arguments(argument_to_use = @args) ⇒ Object

#

check_on_argument

#


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/roebe/classes/mrxvt_options.rb', line 100

def check_on_arguments(
    argument_to_use = @args
  )
  pp argument_to_use if DEBUG 
  case argument_to_use # case tag.
  # ======================================================================= #
  # === ^-st
  # ======================================================================= #
  when /^-st/  # hide/show tab
    printf("%c]%d;%s%c",  033,  XTERM_HIDE, 't', 007)
  # ======================================================================= #
  # === ^-so
  # ======================================================================= #
  when /^-so/  # show/hide toolbar
    printf("%c]%d;%c",    033,  XTERM_TABBTN, 007)
  # ======================================================================= #
  # === ^-ss
  #
  # Entry point for hiding/showing the scroll bar.
  # ======================================================================= #
  when /^-ss/
    printf('%c]%d;%s%c',  033,  XTERM_HIDE,  's',  007)
  # ======================================================================= #
  # === ^-pt
  # ======================================================================= #
  when /^-pt/  # previous tab
    printf("%c]%d;%c",    033,  XTERM_PREVTAB,  007)
  when /^-nt/,/^-next-tab/  # next tab
    printf('%c]%d;%c',    033,  XTERM_NEXTTAB,  007)
  when /^-new/,/^-new-tab/ # new tab
    printf('%c]%d;%s%c',  033,  XTERM_NEWTAB,  argument_to_use, 007)
  when /^-t/ # set title here.
    @title_of_tab = @splitted[1..-1].join(' ')
    sanitize_title
    set_title
  when 'title empty'
    e 'empty title'
  else
    show_usage
  end
end

#reset ⇒ Object

#

reset

#


84
85
86
87
88
 
# File 'lib/roebe/classes/mrxvt_options.rb', line 84

def reset
  super()
  @title_of_tab = ''
  @use_colours = ::Roebe.use_colours?
end

#sanitize_title ⇒ Object

#

sanitize_title

Do some sanitizing here.

#


147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/roebe/classes/mrxvt_options.rb', line 147

def sanitize_title
  @title_of_tab = 
  case @title_of_tab.downcase
  when 'geas'
    'GEAS'
  when 'pwd'
    return_pwd
  else
    @title_of_tab
  end
end

#set_title(use_this_title = @title_of_tab) ⇒ Object

#

set_title

Set our title.

A (complete) standalone usage example:

require 'x/tools/mrxvt_options.rb'
_ = MrxvtOptions.new
_.set_title 'Yo hi'
#


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/roebe/classes/mrxvt_options.rb', line 171

def set_title(
    use_this_title = @title_of_tab
  )
  sanitize_title
  be_verbose = @be_verbose
  if block_given?
    yielded = yield
    case yielded
    when :be_quiet
      be_verbose = false
    end
  end
  if be_verbose
    unless use_this_title.empty?
      opn; e "Setting title of Tab to `"\
             "#{sfancy(use_this_title.to_s)}` now."
    end
  end
  printf(
    "%c]%d;%s%c", 033, XTERM_TABTERM, use_this_title.to_s, 007
  )
end

#show_usage ⇒ Object

#

show_usage

#


93
94
95
 
# File 'lib/roebe/classes/mrxvt_options.rb', line 93

def show_usage
  e SHOW_USAGE
end