Class: Roebe::Zenity

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

Overview

Roebe::Zenity

Constant Summary collapse

AVAILABLE_OPTIONS =
#

AVAILABLE_OPTIONS

Which options are available for Zenity.

#
[
  :calendar,
  :entry,
  :error,
  :'file-selection',
  :info,
  :list,
  :notification,
  :progress,
  :question,
  :'text-info',
  :warning,
  :scale
].map(&:to_s)

Constants inherited from Base

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

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_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(options = {}, run_already = false) ⇒ Zenity

#

initialize

The first argument, ‘options` is a Hash that should contain the options we wish to pass to “zenity” itself.

#


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/roebe/classes/zenity.rb', line 48

def initialize(
    options     = {},
    run_already = false
  )
  reset
  if options.is_a? Hash
    set_title(options[:title]) if options.has_key? :title
    set_text(options[:text])   if options.has_key? :text
  end
  if options.include? :type
    set_mode(options[:type])
  else # Else set the default mode.
    set_mode
  end
  run if run_already
end

Class Method Details

.[](i = 'Hello world') ⇒ Object

#


289
290
291
292
293
 
# File 'lib/roebe/classes/zenity.rb', line 289

def self.[](i = 'Hello world')
  self.entry(
    :text => i
  )
end

.calendar(title = 'select a date') ⇒ Object

#

Zenity.calendar (calendar tag)

Run the calendar variant of Zenity.

Usage example:

Zenity.calendar( :title => 'Select a date')
#


123
124
125
126
127
128
129
130
131
 
# File 'lib/roebe/classes/zenity.rb', line 123

def self.calendar(title = 'select a date')
  type = :calendar
  hash = {}
  hash[:type]  = type
  hash[:title] = title if title.is_a? String
  hash[:text]  = 'Click on a date to select that date.' 
  hash.merge!(title) if title.is_a? Hash
  Zenity.new(hash).run
end

.entry(title = 'select a date') ⇒ Object

#

Zenity.entry (entry tag)

Run the password variant of Zenity.

Usage example:

Zenity.entry( title: 'Select a date')
#


103
104
105
106
107
108
109
110
111
 
# File 'lib/roebe/classes/zenity.rb', line 103

def self.entry(title = 'select a date')
  type = :entry
  hash = {}
  hash[:type]  = type
  hash[:title] = title if title.is_a? String
  hash[:text]  = 'Click on a date to select that date.' 
  hash.merge!(title) if title.is_a? Hash
  Zenity.new(hash).run
end

Instance Method Details

#add(i) ⇒ Object

#

add (add tag)

#


254
255
256
257
258
259
260
 
# File 'lib/roebe/classes/zenity.rb', line 254

def add(i)
  unless i.end_with? ' '
    i = i.dup if i.frozen?
    i << ' '
  end
  @sys_cmd << i
end

#build_sys_cmd ⇒ Object

#

build_sys_cmd

#


221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/roebe/classes/zenity.rb', line 221

def build_sys_cmd
  add @mode.to_s
  add '--title="'
  add @title.to_s
  add '"'
  add ' --text="'
  add @text.to_s
  add '" '
  add @height.to_s
  add @width.to_s
  add @window_icon.to_s
  if @do_open_in_the_background
    add ' &'
  end
end

#enable_auto_close ⇒ Object

#

enable_auto_close

Whether to auto-close after showing this or not.

#


214
215
216
 
# File 'lib/roebe/classes/zenity.rb', line 214

def enable_auto_close
  add ' --auto-close'
end

#open_in_background ⇒ Object

#

open_in_background

#


247
248
249
 
# File 'lib/roebe/classes/zenity.rb', line 247

def open_in_background
  @do_open_in_the_background = true
end

#reset ⇒ Object

#

reset

#


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/roebe/classes/zenity.rb', line 68

def reset
  super()
  infer_the_namespace
  # ================================================================== #
  # === @sys_cmd
  # ================================================================== #
  @sys_cmd = 'zenity '.dup
  # ================================================================== #
  # === @do_open_in_the_background
  # ================================================================== #
  @do_open_in_the_background = false
  set_width
  set_height
  set_windowicon
end

#run ⇒ Object

#

run

Run this thingy.

#


275
276
277
278
279
 
# File 'lib/roebe/classes/zenity.rb', line 275

def run
  build_sys_cmd
  sanitize_the_sys_cmd
  run_sys_cmd
end

#run_sys_cmd ⇒ Object

#

run_sys_cmd

This runs our sys command.

#


197
198
199
200
 
# File 'lib/roebe/classes/zenity.rb', line 197

def run_sys_cmd
  e sys_cmd?
  Kernel.system sys_cmd?
end

#sanitize_the_sys_cmd ⇒ Object

#

sanitize_the_sys_cmd

#


265
266
267
268
 
# File 'lib/roebe/classes/zenity.rb', line 265

def sanitize_the_sys_cmd
  @sys_cmd.strip!
  @sys_cmd.squeeze(' ')
end

#set_height(height = 620) ⇒ Object

#

set_height

#


136
137
138
 
# File 'lib/roebe/classes/zenity.rb', line 136

def set_height(height = 620)
  @height = "--height=#{height} "
end

#set_mode(mode = '--info') ⇒ Object Also known as: set_type

#

set_mode

Set zenity mode.

Possible modes are (for the others, look at the top of this file):

--text-info
--info
#


158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/roebe/classes/zenity.rb', line 158

def set_mode(mode = '--info')
  mode = mode.to_s.strip
  included_mode = mode.delete('-')
  if AVAILABLE_OPTIONS.include? included_mode # All is fine then.
  else
    e 'Warning: '+included_mode+' is not included.'
  end
  unless mode.start_with? '--'
    mode.prepend('--')
  end
  @mode = ' '+mode+' ' # keeps what mode or type you want to use with zenity
end

#set_text(new_text) ⇒ Object

#

set_text

Set the text of our zenity dialog.

#


188
189
190
 
# File 'lib/roebe/classes/zenity.rb', line 188

def set_text(new_text)
  @text = new_text.to_s ? new_text : 'lala'
end

#set_title(new_title = nil) ⇒ Object

#

set_title

Set the title of our zenity dialog.

#


89
90
91
 
# File 'lib/roebe/classes/zenity.rb', line 89

def set_title(new_title = nil)
  @title = new_title ? new_title : 'Titel'
end

#set_width(width = 620) ⇒ Object

#

set_width

#


143
144
145
 
# File 'lib/roebe/classes/zenity.rb', line 143

def set_width(width = 620)
  @width = '--width='+width.to_s+' '
end

#set_windowicon(this_location = home_directory_of_user_x?+'DATA/images/PC/OS/LINUX/GTK_FAVICON.png') ⇒ Object

#

set_windowicon

Provide the window-icon location as the first argument.

#


176
177
178
179
180
181
 
# File 'lib/roebe/classes/zenity.rb', line 176

def set_windowicon(
    this_location =
      home_directory_of_user_x?+'DATA/images/PC/OS/LINUX/GTK_FAVICON.png'
  )
  @window_icon = '--window-icon="'+this_location+'" '
end

#sys_cmd? ⇒ Boolean Also known as: cmd?

#

sys_cmd?

#

Returns:

  • (Boolean) 


240
241
242
 
# File 'lib/roebe/classes/zenity.rb', line 240

def sys_cmd?
  @sys_cmd
end

#use_this_column(i = 'Hello World') ⇒ Object

#

use_this_column

#


205
206
207
 
# File 'lib/roebe/classes/zenity.rb', line 205

def use_this_column(i = 'Hello World')
  add(' --column="'+i+'"')
end